org.n52.io.response.extension

Class MetadataExtension<T extends ParameterOutput>

java.lang.Object

org.n52.io.response.extension.MetadataExtension<T>

Direct Known Subclasses:

LicenseExtension

public abstract class MetadataExtension<T extends ParameterOutput>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MetadataExtension()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getExtensionName()
java.util.Collection<java.lang.String>	getExtraMetadataFieldNames(T output)
abstract java.util.Map<java.lang.String,java.lang.Object>	getExtras(T output, IoParameters parameters) Gets the extra metadata as simple key=value mapping.
protected boolean	hasExtrasToReturn(T output, IoParameters parameters)
protected java.util.Map<java.lang.String,java.lang.Object>	wrapSingleIntoMap(java.lang.Object metadata)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataExtension

public MetadataExtension()

Method Detail

getExtensionName

public abstract java.lang.String getExtensionName()

getExtras

public abstract java.util.Map<java.lang.String,java.lang.Object> getExtras(T output,
                                                                           IoParameters parameters)

Gets the extra metadata as simple key=value mapping. The value is of kind object, so the implementation is free to put any data structure which might make sense to serialize.

Implementation is responsible to respect selected fields from the query which can be obtained by IoParameters.getFields().

Parameters:

output - the actual parameter output to get extra metadata for.

parameters - I/O parameters to fine grain extra metadata assembly.

Returns:

the extra metadata.

getExtraMetadataFieldNames

public java.util.Collection<java.lang.String> getExtraMetadataFieldNames(T output)

hasExtrasToReturn

protected boolean hasExtrasToReturn(T output,
                                    IoParameters parameters)

wrapSingleIntoMap

protected java.util.Map<java.lang.String,java.lang.Object> wrapSingleIntoMap(java.lang.Object metadata)