Package org.ivoa.dm.registry.cone

Class Query

java.lang.Object
org.ivoa.dm.registry.cone.Query
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="ConeSearch:Query", role=objectType) public class Query extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
A query to be sent to the service. objectType: Query

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • ra

      @VoDml(id="ConeSearch:Query.ra", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double ra
      the right ascension of the search cone's center in decimal degrees. : Attribute ra : multiplicity 1

    • dec

      @VoDml(id="ConeSearch:Query.dec", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double dec
      the declination of the search cone's center in decimal degrees. : Attribute dec : multiplicity 1

    • sr

      @VoDml(id="ConeSearch:Query.sr", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double sr
      the radius of the search cone in decimal degrees. : Attribute sr : multiplicity 1

    • verb

      @VoDml(id="ConeSearch:Query.verb", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer verb
      the verbosity level to use where 1 means the bare minimum set of columns and 3 means the full set of available columns. : Attribute verb : multiplicity 0..1

    • catalog

      @VoDml(id="ConeSearch:Query.catalog", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String catalog
      the catalog to query. When the service can access more than one catalog, this input parameter, if available, is used to indicate which service to access. : Attribute catalog : multiplicity 0..1

    • extras

      @VoDml(id="ConeSearch:Query.extras", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String extras
      any extra (non-standard) parameters that must be provided (apart from what is part of base URL given by the accessURL element). this value should be in the form of name=value pairs delimited with ampersands. : Attribute extras : multiplicity 0..1

  • Constructor Details

    • Query

      public Query()
      Creates a new Query

    • Query

      public Query(Double ra, Double dec, Double sr, Integer verb, String catalog, String extras)
      full parameter constructor.
      Parameters:
      ra - the right ascension of the search cone's center in decimal degrees.
      dec - the declination of the search cone's center in decimal degrees.
      sr - the radius of the search cone in decimal degrees.
      verb - the verbosity level to use where 1 means the bare minimum set of columns and 3 means the full set of available columns.
      catalog - the catalog to query. When the service can access more than one catalog, this input parameter, if available, is used to indicate which service to access.
      extras - any extra (non-standard) parameters that must be provided (apart from what is part of base URL given by the accessURL element). this value should be in the form of name=value pairs delimited with ampersands.

    • Query

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

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Returns:
      the id

    • updateUsing

      public void updateUsing(Query 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.

    • getRa

      public Double getRa()
      Returns ra Attribute.
      Returns:
      ra Attribute

    • setRa

      public void setRa(Double pRa)
      Set ra Attribute.
      Parameters:
      pRa - value to set

    • withRa

      public Query withRa(Double pRa)
      fluent setter for ra Attribute.
      Parameters:
      pRa - value to set
      Returns:
      Query

    • getDec

      public Double getDec()
      Returns dec Attribute.
      Returns:
      dec Attribute

    • setDec

      public void setDec(Double pDec)
      Set dec Attribute.
      Parameters:
      pDec - value to set

    • withDec

      public Query withDec(Double pDec)
      fluent setter for dec Attribute.
      Parameters:
      pDec - value to set
      Returns:
      Query

    • getSr

      public Double getSr()
      Returns sr Attribute.
      Returns:
      sr Attribute

    • setSr

      public void setSr(Double pSr)
      Set sr Attribute.
      Parameters:
      pSr - value to set

    • withSr

      public Query withSr(Double pSr)
      fluent setter for sr Attribute.
      Parameters:
      pSr - value to set
      Returns:
      Query

    • getVerb

      public Integer getVerb()
      Returns verb Attribute.
      Returns:
      verb Attribute

    • setVerb

      public void setVerb(Integer pVerb)
      Set verb Attribute.
      Parameters:
      pVerb - value to set

    • withVerb

      public Query withVerb(Integer pVerb)
      fluent setter for verb Attribute.
      Parameters:
      pVerb - value to set
      Returns:
      Query

    • getCatalog

      public String getCatalog()
      Returns catalog Attribute.
      Returns:
      catalog Attribute

    • setCatalog

      public void setCatalog(String pCatalog)
      Set catalog Attribute.
      Parameters:
      pCatalog - value to set

    • withCatalog

      public Query withCatalog(String pCatalog)
      fluent setter for catalog Attribute.
      Parameters:
      pCatalog - value to set
      Returns:
      Query

    • getExtras

      public String getExtras()
      Returns extras Attribute.
      Returns:
      extras Attribute

    • setExtras

      public void setExtras(String pExtras)
      Set extras Attribute.
      Parameters:
      pExtras - value to set

    • withExtras

      public Query withExtras(String pExtras)
      fluent setter for extras Attribute.
      Parameters:
      pExtras - value to set
      Returns:
      Query

    • createQuery

      public static Query createQuery(Consumer<Query.QueryBuilder> f)
      create a Query 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

    • delete

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