Package org.javastro.ivoa.entities.vodml

Class ElementRef

java.lang.Object

org.javastro.ivoa.entities.vodml.ElementRef

All Implemented Interfaces:

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

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

This type represents how to reference a ReferencableElement. It can serve as base class to those types that explicitly reference another type, such as relations and roles. It provides for a uniform way to represent the reference to the target element using the 'utyperef' element. An important design choice is that we wish to allow references to elements in remote models. For that reasons we can not use an ID/IDREF or key/keyref pattern. Instead we define various constraints on this type and its usage in various contexts using the Schematron file in vo-dml.sch.xml.

Java class for ElementRef complex type

.

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

 <complexType name="ElementRef">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="vodml-ref" type="{http://www.ivoa.net/xml/VODML/v1}VODMLREF"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected ElementRef.Modifier	__cachedModifier__
protected String	vodmlRef	The element identifying the referenced target element.

Constructor Summary

Constructors

Constructor	Description
ElementRef()	Default no-arg constructor
ElementRef(String vodmlRef)	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 ElementRef.Builder<Void>	builder()
ElementRef	clone()
ElementRef	copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
static ElementRef.Builder<Void>	copyExcept(ElementRef _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> ElementRef.Builder<_B>	copyOf(ElementRef _other)
static <_B> ElementRef.Builder<_B>	copyOf(ElementRef _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
ElementRef	copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
static ElementRef.Builder<Void>	copyOnly(ElementRef _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(ElementRef.Builder<_B> _other)	Copies all state of this object to a builder.
<_B> void	copyTo(ElementRef.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)	Copies all state of this object to a builder.
ElementRef	createCopy()
ElementRef	createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Object	createNewInstance()
boolean	equals(Object object)
String	getVodmlRef()	The element identifying the referenced target 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)
ElementRef.Modifier	modifier()
ElementRef.Builder<Void>	newCopyBuilder()
<_B> ElementRef.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> ElementRef.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
ElementRef.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
void	setVodmlRef(String value)	Sets the value of the vodmlRef property.
String	toString()
ElementRef	visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Methods inherited from class java.lang.Object

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

Field Details

vodmlRef

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

The element identifying the referenced target element. See the documentation for the VODMLREF type.

__cachedModifier__

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

Constructor Details

ElementRef

public ElementRef()

Default no-arg constructor

ElementRef

public ElementRef(String vodmlRef)

Fully-initialising value constructor

Method Details

getVodmlRef

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

The element identifying the referenced target element. See the documentation for the VODMLREF type.

Returns:

possible object is String

setVodmlRef

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

Sets the value of the vodmlRef property.

Parameters:

value - allowed object is String

See Also:

• getVodmlRef()

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 ElementRef 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 ElementRef 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 ElementRef 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 ElementRef 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 ElementRef 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 ElementRef.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(ElementRef.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> ElementRef.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 ElementRef.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 ElementRef.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> ElementRef.Builder<_B> copyOf(ElementRef _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(ElementRef.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> ElementRef.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 ElementRef.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> ElementRef.Builder<_B> copyOf(ElementRef _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 ElementRef.Builder<Void> copyExcept(ElementRef _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 ElementRef.Builder<Void> copyOnly(ElementRef _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 ElementRef visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)