org.nuxeo.ecm.platform.semanticentities.adapter

Interface OccurrenceRelation

All Known Implementing Classes:

OccurrenceRelationImpl

public interface OccurrenceRelation

Helper interface to adapt a document model with the occurrence schema and facet to help the manipulation of occurrence of names of entities in the text rendition of a document.

Author:

ogrisel

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()
DocumentRef	getSourceDocumentRef()
DocumentRef	getTargetEntityRef()
void	setOccurrences(List<OccurrenceInfo> occurrences) Replace existing occurrences with the a new list of occurrence info.

Method Detail

getOccurrenceDocument

DocumentModel getOccurrenceDocument()

Returns:

the adapted occurrence relation document

getSourceDocumentRef

DocumentRef getSourceDocumentRef()
                                 throws ClientException

Returns:

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

Throws:

ClientException

getTargetEntityRef

DocumentRef getTargetEntityRef()
                               throws ClientException

Returns:

the reference of the entity that is mentioned by the document

Throws:

ClientException

getOccurrences

List<OccurrenceInfo> getOccurrences()
                                    throws ClientException

Returns:

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

Throws:

ClientException

addOccurrences

void addOccurrences(List<OccurrenceInfo> occurrences)
                    throws ClientException

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.

Throws:

ClientException

setOccurrences

void setOccurrences(List<OccurrenceInfo> occurrences)
                    throws ClientException

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

Throws:

ClientException