Package ddf.catalog.transform

Interface MetacardTransformer

public interface MetacardTransformer

The MetacardTransfomer is used to transform a Metacard to a provided BinaryContent. The purpose of a MetacardTransformer is to change the format of the Metacard. For example if the Metacard content is in an XML format, then a MetacardTransformer implementation can be used to transform the Metacard content into an HTML format.

Implementations of this interface must:

• Register with the OSGi Service Registry using the MetacardTransformer 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
BinaryContent	transform(Metacard metacard, Map<String,Serializable> arguments)	Transforms the provided Metacard into a BinaryContent

Method Details

transform

BinaryContent transform(Metacard metacard,
 Map<String,Serializable> arguments)
                 throws CatalogTransformerException

Transforms the provided Metacard into a BinaryContent

Parameters:

metacard - the Metacard to be transformed

arguments - any arguments to be used in the transformation. Keys are specific to each MetacardTransformer implementation

Returns:

BinaryContent the result of the Metacard transformation

Throws:

CatalogTransformerException - if the Metacard can not be transformed