Package com.basistech.rosette.dm

Class Keyphrase

java.lang.Object

com.basistech.rosette.dm.BaseAttribute

com.basistech.rosette.dm.Keyphrase

All Implemented Interfaces:

Serializable

public class Keyphrase
extends BaseAttribute
implements Serializable

A reference to a "keyphrase" of a document. Each keyphrase is a specific span of text that is highly relevant to the document. Each Keyphrase provides:

• the name of the specific keyphrase
• the salience associated with the keyphrase
• a list of Extents marking each location of the keyphrase in the text

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Keyphrase.Builder	A builder for keyphrases

Field Summary

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

extendedProperties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Keyphrase(String phrase, Double salience, List<Extent> extents, Map<String,Object> extendedProperties)

Method Summary

Modifier and Type	Method	Description
List<Extent>	getExtents()	Returns the list of extents marking the offsets of each instance of the keyphrase in the text
String	getPhrase()	Returns the name of the keyphrase
Double	getSalience()	Returns the salience value associated with the keyphrase
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

Keyphrase

protected Keyphrase(String phrase,
 Double salience,
 List<Extent> extents,
 Map<String,Object> extendedProperties)

Method Details

getPhrase

public String getPhrase()

Returns the name of the keyphrase

Returns:

phrase the name of the keyphrase

getSalience

public Double getSalience()

Returns the salience value associated with the keyphrase

Returns:

the salience value

getExtents

public List<Extent> getExtents()

Returns the list of extents marking the offsets of each instance of the keyphrase in the text

Returns:

the list of extents

toStringHelper

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

Overrides:

toStringHelper in class BaseAttribute