Package org.javastro.ivoa.entities.resource.registry

Class Search

java.lang.Object

org.javastro.ivoa.entities.resource.Capability

org.javastro.ivoa.entities.resource.registry.RegCapRestriction

org.javastro.ivoa.entities.resource.registry.Search

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 Search
extends RegCapRestriction
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 the Registry Search implementation.

Java class for Search complex type

.

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

 <complexType name="Search">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/VORegistry/v1.0}RegCapRestriction">
       <sequence>
         <element name="maxRecords" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="extensionSearchSupport" type="{http://www.ivoa.net/xml/VORegistry/v1.0}ExtensionSearchSupport"/>
         <element name="optionalProtocol" type="{http://www.ivoa.net/xml/VORegistry/v1.0}OptionalProtocol" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected ExtensionSearchSupport	extensionSearchSupport	A legal VOResource extension schema is one that imports and extends the VOResource core schema in compliance with the VOResource standard.
protected int	maxRecords	The largest number of records that the registry search method will return.
protected List<OptionalProtocol>	optionalProtocols	Only one optional protocol is currently allowed (XQuery).

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

__cachedModifier__, description, interfaces, standardID, validationLevels

Constructor Summary

Constructors

Constructor	Description
Search()	Default no-arg constructor
Search(List<Validation> validationLevels, String description, List<ServiceInterface> interfaces, String standardID, int maxRecords, ExtensionSearchSupport extensionSearchSupport, List<OptionalProtocol> optionalProtocols)	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 Search.Builder<Void>	builder()
Search	clone()
Search	copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
static Search.Builder<Void>	copyExcept(Capability _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static Search.Builder<Void>	copyExcept(RegCapRestriction _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static Search.Builder<Void>	copyExcept(Search _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> Search.Builder<_B>	copyOf(Capability _other)
static <_B> Search.Builder<_B>	copyOf(Capability _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static <_B> Search.Builder<_B>	copyOf(RegCapRestriction _other)
static <_B> Search.Builder<_B>	copyOf(RegCapRestriction _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static <_B> Search.Builder<_B>	copyOf(Search _other)
static <_B> Search.Builder<_B>	copyOf(Search _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Search	copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
static Search.Builder<Void>	copyOnly(Capability _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static Search.Builder<Void>	copyOnly(RegCapRestriction _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static Search.Builder<Void>	copyOnly(Search _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(Search.Builder<_B> _other)	Copies all state of this object to a builder.
<_B> void	copyTo(Search.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)	Copies all state of this object to a builder.
Search	createCopy()
Search	createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Object	createNewInstance()
boolean	equals(Object object)
ExtensionSearchSupport	getExtensionSearchSupport()	A legal VOResource extension schema is one that imports and extends the VOResource core schema in compliance with the VOResource standard.
int	getMaxRecords()	The largest number of records that the registry search method will return.
List<OptionalProtocol>	getOptionalProtocols()	Only one optional protocol is currently allowed (XQuery).
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)
Search.Modifier	modifier()
Search.Builder<Void>	newCopyBuilder()
<_B> Search.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> Search.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Search.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
void	setExtensionSearchSupport(ExtensionSearchSupport value)	Sets the value of the extensionSearchSupport property.
void	setMaxRecords(int value)	Sets the value of the maxRecords property.
String	toString()
Search	visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Methods inherited from class org.javastro.ivoa.entities.resource.registry.RegCapRestriction

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

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 registry search method will return. A value of zero or less indicates that there is no explicit limit.

extensionSearchSupport

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

A legal VOResource extension schema is one that imports and extends the VOResource core schema in compliance with the VOResource standard.

optionalProtocols

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
protected List<OptionalProtocol> optionalProtocols

Only one optional protocol is currently allowed (XQuery). It is assumed that the required protocols (simple keyword search and ADQL) are supported.

Constructor Details

Search

public Search()

Default no-arg constructor

Search

public Search(List<Validation> validationLevels,
 String description,
 List<ServiceInterface> interfaces,
 String standardID,
 int maxRecords,
 ExtensionSearchSupport extensionSearchSupport,
 List<OptionalProtocol> optionalProtocols)

Fully-initialising value constructor

Method Details

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 registry search method will return. A value of zero or less indicates that there is no explicit limit.

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.

getExtensionSearchSupport

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

A legal VOResource extension schema is one that imports and extends the VOResource core schema in compliance with the VOResource standard.

Returns:

possible object is ExtensionSearchSupport

setExtensionSearchSupport

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

Sets the value of the extensionSearchSupport property.

Parameters:

value - allowed object is ExtensionSearchSupport

See Also:

• getExtensionSearchSupport()

getOptionalProtocols

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

Only one optional protocol is currently allowed (XQuery). It is assumed that the required protocols (simple keyword search and ADQL) are supported. Gets the value of the optionalProtocols 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 optionalProtocols property.

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

 getOptionalProtocols().add(newItem);
 

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

Returns:

The value of the optionalProtocols property.

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 RegCapRestriction

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 RegCapRestriction

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 RegCapRestriction

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 RegCapRestriction

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 RegCapRestriction

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 RegCapRestriction

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 RegCapRestriction

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

Overrides:

clone in class RegCapRestriction

createCopy

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

Specified by:

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

Overrides:

createCopy in class RegCapRestriction

createCopy

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

copyExcept

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

Specified by:

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

Overrides:

copyExcept in class RegCapRestriction

copyOnly

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

Specified by:

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

Overrides:

copyOnly in class RegCapRestriction

modifier

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

Overrides:

modifier in class RegCapRestriction

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

Specified by:

newCopyBuilder in class RegCapRestriction

newCopyBuilder

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

Specified by:

newCopyBuilder in class RegCapRestriction

builder

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

Specified by:

newCopyBuilder in class RegCapRestriction

newCopyBuilder

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

Specified by:

newCopyBuilder in class RegCapRestriction

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

Overrides:

visit in class RegCapRestriction