Package org.javastro.ivoa.entities.vodml

Class Reference

java.lang.Object

org.javastro.ivoa.entities.vodml.ReferableElement

org.javastro.ivoa.entities.vodml.Role

org.javastro.ivoa.entities.vodml.Relation

org.javastro.ivoa.entities.vodml.Reference

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="2024-10-20T18:15:02+01:00")
public class Reference
extends Relation
implements Cloneable, com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

A Reference is a Relation that indicates a kind of "usage" relationship between the target ObjectType and the owner of the reference, the "referrer". The referrer can be an ObjectType (typically) but also a DataType. The relation is looser than the composition relationship, acting like a semantically meaningful pointer rather than indicating a component of the referrer. Consequently, in general many referrers can point at the same target instance, and ObjectType-s can be the target in different reference definitions. The lifecycle of the target is not bound to that of the referrer. Often the target instance is used to provide a context for the definition of the referrer. For example a coordinate frame may be referenced to provide context to coordinate values. TBD more needed ...? TBD Should have multiplicity 0..1 or 1?

Java class for Reference complex type

.

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

 <complexType name="Reference">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/VODML/v1}Relation">
     </extension>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.javastro.ivoa.entities.vodml.Role

datatype, multiplicity

Fields inherited from class org.javastro.ivoa.entities.vodml.ReferableElement

__cachedModifier__, description, id, name, vodmlId

Constructor Summary

Constructors

Constructor	Description
Reference()	Default no-arg constructor
Reference(String vodmlId, String name, String description, String id, ElementRef datatype, Multiplicity multiplicity)	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 Reference.Builder<Void>	builder()
Reference	clone()
Reference	copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
static Reference.Builder<Void>	copyExcept(ReferableElement _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static Reference.Builder<Void>	copyExcept(Reference _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static Reference.Builder<Void>	copyExcept(Relation _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static Reference.Builder<Void>	copyExcept(Role _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> Reference.Builder<_B>	copyOf(ReferableElement _other)
static <_B> Reference.Builder<_B>	copyOf(ReferableElement _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static <_B> Reference.Builder<_B>	copyOf(Reference _other)
static <_B> Reference.Builder<_B>	copyOf(Reference _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static <_B> Reference.Builder<_B>	copyOf(Relation _other)
static <_B> Reference.Builder<_B>	copyOf(Relation _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static <_B> Reference.Builder<_B>	copyOf(Role _other)
static <_B> Reference.Builder<_B>	copyOf(Role _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Reference	copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
static Reference.Builder<Void>	copyOnly(ReferableElement _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static Reference.Builder<Void>	copyOnly(Reference _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static Reference.Builder<Void>	copyOnly(Relation _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static Reference.Builder<Void>	copyOnly(Role _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(Reference.Builder<_B> _other)	Copies all state of this object to a builder.
<_B> void	copyTo(Reference.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)	Copies all state of this object to a builder.
Reference	createCopy()
Reference	createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Object	createNewInstance()
boolean	equals(Object object)
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)
Reference.Modifier	modifier()
Reference.Builder<Void>	newCopyBuilder()
<_B> Reference.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> Reference.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Reference.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
String	toString()
Reference	visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Methods inherited from class org.javastro.ivoa.entities.vodml.Relation

copyTo, copyTo

Methods inherited from class org.javastro.ivoa.entities.vodml.Role

copyTo, copyTo, getDatatype, getMultiplicity, setDatatype, setMultiplicity

Methods inherited from class org.javastro.ivoa.entities.vodml.ReferableElement

copyTo, copyTo, getDescription, getId, getName, getVodmlId, setDescription, setId, setName, setVodmlId

Methods inherited from class java.lang.Object

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

Constructor Details

Reference

public Reference()

Default no-arg constructor

Reference

public Reference(String vodmlId,
 String name,
 String description,
 String id,
 ElementRef datatype,
 Multiplicity multiplicity)

Fully-initialising value constructor

Method Details

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public boolean equals(Object object)

Overrides:

equals in class Relation

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public int hashCode()

Overrides:

hashCode in class Relation

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public String toString()

Overrides:

toString in class Relation

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+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

Overrides:

append in class Relation

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+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

Overrides:

appendFields in class Relation

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

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

Overrides:

mergeFrom in class Relation

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+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

Overrides:

mergeFrom in class Relation

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+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="2024-10-20T18:15:02+01:00")
public Reference clone()

Overrides:

clone in class Relation

createCopy

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public Reference createCopy()

Specified by:

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

Overrides:

createCopy in class Relation

createCopy

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public Reference createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Specified by:

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

Overrides:

createCopy in class Relation

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public Reference copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)

Specified by:

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

Overrides:

copyExcept in class Relation

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public Reference copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)

Specified by:

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

Overrides:

copyOnly in class Relation

modifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public Reference.Modifier modifier()

Overrides:

modifier in class Relation

copyTo

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public <_B> void copyTo(Reference.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="2024-10-20T18:15:02+01:00")
public <_B> Reference.Builder<_B> newCopyBuilder(_B _parentBuilder)

Specified by:

newCopyBuilder in class Relation

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public Reference.Builder<Void> newCopyBuilder()

Specified by:

newCopyBuilder in class Relation

builder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static Reference.Builder<Void> builder()

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static <_B> Reference.Builder<_B> copyOf(ReferableElement _other)

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static <_B> Reference.Builder<_B> copyOf(Role _other)

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static <_B> Reference.Builder<_B> copyOf(Relation _other)

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static <_B> Reference.Builder<_B> copyOf(Reference _other)

copyTo

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public <_B> void copyTo(Reference.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="2024-10-20T18:15:02+01:00")
public <_B> Reference.Builder<_B> newCopyBuilder(_B _parentBuilder,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Specified by:

newCopyBuilder in class Relation

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public Reference.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Specified by:

newCopyBuilder in class Relation

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static <_B> Reference.Builder<_B> copyOf(ReferableElement _other,
 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="2024-10-20T18:15:02+01:00")
public static <_B> Reference.Builder<_B> copyOf(Role _other,
 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="2024-10-20T18:15:02+01:00")
public static <_B> Reference.Builder<_B> copyOf(Relation _other,
 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="2024-10-20T18:15:02+01:00")
public static <_B> Reference.Builder<_B> copyOf(Reference _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="2024-10-20T18:15:02+01:00")
public static Reference.Builder<Void> copyExcept(ReferableElement _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static Reference.Builder<Void> copyExcept(Role _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static Reference.Builder<Void> copyExcept(Relation _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static Reference.Builder<Void> copyExcept(Reference _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static Reference.Builder<Void> copyOnly(ReferableElement _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static Reference.Builder<Void> copyOnly(Role _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static Reference.Builder<Void> copyOnly(Relation _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static Reference.Builder<Void> copyOnly(Reference _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

visit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public Reference visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Overrides:

visit in class Relation