|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.collection.impl.cpm.container.CPEFactory
public class 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 | |
---|---|
java.util.HashMap |
casProcessorConfigMap
|
static java.lang.String |
CPM_HOME
|
Constructor Summary | |
---|---|
CPEFactory(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 | |
---|---|
void |
addCasProcessor(CasProcessor aCasProcessor)
Appends given Cas Processor to the list of CasProcessors |
void |
addCollectionReader(BaseCollectionReader collectionReader)
|
CasProcessor[] |
getCasProcessors()
Returns an array of Cas Processors instantiated from the cpe descriptor |
BaseCollectionReader |
getCollectionReader()
Returns Collection Reader instantiated from configuration in the cpe descriptor. |
CpeConfiguration |
getCPEConfig()
Returns an object containing global CPE configuration including: Number of documents to process Checkpoint configuration id of the document begin processing |
CpeDescription |
getCpeDescriptor()
Returns Cpe Descriptor |
java.lang.String |
getDescriptor(java.util.List aList)
|
java.net.URL |
getDescriptorURL(CpeCasProcessor aCasProcessorCfg)
Returns a descriptor path associated with Cas Processor |
int |
getProcessingUnitThreadCount()
Returns number of processing threads (Processing Units) |
ResourceManager |
getResourceManager()
Gets the ResourceManager that all components of this CPE should share. |
ResourceSpecifier |
getSpecifier(java.net.URL aDescriptorUrl)
Instantiates a ResourceSpecifier from a given URL. |
boolean |
isDefault()
|
boolean |
isDefinitionInstanceOf(java.lang.Class aResourceClass,
ResourceSpecifier resourceSpecifier,
java.lang.String aDescriptor)
Check if a class has appropriate type |
void |
parse()
Creates an object representation from default cpe descriptor. |
void |
parse(java.io.InputStream aDescriptorStream)
Creates an object representation for configuration in a given stream |
void |
parse(java.lang.String aDescriptor)
Creates an object representation for configuration in a given cpe descriptor file. |
CasProcessor |
produceCasDataConsumer(java.lang.Class aResourceClass,
ResourceSpecifier aSpecifier,
java.util.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 |
---|
public static final java.lang.String CPM_HOME
public java.util.HashMap casProcessorConfigMap
Constructor Detail |
---|
public CPEFactory(ResourceManager aResourceManager)
public CPEFactory(CpeDescription aDescriptor, ResourceManager aResourceManager) throws ResourceInitializationException
aDescriptor
- aResourceManager
- the resource manager that all components of this CPE will share If null, a new
ResourceManager will be created.
ResourceInitializationException
Method Detail |
---|
public void parse(java.lang.String aDescriptor) throws java.lang.InstantiationException
aDescriptor
- -
path to the descriptor
java.lang.InstantiationException
public void parse(java.io.InputStream aDescriptorStream) throws java.lang.InstantiationException
aDescriptorStream
- -
stream containing cpe description
java.lang.InstantiationException
public void parse()
aDescriptorStream
- -
stream containing cpe description
java.lang.InstantiationException
public BaseCollectionReader getCollectionReader() throws ResourceConfigurationException
javax.naming.ConfigurationException
ResourceConfigurationException
public CasProcessor[] getCasProcessors() throws ResourceConfigurationException
ResourceConfigurationException
public boolean isDefinitionInstanceOf(java.lang.Class aResourceClass, ResourceSpecifier resourceSpecifier, java.lang.String aDescriptor) throws ResourceConfigurationException
aResourceClass
- -
class to checkresourceSpecifier
- -
specifier containing expected typeaDescriptor
- -
descriptor name
ResourceConfigurationException
public CasProcessor produceCasDataConsumer(java.lang.Class aResourceClass, ResourceSpecifier aSpecifier, java.util.Map aAdditionalParams) throws ResourceInitializationException
aResourceClass
- -
CasDataConsumer classaSpecifier
- -
specifieraAdditionalParams
- -
parameters used to initialize CasDataConsumer
ResourceInitializationException
public java.net.URL getDescriptorURL(CpeCasProcessor aCasProcessorCfg) throws ResourceConfigurationException
aCasProcessorCfg
- -
Cas Processor configuration
ResourceConfigurationException
public ResourceSpecifier getSpecifier(java.net.URL aDescriptorUrl) throws java.lang.Exception
aDescriptorURL
- - URL of descriptor
java.lang.Exception
public CpeConfiguration getCPEConfig() throws java.lang.InstantiationException
java.lang.InstantiationException
public int getProcessingUnitThreadCount() throws ResourceConfigurationException
ResourceConfigurationException
public boolean isDefault()
public CpeDescription getCpeDescriptor()
public void addCasProcessor(CasProcessor aCasProcessor) throws ResourceConfigurationException
aCasProcessor
- -
CasProcessor to add
ResourceConfigurationException
public java.lang.String getDescriptor(java.util.List aList) throws ResourceConfigurationException
aList
-
ResourceConfigurationException
public void addCollectionReader(BaseCollectionReader collectionReader)
collectionReader
- -
collection reader to use by the CPMpublic ResourceManager getResourceManager()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |