Engine Developer Guide

Back Next

Java Interface Example

As an example, consider a document processor that accepts file input. The processor must implement the

CMXFileProcessor

class, which has the following method:

public String process(
    CMXContext context,
    String in,
    String additionalFilesDir,
    CMXEventReporter reporter)
    throws Exception

The meaning of the parameters is as follows:

Parameter	Description
context	Input parameter. An object containing the properties that the Script passes to the component. The parameters method of the object returns a vector containing the property values.
in	Input parameter. The full path of the file that the component operates on.
additionalFilesDir	Optional output parameter. The path of a temporary directory where the component writes files. At the end of processing, the Script deletes the entire directory content.
reporter	Input parameter. An object providing the report method, which the component can use to write events to the event log.