org.apache.tika.parser.xml

Class ElementMetadataHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.tika.parser.xml.AbstractMetadataHandler

org.apache.tika.parser.xml.ElementMetadataHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class ElementMetadataHandler
extends AbstractMetadataHandler

SAX event handler that maps the contents of an XML element into a metadata field.

Since:

Apache Tika 0.10

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowDuplicateValues
private boolean	allowEmptyValues
private java.lang.StringBuilder	bufferBagged The buffer used to capture characters when inside a bag li element.
private java.lang.StringBuilder	bufferBagless The buffer used to capture characters inside standard elements.
private boolean	isBagless Whether or not the value was found in a standard element structure or inside a bag.
private static java.lang.String	LOCAL_NAME_RDF_BAG
private static java.lang.String	LOCAL_NAME_RDF_LI
private java.lang.String	localName
private static org.slf4j.Logger	LOG
private int	matchLevel
private Metadata	metadata
private java.lang.String	name
private int	parentMatchLevel
private Property	targetProperty
private java.lang.String	uri
private static java.lang.String	URI_RDF

Constructor Summary

Constructors

Constructor and Description
ElementMetadataHandler(java.lang.String uri, java.lang.String localName, Metadata metadata, Property targetProperty) Constructor for Property metadata keys.
ElementMetadataHandler(java.lang.String uri, java.lang.String localName, Metadata metadata, Property targetProperty, boolean allowDuplicateValues, boolean allowEmptyValues) Constructor for Property metadata keys which allows change of behavior for duplicate and empty entry values.
ElementMetadataHandler(java.lang.String uri, java.lang.String localName, Metadata metadata, java.lang.String name) Constructor for string metadata keys.
ElementMetadataHandler(java.lang.String uri, java.lang.String localName, Metadata metadata, java.lang.String name, boolean allowDuplicateValues, boolean allowEmptyValues) Constructor for string metadata keys which allows change of behavior for duplicate and empty entry values.

Method Summary

Modifier and Type	Method and Description
protected void	addMetadata(java.lang.String value) Adds the given metadata value.
void	characters(char[] ch, int start, int length)
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String name)
void	ignorableWhitespace(char[] ch, int start, int length)
protected boolean	isMatchingElement(java.lang.String uri, java.lang.String localName)
protected boolean	isMatchingParentElement(java.lang.String uri, java.lang.String localName)
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String name, org.xml.sax.Attributes attributes)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

LOCAL_NAME_RDF_BAG

private static final java.lang.String LOCAL_NAME_RDF_BAG

See Also:

Constant Field Values

LOCAL_NAME_RDF_LI

private static final java.lang.String LOCAL_NAME_RDF_LI

See Also:

Constant Field Values

URI_RDF

private static final java.lang.String URI_RDF

See Also:

Constant Field Values

uri

private final java.lang.String uri

localName

private final java.lang.String localName

metadata

private final Metadata metadata

name

private final java.lang.String name

targetProperty

private Property targetProperty

allowDuplicateValues

private final boolean allowDuplicateValues

allowEmptyValues

private final boolean allowEmptyValues

bufferBagged

private final java.lang.StringBuilder bufferBagged

The buffer used to capture characters when inside a bag li element.

bufferBagless

private final java.lang.StringBuilder bufferBagless

The buffer used to capture characters inside standard elements.

isBagless

private boolean isBagless

Whether or not the value was found in a standard element structure or inside a bag.

matchLevel

private int matchLevel

parentMatchLevel

private int parentMatchLevel

Constructor Detail

ElementMetadataHandler

public ElementMetadataHandler(java.lang.String uri,
                              java.lang.String localName,
                              Metadata metadata,
                              java.lang.String name)

Constructor for string metadata keys.

Parameters:

uri - the uri of the namespace of the element

localName - the local name of the element

metadata - the Tika metadata object to populate

name - the Tika metadata field key

ElementMetadataHandler

public ElementMetadataHandler(java.lang.String uri,
                              java.lang.String localName,
                              Metadata metadata,
                              java.lang.String name,
                              boolean allowDuplicateValues,
                              boolean allowEmptyValues)

Constructor for string metadata keys which allows change of behavior for duplicate and empty entry values.

Parameters:

uri - the uri of the namespace of the element

localName - the local name of the element

metadata - the Tika metadata object to populate

name - the Tika metadata field key

allowDuplicateValues - add duplicate values to the Tika metadata

allowEmptyValues - add empty values to the Tika metadata

ElementMetadataHandler

public ElementMetadataHandler(java.lang.String uri,
                              java.lang.String localName,
                              Metadata metadata,
                              Property targetProperty)

Constructor for Property metadata keys.

Parameters:

uri - the uri of the namespace of the element

localName - the local name of the element

metadata - the Tika metadata object to populate

targetProperty - the Tika metadata Property key

ElementMetadataHandler

public ElementMetadataHandler(java.lang.String uri,
                              java.lang.String localName,
                              Metadata metadata,
                              Property targetProperty,
                              boolean allowDuplicateValues,
                              boolean allowEmptyValues)

Constructor for Property metadata keys which allows change of behavior for duplicate and empty entry values.

Parameters:

uri - the uri of the namespace of the element

localName - the local name of the element

metadata - the Tika metadata object to populate

targetProperty - the Tika metadata Property key

allowDuplicateValues - add duplicate values to the Tika metadata

allowEmptyValues - add empty values to the Tika metadata

Method Detail

isMatchingParentElement

protected boolean isMatchingParentElement(java.lang.String uri,
                                          java.lang.String localName)

isMatchingElement

protected boolean isMatchingElement(java.lang.String uri,
                                    java.lang.String localName)

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String name,
                         org.xml.sax.Attributes attributes)

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String name)

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

characters

public void characters(char[] ch,
                       int start,
                       int length)

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Overrides:

ignorableWhitespace in class org.xml.sax.helpers.DefaultHandler

addMetadata

protected void addMetadata(java.lang.String value)

Description copied from class: AbstractMetadataHandler

Adds the given metadata value. The value is ignored if it is null or empty. If the metadata entry already exists, then the given value is appended to it with a comma as the separator.

Overrides:

addMetadata in class AbstractMetadataHandler

Parameters:

value - metadata value