Package org.ivoa.dm.registry.cone

Class ConeSearch

java.lang.Object
org.ivoa.dm.registry.voresource.Capability
org.ivoa.dm.registry.cone.ConeSearch
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="ConeSearch:ConeSearch", role=objectType) public class ConeSearch extends Capability implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
The capabilities of a Cone Search implementation. objectType: ConeSearch

  • Field Details

    • maxSR

      @VoDml(id="ConeSearch:ConeSearch.maxSR", role=attribute, type="ivoa:real", typeRole=primitiveType) protected 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. : Attribute maxSR : multiplicity 0..1

    • maxRecords

      @VoDml(id="ConeSearch:ConeSearch.maxRecords", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected 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.). : Attribute maxRecords : multiplicity 0..1

    • verbosity

      @VoDml(id="ConeSearch:ConeSearch.verbosity", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean verbosity
      True if the service supports the VERB keyword; false, otherwise. : Attribute verbosity : multiplicity 1

    • testQuery

      @VoDml(id="ConeSearch:ConeSearch.testQuery", role=composition, type="ConeSearch:Query", typeRole=objectType) protected Query testQuery
      A query that will result in at least on matched record that can be used to test the service. composition testQuery : ( Multiplicity : 0..1 )

  • Constructor Details

    • ConeSearch

      public ConeSearch()
      Creates a new ConeSearch

    • ConeSearch

      public ConeSearch(Double maxSR, Integer maxRecords, Boolean verbosity, Query testQuery, List<Validation> validationLevel, String description, List<Interface> interface_, String standardID)
      full parameter constructor.
      Parameters:
      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 - 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 - True if the service supports the VERB keyword; false, otherwise.
      testQuery - A query that will result in at least on matched record that can be used to test the service.
      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 - 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_ - 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 - 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.

    • ConeSearch

      public ConeSearch(ConeSearch other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • ConeSearch

      public ConeSearch(Capability superinstance, Double maxSR, Integer maxRecords, Boolean verbosity, Query testQuery)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      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 - 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 - True if the service supports the VERB keyword; false, otherwise.
      testQuery - A query that will result in at least on matched record that can be used to test the service.

  • Method Details

    • copyMe

      public Capability copyMe()
      make a clone of the object taking into account current polymorhic type.
      Overrides:
      copyMe in class Capability
      Returns:
      the cloned object.

    • updateUsing

      public void updateUsing(ConeSearch other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getMaxSR

      public Double getMaxSR()
      Returns maxSR Attribute.
      Returns:
      maxSR Attribute

    • setMaxSR

      public void setMaxSR(Double pMaxSR)
      Set maxSR Attribute.
      Parameters:
      pMaxSR - value to set

    • withMaxSR

      public ConeSearch withMaxSR(Double pMaxSR)
      fluent setter for maxSR Attribute.
      Parameters:
      pMaxSR - value to set
      Returns:
      ConeSearch

    • getMaxRecords

      public Integer getMaxRecords()
      Returns maxRecords Attribute.
      Returns:
      maxRecords Attribute

    • setMaxRecords

      public void setMaxRecords(Integer pMaxRecords)
      Set maxRecords Attribute.
      Parameters:
      pMaxRecords - value to set

    • withMaxRecords

      public ConeSearch withMaxRecords(Integer pMaxRecords)
      fluent setter for maxRecords Attribute.
      Parameters:
      pMaxRecords - value to set
      Returns:
      ConeSearch

    • getVerbosity

      public Boolean getVerbosity()
      Returns verbosity Attribute.
      Returns:
      verbosity Attribute

    • setVerbosity

      public void setVerbosity(Boolean pVerbosity)
      Set verbosity Attribute.
      Parameters:
      pVerbosity - value to set

    • withVerbosity

      public ConeSearch withVerbosity(Boolean pVerbosity)
      fluent setter for verbosity Attribute.
      Parameters:
      pVerbosity - value to set
      Returns:
      ConeSearch

    • getTestQuery

      public Query getTestQuery()
      Returns testQuery Attribute.
      Returns:
      testQuery Attribute

    • setTestQuery

      public void setTestQuery(Query pTestQuery)
      Set testQuery Attribute.
      Parameters:
      pTestQuery - value to set

    • withTestQuery

      public ConeSearch withTestQuery(Query pTestQuery)
      fluent setter for testQuery Attribute.
      Parameters:
      pTestQuery - value to set
      Returns:
      ConeSearch

    • createConeSearch

      public static ConeSearch createConeSearch(Consumer<ConeSearch.ConeSearchBuilder> f)
      create a ConeSearch in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations
      Overrides:
      forceLoad in class Capability

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Overrides:
      delete in class Capability