Package org.javastro.ivoa.entities.resource

Class Capability

java.lang.Object

org.javastro.ivoa.entities.resource.Capability

All Implemented Interfaces:

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

Direct Known Subclasses:

CSCapRestriction, RegCapRestriction, SIACapRestriction, SimpleSpectralAccess, TableAccess

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

a description of what the service does (in terms of context-specific behavior), and how to use it (in terms of an interface)

Java class for Capability complex type

.

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

 <complexType name="Capability">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="validationLevel" type="{http://www.ivoa.net/xml/VOResource/v1.0}Validation" maxOccurs="unbounded" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="interface" type="{http://www.ivoa.net/xml/VOResource/v1.0}Interface" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="standardID" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description	Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.
protected List<ServiceInterface>	interfaces	Multiple occurences can describe different interfaces to the logically same capability, i.e.
protected String	standardID	This provides a unique way to refer to a service specification standard, such as a Simple Image Access service.
protected List<Validation>	validationLevels	See vr:ValidationLevel for an explanation of the allowed levels.

Constructor Summary

Constructors

Constructor	Description
Capability()	Default no-arg constructor
Capability(List<Validation> validationLevels, String description, List<ServiceInterface> interfaces, String standardID)	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)
String	getDescription()	Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.
List<ServiceInterface>	getInterfaces()	Multiple occurences can describe different interfaces to the logically same capability, i.e.
String	getStandardID()	This provides a unique way to refer to a service specification standard, such as a Simple Image Access service.
List<Validation>	getValidationLevels()	See vr:ValidationLevel for an explanation of the allowed levels.
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	setStandardID(String value)	Sets the value of the standardID property.
String	toString()
Capability	withDescription(String value)
Capability	withInterfaces(Collection<ServiceInterface> values)
Capability	withInterfaces(ServiceInterface... values)
Capability	withStandardID(String value)
Capability	withValidationLevels(Collection<Validation> values)
Capability	withValidationLevels(Validation... values)

Methods inherited from class java.lang.Object

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

Field Details

validationLevels

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

See vr:ValidationLevel for an explanation of the allowed levels.

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

Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.

interfaces

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

Multiple occurences can describe different interfaces to the logically same capability, i.e. data or functionality. That is, the inputs accepted and the output provides should be logically the same. For example, a WebBrowser interface given in addition to a WebService interface would simply provide an interactive, human-targeted interface to the underlying WebService interface.

standardID

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

This provides a unique way to refer to a service specification standard, such as a Simple Image Access service. The use of an IVOA identifier here implies that a VOResource description of the standard is registered and accessible.

Constructor Details

Capability

public Capability()

Default no-arg constructor

Capability

public Capability(List<Validation> validationLevels,
 String description,
 List<ServiceInterface> interfaces,
 String standardID)

Fully-initialising value constructor

Method Details

getValidationLevels

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

See vr:ValidationLevel for an explanation of the allowed levels. Gets the value of the validationLevels property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the validationLevels property.

For example, to add a new item, do as follows:

 getValidationLevels().add(newItem);
 

Objects of the following type(s) are allowed in the list Validation

Returns:

The value of the validationLevels property.

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()

Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.

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()

getInterfaces

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

Multiple occurences can describe different interfaces to the logically same capability, i.e. data or functionality. That is, the inputs accepted and the output provides should be logically the same. For example, a WebBrowser interface given in addition to a WebService interface would simply provide an interactive, human-targeted interface to the underlying WebService interface. Gets the value of the interfaces property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the interfaces property.

For example, to add a new item, do as follows:

 getInterfaces().add(newItem);
 

Objects of the following type(s) are allowed in the list ServiceInterface

Returns:

The value of the interfaces property.

getStandardID

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

This provides a unique way to refer to a service specification standard, such as a Simple Image Access service. The use of an IVOA identifier here implies that a VOResource description of the standard is registered and accessible.

Returns:

possible object is String

setStandardID

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

Sets the value of the standardID property.

Parameters:

value - allowed object is String

See Also:

• getStandardID()

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

withValidationLevels

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

withValidationLevels

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Capability withValidationLevels(Collection<Validation> values)

withDescription

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

withInterfaces

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

withInterfaces

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Capability withInterfaces(Collection<ServiceInterface> values)

withStandardID

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

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