org.deegree.protocol.ows.metadata.domain
Class Domain

java.lang.Object
  org.deegree.protocol.ows.metadata.domain.Domain

public class Domain
extends Object

Defines the domain of validity for a quantity with an optional name.

Data model has been designed to capture the expressiveness of all OWS specifications and versions and was verified against the following specifications:

• OWS Common 2.0

From OWS Common 2.0: Valid domain (or allowed set of values) of one quantity, with its name or identifier.

Version:

$Revision: 31896 $, $Date: 2011-09-15 15:12:23 +0200 (Thu, 15 Sep 2011) $

Author:

Markus Schneider, Andrei Ionita, last edited by: $Author: mschneider $

Constructor Summary

Domain(String name, List<String> allowedValues)
Creates a new Domain instance with an AllowedValues value model.

Domain(String name, PossibleValues possibleValues, String defaultValue, StringOrRef meaning, StringOrRef dataType, StringOrRef valuesUnitUom, StringOrRef valuesUnitRefSys, List<org.apache.axiom.om.OMElement> metadata)
Creates a new Domain instance.

Domain(String name, String defaultValue)
Creates a new Domain instance with a NoValues value model and a default value (as used for service profile constraints, e.g. in WFS 2.0).

Method Summary

StringOrRef	getDataType() Returns the data type.
String	getDefaultValue() Returns the default value.
StringOrRef	getMeaning() Returns the meaning.
List<org.apache.axiom.om.OMElement>	getMetadata() Returns additional metadata.
String	getName() Returns the name or identifier of the quantity.
PossibleValues	getPossibleValues() Returns the possible values.
StringOrRef	getValuesUnitRefSys() Returns the unit reference system identifier.
StringOrRef	getValuesUnitUom() Returns the unit-of-measure identifier.
void	setDataTypeName(StringOrRef dataType)
void	setDefaultValue(String defaultValue)
void	setMeaning(StringOrRef meaning)
void	setName(String name)
void	setPossibleValues(PossibleValues possibleValues)
void	setValuesUnitRefSys(StringOrRef valuesUnitRefSys)
void	setValuesUnitUom(StringOrRef valuesUnitUom)

Methods inherited from class java.lang.Object

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

Constructor Detail

Domain

public Domain(String name,
              List<String> allowedValues)

Creates a new Domain instance with an AllowedValues value model.

Parameters:

name - domain name, may be null

allowedValues - allowed values, must not be null

Domain

public Domain(String name,
              String defaultValue)

Creates a new Domain instance with a NoValues value model and a default value (as used for service profile constraints, e.g. in WFS 2.0).

Parameters:

name - domain name, may be null

defaultValue - default value, must not be null

Domain

public Domain(String name,
              PossibleValues possibleValues,
              String defaultValue,
              StringOrRef meaning,
              StringOrRef dataType,
              StringOrRef valuesUnitUom,
              StringOrRef valuesUnitRefSys,
              List<org.apache.axiom.om.OMElement> metadata)

Creates a new Domain instance.

Parameters:

name - domain name, may be null

possibleValues - possible values, may be null

defaultValue - default value, may be null

meaning - meaning, may be null

dataType - data type, may be null

valuesUnitUom - unit-of-measure identifier for the value, may be null

valuesUnitRefSys - unit-of-measure reference system identifier, may be null

metadata - additional metadata, may be null

Method Detail

getName

public String getName()

Returns the name or identifier of the quantity.

From OWS Common 2.0: Name or identifier of this quantity.

Returns:

quantity name, may be null

setName

public void setName(String name)

Parameters:

name -

getPossibleValues

public PossibleValues getPossibleValues()

Returns the possible values.

From OWS Common 2.0: Specifies the possible values of this quantity.

Returns:

possible values, may be null

setPossibleValues

public void setPossibleValues(PossibleValues possibleValues)

Parameters:

possibleValues -

getDefaultValue

public String getDefaultValue()

Returns the default value.

From OWS Common 2.0: The default value for a quantity for which multiple values are allowed.

Returns:

default value, may be null

setDefaultValue

public void setDefaultValue(String defaultValue)

Parameters:

defaultValue -

getMeaning

public StringOrRef getMeaning()

Returns the meaning.

From OWS Common 2.0: Definition of the meaning or semantics of this set of values. This Meaning can provide more specific, complete, precise, machine accessible, and machine understandable semantics about this quantity, relative to other available semantic information. For example, other semantic information is often provided in "documentation" elements in XML Schemas or "description" elements in GML objects.

Returns:

meaning, may be null

setMeaning

public void setMeaning(StringOrRef meaning)

Parameters:

meaning -

getDataType

public StringOrRef getDataType()

Returns the data type.

From OWS Common 2.0: Definition of the data type of this set of values. In this case, the xlink:href attribute can reference a URN for a well-known data type. For example, such a URN could be a data type identification URN defined in the "ogc" URN namespace.

Returns:

data type, may be null

setDataTypeName

public void setDataTypeName(StringOrRef dataType)

Parameters:

dataTypeName -

getValuesUnitUom

public StringOrRef getValuesUnitUom()

Returns the unit-of-measure identifier.

From OWS Common 2.0: Identifier of unit of measure of this set of values. Should be included then this set of values has units (and not a more complete reference system).

Returns:

unit-of-measure identifier for the value, may be null

setValuesUnitUom

public void setValuesUnitUom(StringOrRef valuesUnitUom)

Parameters:

valuesUnitUom -

getValuesUnitRefSys

public StringOrRef getValuesUnitRefSys()

Returns the unit reference system identifier.

From OWS Common 2.0: Identifier of reference system used by this set of values. Should be included then this set of values has a reference system (not just units).

Returns:

unit-of-measure reference system identifier, may be null

setValuesUnitRefSys

public void setValuesUnitRefSys(StringOrRef valuesUnitRefSys)

Parameters:

valuesUnitRefSys -

getMetadata

public List<org.apache.axiom.om.OMElement> getMetadata()

Returns additional metadata.

From OWS Common 2.0: Optional unordered list of other metadata about this quantity. A list of required and optional other metadata elements for this quantity should be specified in the Implementation Specification for this service.

TODO does this need to be typed?

Returns:

additional metadata, may be null