de.tudarmstadt.ukp.dkpro.core.io.xml

Class XmlXPathReader

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CollectionReader_ImplBase

org.apache.uima.fit.component.CasCollectionReader_ImplBase

de.tudarmstadt.ukp.dkpro.core.api.io.FileSetCollectionReaderBase

de.tudarmstadt.ukp.dkpro.core.io.xml.XmlXPathReader

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.BaseCollectionReader, org.apache.uima.collection.CollectionReader, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource

public class XmlXPathReader
extends FileSetCollectionReaderBase

A component reader for XML files implemented with XPath.

This is currently optimized for TREC format, which means the style topics are presented in. You should provide the parameter XPath expression that of the parent node And the child nodes of each parent node will be stored separately in its own CAS.

If your expression evaluates to leaf nodes, empty CASes will be created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlXPathReader.XmlNodes

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_DOC_ID_TAG Tag which contains the docId.
static String	PARAM_EXCLUDE_TAGS Tags which should be ignored.
static String	PARAM_INCLUDE_TAGS Tags which should be worked on.
static String	PARAM_LANGUAGE Language of the documents.
static String	PARAM_SUBSTITUTE_TAGS Specify to substitute tag names in CAS.
static String	PARAM_XPATH_EXPRESSION Specifies the XPath expression to all nodes to be processed.

Fields inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.FileSetCollectionReaderBase

EXCLUDE_PREFIX, INCLUDE_PREFIX, PARAM_CASE_SENSITIVE, PARAM_PATH, PARAM_PATTERNS, PARAM_SOURCE_LOCATION, PARAM_USE_DEFAULT_EXCLUDES

Fields inherited from interface org.apache.uima.resource.Resource

PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

Constructors

Constructor and Description
XmlXPathReader()

Method Summary

Modifier and Type	Method and Description
void	getNext(org.apache.uima.cas.CAS cas)
boolean	hasNext() Check whether there is still nodes to be processed.
void	initialize(org.apache.uima.UimaContext arg0)

Methods inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.FileSetCollectionReaderBase

getFileSetIterator, getIncludedFilesCount, getLanguage, getProgress, initCas, nextFile

Methods inherited from class org.apache.uima.fit.component.CasCollectionReader_ImplBase

close, getLogger, initialize

Methods inherited from class org.apache.uima.collection.CollectionReader_ImplBase

destroy, getCasInitializer, getProcessingResourceMetaData, initialize, isConsuming, reconfigure, setCasInitializer, typeSystemInit

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

getCasManager, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.uima.resource.ConfigurableResource

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from interface org.apache.uima.resource.Resource

getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Detail

PARAM_XPATH_EXPRESSION

public static final String PARAM_XPATH_EXPRESSION

Specifies the XPath expression to all nodes to be processed. Different segments will be separated via PARAM_ID_TAG, and each segment will be stored in a separate CAS.

See Also:

Constant Field Values

PARAM_INCLUDE_TAGS

public static final String PARAM_INCLUDE_TAGS

Tags which should be worked on. If empty then all tags will be processed.

If this and PARAM_EXCLUDE_TAGS are both provided, tags in set PARAM_INCLUDE_TAGS - PARAM_EXCLUDE_TAGS will be processed.

See Also:

Constant Field Values

PARAM_EXCLUDE_TAGS

public static final String PARAM_EXCLUDE_TAGS

Tags which should be ignored. If empty then all tags will be processed.

If this and PARAM_INCLUDE_TAGS are both provided, tags in set PARAM_INCLUDE_TAGS - PARAM_EXCLUDE_TAGS will be processed.

See Also:

Constant Field Values

PARAM_LANGUAGE

public static final String PARAM_LANGUAGE

Language of the documents. If given, it will be set in each CAS.

See Also:

Constant Field Values

PARAM_SUBSTITUTE_TAGS

public static final String PARAM_SUBSTITUTE_TAGS

Specify to substitute tag names in CAS.

Please give the substitutions each in before - after order. For example to substitute "foo" with "bar", and "hey" with "ho", you can provide { "foo", "bar", "hey", "ho" }.

See Also:

Constant Field Values

PARAM_DOC_ID_TAG

public static final String PARAM_DOC_ID_TAG

Tag which contains the docId. If it is given, it will be ensured that within the same document there is only one id tag and it is not empty

See Also:

Constant Field Values

Constructor Detail

XmlXPathReader

public XmlXPathReader()

Method Detail

initialize

public void initialize(org.apache.uima.UimaContext arg0)
                throws org.apache.uima.resource.ResourceInitializationException

Overrides:

initialize in class FileSetCollectionReaderBase

Throws:

org.apache.uima.resource.ResourceInitializationException

hasNext

public boolean hasNext()
                throws IOException,
                       org.apache.uima.collection.CollectionException

Check whether there is still nodes to be processed.

After all nodes from current file get processed, read in nodes from the next file

Specified by:

hasNext in interface org.apache.uima.collection.base_cpm.BaseCollectionReader

Overrides:

hasNext in class FileSetCollectionReaderBase

Returns:

true if there is still nodes to process
false iff there is neither nodes nor files remaining

Throws:

IOException

org.apache.uima.collection.CollectionException

getNext

public void getNext(org.apache.uima.cas.CAS cas)
             throws IOException

Throws:

IOException