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

Class CpeDescriptionImpl

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, Cloneable, org.apache.uima.collection.metadata.CpeDescription, org.apache.uima.resource.metadata.MetaDataObject, org.apache.uima.util.XMLizable

public class CpeDescriptionImpl
extends org.apache.uima.resource.metadata.impl.MetaDataObject_impl
implements org.apache.uima.collection.metadata.CpeDescription

The Class CpeDescriptionImpl.

See Also:

Serialized Form

Nested Class Summary

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

org.apache.uima.resource.metadata.impl.MetaDataObject_impl.MetaDataAttr, org.apache.uima.resource.metadata.impl.MetaDataObject_impl.SerialContext, org.apache.uima.resource.metadata.impl.MetaDataObject_impl.Serializer

Field Summary

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

serialContext

Constructor Summary

Constructors

Constructor and Description
CpeDescriptionImpl() Instantiates a new cpe description impl.
CpeDescriptionImpl(org.apache.uima.util.XMLInputSource aInput) Instantiates a new cpe description impl.

Method Summary

Modifier and Type	Method and Description
org.apache.uima.collection.metadata.CpeCollectionReaderCasInitializer	addCasInitializer(String aInitializerDescriptorPath) Deprecated. As of v2.0, CAS Initializers are deprecated.
void	addCasProcessor(org.apache.uima.collection.metadata.CpeCasProcessor aCasProcessor)
void	addCasProcessor(int index, org.apache.uima.collection.metadata.CpeCasProcessor aCasProcessor)
void	addCollectionReader(org.apache.uima.collection.metadata.CpeCollectionReader aCollectionReader)
org.apache.uima.collection.metadata.CpeCollectionReader	addCollectionReader(String aCollectionReaderPath)
org.apache.uima.collection.metadata.CpeCollectionReader[]	getAllCollectionCollectionReaders()
org.apache.uima.collection.metadata.CpeCasProcessors	getCpeCasProcessors()
org.apache.uima.collection.metadata.CpeConfiguration	getCpeConfig() Gets the cpe config.
org.apache.uima.collection.metadata.CpeConfiguration	getCpeConfiguration()
org.apache.uima.collection.metadata.CpeResourceManagerConfiguration	getCpeResourceManagerConfiguration() Gets the cpe resource manager configuration.
org.apache.uima.collection.metadata.CpeResourceManagerConfiguration	getResourceManagerConfiguration()
protected org.apache.uima.resource.metadata.impl.XmlizationInfo	getXmlizationInfo()
protected void	readUnknownPropertyValueFromXMLElement(Element aElement, org.apache.uima.util.XMLParser aParser, org.apache.uima.util.XMLParser.ParsingOptions aOptions, List aKnownPropertyNames)
void	setAllCollectionCollectionReaders(org.apache.uima.collection.metadata.CpeCollectionReader[] areaders)
void	setCheckpoint(String aCheckpointFile, int aFrequency)
void	setCpeCasProcessors(org.apache.uima.collection.metadata.CpeCasProcessors aCasProcessors)
void	setCpeConfig(org.apache.uima.collection.metadata.CpeConfiguration aConfiguration) Sets the cpe config.
void	setCpeConfiguration(org.apache.uima.collection.metadata.CpeConfiguration aConfiguration)
void	setCpeResourceManagerConfiguration(org.apache.uima.collection.metadata.CpeResourceManagerConfiguration aResMgrConfPagth)
void	setDeployment(String aDeployMode)
void	setInputQueueSize(int aSize) Deprecated.
void	setNumToProcess(long aEntityCount)
void	setOutputQueueSize(int aSize) Deprecated.
void	setProcessingUnitThreadCount(int aSize)
void	setResourceManagerConfiguration(String aResMgrConfPagth)
void	setStartingEntityId(String aStartEntityId)
void	setTimer(String aTimerClass)

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, 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.collection.metadata.CpeDescription

toXML

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

Constructor Detail

CpeDescriptionImpl

public CpeDescriptionImpl()

Instantiates a new cpe description impl.

CpeDescriptionImpl

public CpeDescriptionImpl(org.apache.uima.util.XMLInputSource aInput)
                   throws org.apache.uima.util.InvalidXMLException

Instantiates a new cpe description impl.

Parameters:

aInput - the a input

Throws:

org.apache.uima.util.InvalidXMLException - the invalid XML exception

Method Detail

addCollectionReader

public void addCollectionReader(org.apache.uima.collection.metadata.CpeCollectionReader aCollectionReader)
                         throws org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

addCollectionReader in interface org.apache.uima.collection.metadata.CpeDescription

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException

addCollectionReader

public org.apache.uima.collection.metadata.CpeCollectionReader addCollectionReader(String aCollectionReaderPath)
                                                                            throws org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

addCollectionReader in interface org.apache.uima.collection.metadata.CpeDescription

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException

addCasInitializer

@Deprecated
public org.apache.uima.collection.metadata.CpeCollectionReaderCasInitializer addCasInitializer(String aInitializerDescriptorPath)
                                                                                                     throws org.apache.uima.collection.metadata.CpeDescriptorException

Deprecated. As of v2.0, CAS Initializers are deprecated.

Adds the cas initializer.

Specified by:

addCasInitializer in interface org.apache.uima.collection.metadata.CpeDescription

Parameters:

aInitializerDescriptorPath - the a initializer descriptor path

Returns:

the cpe collection reader cas initializer

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

getAllCollectionCollectionReaders

public org.apache.uima.collection.metadata.CpeCollectionReader[] getAllCollectionCollectionReaders()
                                                                                            throws org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

getAllCollectionCollectionReaders in interface org.apache.uima.collection.metadata.CpeDescription

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException

setAllCollectionCollectionReaders

public void setAllCollectionCollectionReaders(org.apache.uima.collection.metadata.CpeCollectionReader[] areaders)
                                       throws org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

setAllCollectionCollectionReaders in interface org.apache.uima.collection.metadata.CpeDescription

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException

setResourceManagerConfiguration

public void setResourceManagerConfiguration(String aResMgrConfPagth)

Specified by:

setResourceManagerConfiguration in interface org.apache.uima.collection.metadata.CpeDescription

setCpeResourceManagerConfiguration

public void setCpeResourceManagerConfiguration(org.apache.uima.collection.metadata.CpeResourceManagerConfiguration aResMgrConfPagth)

Specified by:

setCpeResourceManagerConfiguration in interface org.apache.uima.collection.metadata.CpeDescription

getCpeResourceManagerConfiguration

public org.apache.uima.collection.metadata.CpeResourceManagerConfiguration getCpeResourceManagerConfiguration()

Gets the cpe resource manager configuration.

Returns:

the cpe resource manager configuration

setInputQueueSize

@Deprecated
public void setInputQueueSize(int aSize)
                                    throws org.apache.uima.collection.metadata.CpeDescriptorException

Deprecated.

Sets the input queue size.

Specified by:

setInputQueueSize in interface org.apache.uima.collection.metadata.CpeDescription

Parameters:

aSize - the new input queue size

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

setProcessingUnitThreadCount

public void setProcessingUnitThreadCount(int aSize)
                                  throws org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

setProcessingUnitThreadCount in interface org.apache.uima.collection.metadata.CpeDescription

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException

setOutputQueueSize

@Deprecated
public void setOutputQueueSize(int aSize)
                                     throws org.apache.uima.collection.metadata.CpeDescriptorException

Deprecated.

Sets the output queue size.

Specified by:

setOutputQueueSize in interface org.apache.uima.collection.metadata.CpeDescription

Parameters:

aSize - the new output queue size

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

setCpeCasProcessors

public void setCpeCasProcessors(org.apache.uima.collection.metadata.CpeCasProcessors aCasProcessors)

Specified by:

setCpeCasProcessors in interface org.apache.uima.collection.metadata.CpeDescription

getCpeCasProcessors

public org.apache.uima.collection.metadata.CpeCasProcessors getCpeCasProcessors()
                                                                         throws org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

getCpeCasProcessors in interface org.apache.uima.collection.metadata.CpeDescription

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException

addCasProcessor

public void addCasProcessor(org.apache.uima.collection.metadata.CpeCasProcessor aCasProcessor)
                     throws org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

addCasProcessor in interface org.apache.uima.collection.metadata.CpeDescription

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException

addCasProcessor

public void addCasProcessor(int index,
                            org.apache.uima.collection.metadata.CpeCasProcessor aCasProcessor)
                     throws org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

addCasProcessor in interface org.apache.uima.collection.metadata.CpeDescription

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException

setCpeConfiguration

public void setCpeConfiguration(org.apache.uima.collection.metadata.CpeConfiguration aConfiguration)

Specified by:

setCpeConfiguration in interface org.apache.uima.collection.metadata.CpeDescription

getCpeConfiguration

public org.apache.uima.collection.metadata.CpeConfiguration getCpeConfiguration()
                                                                         throws org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

getCpeConfiguration in interface org.apache.uima.collection.metadata.CpeDescription

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException

setCpeConfig

public void setCpeConfig(org.apache.uima.collection.metadata.CpeConfiguration aConfiguration)

Sets the cpe config.

Parameters:

aConfiguration - the new cpe config

getCpeConfig

public org.apache.uima.collection.metadata.CpeConfiguration getCpeConfig()
                                                                  throws org.apache.uima.collection.metadata.CpeDescriptorException

Gets the cpe config.

Returns:

the cpe config

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

setCheckpoint

public void setCheckpoint(String aCheckpointFile,
                          int aFrequency)

Specified by:

setCheckpoint in interface org.apache.uima.collection.metadata.CpeDescription

setDeployment

public void setDeployment(String aDeployMode)

Specified by:

setDeployment in interface org.apache.uima.collection.metadata.CpeDescription

setNumToProcess

public void setNumToProcess(long aEntityCount)

Specified by:

setNumToProcess in interface org.apache.uima.collection.metadata.CpeDescription

setStartingEntityId

public void setStartingEntityId(String aStartEntityId)

Specified by:

setStartingEntityId in interface org.apache.uima.collection.metadata.CpeDescription

setTimer

public void setTimer(String aTimerClass)

Specified by:

setTimer in interface org.apache.uima.collection.metadata.CpeDescription

getResourceManagerConfiguration

public org.apache.uima.collection.metadata.CpeResourceManagerConfiguration getResourceManagerConfiguration()

Specified by:

getResourceManagerConfiguration in interface org.apache.uima.collection.metadata.CpeDescription

readUnknownPropertyValueFromXMLElement

protected void readUnknownPropertyValueFromXMLElement(Element aElement,
                                                      org.apache.uima.util.XMLParser aParser,
                                                      org.apache.uima.util.XMLParser.ParsingOptions aOptions,
                                                      List aKnownPropertyNames)
                                               throws org.apache.uima.util.InvalidXMLException

Overrides:

readUnknownPropertyValueFromXMLElement in class org.apache.uima.resource.metadata.impl.MetaDataObject_impl

Throws:

org.apache.uima.util.InvalidXMLException

getXmlizationInfo

protected org.apache.uima.resource.metadata.impl.XmlizationInfo getXmlizationInfo()

Specified by:

getXmlizationInfo in class org.apache.uima.resource.metadata.impl.MetaDataObject_impl