prajna.entity.lingpipe

Class LingpipeExtractor

java.lang.Object

prajna.entity.EntityExtractor

prajna.entity.lingpipe.LingpipeExtractor

All Implemented Interfaces:

RecordReasoner

public class LingpipeExtractor
extends EntityExtractor

Lingpipe entity extractor, using the Lingpipe engine to extract entities. This extractor expects a chunker resource (see the Lingpipe documentation), which is specified as the model. For applications that do not require specialized chunkers, the path to the chunker file ne-en-news-muc6.AbstractCharLmRescoringChunker in the Lingpipe installation directory will provide reasonable results.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
LingpipeExtractor() Create a new, uninitialized Lingpipe Entity Extractor.
LingpipeExtractor(java.lang.String chunkerResource) Create a new Lingpipe Entity Extractor.

Method Summary

Methods

Modifier and Type	Method and Description
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 string.
void	setModel(java.lang.String model) Set the model for this entity 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

LingpipeExtractor

public LingpipeExtractor()

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

LingpipeExtractor

public LingpipeExtractor(java.lang.String chunkerResource)

Create a new Lingpipe Entity Extractor. The chunker resource specifies the Entity Chunker used.

Parameters:

chunkerResource - entity chunker resource path

Method Detail

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, and dependent on the entity extractor implementation.

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 string. This returns the the Entity Chunker used

Overrides:

getModel in class EntityExtractor

Returns:

the the Entity Chunker used

setModel

public void setModel(java.lang.String model)

Set the model for this entity extractor. The LingpipeExtractor expects the model argument to define the path to the chunker resource.

Overrides:

setModel in class EntityExtractor

Parameters:

model -