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

Class BaseParam

java.lang.Object

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

All Implemented Interfaces:

com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, Cloneable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

Direct Known Subclasses:

InputParam, TableParam

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public class BaseParam
extends Object
implements Cloneable, com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

As the parameter's data type is usually important, schemas normally employ a sub-class of this type rather than this type directly.

Java class for BaseParam complex type

.

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

 <complexType name="BaseParam">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="unit" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="ucd" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="utype" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
       </sequence>
       <anyAttribute namespace='##other'/>
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseParam.Builder<_B>
class	BaseParam.Modifier
static class	BaseParam.PropInfo
static class	BaseParam.Select
static class	BaseParam.Selector<TRoot extends com.kscs.util.jaxb.Selector<TRoot,?>,TParent>

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseParam.Modifier	__cachedModifier__
protected String	description	A free-text description of a parameter's or column's contents.
protected String	name	The name of the parameter or column.
protected String	ucd	There are no requirements for compliance with any particular UCD standard.
protected String	unit	The unit associated with the values in the parameter or column.
protected String	utype	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).

Constructor Summary

Constructors

Constructor	Description
BaseParam()	Default no-arg constructor
BaseParam(String name, String description, String unit, String ucd, String utype, Map<QName,String> otherAttributes)	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)
static BaseParam.Builder<Void>	builder()
BaseParam	clone()
BaseParam	copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
static BaseParam.Builder<Void>	copyExcept(BaseParam _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> BaseParam.Builder<_B>	copyOf(BaseParam _other)
static <_B> BaseParam.Builder<_B>	copyOf(BaseParam _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
BaseParam	copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
static BaseParam.Builder<Void>	copyOnly(BaseParam _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(BaseParam.Builder<_B> _other)	Copies all state of this object to a builder.
<_B> void	copyTo(BaseParam.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)	Copies all state of this object to a builder.
BaseParam	createCopy()
BaseParam	createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Object	createNewInstance()
boolean	equals(Object object)
String	getDescription()	A free-text description of a parameter's or column's contents.
String	getName()	The name of the parameter or column.
Map<QName,String>	getOtherAttributes()	Gets a map that contains attributes that aren't bound to any typed property on this class.
String	getUcd()	There are no requirements for compliance with any particular UCD standard.
String	getUnit()	The unit associated with the values in the parameter or column.
String	getUtype()	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).
int	hashCode()
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)
BaseParam.Modifier	modifier()
BaseParam.Builder<Void>	newCopyBuilder()
<_B> BaseParam.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> BaseParam.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
BaseParam.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
void	setDescription(String value)	Sets the value of the description property.
void	setName(String value)	Sets the value of the name property.
void	setUcd(String value)	Sets the value of the ucd property.
void	setUnit(String value)	Sets the value of the unit property.
void	setUtype(String value)	Sets the value of the utype property.
String	toString()
BaseParam	visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Methods inherited from class java.lang.Object

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

Field Details

name

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
protected String name

The name of the parameter or column.

description

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
protected String description

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

unit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
protected String unit

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

ucd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
protected String ucd

There are no requirements for compliance with any particular UCD standard. The format of the UCD can be used to distinguish between UCD1, UCD1+, and SIA-UCD. See http://ivoa.net/Documents/latest/UCDlist.html for the latest IVOA standard set.

utype

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
protected String utype

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).

__cachedModifier__

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
protected transient BaseParam.Modifier __cachedModifier__

Constructor Details

BaseParam

public BaseParam()

Default no-arg constructor

BaseParam

public BaseParam(String name,
 String description,
 String unit,
 String ucd,
 String utype,
 Map<QName,String> otherAttributes)

Fully-initialising value constructor

Method Details

getName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public String getName()

The name of the parameter or column.

Returns:

possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

See Also:

• getName()

getDescription

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public String getDescription()

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

Returns:

possible object is String

setDescription

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

See Also:

• getDescription()

getUnit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public String getUnit()

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

Returns:

possible object is String

setUnit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public void setUnit(String value)

Sets the value of the unit property.

Parameters:

value - allowed object is String

See Also:

• getUnit()

getUcd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public String getUcd()

There are no requirements for compliance with any particular UCD standard. The format of the UCD can be used to distinguish between UCD1, UCD1+, and SIA-UCD. See http://ivoa.net/Documents/latest/UCDlist.html for the latest IVOA standard set.

Returns:

possible object is String

setUcd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public void setUcd(String value)

Sets the value of the ucd property.

Parameters:

value - allowed object is String

See Also:

• getUcd()

getUtype

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public String getUtype()

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).

Returns:

possible object is String

setUtype

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public void setUtype(String value)

Sets the value of the utype property.

Parameters:

value - allowed object is String

See Also:

• getUtype()

getOtherAttributes

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public Map<QName,String> getOtherAttributes()

Gets a map that contains attributes that aren't bound to any typed property on this class.

the map is keyed by the name of the attribute and the value is the string value of the attribute. the map returned by this method is live, and you can add new attribute by updating the map directly. Because of this design, there's no setter.

Returns:

always non-null

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public int hashCode()

Overrides:

hashCode in class Object

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public String toString()

Overrides:

toString in class Object

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+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

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+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

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

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

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+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

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public Object createNewInstance()

Specified by:

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

clone

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public BaseParam clone()

Overrides:

clone in class Object

createCopy

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public BaseParam createCopy()

Specified by:

createCopy in interface com.kscs.util.jaxb.Copyable

createCopy

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public BaseParam createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Specified by:

createCopy in interface com.kscs.util.jaxb.PartialCopyable

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public BaseParam copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)

Specified by:

copyExcept in interface com.kscs.util.jaxb.PartialCopyable

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public BaseParam copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)

Specified by:

copyOnly in interface com.kscs.util.jaxb.PartialCopyable

modifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public BaseParam.Modifier modifier()

copyTo

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public <_B> void copyTo(BaseParam.Builder<_B> _other)

Copies all state of this object to a builder. This method is used by the copyOf method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public <_B> BaseParam.Builder<_B> newCopyBuilder(_B _parentBuilder)

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public BaseParam.Builder<Void> newCopyBuilder()

builder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static BaseParam.Builder<Void> builder()

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static <_B> BaseParam.Builder<_B> copyOf(BaseParam _other)

copyTo

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public <_B> void copyTo(BaseParam.Builder<_B> _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Copies all state of this object to a builder. This method is used by the copyOf method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public <_B> BaseParam.Builder<_B> newCopyBuilder(_B _parentBuilder,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public BaseParam.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static <_B> BaseParam.Builder<_B> copyOf(BaseParam _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static BaseParam.Builder<Void> copyExcept(BaseParam _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static BaseParam.Builder<Void> copyOnly(BaseParam _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

visit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public BaseParam visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)