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:

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 Search
extends RegCapRestriction
implements 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>
 

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

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)
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)
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	withDescription(String value)
Search	withExtensionSearchSupport(ExtensionSearchSupport value)
Search	withInterfaces(Collection<ServiceInterface> values)
Search	withInterfaces(ServiceInterface... values)
Search	withMaxRecords(int value)
Search	withOptionalProtocols(Collection<OptionalProtocol> values)
Search	withOptionalProtocols(OptionalProtocol... values)
Search	withStandardID(String value)
Search	withValidationLevels(Collection<Validation> values)
Search	withValidationLevels(Validation... values)

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

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 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-08-01T13:15:43+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-08-01T13:15:43+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-08-01T13:15:43+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-08-01T13:15:43+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-08-01T13:15:43+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-08-01T13:15:43+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-08-01T13:15:43+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-08-01T13:15:43+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-08-01T13:15:43+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-08-01T13:15:43+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-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 RegCapRestriction

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 RegCapRestriction

withMaxRecords

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

withExtensionSearchSupport

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

withOptionalProtocols

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

withOptionalProtocols

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

withValidationLevels

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

Overrides:

withValidationLevels in class RegCapRestriction

withValidationLevels

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

Overrides:

withValidationLevels in class RegCapRestriction

withDescription

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

Overrides:

withDescription in class RegCapRestriction

withInterfaces

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

Overrides:

withInterfaces in class RegCapRestriction

withInterfaces

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

Overrides:

withInterfaces in class RegCapRestriction

withStandardID

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

Overrides:

withStandardID in class RegCapRestriction

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 RegCapRestriction

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 RegCapRestriction

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