org.astrogrid.acr.astrogrid
Class ParameterBean

java.lang.Object
  org.astrogrid.acr.ivoa.resource.BaseParam
      org.astrogrid.acr.astrogrid.ParameterBean

All Implemented Interfaces:

Serializable

public class ParameterBean
extends BaseParam

An input or output parameter of a remote application (CEA).

Notes:

Most fields are inherited from the parent class - BaseParam,

All fields, apart from name and type may be null

In previous schema, the element now called name was called UiName, while the element now called id was called name. Because of this overlapping name shift, it's impossible to just deprecate the previous methods. So, to ensure backwards compatibility, this bean provides access to elements in the new schema as follows

element	getter
id	ParameterBean.getId(), ParameterBean.getName() (deprecated)
name	ParameterBean.getUiName()

See Also:

CeaApplication, Executing remote applications, Querying for registry resources, CEA Specification, Serialized Form

Data Structure

Method Summary

String	getArraysize() the shape of the array that constitutes the value.
String[]	getDefaultValues() a possible default for this type of parameter this is array-valued for the case of array parameters.
String	getId() the unique identifier for the parameter
String	getMimeType() possibly a mime type for this parameter
String[]	getOptions() an enumeration of possible values for the parameter - may be null.
String	getType() type of ths parameter
String	getUiName() user-readable name for this parameter.
String	getUType() possibly access uType for this parameter

Methods inherited from class org.astrogrid.acr.ivoa.resource.BaseParam

getDescription, getName, getUcd, getUnit

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

the unique identifier for the parameter

getOptions

public String[] getOptions()

an enumeration of possible values for the parameter - may be null.

getType

public String getType()

type of ths parameter

Returns:

A type defined in the CEA specification. One of integer, real, complex ,text,boolean, anyURI, VOTable, RA, Dec, MJD, DateTime, ADQL, ADQL-S,STC-S,binary,FITS,XML

getUiName

public String getUiName()

user-readable name for this parameter.

Warnings:

Once the deprecated method ParameterBean.getName() has been retired this method will be deprecated in favour of getName

getDefaultValues

public final String[] getDefaultValues()

a possible default for this type of parameter this is array-valued for the case of array parameters.

getUType

public final String getUType()

possibly access uType for this parameter

Returns:

may be null

getMimeType

public final String getMimeType()

possibly a mime type for this parameter

Returns:

may be null

getArraysize

public final String getArraysize()

the shape of the array that constitutes the value.

An expression of a the shape of a multi-dimensional array of the form LxNxM... where each value between gives the integer length of the array along a dimension. An asterisk (*) as the last dimension of the shape indicates that the length of the last axis is variable or undetermined.

the default is "1"; i.e. the value is a scalar.