org.nuxeo.ecm.platform.categorization.service

Interface DocumentCategorizationService

All Known Implementing Classes:

DocumentCategorizationServiceImpl

public interface DocumentCategorizationService

Service to automatically suggests values for metadata category fields from the text content of a document.

Author:

ogrisel

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

updateCategories

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

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.

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

ClientException

updateCategories

List<DocumentModel> updateCategories(List<DocumentModel> documents)
                                     throws ClientException,
                                            Exception

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

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

ClientException