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:

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 ConeSearch
extends CSCapRestriction
implements Cloneable, com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, 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>
 

Nested Class Summary

Nested Classes

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

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

__cachedModifier__, 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)
static ConeSearch.Builder<Void>	builder()
ConeSearch	clone()
ConeSearch	copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
static ConeSearch.Builder<Void>	copyExcept(Capability _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static ConeSearch.Builder<Void>	copyExcept(ConeSearch _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static ConeSearch.Builder<Void>	copyExcept(CSCapRestriction _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> ConeSearch.Builder<_B>	copyOf(Capability _other)
static <_B> ConeSearch.Builder<_B>	copyOf(Capability _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static <_B> ConeSearch.Builder<_B>	copyOf(ConeSearch _other)
static <_B> ConeSearch.Builder<_B>	copyOf(ConeSearch _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static <_B> ConeSearch.Builder<_B>	copyOf(CSCapRestriction _other)
static <_B> ConeSearch.Builder<_B>	copyOf(CSCapRestriction _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
ConeSearch	copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
static ConeSearch.Builder<Void>	copyOnly(Capability _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static ConeSearch.Builder<Void>	copyOnly(ConeSearch _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static ConeSearch.Builder<Void>	copyOnly(CSCapRestriction _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(ConeSearch.Builder<_B> _other)	Copies all state of this object to a builder.
<_B> void	copyTo(ConeSearch.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)	Copies all state of this object to a builder.
ConeSearch	createCopy()
ConeSearch	createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
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)
ConeSearch.Modifier	modifier()
ConeSearch.Builder<Void>	newCopyBuilder()
<_B> ConeSearch.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> ConeSearch.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
ConeSearch.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
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	visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Methods inherited from class org.javastro.ivoa.entities.resource.cone.CSCapRestriction

copyTo, copyTo

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

copyTo, copyTo, getDescription, getInterfaces, getStandardID, getValidationLevels, setDescription, setStandardID

Methods inherited from class java.lang.Object

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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-10-20T18:15:02+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-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 CSCapRestriction

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 CSCapRestriction

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 CSCapRestriction

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 CSCapRestriction

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

Overrides:

createNewInstance in class Capability

clone

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

Overrides:

clone in class CSCapRestriction

createCopy

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

Specified by:

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

Overrides:

createCopy in class CSCapRestriction

createCopy

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

copyExcept

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

Specified by:

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

Overrides:

copyExcept in class CSCapRestriction

copyOnly

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

Specified by:

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

Overrides:

copyOnly in class CSCapRestriction

modifier

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

Overrides:

modifier in class CSCapRestriction

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

Specified by:

newCopyBuilder in class CSCapRestriction

newCopyBuilder

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

Specified by:

newCopyBuilder in class CSCapRestriction

builder

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

Specified by:

newCopyBuilder in class CSCapRestriction

newCopyBuilder

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

Specified by:

newCopyBuilder in class CSCapRestriction

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> ConeSearch.Builder<_B> copyOf(Capability _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> ConeSearch.Builder<_B> copyOf(CSCapRestriction _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> ConeSearch.Builder<_B> copyOf(ConeSearch _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 ConeSearch.Builder<Void> copyExcept(Capability _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 ConeSearch.Builder<Void> copyExcept(CSCapRestriction _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 ConeSearch.Builder<Void> copyExcept(ConeSearch _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 ConeSearch.Builder<Void> copyOnly(Capability _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 ConeSearch.Builder<Void> copyOnly(CSCapRestriction _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 ConeSearch.Builder<Void> copyOnly(ConeSearch _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 ConeSearch visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Overrides:

visit in class CSCapRestriction