Engine Developer Guide

Back Next

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 following table describes the

CMXFileProcessor

parameters:

Parameter	Description
context	In: 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	In: The full path of the file upon which the component should operate.
additionalFilesDir	Out: Optionally, the path of a temporary directory where the component writes files. At the end of processing, the script deletes the entire directory content.
reporter	In: An object providing the report method, which the component can use to write events to the event log.
reporter	Out: The full path of a file that contains the output of the component.