CleartkMultiAnnotator (ClearTK TimeML 2.0.0 API)

java.lang.Object
- org.apache.uima.analysis_component.AnalysisComponent_ImplBase
- - org.apache.uima.analysis_component.Annotator_ImplBase
  - - org.apache.uima.analysis_component.JCasAnnotator_ImplBase
    - - org.apache.uima.fit.component.JCasAnnotator_ImplBase
      - org.cleartk.ml.multi.CleartkMultiAnnotator<OUTCOME_TYPE>

All Implemented Interfaces:

AnalysisComponent, org.apache.uima.fit.factory.initializable.Initializable
```
public abstract class CleartkMultiAnnotator<OUTCOME_TYPE>
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase
implements org.apache.uima.fit.factory.initializable.Initializable
```
Copyright (c) 2011, Regents of the University of Colorado
All rights reserved.
Author:
Lee Becker This class provides a framework for handling multiple classifiers within a single analysis engine.
Use cases that may lend themselves to CleartkMultiAnnotator over CleartkAnnotator include:
- Explicit control for one-vs-all multi-label classification
- Predicating training/classification on specific conditions. (e.g. if the the word to the left is a verb, use the verb classifier, else use the default classifier)
- Voting or ensemble classification

Field Summary

Fields
Modifier and Type	Field and Description
`protected ClassifierFactory<?>`	`classifierFactory`
`protected File`	`classifierJarPathRoot`
`protected Map<String,Classifier<OUTCOME_TYPE>>`	`classifiers`
`protected DataWriterFactory<?>`	`dataWriterFactory`
`protected Map<String,DataWriter<OUTCOME_TYPE>>`	`dataWriters`
`protected File`	`outputDirectoryRoot`
`static String`	`PARAM_CLASSIFIER_FACTORY_CLASS_NAME`
`static String`	`PARAM_DATA_WRITER_FACTORY_CLASS_NAME`
`static String`	`PARAM_IS_TRAINING`

Constructor Summary

Constructors
Constructor and Description

CleartkMultiAnnotator()

Constructors
Constructor and Description
`CleartkMultiAnnotator()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`collectionProcessComplete()`
`protected Classifier<OUTCOME_TYPE>`	`getClassifier(String name)` Gets the classifier associated with name.
`protected DataWriter<OUTCOME_TYPE>`	`getDataWriter(String name)` Gets the `DataWriter` associated with name.
`void`	`initialize(UimaContext context)`
`protected boolean`	`isTraining()`

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase
getLogger

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
getRequiredCasInterface, process, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase
getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
batchProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - classifierFactory
```
protected ClassifierFactory<?> classifierFactory
```
  - classifierJarPathRoot
```
protected File classifierJarPathRoot
```
  - classifiers
```
protected Map<String,Classifier<OUTCOME_TYPE>> classifiers
```
  - dataWriterFactory
```
protected DataWriterFactory<?> dataWriterFactory
```
  - dataWriters
```
protected Map<String,DataWriter<OUTCOME_TYPE>> dataWriters
```
  - outputDirectoryRoot
```
protected File outputDirectoryRoot
```
  - PARAM_CLASSIFIER_FACTORY_CLASS_NAME
```
public static final String PARAM_CLASSIFIER_FACTORY_CLASS_NAME
```
    See Also:
    Constant Field Values
  - PARAM_DATA_WRITER_FACTORY_CLASS_NAME
```
public static final String PARAM_DATA_WRITER_FACTORY_CLASS_NAME
```
    See Also:
    Constant Field Values
  - PARAM_IS_TRAINING
```
public static final String PARAM_IS_TRAINING
```
    See Also:
    Constant Field Values
- Constructor Detail
  - CleartkMultiAnnotator
```
public CleartkMultiAnnotator()
```
- Method Detail
  - collectionProcessComplete
```
public void collectionProcessComplete()
                               throws AnalysisEngineProcessException
```
    Specified by:
    
    collectionProcessComplete in interface AnalysisComponent
    
    Overrides:
    
    collectionProcessComplete in class AnalysisComponent_ImplBase
    
    Throws:
    
    AnalysisEngineProcessException
  - getClassifier
```
protected Classifier<OUTCOME_TYPE> getClassifier(String name)
                                          throws ResourceInitializationException
```
    Gets the classifier associated with name. If it does not exist, this method will use the ClassifierFactory specified at initialization to create a new one.
    
    Parameters:
    name - The name of the classifier
    
    Returns:
    The classifier associated with the name
    
    Throws:
    
    ResourceInitializationException
  - getDataWriter
```
protected DataWriter<OUTCOME_TYPE> getDataWriter(String name)
                                          throws ResourceInitializationException
```
    Gets the DataWriter associated with name. If it does not exist, this method will use the DataWriterFactory specified during initialization to create a dataWriter associated with the name parameter.
    
    Parameters:
    name - The name of the DataWriter
    
    Returns:
    The DataWriter associated with the name
    
    Throws:
    
    ResourceInitializationException
  - initialize
```
public void initialize(UimaContext context)
                throws ResourceInitializationException
```
    Specified by:
    
    initialize in interface AnalysisComponent
    
    Specified by:
    
    initialize in interface org.apache.uima.fit.factory.initializable.Initializable
    
    Overrides:
    
    initialize in class org.apache.uima.fit.component.JCasAnnotator_ImplBase
    
    Throws:
    
    ResourceInitializationException
  - isTraining
```
protected boolean isTraining()
```

Class CleartkMultiAnnotator<OUTCOME_TYPE>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

Methods inherited from class java.lang.Object

Field Detail

classifierFactory

classifierJarPathRoot

classifiers

dataWriterFactory

dataWriters

outputDirectoryRoot

PARAM_CLASSIFIER_FACTORY_CLASS_NAME

PARAM_DATA_WRITER_FACTORY_CLASS_NAME

PARAM_IS_TRAINING

Constructor Detail

CleartkMultiAnnotator

Method Detail

collectionProcessComplete

getClassifier

getDataWriter

initialize

isTraining