Package org.apache.uima.collection.impl.metadata.cpe

Class CpeCollectionReaderImpl

java.lang.Object

org.apache.uima.resource.metadata.impl.MetaDataObject_impl

org.apache.uima.collection.impl.metadata.cpe.CpeCollectionReaderImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, CpeCollectionReader, MetaDataObject, XMLizable

public class CpeCollectionReaderImpl
extends MetaDataObject_impl
implements CpeCollectionReader

The Class CpeCollectionReaderImpl.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl

MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer

Field Summary

Fields

Modifier and Type	Field	Description
private CpeCollectionReaderCasInitializer	casInitializer	The cas initializer.
private CpeCollectionReaderIterator	collectionIterator	The collection iterator.
private static long	serialVersionUID	The Constant serialVersionUID.
private static XmlizationInfo	XMLIZATION_INFO	The Constant XMLIZATION_INFO.

Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl

serialContext

Constructor Summary

Constructors

Constructor	Description
CpeCollectionReaderImpl()	Instantiates a new cpe collection reader impl.

Method Summary

Modifier and Type	Method	Description
CpeCollectionReaderCasInitializer	getCasInitializer()	Returns CasInitializer associated with CollectionReader.
CpeCollectionReaderIterator	getCollectionIterator()
CasProcessorConfigurationParameterSettings	getConfigurationParameterSettings()	Returns configuration parameter settings for this CollectionReader.
CpeComponentDescriptor	getDescriptor()	Returns CpeComponentDescriptor containing CollectionReader descriptor path.
protected XmlizationInfo	getXmlizationInfo()	To be implemented by subclasses to return information describing how to represent this object in XML.
void	removeCasInitializer()	Removes CpeCollectionReaderCasInitializer from CollectionReader
void	setCasInitializer(CpeCollectionReaderCasInitializer aCasInitializer)	Sets CasInitializer for the CollectionReader will use.
void	setCollectionIterator(CpeCollectionReaderIterator iterator)	Sets the collection iterator.
void	setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings aParams)	Sets configuration parameter settings for this CollectionReader.
void	setDescriptor(CpeComponentDescriptor aDescriptor)	Sets descriptor path containing configuration for the CollectionReader

Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl

buildFromXMLElement, buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject

clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl

Methods inherited from interface org.apache.uima.util.XMLizable

buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML

Field Detail

serialVersionUID

private static final long serialVersionUID

The Constant serialVersionUID.

See Also:

Constant Field Values

collectionIterator

private CpeCollectionReaderIterator collectionIterator

The collection iterator.

casInitializer

private CpeCollectionReaderCasInitializer casInitializer

The cas initializer.

XMLIZATION_INFO

private static final XmlizationInfo XMLIZATION_INFO

The Constant XMLIZATION_INFO.

Constructor Detail

CpeCollectionReaderImpl

public CpeCollectionReaderImpl()

Instantiates a new cpe collection reader impl.

Method Detail

setCasInitializer

public void setCasInitializer(CpeCollectionReaderCasInitializer aCasInitializer)
                       throws CpeDescriptorException

Description copied from interface: CpeCollectionReader

Sets CasInitializer for the CollectionReader will use. This object initializes the CAS with SoFas.

Specified by:

setCasInitializer in interface CpeCollectionReader

Parameters:

aCasInitializer - - CpeCollectionReaderCasInitializer

Throws:

CpeDescriptorException - tbd

getCasInitializer

public CpeCollectionReaderCasInitializer getCasInitializer()
                                                    throws CpeDescriptorException

Description copied from interface: CpeCollectionReader

Returns CasInitializer associated with CollectionReader. This object initializes the CAS with SoFas.

Specified by:

getCasInitializer in interface CpeCollectionReader

Returns:

CpeCollectionReaderCasInitializer

Throws:

CpeDescriptorException - tbd

removeCasInitializer

public void removeCasInitializer()

Description copied from interface: CpeCollectionReader

Removes CpeCollectionReaderCasInitializer from CollectionReader

Specified by:

removeCasInitializer in interface CpeCollectionReader

setDescriptor

public void setDescriptor(CpeComponentDescriptor aDescriptor)

Description copied from interface: CpeCollectionReader

Sets descriptor path containing configuration for the CollectionReader

Specified by:

setDescriptor in interface CpeCollectionReader

Parameters:

aDescriptor - - component containing descriptor path

getDescriptor

public CpeComponentDescriptor getDescriptor()

Description copied from interface: CpeCollectionReader

Returns CpeComponentDescriptor containing CollectionReader descriptor path.

Specified by:

getDescriptor in interface CpeCollectionReader

Returns:

component containing descriptor path

getConfigurationParameterSettings

public CasProcessorConfigurationParameterSettings getConfigurationParameterSettings()

Returns configuration parameter settings for this CollectionReader.

Specified by:

getConfigurationParameterSettings in interface CpeCollectionReader

Returns:

the configuration parameter settings

setConfigurationParameterSettings

public void setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings aParams)
                                       throws CpeDescriptorException

Sets configuration parameter settings for this CollectionReader.

Specified by:

setConfigurationParameterSettings in interface CpeCollectionReader

Parameters:

aParams - the new configuration parameter settings

Throws:

CpeDescriptorException - the cpe descriptor exception

getXmlizationInfo

protected XmlizationInfo getXmlizationInfo()

Description copied from class: MetaDataObject_impl

To be implemented by subclasses to return information describing how to represent this object in XML.

Specified by:

getXmlizationInfo in class MetaDataObject_impl

Returns:

information defining this object's XML representation

setCollectionIterator

public void setCollectionIterator(CpeCollectionReaderIterator iterator)

Sets the collection iterator.

Specified by:

setCollectionIterator in interface CpeCollectionReader

Parameters:

iterator - the new collection iterator

getCollectionIterator

public CpeCollectionReaderIterator getCollectionIterator()

Specified by:

getCollectionIterator in interface CpeCollectionReader