Package org.javastro.ivoa.entities.vodml

Class Role

java.lang.Object

org.javastro.ivoa.entities.vodml.ReferableElement

org.javastro.ivoa.entities.vodml.Role

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:

Attribute, Relation

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

Role extends ReferencableElement. The 'name' element that is inherited from that type must be unique in the collection of roles defined on the parent type. This uniqueness must extend over the roles available on the type by inheritance.

Java class for Role complex type

.

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

 <complexType name="Role">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/VODML/v1}ReferableElement">
       <sequence>
         <element name="datatype" type="{http://www.ivoa.net/xml/VODML/v1}ElementRef"/>
         <element name="multiplicity" type="{http://www.ivoa.net/xml/VODML/v1}Multiplicity"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected ElementRef	datatype	Reference to the type that plays the role represented by this Role.
protected Multiplicity	multiplicity	The multiplicity of the role (also called cardinality) indicates whether it must have a value or may be without value, or possibly how many values are allowed.

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

__cachedModifier__, description, id, name, vodmlId

Constructor Summary

Constructors

Constructor	Description
Role()	Default no-arg constructor
Role(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)
Role	clone()
Role	copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
Role	copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(Role.Builder<_B> _other)	Copies all state of this object to a builder.
<_B> void	copyTo(Role.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)	Copies all state of this object to a builder.
Role	createCopy()
Role	createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
boolean	equals(Object object)
ElementRef	getDatatype()	Reference to the type that plays the role represented by this Role.
Multiplicity	getMultiplicity()	The multiplicity of the role (also called cardinality) indicates whether it must have a value or may be without value, or possibly how many values are allowed.
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)
Role.Modifier	modifier()
abstract Role.Builder<Void>	newCopyBuilder()
abstract <_B> Role.Builder<_B>	newCopyBuilder(_B _parentBuilder)
abstract <_B> Role.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
abstract Role.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
void	setDatatype(ElementRef value)	Sets the value of the datatype property.
void	setMultiplicity(Multiplicity value)	Sets the value of the multiplicity property.
String	toString()
Role	visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

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

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

createNewInstance

Field Details

datatype

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

Reference to the type that plays the role represented by this Role.

multiplicity

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

The multiplicity of the role (also called cardinality) indicates whether it must have a value or may be without value, or possibly how many values are allowed.

Constructor Details

Role

public Role()

Default no-arg constructor

Role

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

Fully-initialising value constructor

Method Details

getDatatype

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

Reference to the type that plays the role represented by this Role.

Returns:

possible object is ElementRef

setDatatype

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

Sets the value of the datatype property.

Parameters:

value - allowed object is ElementRef

See Also:

• getDatatype()

getMultiplicity

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

The multiplicity of the role (also called cardinality) indicates whether it must have a value or may be without value, or possibly how many values are allowed.

Returns:

possible object is Multiplicity

setMultiplicity

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

Sets the value of the multiplicity property.

Parameters:

value - allowed object is Multiplicity

See Also:

• getMultiplicity()

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 ReferableElement

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 ReferableElement

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 ReferableElement

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

Overrides:

append in class ReferableElement

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

Overrides:

appendFields in class ReferableElement

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

Overrides:

mergeFrom in class ReferableElement

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

Overrides:

mergeFrom in class ReferableElement

clone

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

Overrides:

clone in class ReferableElement

createCopy

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

Specified by:

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

Overrides:

createCopy in class ReferableElement

createCopy

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

copyExcept

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

Specified by:

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

Overrides:

copyExcept in class ReferableElement

copyOnly

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

Specified by:

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

Overrides:

copyOnly in class ReferableElement

modifier

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

Overrides:

modifier in class ReferableElement

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(Role.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 abstract <_B> Role.Builder<_B> newCopyBuilder(_B _parentBuilder)

Specified by:

newCopyBuilder in class ReferableElement

newCopyBuilder

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

Specified by:

newCopyBuilder in class ReferableElement

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(Role.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 abstract <_B> Role.Builder<_B> newCopyBuilder(_B _parentBuilder,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Specified by:

newCopyBuilder in class ReferableElement

newCopyBuilder

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

Specified by:

newCopyBuilder in class ReferableElement

visit

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

Overrides:

visit in class ReferableElement