Package org.apache.nifi.xml

Class WriteXMLResult

java.lang.Object

org.apache.nifi.serialization.AbstractRecordSetWriter

org.apache.nifi.xml.WriteXMLResult

All Implemented Interfaces:

Closeable, AutoCloseable, RawRecordWriter, RecordSetWriter, RecordWriter

public class WriteXMLResult
extends AbstractRecordSetWriter
implements RecordSetWriter, RawRecordWriter

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	allowWritingMultipleRecords
private final String	arrayTagName
private final ArrayWrapping	arrayWrapping
private final String	dateFormat
private boolean	hasWrittenRecord
private final org.apache.nifi.NullSuppression	nullSuppression
private final boolean	omitDeclaration
private final RecordSchema	recordSchema
private final String	recordTagName
private final String	rootTagName
private final SchemaAccessWriter	schemaAccess
private static final FieldConverter<Object,String>	STRING_FIELD_CONVERTER
private static final Pattern	TAG_NAME_CHARS_TO_STRIP
private final String	timeFormat
private final String	timestampFormat
private final XMLStreamWriter	writer

Constructor Summary

Constructors

Constructor	Description
WriteXMLResult(RecordSchema recordSchema, SchemaAccessWriter schemaAccess, OutputStream out, boolean prettyPrint, boolean omitDeclaration, org.apache.nifi.NullSuppression nullSuppression, ArrayWrapping arrayWrapping, String arrayTagName, String rootTagName, String recordTagName, String charSet, String dateFormat, String timeFormat, String timestampFormat)

Method Summary

Modifier and Type	Method	Description
private void	checkWritingMultipleRecords()
void	close()
private String	escapeTagName(String tagName)
void	flush()
String	getMimeType()
private boolean	iterateThroughRecordUsingSchema(Deque<String> tagsToOpen, Record record, RecordSchema schema)
private boolean	iterateThroughRecordWithoutSchema(Deque<String> tagsToOpen, Record record)
protected void	onBeginRecordSet()
protected Map<String,String>	onFinishRecordSet()
private boolean	recordHasField(RecordField field, Record record)
private void	writeAllTags(Deque<String> tagsToOpen)
private void	writeAllTags(Deque<String> tagsToOpen, String fieldName)
private boolean	writeFieldForType(Deque<String> tagsToOpen, Object coercedValue, DataType dataType, String fieldName)
WriteResult	writeRawRecord(Record record)
protected Map<String,String>	writeRecord(Record record)
private boolean	writeUnknownField(Deque<String> tagsToOpen, Object value, String fieldName)

Methods inherited from class org.apache.nifi.serialization.AbstractRecordSetWriter

beginRecordSet, finishRecordSet, getOutputStream, getRecordCount, incrementRecordCount, isActiveRecordSet, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.nifi.serialization.RecordSetWriter

beginRecordSet, finishRecordSet, write

Methods inherited from interface org.apache.nifi.serialization.RecordWriter

write

Field Details

TAG_NAME_CHARS_TO_STRIP

private static final Pattern TAG_NAME_CHARS_TO_STRIP

STRING_FIELD_CONVERTER

private static final FieldConverter<Object,String> STRING_FIELD_CONVERTER

recordSchema

private final RecordSchema recordSchema

schemaAccess

private final SchemaAccessWriter schemaAccess

writer

private final XMLStreamWriter writer

nullSuppression

private final org.apache.nifi.NullSuppression nullSuppression

omitDeclaration

private final boolean omitDeclaration

arrayWrapping

private final ArrayWrapping arrayWrapping

arrayTagName

private final String arrayTagName

recordTagName

private final String recordTagName

rootTagName

private final String rootTagName

allowWritingMultipleRecords

private final boolean allowWritingMultipleRecords

hasWrittenRecord

private boolean hasWrittenRecord

dateFormat

private final String dateFormat

timeFormat

private final String timeFormat

timestampFormat

private final String timestampFormat

Constructor Details

WriteXMLResult

public WriteXMLResult(RecordSchema recordSchema,
 SchemaAccessWriter schemaAccess,
 OutputStream out,
 boolean prettyPrint,
 boolean omitDeclaration,
 org.apache.nifi.NullSuppression nullSuppression,
 ArrayWrapping arrayWrapping,
 String arrayTagName,
 String rootTagName,
 String recordTagName,
 String charSet,
 String dateFormat,
 String timeFormat,
 String timestampFormat)
               throws IOException

Throws:

IOException

Method Details

onBeginRecordSet

protected void onBeginRecordSet()
                         throws IOException

Overrides:

onBeginRecordSet in class AbstractRecordSetWriter

Throws:

IOException

onFinishRecordSet

protected Map<String,String> onFinishRecordSet()
                                        throws IOException

Overrides:

onFinishRecordSet in class AbstractRecordSetWriter

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class AbstractRecordSetWriter

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface RecordWriter

Overrides:

flush in class AbstractRecordSetWriter

Throws:

IOException

checkWritingMultipleRecords

private void checkWritingMultipleRecords()
                                  throws IOException

Throws:

IOException

writeRecord

protected Map<String,String> writeRecord(Record record)
                                  throws IOException

Specified by:

writeRecord in class AbstractRecordSetWriter

Throws:

IOException

iterateThroughRecordUsingSchema

private boolean iterateThroughRecordUsingSchema(Deque<String> tagsToOpen,
 Record record,
 RecordSchema schema)
                                         throws XMLStreamException

Throws:

XMLStreamException

writeFieldForType

private boolean writeFieldForType(Deque<String> tagsToOpen,
 Object coercedValue,
 DataType dataType,
 String fieldName)
                           throws XMLStreamException

Throws:

XMLStreamException

writeAllTags

private void writeAllTags(Deque<String> tagsToOpen,
 String fieldName)
                   throws XMLStreamException

Throws:

XMLStreamException

escapeTagName

private String escapeTagName(String tagName)

writeAllTags

private void writeAllTags(Deque<String> tagsToOpen)
                   throws XMLStreamException

Throws:

XMLStreamException

writeRawRecord

public WriteResult writeRawRecord(Record record)
                           throws IOException

Specified by:

writeRawRecord in interface RawRecordWriter

Throws:

IOException

iterateThroughRecordWithoutSchema

private boolean iterateThroughRecordWithoutSchema(Deque<String> tagsToOpen,
 Record record)
                                           throws XMLStreamException

Throws:

XMLStreamException

writeUnknownField

private boolean writeUnknownField(Deque<String> tagsToOpen,
 Object value,
 String fieldName)
                           throws XMLStreamException

Throws:

XMLStreamException

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface RecordWriter

recordHasField

private boolean recordHasField(RecordField field,
 Record record)