org.n52.oxf.ows.capabilities
Class Parameter

java.lang.Object
  extended by org.n52.oxf.ows.capabilities.Parameter
Direct Known Subclasses:
DatasetParameter

public class Parameter
extends Object

This class is used by each Operation and is utilized to describe one possible parameter of the operation.
If you need to associate the Parameter with a specific dataset (or resource) please use the sub-class DatasetParameter.

Author:
Theodor Foerster, Arne Broering

Field Summary
static String COMMON_NAME_BBOX
          type of associated specifiedValue: org.n52.oxf.valueDomains.BoundingBox
static String COMMON_NAME_FORMAT
          type of associated specifiedValue: java.lang.String
static String COMMON_NAME_HEIGHT
          type of associated specifiedValue: java.lang.Integer
static String COMMON_NAME_RESOURCE_ID
          type of associated specifiedValue: java.lang.String
the name or id of the dataset (--> dataset means layer, coverage or something like that).
static String COMMON_NAME_SRS
          type of associated specifiedValue: java.lang.String
static String COMMON_NAME_STYLE
           
static String COMMON_NAME_TIME
          type of associated specifiedValue: org.n52.oxf.valueDomains.time.ITime
static String COMMON_NAME_VERSION
           
static String COMMON_NAME_WIDTH
          type of associated specifiedValue: java.lang.Integer
protected  boolean required
          indicates if this ParameterContainer is required for the operation.
protected  String serviceSidedName
          The service-sided-name or identifier of this parameter.
protected  IValueDomain valueDomain
          Valid values for this parameter.
 
Constructor Summary
Parameter(String name, boolean required, IValueDomain valueDomain, String commonName)
          this constructor has all attributes as its parameters.
 
Method Summary
 String getCommonName()
           
 String getServiceSidedName()
           
 IValueDomain getValueDomain()
          IValueDomain describes the allowed values of a parameter.
 boolean isRequired()
          indicates if a parameter has to be part of a certain operation.
protected  void setCommonName(String commonName)
           
protected  void setRequired(boolean required)
           
protected  void setServiceSidedName(String name)
           
protected  void setValueDomain(IValueDomain valueDomain)
          IValueDomain describes the allowed values of a parameter.
 String toString()
           
 String toXML()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COMMON_NAME_BBOX

public static final String COMMON_NAME_BBOX
type of associated specifiedValue: org.n52.oxf.valueDomains.BoundingBox

See Also:
Constant Field Values

COMMON_NAME_WIDTH

public static final String COMMON_NAME_WIDTH
type of associated specifiedValue: java.lang.Integer

See Also:
Constant Field Values

COMMON_NAME_HEIGHT

public static final String COMMON_NAME_HEIGHT
type of associated specifiedValue: java.lang.Integer

See Also:
Constant Field Values

COMMON_NAME_SRS

public static final String COMMON_NAME_SRS
type of associated specifiedValue: java.lang.String

See Also:
Constant Field Values

COMMON_NAME_FORMAT

public static final String COMMON_NAME_FORMAT
type of associated specifiedValue: java.lang.String

See Also:
Constant Field Values

COMMON_NAME_STYLE

public static final String COMMON_NAME_STYLE
See Also:
Constant Field Values

COMMON_NAME_VERSION

public static final String COMMON_NAME_VERSION
See Also:
Constant Field Values

COMMON_NAME_TIME

public static final String COMMON_NAME_TIME
type of associated specifiedValue: org.n52.oxf.valueDomains.time.ITime

See Also:
Constant Field Values

COMMON_NAME_RESOURCE_ID

public static final String COMMON_NAME_RESOURCE_ID
type of associated specifiedValue: java.lang.String
the name or id of the dataset (--> dataset means layer, coverage or something like that).

See Also:
Constant Field Values

serviceSidedName

protected String serviceSidedName
The service-sided-name or identifier of this parameter. This name is specified by the OWS spec of the service.

One (mandatory)


required

protected boolean required
indicates if this ParameterContainer is required for the operation.

One (mandatory)


valueDomain

protected IValueDomain valueDomain
Valid values for this parameter.
Holds all possible values. In OWScommon this is named "value".

One (mandatory)

Constructor Detail

Parameter

public Parameter(String name,
                 boolean required,
                 IValueDomain valueDomain,
                 String commonName)
this constructor has all attributes as its parameters. Constructs a Parameter with a given serviceSidedName and the indication, if the Parameter is required.

Parameters:
serviceSidedName - the serviceSidedName of the parameter
required - indicates if a ParameterContainer is required.
valueDomain - holds all possible values.
Method Detail

toString

public String toString()
Overrides:
toString in class Object

toXML

public String toXML()
Returns:
a XML representation of this Parameter.

getServiceSidedName

public String getServiceSidedName()
Returns:
Returns the serviceSidedName of the parameter.

setServiceSidedName

protected void setServiceSidedName(String name)
                            throws IllegalArgumentException
Parameters:
serviceSidedName - The serviceSidedName to set.
Throws:
IllegalArgumentException

getCommonName

public String getCommonName()
Returns:
the "commonName" of this parameter which is used by the OX-framework to address this parameter. All possible "common names" are specified as static attributes in this class. If this parameter doesn't correspond to any of the listed commonNames, this method will return null.

setCommonName

protected void setCommonName(String commonName)
Parameters:
commonName - The "commonName" is used by the OX-framework to address this parameter. All possible "common names" are specified as static attributes in this class. Please look up the possible values and mark this parameter with the corresponding "commonName". If this parameter doesn't correspond to any of the listed commonNames, let the commonName-attribute stay null.

isRequired

public boolean isRequired()
indicates if a parameter has to be part of a certain operation.

Returns:
Returns the required.

setRequired

protected void setRequired(boolean required)
Parameters:
required - has to be set, if the parameter is required in the Operation. false is standard!.

getValueDomain

public IValueDomain getValueDomain()
IValueDomain describes the allowed values of a parameter.

Returns:
Returns the valueDomain.

setValueDomain

protected void setValueDomain(IValueDomain valueDomain)
IValueDomain describes the allowed values of a parameter.

Parameters:
valueDomain - The valueDomain to set.


Copyright © 2012-2013 52north.org. All Rights Reserved.