Package org.javastro.ivoa.entities.resource.cone

Class ConeSearch

java.lang.Object

org.javastro.ivoa.entities.resource.Capability

org.javastro.ivoa.entities.resource.cone.CSCapRestriction

org.javastro.ivoa.entities.resource.cone.ConeSearch

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 ConeSearch
extends CSCapRestriction
implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

The capabilities of a Cone Search implementation.

Java class for ConeSearch complex type

.

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

 <complexType name="ConeSearch">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/ConeSearch/v1.0}CSCapRestriction">
       <sequence>
         <element name="maxSR" type="{http://www.w3.org/2001/XMLSchema}float"/>
         <element name="maxRecords" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="verbosity" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="testQuery" type="{http://www.ivoa.net/xml/ConeSearch/v1.0}Query"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected int	maxRecords	The largest number of records that the service will return.
protected float	maxSR	Use 180.0 if there is no restriction.
protected Query	testQuery	A query that will result in at least on matched record that can be used to test the service.
protected boolean	verbosity	True if the service supports the VERB keyword; false, otherwise.

Fields inherited from class org.javastro.ivoa.entities.resource.Capability

description, interfaces, standardID, validationLevels

Constructor Summary

Constructors

Constructor	Description
ConeSearch()	Default no-arg constructor
ConeSearch(List<Validation> validationLevels, String description, List<ServiceInterface> interfaces, String standardID, float maxSR, int maxRecords, boolean verbosity, Query testQuery)	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)
int	getMaxRecords()	The largest number of records that the service will return.
float	getMaxSR()	Use 180.0 if there is no restriction.
Query	getTestQuery()	A query that will result in at least on matched record that can be used to test the service.
int	hashCode()
boolean	isVerbosity()	True if the service supports the VERB keyword; false, otherwise.
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	setMaxRecords(int value)	Sets the value of the maxRecords property.
void	setMaxSR(float value)	Sets the value of the maxSR property.
void	setTestQuery(Query value)	Sets the value of the testQuery property.
void	setVerbosity(boolean value)	Sets the value of the verbosity property.
String	toString()
ConeSearch	withDescription(String value)
ConeSearch	withInterfaces(Collection<ServiceInterface> values)
ConeSearch	withInterfaces(ServiceInterface... values)
ConeSearch	withMaxRecords(int value)
ConeSearch	withMaxSR(float value)
ConeSearch	withStandardID(String value)
ConeSearch	withTestQuery(Query value)
ConeSearch	withValidationLevels(Collection<Validation> values)
ConeSearch	withValidationLevels(Validation... values)
ConeSearch	withVerbosity(boolean value)

Methods inherited from class org.javastro.ivoa.entities.resource.Capability

getDescription, getInterfaces, getStandardID, getValidationLevels, setDescription, setStandardID

Methods inherited from class java.lang.Object

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

Field Details

maxSR

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

Use 180.0 if there is no restriction.

maxRecords

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

The largest number of records that the service will return.

verbosity

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

True if the service supports the VERB keyword; false, otherwise.

testQuery

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

A query that will result in at least on matched record that can be used to test the service.

Constructor Details

ConeSearch

public ConeSearch()

Default no-arg constructor

ConeSearch

public ConeSearch(List<Validation> validationLevels,
 String description,
 List<ServiceInterface> interfaces,
 String standardID,
 float maxSR,
 int maxRecords,
 boolean verbosity,
 Query testQuery)

Fully-initialising value constructor

Method Details

getMaxSR

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

Use 180.0 if there is no restriction.

setMaxSR

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

Sets the value of the maxSR property.

getMaxRecords

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

The largest number of records that the service will return.

setMaxRecords

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

Sets the value of the maxRecords property.

isVerbosity

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

True if the service supports the VERB keyword; false, otherwise.

setVerbosity

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

Sets the value of the verbosity property.

getTestQuery

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

A query that will result in at least on matched record that can be used to test the service.

Returns:

possible object is Query

setTestQuery

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

Sets the value of the testQuery property.

Parameters:

value - allowed object is Query

See Also:

• getTestQuery()

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 CSCapRestriction

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 CSCapRestriction

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 CSCapRestriction

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 CSCapRestriction

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 CSCapRestriction

withMaxSR

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

withMaxRecords

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

withVerbosity

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

withTestQuery

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

withValidationLevels

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

Overrides:

withValidationLevels in class CSCapRestriction

withValidationLevels

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

Overrides:

withValidationLevels in class CSCapRestriction

withDescription

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

Overrides:

withDescription in class CSCapRestriction

withInterfaces

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

Overrides:

withInterfaces in class CSCapRestriction

withInterfaces

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

Overrides:

withInterfaces in class CSCapRestriction

withStandardID

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

Overrides:

withStandardID in class CSCapRestriction

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 CSCapRestriction

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 CSCapRestriction

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 Capability