org.nuxeo.ecm.platform.semanticentities.service

Class SemanticAnalysisServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.semanticentities.service.SemanticAnalysisServiceImpl

All Implemented Interfaces:

SemanticAnalysisService, Adaptable, Component, Extensible, TimestampedService

public class SemanticAnalysisServiceImpl
extends DefaultComponent
implements SemanticAnalysisService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SemanticAnalysisServiceImpl.NamedThreadFactory Creates non-daemon threads at normal priority.

Constructor Summary

Constructors

Constructor and Description
SemanticAnalysisServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
List<OccurrenceGroup>	analyze(CoreSession session, DocumentModel doc) Synchronous analysis of a document (without linking).
List<OccurrenceGroup>	analyze(CoreSession session, String textContent) Synchronous analysis of pre-extracted text content (without linking).
String	callSemanticEngine(String textContent, String outputFormat, int retry)
void	clearProgressStatus(String repositoryName, DocumentRef docRef) Mark the status as complete (even though the document might still be under processing).
void	createLinks(DocumentModel doc, CoreSession session, List<OccurrenceGroup> groups) Save semantic links in the repository to materialize the occurrence relationships between documents and entities
void	deactivate(ComponentContext context) Deactivates the component.
List<OccurrenceGroup>	findStanbolEntityOccurrences(CoreSession session, com.hp.hpl.jena.rdf.model.Model model)
ProgressStatus	getProgressStatus(String repositoryName, DocumentRef docRef) Return a description of the state of the analysis of the document or null if no analysis is in progress.
boolean	isActive()
void	launchAnalysis(String repositoryName, DocumentRef docRef) Launch an asynchronous analysis of a document.
void	launchSynchronousAnalysis(DocumentModel doc, CoreSession session) Launch a analysis of a document and wait for the result before returning.
void	scheduleSerializationTask(SerializationTask task) Asynchronously save the result of the analyze using a dedicated sequential thread.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getAdapter, getApplicationStartedOrder, getLastModified, registerContribution, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Constructor Detail

SemanticAnalysisServiceImpl

public SemanticAnalysisServiceImpl()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

scheduleSerializationTask

public void scheduleSerializationTask(SerializationTask task)

Description copied from interface: SemanticAnalysisService

Asynchronously save the result of the analyze using a dedicated sequential thread.

Specified by:

scheduleSerializationTask in interface SemanticAnalysisService

Parameters:

task - a DTO that contains the reference of a document and the occurrence groups to link to it

launchAnalysis

public void launchAnalysis(String repositoryName,
                  DocumentRef docRef)
                    throws ClientException

Description copied from interface: SemanticAnalysisService

Launch an asynchronous analysis of a document. The result of the analysis is stored directly in the Nuxeo repository, usually as relationship to semantic entities, other documents or updated properties.

Specified by:

launchAnalysis in interface SemanticAnalysisService

Parameters:

repositoryName - the repository where the document is stored

docRef - the reference of the document to analyze

Throws:

ClientException - if a property of the document to analyze is not available due to a database connection issue for instance.

launchSynchronousAnalysis

public void launchSynchronousAnalysis(DocumentModel doc,
                             CoreSession session)
                               throws ClientException,
                                      IOException

Description copied from interface: SemanticAnalysisService

Launch a analysis of a document and wait for the result before returning. The result of the analysis is stored directly in the Nuxeo repository, usually as relationship to semantic entities, other documents or updated properties.

Specified by:

launchSynchronousAnalysis in interface SemanticAnalysisService

Parameters:

doc - the document to analyze

Throws:

ClientException - if a property of the document to analyze is not available due to a database connection issue for instance.

IOException - if the connection to the analysis engine fails, or if the engine it-self fails

DereferencingException - if the dereferencing process fails (e.g. due to a network failure to a remote knowledge base).

createLinks

public void createLinks(DocumentModel doc,
               CoreSession session,
               List<OccurrenceGroup> groups)
                 throws ClientException,
                        IOException

Description copied from interface: SemanticAnalysisService

Save semantic links in the repository to materialize the occurrence relationships between documents and entities

Specified by:

createLinks in interface SemanticAnalysisService

Throws:

ClientException - if the document repository fails during local lookups or saving entities and occurrences

IOException - if the remote entity sources fail during lookups

findStanbolEntityOccurrences

public List<OccurrenceGroup> findStanbolEntityOccurrences(CoreSession session,
                                                 com.hp.hpl.jena.rdf.model.Model model)
                                                   throws DereferencingException,
                                                          ClientException

Throws:

DereferencingException

ClientException

analyze

public List<OccurrenceGroup> analyze(CoreSession session,
                            String textContent)
                              throws IOException,
                                     ClientException

Description copied from interface: SemanticAnalysisService

Synchronous analysis of pre-extracted text content (without linking).

Specified by:

analyze in interface SemanticAnalysisService

Parameters:

session - used to create in-memory prefetched entity suggestions if available in the analysis engine response.

textContent - the text to send to the engines

Returns:

Occurrence suggestions

Throws:

IOException - if the engine is not reachable or fails

ClientException - if the in-memory creation of prefetched entity suggestions fails (very unlikely)

analyze

public List<OccurrenceGroup> analyze(CoreSession session,
                            DocumentModel doc)
                              throws IOException,
                                     ClientException

Description copied from interface: SemanticAnalysisService

Synchronous analysis of a document (without linking).

Specified by:

analyze in interface SemanticAnalysisService

Parameters:

session - used to create in-memory prefetched entity suggestions if available in the analysis engine response.

doc - the document to analyze (must be attached to an active core session to extract the text content)

Returns:

Occurrence suggestions

Throws:

IOException - if the engine is not reachable or fails

ClientException - if the text extraction fails

callSemanticEngine

public String callSemanticEngine(String textContent,
                        String outputFormat,
                        int retry)
                          throws IOException

Throws:

IOException

getProgressStatus

public ProgressStatus getProgressStatus(String repositoryName,
                               DocumentRef docRef)

Description copied from interface: SemanticAnalysisService

Return a description of the state of the analysis of the document or null if no analysis is in progress.

Specified by:

getProgressStatus in interface SemanticAnalysisService

Returns:

state description or null

clearProgressStatus

public void clearProgressStatus(String repositoryName,
                       DocumentRef docRef)

Description copied from interface: SemanticAnalysisService

Mark the status as complete (even though the document might still be under processing).

Specified by:

clearProgressStatus in interface SemanticAnalysisService

isActive

public boolean isActive()

Specified by:

isActive in interface SemanticAnalysisService

Returns:

true if the service could be correctly initialized