org.apache.ctakes.postagger

Class OpenNLPPOSCollectionReader

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CollectionReader_ImplBase

org.apache.ctakes.postagger.OpenNLPPOSCollectionReader

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.BaseCollectionReader, org.apache.uima.collection.CollectionReader, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource

@PipeBitInfo(name="OpenNLP POS Reader",
             description="Reads in part-of-speech training/test data in the OpenNLP format.",
             role=READER,
             products={BASE_TOKEN,SENTENCE})
public class OpenNLPPOSCollectionReader
extends org.apache.uima.collection.CollectionReader_ImplBase

This collection reader reads in part-of-speech training/test data in the OpenNLP format. See note below for POS_DATA_FILE_PARAM for details about this format. Each line in the file will correspond to a "document" - i.e. getNext() will populate the CAS with information from one line of the file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOAD_WORDS_ONLY_PARAM "LoadWordsOnly" is a optional, single, boolean parameter that determines whether or not the part-of-speech tags associated with each word will be loaded into the CAS or not.
static String	POS_DATA_FILE_PARAM "PosDataFile" is a required, single, string parameter that specifies the location of a data file that contains part-of-speech data in it.

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

PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

Constructors

Constructor and Description
OpenNLPPOSCollectionReader()

Method Summary

Modifier and Type	Method and Description
void	close()
void	getNext(org.apache.uima.cas.CAS cas) Some of the code in this method is based loosely on opennlp.tools.postag.POSEventCollector
org.apache.uima.util.Progress[]	getProgress()
boolean	hasNext()
void	initialize()

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

destroy, getCasInitializer, getProcessingResourceMetaData, initialize, isConsuming, reconfigure, setCasInitializer, typeSystemInit

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, setMetaData

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

Field Detail

POS_DATA_FILE_PARAM

public static final String POS_DATA_FILE_PARAM

"PosDataFile" is a required, single, string parameter that specifies the location of a data file that contains part-of-speech data in it. The format of the file should have one sentence per line where each word is followed immediately by "_" and it pos tag followed by a space.

                        IL-2_NN gene_NN expression_NN and_CC ...
                
 

See Also:

Constant Field Values

LOAD_WORDS_ONLY_PARAM

public static final String LOAD_WORDS_ONLY_PARAM

"LoadWordsOnly" is a optional, single, boolean parameter that determines whether or not the part-of-speech tags associated with each word will be loaded into the CAS or not. The default value is false.

See Also:

Constant Field Values

Constructor Detail

OpenNLPPOSCollectionReader

public OpenNLPPOSCollectionReader()

Method Detail

initialize

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

Overrides:

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

Throws:

org.apache.uima.resource.ResourceInitializationException

getNext

public void getNext(org.apache.uima.cas.CAS cas)
             throws IOException,
                    org.apache.uima.collection.CollectionException

Some of the code in this method is based loosely on opennlp.tools.postag.POSEventCollector

Throws:

IOException

org.apache.uima.collection.CollectionException

close

public void close()
           throws IOException

Throws:

IOException

getProgress

public org.apache.uima.util.Progress[] getProgress()

hasNext

public boolean hasNext()
                throws IOException,
                       org.apache.uima.collection.CollectionException

Throws:

IOException

org.apache.uima.collection.CollectionException