|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
QueueItem
and retried as often as set in the RetryCount property. Save
method on the source object of the event,
as long as there is no infinite loop to waste system resources.CodeModule
object in a Content Engine object store,
or you can specify the document classifier in the classpath of the application server where the Content Engine is running.
See Deploying Action Handlers for more information.For restrictions and best practices on implementing document classifiers, see Implementation Concepts.
DocumentClassificationAction
,
checkin
,
Working with Document Classification-related ObjectsMethod Summary | |
---|---|
void |
classify(Document doc)
Assigns a Content Engine class to the Document object passed to the method. |
Method Detail |
---|
void classify(Document doc) throws EngineRuntimeException
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:
doc
parameter is checked in by calling its checkin
method with the autoClassify
parameter set to AUTO_CLASSIFY
.DocumentClassificationAction
object exists whose MimeType
property value is
identical to that of the MimeType
property of the document to be checked in.
doc
- A Document
object that specifies the document to auto-classify during check-in.
EngineRuntimeException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |