Package com.basistech.rosette.dm

Class Mention

java.lang.Object

com.basistech.rosette.dm.BaseAttribute

com.basistech.rosette.dm.Attribute

com.basistech.rosette.dm.Mention

All Implemented Interfaces:

Serializable

public class Mention
extends Attribute
implements Serializable

A mention of a entity in the text. For example, "George" and "George Washington" are mentions of type "PERSON".

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Mention.Builder	A builder for entity mentions.

Field Summary

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

endOffset, startOffset

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

extendedProperties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Mention(int startOffset, int endOffset, Double confidence, Double linkingConfidence, String source, String subsource, String normalized, Map<String,Object> extendedProperties)

Method Summary

Modifier and Type	Method	Description
Double	getConfidence()	Returns the confidence of the entity extractor in identifying this mention.
Double	getLinkingConfidence()	Returns the linking confidence of the kb-linker in link this mention and entity id.
String	getNormalized()	Returns the normalized form of the mention.
String	getSource()	Returns the entity extraction source that produced this entity.
String	getSubsource()	Returns the entity extraction subsource that produced this entity.
protected com.google.common.base.MoreObjects.ToStringHelper	toStringHelper()

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

getEndOffset, getStartOffset

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

Mention

protected Mention(int startOffset,
 int endOffset,
 Double confidence,
 Double linkingConfidence,
 String source,
 String subsource,
 String normalized,
 Map<String,Object> extendedProperties)

Method Details

getConfidence

public Double getConfidence()

Returns the confidence of the entity extractor in identifying this mention.

Returns:

the confidence of the entity extractor in identifying this mention. This value will be null if there is no calculated confidence value.

getLinkingConfidence

public Double getLinkingConfidence()

Returns the linking confidence of the kb-linker in link this mention and entity id.

Returns:

the linking confidence of the kb-linker in link this mention and entity id. This value will be null if there is no calculated confidence value.

getSource

public String getSource()

Returns the entity extraction source that produced this entity. For example, "statistical", "regex", "gazetteer".

Returns:

the entity extraction source

getSubsource

public String getSubsource()

Returns the entity extraction subsource that produced this entity. This is usually filename for the regular expression file or gazetteer in which the entity appears. For example, "./data/gazetteer/eng/accept/gaz-LE.bin"

Returns:

the entity extraction subsource

getNormalized

public String getNormalized()

Returns the normalized form of the mention. This form typically normalizes spaces spaces and removes embedded newlines. It may omit prefixes in languages like Arabic. This is not a canonical way to refer to the entity (see ResolvedEntity) but rather a simplified form of this particular mention text.

Returns:

the normalized form of the mention

toStringHelper

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

Overrides:

toStringHelper in class Attribute