You use Developer Studio to configure a Java manipulator for transforming and producing records. A single Java manipulator can take records from several record servers.
Java manipulators read records from multiple inputs, transform specific properties of the records, and write the results to a records output that can be passed to another component in the pipeline. A Java manipulator is not limited to changing properties on existing records. It can produce records in any form you choose.
Typically, the records that the Java manipulator takes as inputs come from one or more record servers, such as record adapters that already exist in your pipeline.
When you create a Java manipulator, you specify the Java class used for cleaning or changing the record properties, configuration pass throughs for the manipulator (typically these are the properties in the records that will be transformed), and the record sources that the Java manipulator should take as its input.
To deploy your Java manipulator in the pipeline:
In Developer Studio, open the project that will contain the Java manipulator. In the Project Explorer, double-click Pipeline Diagram, and then click → .
The New Java Manipulator editor displays.
In the Name field, enter a name for your Java manipulator. The name must be unique among the pipeline components.
(Optional) Under the General tab, in the Java home field, specify the location of the Java Runtime Engine (JRE).
If you do not specify this attribute, Forge obtains the location of the JRE by using the attribute specified to the Forge, the
--javaHomeflag. If it is not available, Forge uses theENDECA_ROOT/j2sdkdirectory, which is installed as part of the Endeca Platform Services package. As a final fallback, Forge uses theJAVA_HOMEenvironment variable.Under the General tab, in the Class field, specify the name of the Java class that will be used by this Java manipulator. This is the class that you built with the CADK.
For example, use this class for the sample Java manipulator:
com.endeca.soleng.javamanipulator.SampleJavaManipulator(Optional) Under the General tab, in the Class path field, specify the absolute path to the JAR file that contains the class specified by the
Classattribute.The JAR file must contain the class and all other classes it depends on. If you do not specify this attribute, the Java manipulator uses the default class path of
ENDECA_ROOT/lib/java. If you use this attribute, the specified class path is prefixed to the default classpath.For example, you can specify this class path for the
SampleJavaManipulator.jar:lib\SampleJavaManipulator.jarNote
When running your pipeline, you can override the Java home and Class path settings using command-line options.
Under the Sources tab, specify which record servers in the pipeline are providing records to your Java manipulator. You can specify multiple record sources.
Under the Pass Throughs tab, specify any pass through arguments that your Java manipulator expects. For example, you can specify the properties of the records that you want to be cleaned or changed by your Java manipulator. Enter the name and value pair for each record property that you will be using as your pass through.
(Optional) Use the Comment tab to describe your Java manipulator.
The Java manipulator is added to the Forge pipeline.
