org.apache.uima.collection.impl.cpm.container

Class CPEFactory

java.lang.Object

org.apache.uima.collection.impl.cpm.container.CPEFactory

public class CPEFactory
extends Object

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

Fields

Modifier and Type	Field and Description
HashMap	casProcessorConfigMap The cas processor config map.
static String	CPM_HOME The Constant CPM_HOME.

Constructor Summary

Constructors

Constructor and Description
CPEFactory(org.apache.uima.collection.metadata.CpeDescription aDescriptor, org.apache.uima.resource.ResourceManager aResourceManager) Create a new CPEFactory for a CpeDescription that's already been parsed.
CPEFactory(org.apache.uima.resource.ResourceManager aResourceManager) Create a new CPEFactory on which we will later call parse(String) to parse a CPE descriptor.

Method Summary

Modifier and Type	Method and Description
void	addCasProcessor(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor) Appends given Cas Processor to the list of CasProcessors.
void	addCollectionReader(org.apache.uima.collection.base_cpm.BaseCollectionReader collectionReader) Adds the collection reader.
org.apache.uima.collection.base_cpm.CasProcessor[]	getCasProcessors() Returns an array of Cas Processors instantiated from the cpe descriptor.
org.apache.uima.collection.base_cpm.BaseCollectionReader	getCollectionReader() Returns Collection Reader instantiated from configuration in the cpe descriptor.
org.apache.uima.collection.metadata.CpeConfiguration	getCPEConfig() Returns an object containing global CPE configuration including: Number of documents to process Checkpoint configuration id of the document begin processing .
org.apache.uima.collection.metadata.CpeDescription	getCpeDescriptor() Returns Cpe Descriptor.
String	getDescriptor(List aList) Gets the descriptor.
URL	getDescriptorURL(org.apache.uima.collection.metadata.CpeCasProcessor aCasProcessorCfg) Returns a descriptor path associated with Cas Processor.
int	getProcessingUnitThreadCount() Returns number of processing threads (Processing Units).
org.apache.uima.resource.ResourceManager	getResourceManager() Gets the ResourceManager that all components of this CPE should share.
org.apache.uima.resource.ResourceSpecifier	getSpecifier(URL aDescriptorUrl) Instantiates a ResourceSpecifier from a given URL.
boolean	isDefault() Checks if is default.
boolean	isDefinitionInstanceOf(Class aResourceClass, org.apache.uima.resource.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	parse(String aDescriptor) Creates an object representation for configuration in a given cpe descriptor file.
org.apache.uima.collection.base_cpm.CasProcessor	produceCasDataConsumer(Class aResourceClass, org.apache.uima.resource.ResourceSpecifier aSpecifier, Map aAdditionalParams) Instantiates CasData Consumer from a given class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CPM_HOME

public static final String CPM_HOME

The Constant CPM_HOME.

See Also:

Constant Field Values

casProcessorConfigMap

public HashMap casProcessorConfigMap

The cas processor config map.

Constructor Detail

CPEFactory

public CPEFactory(org.apache.uima.resource.ResourceManager aResourceManager)

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(org.apache.uima.collection.metadata.CpeDescription aDescriptor,
                  org.apache.uima.resource.ResourceManager aResourceManager)
           throws org.apache.uima.resource.ResourceInitializationException

Create a new CPEFactory for a CpeDescription that's already been parsed.

Parameters:

aDescriptor - the a descriptor

aResourceManager - the resource manager that all components of this CPE will share If null, a new ResourceManager will be created.

Throws:

org.apache.uima.resource.ResourceInitializationException - the resource initialization exception

Method Detail

parse

public void parse(String aDescriptor)
           throws InstantiationException

Creates an object representation for configuration in a given cpe descriptor file.

Parameters:

aDescriptor - - path to the descriptor

Throws:

InstantiationException - -

parse

public void parse(InputStream aDescriptorStream)
           throws InstantiationException

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:

org.apache.uima.UIMARuntimeException - wraps Exception

getCollectionReader

public org.apache.uima.collection.base_cpm.BaseCollectionReader getCollectionReader()
                                                                             throws org.apache.uima.resource.ResourceConfigurationException

Returns Collection Reader instantiated from configuration in the cpe descriptor. It also creates and intializes the Cas Initializer if one is defined and associates it with the CollectionReader.

Returns:

CollectionReader instance

Throws:

org.apache.uima.resource.ResourceConfigurationException - the resource configuration exception

getCasProcessors

public org.apache.uima.collection.base_cpm.CasProcessor[] getCasProcessors()
                                                                    throws org.apache.uima.resource.ResourceConfigurationException

Returns an array of Cas Processors instantiated from the cpe descriptor.

Returns:

- array of CasProcessor instances

Throws:

org.apache.uima.resource.ResourceConfigurationException - -

isDefinitionInstanceOf

public boolean isDefinitionInstanceOf(Class aResourceClass,
                                      org.apache.uima.resource.ResourceSpecifier resourceSpecifier,
                                      String aDescriptor)
                               throws org.apache.uima.resource.ResourceConfigurationException

Check if a class has appropriate type.

Parameters:

aResourceClass - - class to check

resourceSpecifier - - specifier containing expected type

aDescriptor - - descriptor name

Returns:

true - if class matches type

Throws:

org.apache.uima.resource.ResourceConfigurationException - -

produceCasDataConsumer

public org.apache.uima.collection.base_cpm.CasProcessor produceCasDataConsumer(Class aResourceClass,
                                                                               org.apache.uima.resource.ResourceSpecifier aSpecifier,
                                                                               Map aAdditionalParams)
                                                                        throws org.apache.uima.resource.ResourceInitializationException

Instantiates CasData Consumer from a given class.

Parameters:

aResourceClass - - CasDataConsumer class

aSpecifier - - specifier

aAdditionalParams - - parameters used to initialize CasDataConsumer

Returns:

- instance of CasProcessor

Throws:

org.apache.uima.resource.ResourceInitializationException - -

getDescriptorURL

public URL getDescriptorURL(org.apache.uima.collection.metadata.CpeCasProcessor aCasProcessorCfg)
                     throws org.apache.uima.resource.ResourceConfigurationException

Returns a descriptor path associated with Cas Processor.

Parameters:

aCasProcessorCfg - - Cas Processor configuration

Returns:

- Descriptor path

Throws:

org.apache.uima.resource.ResourceConfigurationException - -

getSpecifier

public org.apache.uima.resource.ResourceSpecifier getSpecifier(URL aDescriptorUrl)
                                                        throws Exception

Instantiates a ResourceSpecifier from a given URL.

Parameters:

aDescriptorUrl - - URL of descriptor

Returns:

- ResourceSpecifier

Throws:

Exception - -

getCPEConfig

public org.apache.uima.collection.metadata.CpeConfiguration getCPEConfig()
                                                                  throws InstantiationException

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

public int getProcessingUnitThreadCount()
                                 throws org.apache.uima.resource.ResourceConfigurationException

Returns number of processing threads (Processing Units).

Returns:

Number of processing threads

Throws:

org.apache.uima.resource.ResourceConfigurationException - -

isDefault

public boolean isDefault()

Checks if is default.

Returns:

true if the configuration is the default

getCpeDescriptor

public org.apache.uima.collection.metadata.CpeDescription getCpeDescriptor()

Returns Cpe Descriptor.

Returns:

the Cpe Descriptor

addCasProcessor

public void addCasProcessor(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor)
                     throws org.apache.uima.resource.ResourceConfigurationException

Appends given Cas Processor to the list of CasProcessors.

Parameters:

aCasProcessor - - CasProcessor to add

Throws:

org.apache.uima.resource.ResourceConfigurationException - the resource configuration exception

getDescriptor

public String getDescriptor(List aList)
                     throws org.apache.uima.resource.ResourceConfigurationException

Gets the descriptor.

Parameters:

aList - the a list

Returns:

the cpe descriptor constructed from the list

Throws:

org.apache.uima.resource.ResourceConfigurationException - -

addCollectionReader

public void addCollectionReader(org.apache.uima.collection.base_cpm.BaseCollectionReader collectionReader)

Adds the collection reader.

Parameters:

collectionReader - - collection reader to use by the CPM

getResourceManager

public org.apache.uima.resource.ResourceManager getResourceManager()

Gets the ResourceManager that all components of this CPE should share.

Returns:

the resource manager