Interface CpeCollectionReader
- All Superinterfaces:
Cloneable,MetaDataObject,Serializable,XMLizable
An object that holds configuration that is part of the CPE descriptor. Provides the means of
configuring CPE CollectionReader.
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.As of v2.0 CAS Initializers are deprecated.ReturnsCasProcessorConfigurationParameterSettingsobject containing overrides to parameter settings for this CollectionReader.ReturnsCpeComponentDescriptorcontaining CollectionReader descriptor path.voidRemovesCpeCollectionReaderCasInitializerfrom CollectionReadervoidsetCasInitializer(CpeCollectionReaderCasInitializer aCasInitializer) Deprecated.As of v2.0 CAS Initializers are deprecated.voidvoidSets theCasProcessorConfigurationParameterSettingsobject containing overrides to parameter settings for this CollectionReader.voidsetDescriptor(CpeComponentDescriptor aDescriptor) Sets descriptor path containing configuration for the CollectionReaderMethods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Method Details
-
setCasInitializer
@Deprecated void setCasInitializer(CpeCollectionReaderCasInitializer aCasInitializer) throws CpeDescriptorException Deprecated.As of v2.0 CAS Initializers are deprecated.Sets CasInitializer for the CollectionReader will use. This object initializes the CAS with SoFas.- Parameters:
aCasInitializer- -CpeCollectionReaderCasInitializer- Throws:
CpeDescriptorException- tbd
-
getCasInitializer
Deprecated.As of v2.0 CAS Initializers are deprecated.Returns CasInitializer associated with CollectionReader. This object initializes the CAS with SoFas.- Returns:
CpeCollectionReaderCasInitializer- Throws:
CpeDescriptorException- tbd
-
removeCasInitializer
void removeCasInitializer()RemovesCpeCollectionReaderCasInitializerfrom CollectionReader -
setDescriptor
Sets descriptor path containing configuration for the CollectionReader- Parameters:
aDescriptor- - component containing descriptor path
-
getDescriptor
CpeComponentDescriptor getDescriptor()ReturnsCpeComponentDescriptorcontaining CollectionReader descriptor path.- Returns:
- component containing descriptor path
-
getConfigurationParameterSettings
CasProcessorConfigurationParameterSettings getConfigurationParameterSettings()ReturnsCasProcessorConfigurationParameterSettingsobject containing overrides to parameter settings for this CollectionReader.- Returns:
- - object containing parameter setting overrides
-
setConfigurationParameterSettings
void setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings aSettings) throws CpeDescriptorException Sets theCasProcessorConfigurationParameterSettingsobject containing overrides to parameter settings for this CollectionReader.- Parameters:
aSettings- object containing parameter setting overrides- Throws:
CpeDescriptorException- tbd
-
setCollectionIterator
-
getCollectionIterator
CpeCollectionReaderIterator getCollectionIterator()
-