com.filenet.api.engine
Interface DocumentClassifier


public interface DocumentClassifier

An interface to be implemented to automatically classify documents of a particular content type. When a document of the targeted content type is checked in with AUTO_CLASSIFY specified, the implementation assigns the applicable Content Engine class to the document. A DocumentClassifier implementation runs on the server.

When implementing a document classifier, consider the following points:

For restrictions and best practices on implementing document classifiers, see Implementation Concepts.

See Also:
DocumentClassificationAction, checkin, Working with Document Classification-related Objects

Method Summary
 void classify(Document doc)
          Assigns a Content Engine class to the Document object passed to the method.
 

Method Detail

classify

void classify(Document doc)
              throws EngineRuntimeException
Assigns a Content Engine class to the Document object passed to the method. Typically, this involves parsing the content of the document and mapping metadata from the content to properties of the Content Engine class. This method is executed by the server when both of the following events occur:

Parameters:
doc - A Document object that specifies the document to auto-classify during check-in.
Throws:
EngineRuntimeException


© Copyright IBM Corporation 2006, 2008. All rights reserved.