org.apache.nifi.xml

Class XMLReader

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.serialization.SchemaRegistryService

org.apache.nifi.xml.XMLReader

All Implemented Interfaces:

ConfigurableComponent, ControllerService, RecordReaderFactory

@Tags(value={"xml","record","reader","parser"})
 @CapabilityDescription(value="Reads XML content and creates Record objects. Records are expected in the second level of XML data, embedded in an enclosing root tag.")
public class XMLReader
extends SchemaRegistryService
implements RecordReaderFactory

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ATTRIBUTE_PREFIX
static PropertyDescriptor	CONTENT_FIELD_NAME
private String	dateFormat
static PropertyDescriptor	PARSE_XML_ATTRIBUTES
private boolean	parseXmlAttributes
static AllowableValue	RECORD_ARRAY
static AllowableValue	RECORD_EVALUATE
static PropertyDescriptor	RECORD_FORMAT
static AllowableValue	RECORD_SINGLE
private String	timeFormat
private String	timestampFormat

Fields inherited from class org.apache.nifi.serialization.SchemaRegistryService

schemaAccessStrategy

Constructor Summary

Constructors

Constructor and Description
XMLReader()

Method Summary

Modifier and Type	Method and Description
RecordReader	createRecordReader(Map<String,String> variables, InputStream in, long inputLength, ComponentLog logger)
protected AllowableValue	getDefaultSchemaAccessStrategy()
protected SchemaAccessStrategy	getSchemaAccessStrategy(String strategy, SchemaRegistry schemaRegistry, PropertyContext context)
protected List<AllowableValue>	getSchemaAccessStrategyValues()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private boolean	isMultipleRecords(PropertyContext context, Map<String,String> variables)
void	onEnabled(ConfigurationContext context)
private String	trim(String value)

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

buildStrategyProperty, customValidate, getConfigurationContext, getSchema, getSchema, getSchemaAccessStrategy, getSchemaAcessStrategyDescriptor, getSuppliedSchemaFields, storeSchemaAccessStrategy

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

createRecordReader

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

RECORD_SINGLE

public static final AllowableValue RECORD_SINGLE

RECORD_ARRAY

public static final AllowableValue RECORD_ARRAY

RECORD_EVALUATE

public static final AllowableValue RECORD_EVALUATE

RECORD_FORMAT

public static final PropertyDescriptor RECORD_FORMAT

ATTRIBUTE_PREFIX

public static final PropertyDescriptor ATTRIBUTE_PREFIX

CONTENT_FIELD_NAME

public static final PropertyDescriptor CONTENT_FIELD_NAME

PARSE_XML_ATTRIBUTES

public static final PropertyDescriptor PARSE_XML_ATTRIBUTES

parseXmlAttributes

private volatile boolean parseXmlAttributes

dateFormat

private volatile String dateFormat

timeFormat

private volatile String timeFormat

timestampFormat

private volatile String timestampFormat

Constructor Detail

XMLReader

public XMLReader()

Method Detail

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class SchemaRegistryService

getSchemaAccessStrategyValues

protected List<AllowableValue> getSchemaAccessStrategyValues()

Overrides:

getSchemaAccessStrategyValues in class SchemaRegistryService

getSchemaAccessStrategy

protected SchemaAccessStrategy getSchemaAccessStrategy(String strategy,
                                                       SchemaRegistry schemaRegistry,
                                                       PropertyContext context)

Overrides:

getSchemaAccessStrategy in class SchemaRegistryService

isMultipleRecords

private boolean isMultipleRecords(PropertyContext context,
                                  Map<String,String> variables)

getDefaultSchemaAccessStrategy

protected AllowableValue getDefaultSchemaAccessStrategy()

Overrides:

getDefaultSchemaAccessStrategy in class SchemaRegistryService

createRecordReader

public RecordReader createRecordReader(Map<String,String> variables,
                                       InputStream in,
                                       long inputLength,
                                       ComponentLog logger)
                                throws IOException,
                                       SchemaNotFoundException,
                                       MalformedRecordException

Specified by:

createRecordReader in interface RecordReaderFactory

Throws:

IOException

SchemaNotFoundException

MalformedRecordException

trim

private String trim(String value)