|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.n52.oxf.ows.capabilities.Parameter
public class Parameter
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.
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 |
---|
public static final String COMMON_NAME_BBOX
public static final String COMMON_NAME_WIDTH
public static final String COMMON_NAME_HEIGHT
public static final String COMMON_NAME_SRS
public static final String COMMON_NAME_FORMAT
public static final String COMMON_NAME_STYLE
public static final String COMMON_NAME_VERSION
public static final String COMMON_NAME_TIME
public static final String COMMON_NAME_RESOURCE_ID
protected String serviceSidedName
protected boolean required
protected IValueDomain valueDomain
Constructor Detail |
---|
public Parameter(String name, boolean required, IValueDomain valueDomain, String commonName)
serviceSidedName
- the serviceSidedName of the parameterrequired
- indicates if a ParameterContainer is required.valueDomain
- holds all possible values.Method Detail |
---|
public String toString()
toString
in class Object
public String toXML()
public String getServiceSidedName()
protected void setServiceSidedName(String name) throws IllegalArgumentException
serviceSidedName
- The serviceSidedName to set.
IllegalArgumentException
public String getCommonName()
null
.protected void setCommonName(String commonName)
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
.public boolean isRequired()
protected void setRequired(boolean required)
required
- has to be set, if the parameter is required in the Operation. false is standard!.public IValueDomain getValueDomain()
protected void setValueDomain(IValueDomain valueDomain)
valueDomain
- The valueDomain to set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |