org.codice.ddf.transformer.xml.streaming.lib

Class XmlInputTransformer

java.lang.Object

org.codice.ddf.transformer.xml.streaming.lib.XmlInputTransformer

All Implemented Interfaces:

InputTransformer, Describable

public class XmlInputTransformer
extends Object
implements InputTransformer, Describable

A InputTransformer that can be configured to parse any XML into a Metacard It is configured through setSaxEventHandlerConfiguration(List) and XmlInputTransformer#getMetacardType()

Constructor Summary

Constructors

Constructor and Description
XmlInputTransformer()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a description of the describable item.
String	getId() Returns the name, aka ID, of the describable item.
String	getOrganization() Returns the organization associated with the describable item.
String	getTitle() Returns the title of the describable item.
String	getVersion() Retrieve the version.
void	setDescription(String description)
void	setId(String id)
void	setOrganization(String organization)
void	setSaxEventHandlerConfiguration(List<String> saxEventHandlerConfiguration) Setter to set the configuration of SaxEventHandlers used to parse metacards
void	setSaxEventHandlerFactories(List<SaxEventHandlerFactory> saxEventHandlerFactories) Setter to set the list of all SaxEventHandlerFactorys.
void	setTitle(String title)
void	setVersion(String version)
Metacard	transform(InputStream inputStream) Takes in an XML InputStream and returns a populated Metacard The Metacard is populated with all attributes that have been parsed by the SaxEventHandlers declared in saxEventHandlerConfigurations
Metacard	transform(InputStream inputStream, String id) Takes in an XML InputStream and an ID and returns a populated Metacard The Metacard is populated with all attributes that have been parsed by the SaxEventHandlers declared in saxEventHandlerConfigurations and with the specific ID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlInputTransformer

public XmlInputTransformer()

Method Detail

transform

public Metacard transform(InputStream inputStream)
                   throws CatalogTransformerException

Takes in an XML InputStream and returns a populated Metacard The Metacard is populated with all attributes that have been parsed by the SaxEventHandlers declared in saxEventHandlerConfigurations

Specified by:

transform in interface InputTransformer

Parameters:

inputStream - an XML input stream to be turned into a Metacard

Returns:

a populated Metacard

Throws:

CatalogTransformerException

IOException

transform

public Metacard transform(InputStream inputStream,
                          String id)
                   throws CatalogTransformerException,
                          IOException

Takes in an XML InputStream and an ID and returns a populated Metacard The Metacard is populated with all attributes that have been parsed by the SaxEventHandlers declared in saxEventHandlerConfigurations and with the specific ID

Specified by:

transform in interface InputTransformer

Parameters:

inputStream - an XML input stream to be turned into a Metacard.

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

Returns:

a populated Metacard

Throws:

CatalogTransformerException

IOException

setSaxEventHandlerFactories

public void setSaxEventHandlerFactories(List<SaxEventHandlerFactory> saxEventHandlerFactories)

Setter to set the list of all SaxEventHandlerFactorys. Usually called from a blueprint, and the blueprint will keep the factories updated

Parameters:

saxEventHandlerFactories - a list of all SaxEventHandlerFactories (usually a list of all factories that are available as services)

setSaxEventHandlerConfiguration

public void setSaxEventHandlerConfiguration(List<String> saxEventHandlerConfiguration)

Setter to set the configuration of SaxEventHandlers used to parse metacards

Parameters:

saxEventHandlerConfiguration - a list of SaxEventHandlerFactory ids

getVersion

public String getVersion()

Description copied from interface: Describable

Retrieve the version.

Specified by:

getVersion in interface Describable

Returns:

the version of the item being described (example: 1.0)

getId

public String getId()

Description copied from interface: Describable

Returns the name, aka ID, of the describable item. The name should be unique for each instance.
Example: html for a MetacardTransformer that transforms Metacards to HTML

Specified by:

getId in interface Describable

Returns:

ID of the item

getTitle

public String getTitle()

Description copied from interface: Describable

Returns the title of the describable item. It is generally more verbose than the name (aka ID).

Specified by:

getTitle in interface Describable

Returns:

title of the item (example: Dummy Catalog Provider)

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Specified by:

getDescription in interface Describable

Returns:

description of the item (example: Provider that returns back static results)

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Specified by:

getOrganization in interface Describable

Returns:

organizational name or acronym (example: USAF)

setVersion

public void setVersion(String version)

setId

public void setId(String id)

setTitle

public void setTitle(String title)

setDescription

public void setDescription(String description)

setOrganization

public void setOrganization(String organization)