Package org.javastro.ivoa.entities.vodml

Class SubsettedRole

java.lang.Object

org.javastro.ivoa.entities.vodml.Constraint

org.javastro.ivoa.entities.vodml.SubsettedRole

All Implemented Interfaces:

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-08-01T13:15:43+01:00")
public class SubsettedRole
extends Constraint
implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

A special type of constraint that represents the common pattern where a subtype. would like to restrict certain aspects of a definition of a roles defined on a super type. The constraint explicitly defines the datatype of the identified role. This new datatype MUST be a subtype of the declared datatype of the role that is being constrained. Similarly a new, more restrictive semantic concept may be defined.

Java class for SubsettedRole complex type

.

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

 <complexType name="SubsettedRole">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/VODML/v1}Constraint">
       <sequence>
         <element name="role" type="{http://www.ivoa.net/xml/VODML/v1}ElementRef"/>
         <element name="datatype" type="{http://www.ivoa.net/xml/VODML/v1}ElementRef" minOccurs="0"/>
         <element name="semanticconcept" type="{http://www.ivoa.net/xml/VODML/v1}SemanticConcept" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected ElementRef	datatype	Pointer to datatype that the constrained Role must take.
protected ElementRef	role	VODMLREF identifying the constrained Role.
protected SemanticConcept	semanticconcept	Maybe the super type has not defined a semantic concept for the Role, but the subtype needs that.

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

description

Constructor Summary

Constructors

Constructor	Description
SubsettedRole()	Default no-arg constructor
SubsettedRole(String description, ElementRef role, ElementRef datatype, SemanticConcept semanticconcept)	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)
Object	createNewInstance()
boolean	equals(Object object)
ElementRef	getDatatype()	Pointer to datatype that the constrained Role must take.
ElementRef	getRole()	VODMLREF identifying the constrained Role.
SemanticConcept	getSemanticconcept()	Maybe the super type has not defined a semantic concept for the Role, but the subtype needs that.
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	setDatatype(ElementRef value)	Sets the value of the datatype property.
void	setRole(ElementRef value)	Sets the value of the role property.
void	setSemanticconcept(SemanticConcept value)	Sets the value of the semanticconcept property.
String	toString()
SubsettedRole	withDatatype(ElementRef value)
SubsettedRole	withDescription(String value)
SubsettedRole	withRole(ElementRef value)
SubsettedRole	withSemanticconcept(SemanticConcept value)

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

getDescription, setDescription

Methods inherited from class java.lang.Object

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

Field Details

role

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

VODMLREF identifying the constrained Role. This role MUST be available to the type containing this constraint.

datatype

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

Pointer to datatype that the constrained Role must take. This datatype MUST be a sub-type of the declared datatype of the constrained Role.

semanticconcept

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

Maybe the super type has not defined a semantic concept for the Role, but the subtype needs that. This attribute allows this assignment. But alse when the Role on the super-type already has a semanticconcept with a topConcept defined on it, the subtype may restrict the values to a narrower concept than that assigned to it on the super-type.

Constructor Details

SubsettedRole

public SubsettedRole()

Default no-arg constructor

SubsettedRole

public SubsettedRole(String description,
 ElementRef role,
 ElementRef datatype,
 SemanticConcept semanticconcept)

Fully-initialising value constructor

Method Details

getRole

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

VODMLREF identifying the constrained Role. This role MUST be available to the type containing this constraint.

Returns:

possible object is ElementRef

setRole

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

Sets the value of the role property.

Parameters:

value - allowed object is ElementRef

See Also:

• getRole()

getDatatype

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

Pointer to datatype that the constrained Role must take. This datatype MUST be a sub-type of the declared datatype of the constrained Role.

Returns:

possible object is ElementRef

setDatatype

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

Sets the value of the datatype property.

Parameters:

value - allowed object is ElementRef

See Also:

• getDatatype()

getSemanticconcept

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

Maybe the super type has not defined a semantic concept for the Role, but the subtype needs that. This attribute allows this assignment. But alse when the Role on the super-type already has a semanticconcept with a topConcept defined on it, the subtype may restrict the values to a narrower concept than that assigned to it on the super-type.

Returns:

possible object is SemanticConcept

setSemanticconcept

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

Sets the value of the semanticconcept property.

Parameters:

value - allowed object is SemanticConcept

See Also:

• getSemanticconcept()

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 Constraint

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 Constraint

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 Constraint

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

Overrides:

append in class Constraint

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

Overrides:

appendFields in class Constraint

withRole

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

withDatatype

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

withSemanticconcept

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

withDescription

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

Overrides:

withDescription in class Constraint

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

Overrides:

mergeFrom in class Constraint

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

Overrides:

mergeFrom in class Constraint

createNewInstance

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

Specified by:

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

Overrides:

createNewInstance in class Constraint