org.eaglei.lexical
Interface EntityMatch

public interface EntityMatch

Interface for classes that represent on potential entity match for a segment of text.

Author:

rfrost

Method Summary

org.eaglei.model.EIEntity	getEntity() Gets match entity.
java.lang.String	getHighlight() Gets the match highlight.
java.lang.String	getMatchLabel() Gets label of the entity on which the match was made.
java.lang.String	getRootTypeLabel() Gets label of the "root type" of this entity.
float	getScore() Gets a match score.

Method Detail

getEntity

org.eaglei.model.EIEntity getEntity()

Gets match entity.

Returns:

Match entity.

getScore

float getScore()

Gets a match score.

Returns:

Match score as a float.

getHighlight

java.lang.String getHighlight()

Gets the match highlight.

Returns:

Match highlight. HTML syntax.

getMatchLabel

java.lang.String getMatchLabel()

Gets label of the entity on which the match was made. This may be different than the preferred label of the entity.

Returns:

Match label. No HTML syntax.

getRootTypeLabel

java.lang.String getRootTypeLabel()

Gets label of the "root type" of this entity. Will be null if the entity is itself a root type.

Returns:

Root type label. No HTML syntax.