org.apache.uima.examples.xmi

Class XmiCollectionReader

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CollectionReader_ImplBase

org.apache.uima.examples.xmi.XmiCollectionReader

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 XmiCollectionReader
extends org.apache.uima.collection.CollectionReader_ImplBase

A simple collection reader that reads CASes in XMI format from a directory in the filesystem.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_FAILUNKNOWN Name of the configuration parameter that must be set to indicate if the execution fails if an encountered type is unknown
static String	PARAM_INPUTDIR Name of configuration parameter that must be set to the path of a directory containing the XMI files.

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
XmiCollectionReader()

Method Summary

Modifier and Type	Method and Description
void	close()
void	getNext(org.apache.uima.cas.CAS aCAS)
org.apache.uima.util.Progress[]	getProgress()
boolean	hasNext()
void	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, getLogger, 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

getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Detail

PARAM_INPUTDIR

public static final String PARAM_INPUTDIR

Name of configuration parameter that must be set to the path of a directory containing the XMI files.

See Also:

Constant Field Values

PARAM_FAILUNKNOWN

public static final String PARAM_FAILUNKNOWN

Name of the configuration parameter that must be set to indicate if the execution fails if an encountered type is unknown

See Also:

Constant Field Values

Constructor Detail

XmiCollectionReader

public XmiCollectionReader()

Method Detail

initialize

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

Overrides:

initialize in class org.apache.uima.collection.CollectionReader_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

See Also:

CollectionReader_ImplBase.initialize()

hasNext

public boolean hasNext()

See Also:

BaseCollectionReader.hasNext()

getNext

public void getNext(org.apache.uima.cas.CAS aCAS)
             throws IOException,
                    org.apache.uima.collection.CollectionException

Throws:

IOException

org.apache.uima.collection.CollectionException

See Also:

CollectionReader.getNext(org.apache.uima.cas.CAS)

close

public void close()
           throws IOException

Throws:

IOException

See Also:

BaseCollectionReader.close()

getProgress

public org.apache.uima.util.Progress[] getProgress()

See Also:

BaseCollectionReader.getProgress()