org.codice.ddf.spatial.kml.transformer

Class KMLTransformerImpl

java.lang.Object

org.codice.ddf.spatial.kml.transformer.KMLTransformerImpl

All Implemented Interfaces:

MetacardTransformer, QueryResponseTransformer, KMLTransformer

public class KMLTransformerImpl
extends Object
implements KMLTransformer

The base Transformer for handling KML requests to take a Metacard or SourceResponse and produce a KML representation. This service attempts to first locate a KMLEntryTransformer for a given Metacard based on the metadata-content-type. If no KMLEntryTransformer can be found, the default transformation is performed.

Author:

Ashraf Barakat, Ian Barnett, Keith C Wire

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osgi.framework.BundleContext	context
protected static MimeType	KML_MIMETYPE

Constructor Summary

Constructors

Constructor and Description
KMLTransformerImpl(org.osgi.framework.BundleContext bundleContext, String defaultStylingName, KmlStyleMap mapper, ActionProvider actionProvider)

Method Summary

Modifier and Type	Method and Description
static de.micromata.opengis.kml.v_2_2_0.Document	encloseDoc(de.micromata.opengis.kml.v_2_2_0.Placemark placemark, de.micromata.opengis.kml.v_2_2_0.Style style, String documentId, String docName) Encapsulate the kml content (placemarks, etc.) with a style in a KML Document element If either content or style are null, they will be in the resulting Document
static de.micromata.opengis.kml.v_2_2_0.Kml	encloseKml(de.micromata.opengis.kml.v_2_2_0.Document doc, String docId, String docName) Wrap KML document with the opening and closing kml tags
protected de.micromata.opengis.kml.v_2_2_0.Placemark	performDefaultTransformation(Metacard entry, String url) The default Transformation from a Metacard to a KML Placemark.
BinaryContent	transform(Metacard metacard, Map<String,Serializable> arguments) Transforms the provided Metacard into a BinaryContent
BinaryContent	transform(SourceResponse upstreamResponse, Map<String,Serializable> arguments) Transforms the list of results into the BinaryContent.
de.micromata.opengis.kml.v_2_2_0.Placemark	transformEntry(Subject user, Metacard entry, Map<String,Serializable> arguments) This will return a KML Placemark (i.e.

Methods inherited from class java.lang.Object

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

Field Detail

KML_MIMETYPE

protected static final MimeType KML_MIMETYPE

context

protected org.osgi.framework.BundleContext context

Constructor Detail

KMLTransformerImpl

public KMLTransformerImpl(org.osgi.framework.BundleContext bundleContext,
                          String defaultStylingName,
                          KmlStyleMap mapper,
                          ActionProvider actionProvider)

Method Detail

encloseDoc

public static de.micromata.opengis.kml.v_2_2_0.Document encloseDoc(de.micromata.opengis.kml.v_2_2_0.Placemark placemark,
                                                                   de.micromata.opengis.kml.v_2_2_0.Style style,
                                                                   String documentId,
                                                                   String docName)
                                                            throws IllegalArgumentException

Encapsulate the kml content (placemarks, etc.) with a style in a KML Document element If either content or style are null, they will be in the resulting Document

Parameters:

kml -

style -

documentId - which should be the metacard id

Returns:

KML DocumentType element with style and content

Throws:

IllegalArgumentException

encloseKml

public static de.micromata.opengis.kml.v_2_2_0.Kml encloseKml(de.micromata.opengis.kml.v_2_2_0.Document doc,
                                                              String docId,
                                                              String docName)

Wrap KML document with the opening and closing kml tags

Parameters:

document -

folderId - which should be the subscription id if it exists

Returns:

completed KML

transformEntry

public de.micromata.opengis.kml.v_2_2_0.Placemark transformEntry(Subject user,
                                                                 Metacard entry,
                                                                 Map<String,Serializable> arguments)
                                                          throws CatalogTransformerException

This will return a KML Placemark (i.e. there are no kml tags) <KML> ---> not included <Placemark> ---> What is returned from this method ... ---> What is returned from this method </Placemark> ---> What is returned from this method </KML> ---> not included

Specified by:

transformEntry in interface KMLTransformer

Parameters:

user -

entry - - the Metacard to be transformed

arguments - - additional arguments to assist in the transformation

Returns:

Placemark - kml object containing transformed content

Throws:

CatalogTransformerException

performDefaultTransformation

protected de.micromata.opengis.kml.v_2_2_0.Placemark performDefaultTransformation(Metacard entry,
                                                                                  String url)
                                                                           throws CatalogTransformerException

The default Transformation from a Metacard to a KML Placemark. Protected to easily allow other default transformations.

Parameters:

entry - - the Metacard to transform.

urlToMetacard -

Returns:

Throws:

TransformerException

CatalogTransformerException

transform

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

Description copied from interface: MetacardTransformer

Transforms the provided Metacard into a BinaryContent

Specified by:

transform in interface MetacardTransformer

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

transform

public BinaryContent transform(SourceResponse upstreamResponse,
                               Map<String,Serializable> arguments)
                        throws CatalogTransformerException

Description copied from interface: QueryResponseTransformer

Transforms the list of results into the BinaryContent.

Specified by:

transform in interface QueryResponseTransformer

arguments - the arguments that may be used to execute the transform

Returns:

the transformed content

Throws:

CatalogTransformerException - if the response cannot be transformed