Package org.ivoa.dm.regtap

Class InterfaceParam.InterfaceParamBuilder

java.lang.Object

org.ivoa.dm.regtap.InterfaceParam.InterfaceParamBuilder

Enclosing class:

InterfaceParam

public static class InterfaceParam.InterfaceParamBuilder
extends Object

A builder class for InterfaceParam, mainly for use in the functional builder pattern.

Field Summary

Fields

Modifier and Type	Field	Description
String	arraysize	The shape of the array that constitutes the value, e.g., 4, *, 4*, 5x4, or 5x*, as specified by VOTable.
String	datatype	The type of the data contained in the parameter.
String	delim	The ivoa:string that is used to delimit elements of an array value when arraysize is not '1'.
String	extended_schema	An identifier for the schema that the value given by the extended attribute is drawn from.
String	extended_type	A custom type for the values this parameter contains.
Integer	intf_index	The index of the interface this parameter belongs to.
String	name	The name of the parameter.
String	param_description	A free-text description of the parameter's contents.
String	param_use	An indication of whether this parameter is required to be provided for the application or service to work properly (one of required, optional, ignored, or NULL).
Integer	std	If 1, the meaning and use of this parameter is reserved and defined by a standard model.
String	ucd	A unified content descriptor that describes the scientific content of the parameter.
String	unit	The unit associated with all values in the parameter.
String	utype	An identifier for a role in a data model that the data in this parameter represents.

Constructor Summary

Constructors

Constructor	Description
InterfaceParamBuilder()

Method Summary

Modifier and Type	Method	Description
InterfaceParam	create()	create a InterfaceParam from this builder.

Methods inherited from class java.lang.Object

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

Field Details

intf_index

public Integer intf_index

The index of the interface this parameter belongs to.

name

public String name

The name of the parameter.

unit

public String unit

The unit associated with all values in the parameter.

ucd

public String ucd

A unified content descriptor that describes the scientific content of the parameter.

utype

public String utype

An identifier for a role in a data model that the data in this parameter represents.

std

public Integer std

If 1, the meaning and use of this parameter is reserved and defined by a standard model. If 0, it represents a database-specific parameter that effectively extends beyond the standard.

datatype

public String datatype

The type of the data contained in the parameter.

extended_schema

public String extended_schema

An identifier for the schema that the value given by the extended attribute is drawn from.

extended_type

public String extended_type

A custom type for the values this parameter contains.

arraysize

public String arraysize

The shape of the array that constitutes the value, e.g., 4, *, 4*, 5x4, or 5x*, as specified by VOTable.

delim

public String delim

The ivoa:string that is used to delimit elements of an array value when arraysize is not '1'.

param_use

public String param_use

An indication of whether this parameter is required to be provided for the application or service to work properly (one of required, optional, ignored, or NULL).

param_description

public String param_description

A free-text description of the parameter's contents.

Constructor Details

InterfaceParamBuilder

public InterfaceParamBuilder()

Method Details

create

public InterfaceParam create()

create a InterfaceParam from this builder.

Returns:

an object initialized from the builder.