org.nuxeo.ecm.classification.core

Class ClassificationServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.classification.core.ClassificationServiceImpl

All Implemented Interfaces:

ClassificationService, Adaptable, Component, Extensible, TimestampedService

public class ClassificationServiceImpl
extends DefaultComponent
implements ClassificationService

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.classification.api.ClassificationService

ClassificationService.CLASSIFY_STATE, ClassificationService.UNCLASSIFY_STATE

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME
static String	RESOLVER_XP
static String	TYPES_XP

Constructor Summary

Constructors

Constructor and Description
ClassificationServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
ClassificationResult<ClassificationService.CLASSIFY_STATE>	classify(DocumentModel classificationFolder, Collection<DocumentModel> targetDocs) Try to classify targets document into the classificationFolder.
ClassificationResult<ClassificationService.CLASSIFY_STATE>	classify(DocumentModel classificationFolder, String resolver, Collection<DocumentModel> targetDocs) Classify a list of documents associated them a resolver to perform complex resolution.
void	deactivate(ComponentContext context) Deactivates the component.
List<String>	getClassifiableDocumentTypes() This will return only the document types that was contributed as classifiable.
boolean	isClassifiable(DocumentModel doc) If this document is classifiable
boolean	isClassifiable(String docType) If this type of document is classifiable.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
String	resolveClassification(CoreSession session, String name, String targetDocId) Resolve the expected document id using the resolver contributed as name.
ClassificationResult<ClassificationService.UNCLASSIFY_STATE>	unClassify(DocumentModel classificationFolder, Collection<String> targetDocs) Try to unclassify targets document into the classificationFolder.
ClassificationResult<ClassificationService.UNCLASSIFY_STATE>	unClassifyFrom(Collection<DocumentModel> classificationFolders, String targetId) Try to unclassify targetId from classificationFolders.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

TYPES_XP

public static final String TYPES_XP

See Also:

Constant Field Values

RESOLVER_XP

public static final String RESOLVER_XP

See Also:

Constant Field Values

Constructor Detail

ClassificationServiceImpl

public ClassificationServiceImpl()

Method Detail

activate

public void activate(ComponentContext context)

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

deactivate

public void deactivate(ComponentContext context)

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

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

resolveClassification

public String resolveClassification(CoreSession session,
                           String name,
                           String targetDocId)
                             throws ClientException

Description copied from interface: ClassificationService

Resolve the expected document id using the resolver contributed as name. Resolution is made with an Unrestricted session to prevent from document rights problem.

Specified by:

resolveClassification in interface ClassificationService

Throws:

ClientException

getClassifiableDocumentTypes

public List<String> getClassifiableDocumentTypes()

Description copied from interface: ClassificationService

This will return only the document types that was contributed as classifiable. It is recommanded to use the facet Classifiable instead of the contribution.

Specified by:

getClassifiableDocumentTypes in interface ClassificationService

Returns:

the list of registered Document Types as String

isClassifiable

public boolean isClassifiable(String docType)

Description copied from interface: ClassificationService

If this type of document is classifiable. It is recommanded to use ClassificationService.isClassifiable(DocumentModel) and to addResolver the facet Classifiable to the classifiable document instead of use the contribution.

Specified by:

isClassifiable in interface ClassificationService

Returns:

true if the given doc type is registered.

isClassifiable

public boolean isClassifiable(DocumentModel doc)

Description copied from interface: ClassificationService

If this document is classifiable

Specified by:

isClassifiable in interface ClassificationService

Returns:

classify

public ClassificationResult<ClassificationService.CLASSIFY_STATE> classify(DocumentModel classificationFolder,
                                                                  String resolver,
                                                                  Collection<DocumentModel> targetDocs)
                                                                    throws ClientException

Description copied from interface: ClassificationService

Classify a list of documents associated them a resolver to perform complex resolution.

Specified by:

classify in interface ClassificationService

Throws:

ClientException

classify

public ClassificationResult<ClassificationService.CLASSIFY_STATE> classify(DocumentModel classificationFolder,
                                                                  Collection<DocumentModel> targetDocs)
                                                                    throws ClientException

Description copied from interface: ClassificationService

Try to classify targets document into the classificationFolder. Method return an object containing references to classified documents, already classified documents or invalid documents. Lists are not initialized until there is at least one corresponding documents.

Specified by:

classify in interface ClassificationService

Parameters:

classificationFolder - expected classification folder

targetDocs - documents wanted to be classified

Throws:

ClientException

unClassify

public ClassificationResult<ClassificationService.UNCLASSIFY_STATE> unClassify(DocumentModel classificationFolder,
                                                                      Collection<String> targetDocs)
                                                                        throws ClientException

Description copied from interface: ClassificationService

Try to unclassify targets document into the classificationFolder. Method return an object containing references to unclassified documents and not classified. Lists are not initialized until there is at least one corresponding documents.

Specified by:

unClassify in interface ClassificationService

Parameters:

classificationFolder - expected classification folder

targetDocs - documents id wanted to be unclassified

Throws:

ClientException

unClassifyFrom

public ClassificationResult<ClassificationService.UNCLASSIFY_STATE> unClassifyFrom(Collection<DocumentModel> classificationFolders,
                                                                          String targetId)
                                                                            throws ClientException

Description copied from interface: ClassificationService

Try to unclassify targetId from classificationFolders. Method return an object containing references to unclassified documents and not classified. Lists are not initialized until there is at least one corresponding documents.

Specified by:

unClassifyFrom in interface ClassificationService

targetId - whanted to be unclassified from specific container

Throws:

ClientException