001/*
002 * (C) Copyright 2009 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Olivier Grisel
018 */
019package org.nuxeo.ecm.platform.categorization.service;
020
021import java.util.List;
022
023import org.nuxeo.ecm.core.api.CoreSession;
024import org.nuxeo.ecm.core.api.DocumentModel;
025import org.nuxeo.ecm.core.api.DocumentRef;
026
027/**
028 * Service to automatically suggests values for metadata category fields from the text content of a document.
029 *
030 * @author ogrisel
031 */
032public interface DocumentCategorizationService {
033
034    /**
035     * Run all registered document categorizers on the given documents fetched using the provided session. Note: the
036     * service does not save the documents. This responsibility is left to the caller.
037     *
038     * @param session the Core session used to fetch the document
039     * @param docRefs the list of documents to process
040     * @return the updated documents (unchanged documents are filtered out)
041     */
042    List<DocumentModel> updateCategories(CoreSession session, List<DocumentRef> docRefs);
043
044    /**
045     * Run all registered document categorizers on the given documents. Note: the service does not save the documents.
046     * This responsibility is left to the caller.
047     *
048     * @param documents the list of documents to process
049     * @return the updated documents (unchanged documents are filtered out)
050     */
051    List<DocumentModel> updateCategories(List<DocumentModel> documents);
052
053}