Package org.javastro.ivoa.entities.resource.dataservice

Class InputParam

java.lang.Object

org.javastro.ivoa.entities.resource.dataservice.BaseParam

org.javastro.ivoa.entities.resource.dataservice.InputParam

All Implemented Interfaces:

org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public class InputParam
extends BaseParam
implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

The allowed data type names do not imply a size or precise format. This type is intended to be sufficient for describing an input parameter to a simple REST service or a function written in a weakly-typed language.

Java class for InputParam complex type

.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="InputParam">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/VODataService/v1.1}BaseParam">
       <sequence>
         <element name="dataType" type="{http://www.ivoa.net/xml/VODataService/v1.1}SimpleDataType" minOccurs="0"/>
       </sequence>
       <attribute name="use" type="{http://www.ivoa.net/xml/VODataService/v1.1}ParamUse" default="optional" />
       <attribute name="std" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <anyAttribute namespace='##other'/>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected SimpleDataType	dataType	A type of data contained in the parameter
protected Boolean	std	If true, the meaning and behavior of this parameter is reserved and defined by a standard interface.
protected ParamUse	use	An indication of whether this parameter is required to be provided for the application or service to work properly.

Fields inherited from class org.javastro.ivoa.entities.resource.dataservice.BaseParam

description, name, ucd, unit, utype

Constructor Summary

Constructors

Constructor	Description
InputParam()	Default no-arg constructor
InputParam(String name, String description, String unit, String ucd, String utype, Map<QName,String> otherAttributes, SimpleDataType dataType, ParamUse use, Boolean std)	Fully-initialising value constructor

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
Object	createNewInstance()
boolean	equals(Object object)
SimpleDataType	getDataType()	A type of data contained in the parameter
ParamUse	getUse()	An indication of whether this parameter is required to be provided for the application or service to work properly.
int	hashCode()
boolean	isStd()	If true, the meaning and behavior of this parameter is reserved and defined by a standard interface.
void	mergeFrom(Object left, Object right)
void	mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
void	setDataType(SimpleDataType value)	Sets the value of the dataType property.
void	setStd(Boolean value)	Sets the value of the std property.
void	setUse(ParamUse value)	Sets the value of the use property.
String	toString()
InputParam	withDataType(SimpleDataType value)
InputParam	withDescription(String value)
InputParam	withName(String value)
InputParam	withStd(Boolean value)
InputParam	withUcd(String value)
InputParam	withUnit(String value)
InputParam	withUse(ParamUse value)
InputParam	withUtype(String value)

Methods inherited from class org.javastro.ivoa.entities.resource.dataservice.BaseParam

getDescription, getName, getOtherAttributes, getUcd, getUnit, getUtype, setDescription, setName, setUcd, setUnit, setUtype

Methods inherited from class java.lang.Object

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

Field Details

dataType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected SimpleDataType dataType

A type of data contained in the parameter

use

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected ParamUse use

An indication of whether this parameter is required to be provided for the application or service to work properly.

std

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected Boolean std

If true, the meaning and behavior of this parameter is reserved and defined by a standard interface. If false, it represents an implementation-specific parameter that effectively extends the behavior of the service or application.

Constructor Details

InputParam

public InputParam()

Default no-arg constructor

InputParam

public InputParam(String name,
 String description,
 String unit,
 String ucd,
 String utype,
 Map<QName,String> otherAttributes,
 SimpleDataType dataType,
 ParamUse use,
 Boolean std)

Fully-initialising value constructor

Method Details

getDataType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public SimpleDataType getDataType()

A type of data contained in the parameter

Returns:

possible object is SimpleDataType

setDataType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setDataType(SimpleDataType value)

Sets the value of the dataType property.

Parameters:

value - allowed object is SimpleDataType

See Also:

• getDataType()

getUse

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamUse getUse()

An indication of whether this parameter is required to be provided for the application or service to work properly.

Returns:

possible object is ParamUse

setUse

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setUse(ParamUse value)

Sets the value of the use property.

Parameters:

value - allowed object is ParamUse

See Also:

• getUse()

isStd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public boolean isStd()

If true, the meaning and behavior of this parameter is reserved and defined by a standard interface. If false, it represents an implementation-specific parameter that effectively extends the behavior of the service or application.

Returns:

possible object is Boolean

setStd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setStd(Boolean value)

Sets the value of the std property.

Parameters:

value - allowed object is Boolean

See Also:

• isStd()

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public boolean equals(Object object)

Overrides:

equals in class BaseParam

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public int hashCode()

Overrides:

hashCode in class BaseParam

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String toString()

Overrides:

toString in class BaseParam

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

append in interface org.jvnet.jaxb.lang.ToString

Overrides:

append in class BaseParam

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

appendFields in interface org.jvnet.jaxb.lang.ToString

Overrides:

appendFields in class BaseParam

withDataType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public InputParam withDataType(SimpleDataType value)

withUse

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public InputParam withUse(ParamUse value)

withStd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public InputParam withStd(Boolean value)

withName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public InputParam withName(String value)

Overrides:

withName in class BaseParam

withDescription

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public InputParam withDescription(String value)

Overrides:

withDescription in class BaseParam

withUnit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public InputParam withUnit(String value)

Overrides:

withUnit in class BaseParam

withUcd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public InputParam withUcd(String value)

Overrides:

withUcd in class BaseParam

withUtype

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public InputParam withUtype(String value)

Overrides:

withUtype in class BaseParam

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

mergeFrom in class BaseParam

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator,
 org.jvnet.jaxb.locator.ObjectLocator rightLocator,
 Object left,
 Object right,
 org.jvnet.jaxb.lang.MergeStrategy strategy)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

mergeFrom in class BaseParam

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Object createNewInstance()

Specified by:

createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

createNewInstance in class BaseParam