Package org.ivoa.dm.registry.cone

Class ConeSearch.ConeSearchBuilder

java.lang.Object
org.ivoa.dm.registry.cone.ConeSearch.ConeSearchBuilder
Enclosing class:
ConeSearch
public static class ConeSearch.ConeSearchBuilder extends Object
A builder class for ConeSearch, mainly for use in the functional builder pattern.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    String
    description
    A human-readable description of what this capability provides as part of the over-all service Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.
    List<Interface>
    interface_
    a description of how to call the service to access this capability Since the Interface type is abstract, one must describe the interface using a subclass of Interface, denoting it via xsi:type.
    Integer
    maxRecords
    The largest number of records that the service will return.
    Double
    maxSR
    The largest search radius, in degrees, that will be accepted by the service without returning an error condition.
    String
    standardID
    A URI identifier for a standard service.
    Query
    testQuery
    A query that will result in at least on matched record that can be used to test the service.
    List<Validation>
    validationLevel
    A numeric grade describing the quality of the capability description and interface, when applicable, to be used to indicate the confidence an end-user can put in the resource as part of a VO application or research study.
    Boolean
    verbosity
    True if the service supports the VERB keyword; false, otherwise.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConeSearchBuilder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    ConeSearch
    create()
    create a ConeSearch from this builder.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • maxSR

      public Double maxSR
      The largest search radius, in degrees, that will be accepted by the service without returning an error condition. Not providing this element or specifying a value of 180 indicates that there is no restriction. Not providing a value is the prefered way to indicate that there is no restriction.

    • maxRecords

      public Integer maxRecords
      The largest number of records that the service will return. Not providing this value means that there is no effective limit. This does not refer to the total number of records in the catalog but rather maximum number of records the service is capable of returning. A limit that is greater than the number of records available in the archive is equivalent to their being no effective limit. (See RM, Hanisch 2007.).

    • verbosity

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

    • testQuery

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

    • validationLevel

      public List<Validation> validationLevel
      A numeric grade describing the quality of the capability description and interface, when applicable, to be used to indicate the confidence an end-user can put in the resource as part of a VO application or research study. See VOResource:ValidationLevel for an explanation of the allowed levels.

    • description

      public String description
      A human-readable description of what this capability provides as part of the over-all service Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.

    • interface_

      public List<Interface> interface_
      a description of how to call the service to access this capability Since the Interface type is abstract, one must describe the interface using a subclass of Interface, denoting it via xsi:type. 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

      public String standardID
      A URI identifier for a standard service. 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

    • ConeSearchBuilder

      public ConeSearchBuilder()

  • Method Details

    • create

      public ConeSearch create()
      create a ConeSearch from this builder.
      Returns:
      an object initialized from the builder.