org.nuxeo.ecm.platform.semanticentities.adapter

Class OccurrenceInfo

java.lang.Object

org.nuxeo.ecm.platform.semanticentities.adapter.OccurrenceInfo

All Implemented Interfaces:

Comparable<OccurrenceInfo>

public class OccurrenceInfo
extends Object
implements Comparable<OccurrenceInfo>

Helper data transfer object to handle the occurrence of the name of an entity in some pure text context (typically a document snippet of maximum 3 sentences).

Author:

ogrisel

Field Summary

Fields

Modifier and Type	Field and Description
String	context A maximum 3 sentences long textual context snippet including the mention.
int	endPosInContext The end offset to locate the mention inside the context.
String	mention The context part that actually references an entity
double	order Ordering info such as position in source document to be able to order the occurrences relative to one another.
int	startPosInContext The start offset to locate the mention inside the context.

Constructor Summary

Constructors

Constructor and Description
OccurrenceInfo(String context, int startPosInContext, int endPosInContext)
OccurrenceInfo(String mention, String context)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Serializable>	asQuoteyMap()
int	compareTo(OccurrenceInfo o)
boolean	equals(Object obj)
String	getMention()
String	getPrefixContext()
String	getSuffixContext()
int	hashCode()
String	toString()
OccurrenceInfo	withOrder(double order) The end offset to locate the mention inside the context.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

mention

public final String mention

The context part that actually references an entity

context

public final String context

A maximum 3 sentences long textual context snippet including the mention.

startPosInContext

public final int startPosInContext

The start offset to locate the mention inside the context.

endPosInContext

public final int endPosInContext

The end offset to locate the mention inside the context.

order

public double order

Ordering info such as position in source document to be able to order the occurrences relative to one another.

Constructor Detail

OccurrenceInfo

public OccurrenceInfo(String mention,
              String context)

OccurrenceInfo

public OccurrenceInfo(String context,
              int startPosInContext,
              int endPosInContext)

Method Detail

asQuoteyMap

public Map<String,Serializable> asQuoteyMap()

Returns:

a map suitable for saving the item in the occurrence:quotes field.

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

getMention

public String getMention()

getPrefixContext

public String getPrefixContext()

Returns:

the slice of the context sentence before the actual mention

getSuffixContext

public String getSuffixContext()

Returns:

the slice of the context sentence after the actual mention

compareTo

public int compareTo(OccurrenceInfo o)

Specified by:

compareTo in interface Comparable<OccurrenceInfo>

withOrder

public OccurrenceInfo withOrder(double order)

The end offset to locate the mention inside the context.