Package org.ivoa.dm.registry.vodataservice

Class InputParam

java.lang.Object

org.ivoa.dm.registry.vodataservice.BaseParam

org.ivoa.dm.registry.vodataservice.InputParam

All Implemented Interfaces:

org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

@Entity
@VoDml(id="VODataService:InputParam",
       role=objectType)
public class InputParam
extends BaseParam
implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

A description of a service or function parameter having a fixed data type. DALI-compliant services should use VOTableType here, others should use SimpleDataType. objectType: InputParam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InputParam.InputParamBuilder	A builder class for InputParam, mainly for use in the functional builder pattern.

Nested classes/interfaces inherited from class org.ivoa.dm.registry.vodataservice.BaseParam

BaseParam.BaseParamBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected DataType	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.ivoa.dm.registry.vodataservice.BaseParam

_id, description, name, ucd, unit, utype

Constructor Summary

Constructors

Constructor	Description
InputParam()	Creates a new InputParam
InputParam(BaseParam superinstance, DataType dataType, ParamUse use, Boolean std)	Constructor from supertype instance.
InputParam(DataType dataType, ParamUse use, Boolean std, String name, String description, String unit, String ucd, String utype)	full parameter constructor.
InputParam(InputParam other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
BaseParam	copyMe()	make a clone of the object taking into account current polymorhic type.
static InputParam	createInputParam(Consumer<InputParam.InputParamBuilder> f)	create a InputParam in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
DataType	getDataType()	Returns dataType Attribute.
Boolean	getStd()	Returns std Attribute.
ParamUse	getUse()	Returns use Attribute.
void	setDataType(DataType pDataType)	Set dataType Attribute.
void	setStd(Boolean pStd)	Set std Attribute.
void	setUse(ParamUse pUse)	Set use Attribute.
void	updateUsing(InputParam other)	Update this object with the content of the given object.
InputParam	withDataType(DataType pDataType)	fluent setter for dataType Attribute.
InputParam	withStd(Boolean pStd)	fluent setter for std Attribute.
InputParam	withUse(ParamUse pUse)	fluent setter for use Attribute.

Methods inherited from class org.ivoa.dm.registry.vodataservice.BaseParam

createBaseParam, getDescription, getId, getName, getUcd, getUnit, getUtype, setDescription, setName, setUcd, setUnit, setUtype, updateUsing, withDescription, withName, withUcd, withUnit, withUtype

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType

getId

Field Details

dataType

@VoDml(id="VODataService:InputParam.dataType",
       role=attribute,
       type="VODataService:DataType",
       typeRole=dataType)
protected DataType dataType

A type of data contained in the parameter. : Attribute dataType : multiplicity 0..1

use

@VoDml(id="VODataService:InputParam.use",
       role=attribute,
       type="VODataService:ParamUse",
       typeRole=enumeration)
protected ParamUse use

An indication of whether this parameter is required to be provided for the application or service to work properly. : Attribute use : multiplicity 1

std

@VoDml(id="VODataService:InputParam.std",
       role=attribute,
       type="ivoa:boolean",
       typeRole=primitiveType)
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. : Attribute std : multiplicity 1

Constructor Details

InputParam

public InputParam()

Creates a new InputParam

InputParam

public InputParam(DataType dataType,
 ParamUse use,
 Boolean std,
 String name,
 String description,
 String unit,
 String ucd,
 String utype)

full parameter constructor.

Parameters:

dataType - A type of data contained in the parameter.

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

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.

name - The name of the parameter or column.

description - A free-text description of a parameter's or column's contents.

unit - The unit associated with the values in the parameter or column.

ucd - The name of a unified content descriptor that describes the scientific content of the parameter. There are no requirements for compliance with any particular UCD standard.

utype - An identifier for a concept in a data model that the data in this schema represent. The form of the utype string depends on the data model; common forms are sequences of dotted identifiers (e.g., in SSA) or URIs (e.g., in RegTAP).

InputParam

public InputParam(InputParam other)

Copy Constructor. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

InputParam

public InputParam(BaseParam superinstance,
 DataType dataType,
 ParamUse use,
 Boolean std)

Constructor from supertype instance.

Parameters:

superinstance - The supertype.

dataType - A type of data contained in the parameter.

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

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.

Method Details

copyMe

public BaseParam copyMe()

make a clone of the object taking into account current polymorhic type.

Overrides:

copyMe in class BaseParam

Returns:

the cloned object.

updateUsing

public void updateUsing(InputParam other)

Update this object with the content of the given object. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

getDataType

public DataType getDataType()

Returns dataType Attribute.

Returns:

dataType Attribute

setDataType

public void setDataType(DataType pDataType)

Set dataType Attribute.

Parameters:

pDataType - value to set

withDataType

public InputParam withDataType(DataType pDataType)

fluent setter for dataType Attribute.

Parameters:

pDataType - value to set

Returns:

InputParam

getUse

public ParamUse getUse()

Returns use Attribute.

Returns:

use Attribute

setUse

public void setUse(ParamUse pUse)

Set use Attribute.

Parameters:

pUse - value to set

withUse

public InputParam withUse(ParamUse pUse)

fluent setter for use Attribute.

Parameters:

pUse - value to set

Returns:

InputParam

getStd

public Boolean getStd()

Returns std Attribute.

Returns:

std Attribute

setStd

public void setStd(Boolean pStd)

Set std Attribute.

Parameters:

pStd - value to set

withStd

public InputParam withStd(Boolean pStd)

fluent setter for std Attribute.

Parameters:

pStd - value to set

Returns:

InputParam

createInputParam

public static InputParam createInputParam(Consumer<InputParam.InputParamBuilder> f)

create a InputParam in functional builder style.

Parameters:

f - the functional builder.

Returns:

an object initialized from the builder.

forceLoad

public void forceLoad()

Specified by:

forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

Overrides:

forceLoad in class BaseParam

delete

public void delete(jakarta.persistence.EntityManager em)

Specified by:

delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

Overrides:

delete in class BaseParam