Package org.javastro.ivoa.entities.vodml

Class ReferableElement

java.lang.Object

org.javastro.ivoa.entities.vodml.ReferableElement

All Implemented Interfaces:

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

Direct Known Subclasses:

EnumLiteral, Package, Role, Type

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

This is the base type for all types whose elements can be explicitly referenced. To this end it has a 'vodml-id' element of type VODMLID that allows explicit and unique identification of these elements within the context of the model. Generally these are also elements that can be represented explicitly in alternative serialisations of a data model, such as a VOTable or a relational model. These should use the value of the utype element to "point into a data model" and identify a model element. VO-DML itself also has needs of pointing to other elements, sometimes in another model. The VODMLREF type is used for such references, which will always be named 'vodml-ref'.

Java class for ReferableElement complex type

.

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

 <complexType name="ReferableElement">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="vodml-id" type="{http://www.ivoa.net/xml/VODML/v1}VODMLID"/>
         <element name="name" type="{http://www.ivoa.net/xml/VODML/v1}VODMLName"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description	Human readable description of the model element.
protected String	id	A referencable element may be given an @id attribute to reflect an identifier defined in some source document form which a VO-DML model may have been derived.
protected String	name	The name of the model element.
protected String	vodmlId	Identifier for its containing element.

Constructor Summary

Constructors

Constructor	Description
ReferableElement()	Default no-arg constructor
ReferableElement(String vodmlId, String name, String description, String id)	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)
boolean	equals(Object object)
String	getDescription()	Human readable description of the model element.
String	getId()	A referencable element may be given an @id attribute to reflect an identifier defined in some source document form which a VO-DML model may have been derived.
String	getName()	The name of the model element.
String	getVodmlId()	Identifier for its containing element.
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)
void	setDescription(String value)	Sets the value of the description property.
void	setId(String value)	Sets the value of the id property.
void	setName(String value)	Sets the value of the name property.
void	setVodmlId(String value)	Sets the value of the vodmlId property.
String	toString()
ReferableElement	withDescription(String value)
ReferableElement	withId(String value)
ReferableElement	withName(String value)
ReferableElement	withVodmlId(String value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jvnet.jaxb.lang.MergeFrom

createNewInstance

Field Details

vodmlId

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

Identifier for its containing element. Extracted as a separate type so that we can easily adapt to a different identifier design.

name

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

The name of the model element. MUST NOT be an empty string.

description

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

Human readable description of the model element.

id

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

A referencable element may be given an @id attribute to reflect an identifier defined in some source document form which a VO-DML model may have been derived.

Constructor Details

ReferableElement

public ReferableElement()

Default no-arg constructor

ReferableElement

public ReferableElement(String vodmlId,
 String name,
 String description,
 String id)

Fully-initialising value constructor

Method Details

getVodmlId

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

Identifier for its containing element. Extracted as a separate type so that we can easily adapt to a different identifier design.

Returns:

possible object is String

setVodmlId

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

Sets the value of the vodmlId property.

Parameters:

value - allowed object is String

See Also:

• getVodmlId()

getName

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

The name of the model element. MUST NOT be an empty string.

Returns:

possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+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="2024-08-01T13:15:43+01:00")
public String getDescription()

Human readable description of the model element.

Returns:

possible object is String

setDescription

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

Sets the value of the description property.

Parameters:

value - allowed object is String

See Also:

• getDescription()

getId

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

A referencable element may be given an @id attribute to reflect an identifier defined in some source document form which a VO-DML model may have been derived.

Returns:

possible object is String

setId

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

Sets the value of the id property.

Parameters:

value - allowed object is String

See Also:

• getId()

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 Object

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 Object

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 Object

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

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

withVodmlId

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

withName

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

withDescription

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

withId

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

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

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