Package ddf.catalog.transform

Interface InputTransformer

public interface InputTransformer

An InputTransformer has the purpose of creating a Metacard from a given InputStream. Alternatively a Metacard implementation's constructor can be used to create Metacards.

Implementations of this interface must:

• Register with the OSGi Service Registry using the InputTransformer interface
• Include a Service property with name "id" (Constants.SERVICE_ID) and a String value uniquely identifying the particular implementation

Method Summary

Modifier and Type	Method	Description
Metacard	transform(InputStream input)	Transforms the input into a Metacard.
Metacard	transform(InputStream input, String id)	Transforms the input into a Metacard and associates the id with the Metacard on creation.

Method Details

transform

Metacard transform(InputStream input)
            throws IOException,
CatalogTransformerException

Transforms the input into a Metacard.

Parameters:

input - the binary InputStream to transform

Returns:

the generated Metacard

Throws:

IOException - if an I/O exception occurs when reading the InputStream

CatalogTransformerException - if an error occurs during transformation

transform

Metacard transform(InputStream input,
 String id)
            throws IOException,
CatalogTransformerException

Transforms the input into a Metacard and associates the id with the Metacard on creation.

Parameters:

input - the binary InputStream to transform

id - the attribute value for the Metacard.ID attribute that should be set in the generated Metacard

Returns:

the generated Metacard

Throws:

IOException - if an I/O exception occurs when reading the InputStream

CatalogTransformerException - if an error occurs during transformation