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 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
void	addExtra(String extra)
void	addRawFormat(String format)
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.
String[]	getExtras()
String	getHref()
String	getHrefBase()
String	getId()
String	getLabel()
String	getLicense() Deprecated.
String[]	getRawFormats()
int	hashCode()
boolean	isSetDomainId() Check if the domainId is set and not empty
void	setDomainId(String domainId) Sets the domain id of the parameter, e.g.
void	setHref(String href)
void	setHrefBase(String hrefBase)
void	setId(String id)
void	setLabel(String label)
void	setLicense(String license) Deprecated.
void	setRawFormats(Collection<String> formats)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterOutput

public ParameterOutput()

Method Detail

getId

public String getId()

setId

public void setId(String id)

getHref

public String getHref()

setHref

public void setHref(String href)

setHrefBase

public void setHrefBase(String hrefBase)

getHrefBase

public String getHrefBase()

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 void setDomainId(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.

isSetDomainId

public boolean isSetDomainId()

Check if the domainId is set and not empty

Returns:

true if domainId is set and not empty

getLabel

public String getLabel()

Returns:

the label or the id if label is not set.

setLabel

public void setLabel(String label)

getLicense

@Deprecated
public String getLicense()

Deprecated.

setLicense

@Deprecated
public void setLicense(String license)

Deprecated.

getExtras

public String[] getExtras()

Returns:

a list of extra identifiers available via /<resource>/extras

addExtra

public void addExtra(String extra)

addRawFormat

public void addRawFormat(String format)

Specified by:

addRawFormat in interface RawFormats

Parameters:

format - the rawFormat to add

getRawFormats

public String[] getRawFormats()

Specified by:

getRawFormats in interface RawFormats

Returns:

the rawFormats

setRawFormats

public void setRawFormats(Collection<String> formats)

Specified by:

setRawFormats in interface RawFormats

Parameters:

formats - the rawFormats to set

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