prajna.entity.calais

Class CalaisExtractor

java.lang.Object

prajna.entity.EntityExtractor

prajna.entity.calais.CalaisExtractor

All Implemented Interfaces:

RecordReasoner

public class CalaisExtractor
extends EntityExtractor

Entity extractor which uses the OpenCalais public service at http://www.opencalais.com. This extractor requires an API key, which is specified with the setModel method. An API key may be obtained from the Calais web site.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
CalaisExtractor() Create a new, uninitialized Calais Entity Extractor.
CalaisExtractor(java.lang.String calaisKey) Create a CalaisExtractor, using the API key specified

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.HashMap<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

CalaisExtractor

public CalaisExtractor()

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

CalaisExtractor

public CalaisExtractor(java.lang.String calaisKey)

Create a CalaisExtractor, using the API key specified

Parameters:

calaisKey - the API key

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 calls extractEntityRawTypes(), then uses an internal map to map the raw entity types to EntityType objects.

Specified by:

extractEntities in class EntityExtractor

Parameters:

text - the text to extract

tokenMap - the map to contain the tokens in.

extractEntityRawTypes

public java.util.HashMap<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 API key for the CalaisExtractor

Overrides:

getModel in class EntityExtractor

Returns:

the API key

setModel

public void setModel(java.lang.String model)

Set the model for this entity extractor. The CalaisExtractor uses an API key, which should be provided as the model argument.

Overrides:

setModel in class EntityExtractor

Parameters:

model - the API key