com.mtnfog.entity

Class Entity

java.lang.Object

com.mtnfog.entity.Entity

All Implemented Interfaces:

Serializable

public class Entity
extends Object
implements Serializable

An entity.

Author:

Mountain Fog, Inc.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Entity() Create a new entity.
Entity(Entity entity) Create a new entity from an existing entity.
Entity(String text) Create a new entity given the attributes of the entity.
Entity(String text, double confidence, String type, Span span, String languageCode) Create a new entity given the attributes of the entity.
Entity(String text, double confidence, String type, String languageCode) Create a new entity given the attributes of the entity.
Entity(String text, String type) Create a new entity given the attributes of the entity.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
double	getConfidence() Gets the confidence the entity actually is an entity.
String	getContext() Gets the context of the entity.
String	getDocumentId() Gets the document ID of the entity.
long	getExtractionDate() Gets the extraction date.
String	getLanguageCode() Gets the language code of the entity.
Map<String,String>	getMetadata() Gets the entity metadata.
Span	getSpan() Gets the entity Span in the text.
String	getText() Gets the text of the entity.
String	getType() Gets the type of the entity.
String	getUri() Gets the URI of the entity.
int	hashCode()
void	setConfidence(double confidence) Sets the confidence the entity actually is an entity.
void	setContext(String context) Sets the context of the entity.
void	setDocumentId(String documentId) Sets the document ID of the entity.
void	setExtractionDate(long extractionDate) Sets the extraction date.
void	setLanguageCode(String languageCode) Sets the language code for the entity.
void	setMetadata(Map<String,String> metadata) Sets the entity metadata.
void	setSpan(Span span) Sets the entity Span in the text.
void	setText(String text) Sets the text of the entity.
void	setType(String type) Sets the type of the entity.
void	setUri(String uri) Sets the URI of the entity.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Entity

public Entity()

Create a new entity.

Entity

public Entity(Entity entity)

Create a new entity from an existing entity.

Parameters:

entity - An existing entity.

Entity

public Entity(String text,
              double confidence,
              String type,
              String languageCode)

Create a new entity given the attributes of the entity.

Parameters:

text - The text of the entity.

confidence - The confidence the text as determined during the extraction. This will be a decimal value between 0 and 100. A higher value indicates a higher level of confidence.

type - The type of entity.

languageCode - The two-letter ISO language code of the entity.

Entity

public Entity(String text,
              double confidence,
              String type,
              Span span,
              String languageCode)

Create a new entity given the attributes of the entity.

Parameters:

text - The text of the entity.

confidence - The confidence the text as determined during the extraction. This will be a decimal value between 0 and 100. A higher value indicates a higher level of confidence.

span - The location of the entity in the text.

type - The type of entity.

languageCode - The two-letter ISO language code of the entity.

Entity

public Entity(String text)

Create a new entity given the attributes of the entity.

Parameters:

text - The text of the entity.

Entity

public Entity(String text,
              String type)

Create a new entity given the attributes of the entity.

Parameters:

text - The text of the entity.

type - The type of entity.

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getText

public String getText()

Gets the text of the entity.

Returns:

The text of the entity.

setText

public void setText(String text)

Sets the text of the entity.

Parameters:

text - The text of the entity.

getConfidence

public double getConfidence()

Gets the confidence the entity actually is an entity.

Returns:

The confidence the entity is actually an entity. This will be a value between 0 and 100.

setConfidence

public void setConfidence(double confidence)

Sets the confidence the entity actually is an entity.

Parameters:

confidence - The confidence of the entity. This should be a value between 0 and 100.

getUri

public String getUri()

Gets the URI of the entity.

Returns:

The entity URI.

setUri

public void setUri(String uri)

Sets the URI of the entity.

Parameters:

uri - The entity URI.

getSpan

public Span getSpan()

Gets the entity Span in the text.

Returns:

The entity Span in the text.

setSpan

public void setSpan(Span span)

Sets the entity Span in the text.

Parameters:

span - The entity Span in the text.

getLanguageCode

public String getLanguageCode()

Gets the language code of the entity.

Returns:

The language code.

setLanguageCode

public void setLanguageCode(String languageCode)

Sets the language code for the entity.

Parameters:

languageCode - The language code.

getType

public String getType()

Gets the type of the entity.

Returns:

The type of the entity.

setType

public void setType(String type)

Sets the type of the entity.

Parameters:

type - The type of the entity.

getContext

public String getContext()

Gets the context of the entity.

Returns:

The context of the entity.

setContext

public void setContext(String context)

Sets the context of the entity.

Parameters:

context - The context of the entity.

getDocumentId

public String getDocumentId()

Gets the document ID of the entity.

Returns:

The document ID.

setDocumentId

public void setDocumentId(String documentId)

Sets the document ID of the entity.

Parameters:

documentId - The document ID.

getExtractionDate

public long getExtractionDate()

Gets the extraction date.

Returns:

The extraction date.

setExtractionDate

public void setExtractionDate(long extractionDate)

Sets the extraction date.

Parameters:

extractionDate - The extraction date.

getMetadata

public Map<String,String> getMetadata()

Gets the entity metadata.

Returns:

The entity metadata.

setMetadata

public void setMetadata(Map<String,String> metadata)

Sets the entity metadata.

Parameters:

metadata - The entity metadata.