Class CPEFactory
java.lang.Object
org.apache.uima.collection.impl.cpm.container.CPEFactory
Component responsible for generating objects representing cpe descriptor configuration. Provides
various ways to instantiate object model representing cpe configuration. In the simplest form it
ingests an XML file (CPE descriptor), parses it and creates an object for every element in the
XML file.
Using objects representing configuration, this component creates CollectionReader CasInitializer, Analysis Engines, and CAS Consumers.
In addition to creating object, this component provides read/write access to the object model allowing for dynamic or programmatic modifications. It facilitates plugging in existing CollectionReaders and CasProcessors.
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe cas processor config map.static final String
The Constant CPM_HOME. -
Constructor Summary
ConstructorsConstructorDescriptionCPEFactory
(CpeDescription aDescriptor, ResourceManager aResourceManager) Create a new CPEFactory for a CpeDescription that's already been parsed.CPEFactory
(ResourceManager aResourceManager) Create a new CPEFactory on which we will later call parse(String) to parse a CPE descriptor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCasProcessor
(CasProcessor aCasProcessor) Appends given Cas Processor to the list of CasProcessors.void
addCollectionReader
(BaseCollectionReader collectionReader) Adds the collection reader.Returns an array of Cas Processors instantiated from the cpe descriptor.Returns Collection Reader instantiated from configuration in the CPE descriptor.Returns an object containing global CPE configuration including: Number of documents to process Checkpoint configuration id of the document begin processing .Returns Cpe Descriptor.getDescriptor
(List aList) Gets the descriptor.getDescriptorURL
(CpeCasProcessor aCasProcessorCfg) Returns a descriptor path associated with Cas Processor.int
Returns number of processing threads (Processing Units).Gets the ResourceManager that all components of this CPE should share.getSpecifier
(URL aDescriptorUrl) Instantiates a ResourceSpecifier from a given URL.boolean
Checks if is default.boolean
isDefinitionInstanceOf
(Class aResourceClass, ResourceSpecifier resourceSpecifier, String aDescriptor) Check if a class has appropriate type.void
parse()
Creates an object representation from default cpe descriptor.void
parse
(InputStream aDescriptorStream) Creates an object representation for configuration in a given stream.void
Creates an object representation for configuration in a given cpe descriptor file.produceCasDataConsumer
(Class aResourceClass, ResourceSpecifier aSpecifier, Map aAdditionalParams) Instantiates CasData Consumer from a given class.
-
Field Details
-
CPM_HOME
The Constant CPM_HOME.- See Also:
-
casProcessorConfigMap
The cas processor config map.
-
-
Constructor Details
-
CPEFactory
Create a new CPEFactory on which we will later call parse(String) to parse a CPE descriptor.- Parameters:
aResourceManager
- the a resource manager
-
CPEFactory
public CPEFactory(CpeDescription aDescriptor, ResourceManager aResourceManager) throws ResourceInitializationException Create a new CPEFactory for a CpeDescription that's already been parsed.- Parameters:
aDescriptor
- the a descriptoraResourceManager
- the resource manager that all components of this CPE will share If null, a new ResourceManager will be created.- Throws:
ResourceInitializationException
- the resource initialization exception
-
-
Method Details
-
parse
Creates an object representation for configuration in a given cpe descriptor file.- Parameters:
aDescriptor
- - path to the descriptor- Throws:
InstantiationException
- -
-
parse
Creates an object representation for configuration in a given stream.- Parameters:
aDescriptorStream
- - stream containing cpe description- Throws:
InstantiationException
- -
-
parse
public void parse()Creates an object representation from default cpe descriptor.- Throws:
UIMARuntimeException
- wraps Exception
-
getCollectionReader
Returns Collection Reader instantiated from configuration in the CPE descriptor. It also creates and initializes the CAS Initializer if one is defined and associates it with the CollectionReader.- Returns:
- CollectionReader instance
- Throws:
ResourceConfigurationException
- the resource configuration exception
-
getCasProcessors
Returns an array of Cas Processors instantiated from the cpe descriptor.- Returns:
- - array of CasProcessor instances
- Throws:
ResourceConfigurationException
- -
-
isDefinitionInstanceOf
public boolean isDefinitionInstanceOf(Class aResourceClass, ResourceSpecifier resourceSpecifier, String aDescriptor) throws ResourceConfigurationException Check if a class has appropriate type.- Parameters:
aResourceClass
- - class to checkresourceSpecifier
- - specifier containing expected typeaDescriptor
- - descriptor name- Returns:
- true - if class matches type
- Throws:
ResourceConfigurationException
- -
-
produceCasDataConsumer
public CasProcessor produceCasDataConsumer(Class aResourceClass, ResourceSpecifier aSpecifier, Map aAdditionalParams) throws ResourceInitializationException Instantiates CasData Consumer from a given class.- Parameters:
aResourceClass
- - CasDataConsumer classaSpecifier
- - specifieraAdditionalParams
- - parameters used to initialize CasDataConsumer- Returns:
- - instance of CasProcessor
- Throws:
ResourceInitializationException
- -
-
getDescriptorURL
Returns a descriptor path associated with Cas Processor.- Parameters:
aCasProcessorCfg
- - Cas Processor configuration- Returns:
- - Descriptor path
- Throws:
ResourceConfigurationException
- -
-
getSpecifier
Instantiates a ResourceSpecifier from a given URL.- Parameters:
aDescriptorUrl
- - URL of descriptor- Returns:
- - ResourceSpecifier
- Throws:
Exception
- -
-
getCPEConfig
Returns an object containing global CPE configuration including:- Number of documents to process
- Checkpoint configuration
- id of the document begin processing
- Returns:
- Global CPE Configuration
- Throws:
InstantiationException
- the instantiation exception
-
getProcessingUnitThreadCount
Returns number of processing threads (Processing Units).- Returns:
- Number of processing threads
- Throws:
ResourceConfigurationException
- -
-
isDefault
public boolean isDefault()Checks if is default.- Returns:
- true if the configuration is the default
-
getCpeDescriptor
Returns Cpe Descriptor.- Returns:
- the Cpe Descriptor
-
addCasProcessor
Appends given Cas Processor to the list of CasProcessors.- Parameters:
aCasProcessor
- - CasProcessor to add- Throws:
ResourceConfigurationException
- the resource configuration exception
-
getDescriptor
Gets the descriptor.- Parameters:
aList
- the a list- Returns:
- the cpe descriptor constructed from the list
- Throws:
ResourceConfigurationException
- -
-
addCollectionReader
Adds the collection reader.- Parameters:
collectionReader
- - collection reader to use by the CPM
-
getResourceManager
Gets the ResourceManager that all components of this CPE should share.- Returns:
- the resource manager
-