prajna.entity.opennlp

Class OpenNlpExtractor

java.lang.Object

prajna.entity.EntityExtractor

prajna.entity.opennlp.OpenNlpExtractor

All Implemented Interfaces:

RecordReasoner

public class OpenNlpExtractor
extends EntityExtractor

Implementation of an entity extractor, using the OpenNLP libraries. This entity extractor is initialized with a model or directory of models. The base name of the model file is used as the entity type for each extracted entity.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
OpenNlpExtractor() Create a new, uninitialized OpenNLP Entity Extractor.
OpenNlpExtractor(java.io.File modelFile) Create an OpenNlpExtractor, using the model or models specified.
OpenNlpExtractor(java.lang.String model) Create an OpenNlpExtractor, using the model or models specified.

Method Summary

Methods

Modifier and Type	Method and Description
void	addModel(java.io.File modelFile) Add the model file, or all model files within the directory.
void	addModel(java.io.File modelFile, EntityType type) Add the model file with the specified entity type.
protected void	extractEntities(java.lang.String text, java.util.Map<java.lang.String,EntityTag> tokenMap) Extract the entities from the text provided.
java.util.Map<java.lang.String,java.lang.String>	extractEntityRawTypes(java.lang.String text) Retrieve the entities and the raw types for this entity extractor.
java.lang.String	getModel() Get the model for this extractor.
void	setModel(java.lang.String model) Set the model for this extractor.

Methods inherited from class prajna.entity.EntityExtractor

addTagFieldMapping, addTextField, augmentRecord, extract, extract, extract, extract, getDefaultTagField, isDebug, setDebug, setDefaultTagField

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenNlpExtractor

public OpenNlpExtractor()

Create a new, uninitialized OpenNLP Entity Extractor. When using this constructor, setModel() must be called prior to extracting entities

OpenNlpExtractor

public OpenNlpExtractor(java.io.File modelFile)

Create an OpenNlpExtractor, using the model or models specified. If the model object is a directory, this constructor will recursively traverse the directory, loading any model files it finds.

Parameters:

modelFile - the model file, or directory of model files

OpenNlpExtractor

public OpenNlpExtractor(java.lang.String model)

Create an OpenNlpExtractor, using the model or models specified. If the model object is a directory, this constructor will recursively traverse the directory, loading any model files it finds.

Parameters:

model - the path to the model file, or directory of model files

Method Detail

addModel

public void addModel(java.io.File modelFile)

Add the model file, or all model files within the directory. If the model object is a directory, this constructor will recursively traverse the directory, loading any model files it finds. The base name of the file is used as the entity type.

Parameters:

modelFile - the model file, or directory of model files

addModel

public void addModel(java.io.File modelFile,
            EntityType type)

Add the model file with the specified entity type. If modelFile is a directory, all files within the directory will be assigned to the specified type

Parameters:

modelFile - the model file, or directory of model files

type - entity type for the model file

extractEntities

protected void extractEntities(java.lang.String text,
                   java.util.Map<java.lang.String,EntityTag> tokenMap)

Extract the entities from the text provided. This method iterates through the loaded models, running each of them against the text data. For each entity that matches the model, the entity and type is stored in the tokenMap

Specified by:

extractEntities in class EntityExtractor

Parameters:

text - the text to extract

tokenMap - the map to contain the tokens in.

extractEntityRawTypes

public java.util.Map<java.lang.String,java.lang.String> extractEntityRawTypes(java.lang.String text)

Retrieve the entities and the raw types for this entity extractor. This method runs the extraction process on the text, and generates a map that identifies each entity with a type. The types returned from this method are not normalized. This class returns the basename of the model file for each match.

Specified by:

extractEntityRawTypes in class EntityExtractor

Parameters:

text - the text to parse for entities

Returns:

the raw entity types

getModel

public java.lang.String getModel()

Get the model for this extractor.

Overrides:

getModel in class EntityExtractor

Returns:

the model file path

setModel

public void setModel(java.lang.String model)

Set the model for this extractor. The OpenNLP extractor expects the model argument to be a file path to a model file. It will simply call addModel with the argument.

Overrides:

setModel in class EntityExtractor

Parameters:

model - the model file path