Package com.basistech.rosette.dm

Class Entity

java.lang.Object

com.basistech.rosette.dm.BaseAttribute

com.basistech.rosette.dm.Entity

All Implemented Interfaces:

Serializable

public class Entity
extends BaseAttribute
implements Serializable

A reference to a "real world" entity. Each entity in a document is the result of resolving one or more Mentions -- a Mention is a span of text that mentions an entity, while an Entity describes the entity itself.

Each Entity provides:

• a list of Mentions
• the index of the head Mention in the mentions' list
• the type of the entity, e.g. PERSON
• (optionally) a salience score
• (optionally) an ID that associates the entity some external knowledge base, e.g. Q23 from Wikidata.
• (optionally) a sentiment category associated with it (e.g. "positive", "negative", "neutral").

Entities are not spans of text. The mentions in an entity are in document order.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Entity.Builder	A builder for resolved entities.

Field Summary

Fields inherited from class com.basistech.rosette.dm.BaseAttribute

extendedProperties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Entity(List<Mention> mentions, Integer headMentionIndex, String type, String entityId, Double confidence, List<CategorizerResult> sentiment, Double salience, Map<String,Object> extendedProperties)

Method Summary

Modifier and Type	Method	Description
Double	getConfidence()	Returns the confidence for this resolved entity, or null if there is none.
String	getEntityId()	Returns the unique identifier of this entity.
Integer	getHeadMentionIndex()	Return the head mention index, if any.
List<Mention>	getMentions()
Double	getSalience()	If salience was computed for this entity, return it.
List<CategorizerResult>	getSentiment()	Returns the sentiment of this entity, or null if not computed.
String	getType()	If there is a type established for the entity, return the type.
protected com.google.common.base.MoreObjects.ToStringHelper	toStringHelper()

Methods inherited from class com.basistech.rosette.dm.BaseAttribute

getExtendedProperties, listOrNull, setExtendedProperty, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Entity

protected Entity(List<Mention> mentions,
 Integer headMentionIndex,
 String type,
 String entityId,
 Double confidence,
 List<CategorizerResult> sentiment,
 Double salience,
 Map<String,Object> extendedProperties)

Method Details

getEntityId

public String getEntityId()

Returns the unique identifier of this entity.

Returns:

the unique identifier of this entity

getMentions

public List<Mention> getMentions()

Returns:

the list of mentions that support this entity.

getHeadMentionIndex

public Integer getHeadMentionIndex()

Return the head mention index, if any. The head mention is the mention judged to be the best representation of the entity itself. This returns null if no mention is designated as head.

Returns:

the index of the head mention.

getConfidence

public Double getConfidence()

Returns the confidence for this resolved entity, or null if there is none.

Returns:

the confidence for this resolved entity, or null if there is none

getSentiment

public List<CategorizerResult> getSentiment()

Returns the sentiment of this entity, or null if not computed.

Returns:

the sentiment of this entity, or null if not computed.

getType

public String getType()

If there is a type established for the entity, return the type.

Returns:

the entity type, or null if none was established.

getSalience

public Double getSalience()

If salience was computed for this entity, return it.

Returns:

the salience value, or null if none was calculated.

toStringHelper

protected com.google.common.base.MoreObjects.ToStringHelper toStringHelper()

Overrides:

toStringHelper in class BaseAttribute