opennlp.uima.namefind
Class NameFinderTrainer

java.lang.Object
  org.apache.uima.resource.Resource_ImplBase
      org.apache.uima.resource.ConfigurableResource_ImplBase
          org.apache.uima.collection.CasConsumer_ImplBase
              opennlp.uima.namefind.NameFinderTrainer

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.CasObjectProcessor, org.apache.uima.collection.base_cpm.CasProcessor, org.apache.uima.collection.CasConsumer, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource

public final class NameFinderTrainer
extends org.apache.uima.collection.CasConsumer_ImplBase

OpenNLP NameFinder trainer.

Mandatory parameters

Type	Name	Description
String	opennlp.uima.ModelName	The name of the model file
String	opennlp.uima.Language	The language code
String	opennlp.uima.SentenceType	The full name of the sentence type
String	opennlp.uima.TokenType	The full name of the token type
String	opennlp.uima.NameType	The full name of the name type

Optional parameters

Type	Name	Description
String	opennlp.uima.opennlp.uima.TrainingParamsFile	Training Parameters Properties file
String	opennlp.uima.FeatureGeneratorFile	Feature Generator definition file which contain the feature generator configuration
String	opennlp.uima.FeatureGeneratorResources	Feature Generator resources dictionary
String	opennlp.uima.AdditionalTrainingDataFile	Training file which contains additional data in the OpenNLP format
String	opennlp.uima.AdditionalTrainingDataEncoding	Encoding of the additional training data
String	opennlp.uima.SampleTraceFile	All training samples are traced to this file
String	opennlp.uima.SampleTraceFileEncoding	Encoding of the sample trace file

Field Summary

Fields inherited from interface org.apache.uima.resource.Resource

PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_PARAM_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

NameFinderTrainer()

Method Summary

void	collectionProcessComplete(org.apache.uima.util.ProcessTrace trace) Called if the processing is finished, this method does the training.
void	destroy() Destroys the current instance.
void	initialize() Initializes the current instance.
boolean	isStateless() The trainer is not stateless.
void	processCas(org.apache.uima.cas.CAS cas) Process the given CAS object.
void	typeSystemInit(org.apache.uima.cas.TypeSystem typeSystem) Initialize the current instance with the given type system.

Methods inherited from class org.apache.uima.collection.CasConsumer_ImplBase

batchProcessComplete, getProcessingResourceMetaData, initialize, isReadOnly, processCas, reconfigure

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

getCasManager, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.uima.resource.ConfigurableResource

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from interface org.apache.uima.resource.Resource

getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Constructor Detail

NameFinderTrainer

public NameFinderTrainer()

Method Detail

initialize

public void initialize()
                throws org.apache.uima.resource.ResourceInitializationException

Initializes the current instance.

Overrides:

initialize in class org.apache.uima.collection.CasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

typeSystemInit

public void typeSystemInit(org.apache.uima.cas.TypeSystem typeSystem)
                    throws org.apache.uima.resource.ResourceInitializationException

Initialize the current instance with the given type system.

Specified by:

typeSystemInit in interface org.apache.uima.collection.base_cpm.CasObjectProcessor

Overrides:

typeSystemInit in class org.apache.uima.collection.CasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

processCas

public void processCas(org.apache.uima.cas.CAS cas)

Process the given CAS object.

collectionProcessComplete

public void collectionProcessComplete(org.apache.uima.util.ProcessTrace trace)
                               throws org.apache.uima.resource.ResourceProcessException,
                                      IOException

Called if the processing is finished, this method does the training.

Specified by:

collectionProcessComplete in interface org.apache.uima.collection.base_cpm.CasProcessor

Overrides:

collectionProcessComplete in class org.apache.uima.collection.CasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceProcessException

IOException

isStateless

public boolean isStateless()

The trainer is not stateless.

Specified by:

isStateless in interface org.apache.uima.collection.base_cpm.CasProcessor

Overrides:

isStateless in class org.apache.uima.collection.CasConsumer_ImplBase

destroy

public void destroy()

Destroys the current instance.

Specified by:

destroy in interface org.apache.uima.resource.Resource

Overrides:

destroy in class org.apache.uima.collection.CasConsumer_ImplBase