org.n52.io.response

Class ParameterOutput

java.lang.Object

org.n52.io.response.ParameterOutput

All Implemented Interfaces:

CollatorComparable<ParameterOutput>, RawFormats

Direct Known Subclasses:

AbstractOutput, DatasetOutput, ServiceOutput

public abstract class ParameterOutput
extends Object
implements CollatorComparable<ParameterOutput>, RawFormats

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOMAIN_ID
static String	EXTRAS
static String	HREF
static String	HREF_BASE
static String	ID
static String	LABEL
static String	RAWFORMATS

Fields inherited from interface org.n52.series.spi.srv.RawFormats

RAW_FORMAT

Constructor Summary

Constructors

Constructor and Description
ParameterOutput()

Method Summary

Modifier and Type	Method and Description
int	compare(Collator collator, ParameterOutput o) Compares natural ordering of this instance to another.
static <T extends ParameterOutput> Comparator<T>	defaultComparator() Takes the labels to compare.
boolean	equals(Object obj)
String	getDomainId() Returns the domain id of the parameter, e.g. a natural id (not arbitrarily generated) or the original id actually being used by proxied data sources.
Collection<String>	getExtras()
String	getHref()
String	getHrefBase()
String	getId()
protected <T> T	getIfSerialized(OptionalOutput<T> optional)
protected <T extends Collection<E>,E> T	getIfSerializedCollection(OptionalOutput<T> optional)
protected <K,T> Map<K,T>	getIfSerializedMap(OptionalOutput<Map<K,T>> optional)
protected <T> T	getIfSet(OptionalOutput<T> optional, boolean forced)
protected <T extends Collection<E>,E> T	getIfSetCollection(OptionalOutput<T> optional, boolean forced)
protected <K,T> Map<K,T>	getIfSetMap(OptionalOutput<Map<K,T>> optional, boolean forced)
String	getLabel()
String	getLicense() Deprecated.
Set<String>	getRawFormats()
int	hashCode()
protected <T> boolean	isSet(OptionalOutput<T> optional)
protected <T> boolean	resolvesToNonNullValue(OptionalOutput<T> optional)
ParameterOutput	setDomainId(OptionalOutput<String> domainId) Sets the domain id of the parameter, e.g. a natural (not arbitrarily generated) id or the original id actually being used by proxied data sources.
ParameterOutput	setExtras(OptionalOutput<Collection<String>> extras)
ParameterOutput	setHref(OptionalOutput<String> href)
ParameterOutput	setHrefBase(OptionalOutput<String> hrefBase)
ParameterOutput	setId(String id)
ParameterOutput	setLabel(OptionalOutput<String> label)
ParameterOutput	setLicense(OptionalOutput<String> license) Deprecated.
ParameterOutput	setRawFormats(OptionalOutput<Set<String>> formats)
<T> void	setValue(String parameter, T value, IoParameters parameters, Consumer<OptionalOutput<T>> consumer)

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

HREF

public static final String HREF

See Also:

Constant Field Values

HREF_BASE

public static final String HREF_BASE

See Also:

Constant Field Values

DOMAIN_ID

public static final String DOMAIN_ID

See Also:

Constant Field Values

LABEL

public static final String LABEL

See Also:

Constant Field Values

EXTRAS

public static final String EXTRAS

See Also:

Constant Field Values

RAWFORMATS

public static final String RAWFORMATS

See Also:

Constant Field Values

Constructor Detail

ParameterOutput

public ParameterOutput()

Method Detail

setValue

public <T> void setValue(String parameter,
                         T value,
                         IoParameters parameters,
                         Consumer<OptionalOutput<T>> consumer)

getIfSerialized

protected <T> T getIfSerialized(OptionalOutput<T> optional)

getIfSerializedCollection

protected <T extends Collection<E>,E> T getIfSerializedCollection(OptionalOutput<T> optional)

getIfSerializedMap

protected <K,T> Map<K,T> getIfSerializedMap(OptionalOutput<Map<K,T>> optional)

getIfSet

protected <T> T getIfSet(OptionalOutput<T> optional,
                         boolean forced)

getIfSetCollection

protected <T extends Collection<E>,E> T getIfSetCollection(OptionalOutput<T> optional,
                                                           boolean forced)

getIfSetMap

protected <K,T> Map<K,T> getIfSetMap(OptionalOutput<Map<K,T>> optional,
                                     boolean forced)

isSet

protected <T> boolean isSet(OptionalOutput<T> optional)

resolvesToNonNullValue

protected <T> boolean resolvesToNonNullValue(OptionalOutput<T> optional)

getId

public String getId()

setId

public ParameterOutput setId(String id)

getHref

public String getHref()

setHref

public ParameterOutput setHref(OptionalOutput<String> href)

getHrefBase

public String getHrefBase()

setHrefBase

public ParameterOutput setHrefBase(OptionalOutput<String> hrefBase)

getDomainId

public String getDomainId()

Returns the domain id of the parameter, e.g. a natural id (not arbitrarily generated) or the original id actually being used by proxied data sources.

Returns:

the domain id

setDomainId

public ParameterOutput setDomainId(OptionalOutput<String> domainId)

Sets the domain id of the parameter, e.g. a natural (not arbitrarily generated) id or the original id actually being used by proxied data sources.

Parameters:

domainId - the domain id of the parameter

Returns:

the instance to enable chaining

getLabel

public String getLabel()

Returns:

the label. Returns null if label is not set.

setLabel

public ParameterOutput setLabel(OptionalOutput<String> label)

getLicense

@Deprecated
public String getLicense()

Deprecated.

setLicense

@Deprecated
public ParameterOutput setLicense(OptionalOutput<String> license)

Deprecated.

getExtras

public Collection<String> getExtras()

Returns:

a list of extra identifiers available via /{resource}/extras

setExtras

public ParameterOutput setExtras(OptionalOutput<Collection<String>> extras)

getRawFormats

public Set<String> getRawFormats()

Specified by:

getRawFormats in interface RawFormats

Returns:

the rawFormats

setRawFormats

public ParameterOutput setRawFormats(OptionalOutput<Set<String>> formats)

Specified by:

setRawFormats in interface RawFormats

Parameters:

formats - the rawFormats to set

Returns:

the instance to enable chaining

compare

public int compare(Collator collator,
                   ParameterOutput o)

Description copied from interface: CollatorComparable

Compares natural ordering of this instance to another. Reuses concept of Comparable interface but indicates ordering locale dependend by means of a Collator.

Specified by:

compare in interface CollatorComparable<ParameterOutput>

Parameters:

collator - a collator used to compare. If null a collator is created dependend on the default locale.

o - the object to compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

See Also:

Collator

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

defaultComparator

public static <T extends ParameterOutput> Comparator<T> defaultComparator()

Takes the labels to compare.

Type Parameters:

T - the actual type.

Returns:

a label comparing Comparator