org.nuxeo.ecm.platform.categorization.service

Class DocumentCategorizationServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.categorization.service.DocumentCategorizationServiceImpl

All Implemented Interfaces:

DocumentCategorizationService, Adaptable, Component, Extensible, TimestampedService

public class DocumentCategorizationServiceImpl
extends DefaultComponent
implements DocumentCategorizationService

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY2TEXT
static String	CATEGORIZERS_XP_NAME

Constructor Summary

Constructors

Constructor and Description
DocumentCategorizationServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
String	extractTextContent(DocumentModel doc)
void	registerExtension(Extension extension) Registers the given extension.
void	unregisterExtension(Extension extension) Unregisters the given extension.
List<DocumentModel>	updateCategories(CoreSession session, List<DocumentRef> docRefs) Run all registered document categorizers on the given documents fetched using the provided session.
List<DocumentModel>	updateCategories(List<DocumentModel> documents) Run all registered document categorizers on the given documents.

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

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerContribution, setLastModified, unregisterContribution

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORIZERS_XP_NAME

public static final String CATEGORIZERS_XP_NAME

See Also:

Constant Field Values

ANY2TEXT

public static final String ANY2TEXT

See Also:

Constant Field Values

Constructor Detail

DocumentCategorizationServiceImpl

public DocumentCategorizationServiceImpl()

Method Detail

registerExtension

public void registerExtension(Extension extension)
                       throws Exception

Description copied from interface: Extensible

Registers the given extension.

Specified by:

registerExtension in interface Extensible

Overrides:

registerExtension in class DefaultComponent

Parameters:

extension - the extension to register

Throws:

Exception - if any error occurs

unregisterExtension

public void unregisterExtension(Extension extension)
                         throws Exception

Description copied from interface: Extensible

Unregisters the given extension.

Specified by:

unregisterExtension in interface Extensible

Overrides:

unregisterExtension in class DefaultComponent

Parameters:

extension - the extension to unregister

Throws:

Exception - if any error occurs

updateCategories

public List<DocumentModel> updateCategories(CoreSession session,
                                   List<DocumentRef> docRefs)
                                     throws Exception

Description copied from interface: DocumentCategorizationService

Run all registered document categorizers on the given documents fetched using the provided session. Note: the service does not save the documents. This responsibility is left to the caller.

Specified by:

updateCategories in interface DocumentCategorizationService

Parameters:

session - the Core session used to fetch the document

docRefs - the list of documents to process

Returns:

the updated documents (unchanged documents are filtered out)

Throws:

Exception - if there is a problem while extracting the text content

updateCategories

public List<DocumentModel> updateCategories(List<DocumentModel> documents)
                                     throws Exception

Description copied from interface: DocumentCategorizationService

Run all registered document categorizers on the given documents. Note: the service does not save the documents. This responsibility is left to the caller.

Specified by:

updateCategories in interface DocumentCategorizationService

Parameters:

documents - the list of documents to process

Returns:

the updated documents (unchanged documents are filtered out)

Throws:

Exception - if there is a problem while extracting the text content

extractTextContent

public String extractTextContent(DocumentModel doc)
                          throws Exception

Throws:

Exception