org.nuxeo.ecm.platform.semanticentities.adapter

Class OccurrenceRelationImpl

java.lang.Object

org.nuxeo.ecm.platform.semanticentities.adapter.OccurrenceRelationImpl

All Implemented Interfaces:

OccurrenceRelation

public class OccurrenceRelationImpl
extends Object
implements OccurrenceRelation

Constructor Summary

Constructors

Constructor and Description
OccurrenceRelationImpl(DocumentModel doc)

Method Summary

Methods

Modifier and Type	Method and Description
void	addOccurrences(List<OccurrenceInfo> occurrences) Merge the list of occurrences with the existing occurrence info held by the underlying document model using.
DocumentModel	getOccurrenceDocument()
List<OccurrenceInfo>	getOccurrences()
List<OccurrenceInfo>	getOccurrences(int maxOccurrences)
DocumentModel	getSourceDocument() Lazy fetch the DocumentModel of the document carrying the entity mentions.
DocumentRef	getSourceDocumentRef()
DocumentModel	getTargetEntity() Lazy fetch the DocumentModel of the entity being mentioned.
DocumentRef	getTargetEntityRef()
void	setOccurrences(List<OccurrenceInfo> occurrences) Replace existing occurrences with the a new list of occurrence info.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OccurrenceRelationImpl

public OccurrenceRelationImpl(DocumentModel doc)

Method Detail

getOccurrences

public List<OccurrenceInfo> getOccurrences()
                                    throws ClientException

Specified by:

getOccurrences in interface OccurrenceRelation

Returns:

the snippet info and the precise locations of the mentioned names inside those of snippets

Throws:

ClientException

getOccurrences

public List<OccurrenceInfo> getOccurrences(int maxOccurrences)
                                    throws ClientException

Specified by:

getOccurrences in interface OccurrenceRelation

Throws:

ClientException

addOccurrences

public void addOccurrences(List<OccurrenceInfo> occurrences)
                    throws ClientException

Description copied from interface: OccurrenceRelation

Merge the list of occurrences with the existing occurrence info held by the underlying document model using. Remove the duplicated entries without altering the ordering.

Specified by:

addOccurrences in interface OccurrenceRelation

Throws:

ClientException

setOccurrences

public void setOccurrences(List<OccurrenceInfo> occurrences)
                    throws ClientException

Description copied from interface: OccurrenceRelation

Replace existing occurrences with the a new list of occurrence info. Remove the duplicated entries without altering the ordering.

Specified by:

setOccurrences in interface OccurrenceRelation

Throws:

ClientException

getSourceDocumentRef

public DocumentRef getSourceDocumentRef()
                                 throws ClientException

Specified by:

getSourceDocumentRef in interface OccurrenceRelation

Returns:

the reference of the document that holds the text quotes mentioning the entity

Throws:

ClientException

getTargetEntityRef

public DocumentRef getTargetEntityRef()
                               throws ClientException

Specified by:

getTargetEntityRef in interface OccurrenceRelation

Returns:

the reference of the entity that is mentioned by the document

Throws:

ClientException

getOccurrenceDocument

public DocumentModel getOccurrenceDocument()

Specified by:

getOccurrenceDocument in interface OccurrenceRelation

Returns:

the adapted occurrence relation document

getTargetEntity

public DocumentModel getTargetEntity()
                              throws ClientException

Description copied from interface: OccurrenceRelation

Lazy fetch the DocumentModel of the entity being mentioned.

Specified by:

getTargetEntity in interface OccurrenceRelation

Throws:

ClientException

getSourceDocument

public DocumentModel getSourceDocument()
                                throws ClientException

Description copied from interface: OccurrenceRelation

Lazy fetch the DocumentModel of the document carrying the entity mentions.

Specified by:

getSourceDocument in interface OccurrenceRelation

Throws:

ClientException