org.codice.ddf.spatial.ogc.csw.catalog.converter

Class CswRecordConverter

java.lang.Object

org.codice.ddf.spatial.ogc.csw.catalog.converter.CswRecordConverter

All Implemented Interfaces:

com.thoughtworks.xstream.converters.Converter, com.thoughtworks.xstream.converters.ConverterMatcher, InputTransformer, MetacardTransformer

public class CswRecordConverter
extends Object
implements com.thoughtworks.xstream.converters.Converter, MetacardTransformer, InputTransformer

Converts CSW Record to a Metacard.

Field Summary

Fields

Modifier and Type	Field and Description
static MimeType	XML_MIME_TYPE

Constructor Summary

Constructors

Constructor and Description
CswRecordConverter(MetacardType metacardType)

Method Summary

Modifier and Type	Method and Description
boolean	canConvert(Class clazz)
static Serializable	convertStringValueToMetacardValue(AttributeType.AttributeFormat attributeFormat, String value) Converts properties in CSW records that overlap with same name as a basic Metacard attribute, e.g., title.
static String	getCswAttributeFromAttributeName(String attributeName) Converts an attribute name to the csw:Record attribute it corresponds to.
Attribute	getMetacardAttributeFromCswAttribute(String cswAttributeName, Serializable cswAttributeValue, String metacardAttributeName) Takes a CSW attribute as a name and value and returns an Attribute whose value is cswAttributeValue converted to the type of the attribute metacardAttributeName in a Metacard.
void	marshal(Object source, com.thoughtworks.xstream.io.HierarchicalStreamWriter writer, com.thoughtworks.xstream.converters.MarshallingContext context)
Metacard	transform(InputStream inputStream) Transforms the input into a Metacard.
Metacard	transform(InputStream inputStream, String id) Transforms the input into a Metacard and associates the id with the Metacard on creation.
BinaryContent	transform(Metacard metacard, Map<String,Serializable> arguments) Transforms the provided Metacard into a BinaryContent
Object	unmarshal(com.thoughtworks.xstream.io.HierarchicalStreamReader reader, com.thoughtworks.xstream.converters.UnmarshallingContext context)

Methods inherited from class java.lang.Object

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

Field Detail

XML_MIME_TYPE

public static final MimeType XML_MIME_TYPE

Constructor Detail

CswRecordConverter

public CswRecordConverter(MetacardType metacardType)

Method Detail

canConvert

public boolean canConvert(Class clazz)

Specified by:

canConvert in interface com.thoughtworks.xstream.converters.ConverterMatcher

marshal

public void marshal(Object source,
                    com.thoughtworks.xstream.io.HierarchicalStreamWriter writer,
                    com.thoughtworks.xstream.converters.MarshallingContext context)

Specified by:

marshal in interface com.thoughtworks.xstream.converters.Converter

unmarshal

public Object unmarshal(com.thoughtworks.xstream.io.HierarchicalStreamReader reader,
                        com.thoughtworks.xstream.converters.UnmarshallingContext context)

Specified by:

unmarshal in interface com.thoughtworks.xstream.converters.Converter

transform

public Metacard transform(InputStream inputStream)
                   throws IOException,
                          CatalogTransformerException

Description copied from interface: InputTransformer

Transforms the input into a Metacard.

Specified by:

transform in interface InputTransformer

Parameters:

inputStream - 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

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

Description copied from interface: InputTransformer

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

Specified by:

transform in interface InputTransformer

Parameters:

inputStream - 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

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

convertStringValueToMetacardValue

public static Serializable convertStringValueToMetacardValue(AttributeType.AttributeFormat attributeFormat,
                                                             String value)

Converts properties in CSW records that overlap with same name as a basic Metacard attribute, e.g., title. This conversion method is needed mainly because CSW records express all dates as strings, whereas MetacardImpl expresses them as java.util.Date types.

Parameters:

attributeFormat - the format of the attribute to be converted

value - the value to be converted

Returns:

the value that was extracted from reader and is of the type described by attributeFormat

getMetacardAttributeFromCswAttribute

public Attribute getMetacardAttributeFromCswAttribute(String cswAttributeName,
                                                      Serializable cswAttributeValue,
                                                      String metacardAttributeName)

Takes a CSW attribute as a name and value and returns an Attribute whose value is cswAttributeValue converted to the type of the attribute metacardAttributeName in a Metacard.

Parameters:

cswAttributeName - the name of the CSW attribute

cswAttributeValue - the value of the CSW attribute

metacardAttributeName - the name of the Metacard attribute whose type cswAttributeValue will be converted to

Returns:

an Attribute with the name metacardAttributeName and the value cswAttributeValue converted to the type of the attribute metacardAttributeName in a Metacard.

getCswAttributeFromAttributeName

public static String getCswAttributeFromAttributeName(String attributeName)

Converts an attribute name to the csw:Record attribute it corresponds to.

Parameters:

attributeName - the name of the attribute

Returns:

the name of the csw:Record attribute that this attribute name corresponds to