Package org.ivoa.dm.registry.sia

Class Query

java.lang.Object
org.ivoa.dm.registry.sia.Query
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="SIA: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

    • pos

      @VoDml(id="SIA:Query.pos", role=composition, type="SIA:SkyPos", typeRole=objectType) protected SkyPos pos
      the center position of the rectangular region that should be used as part of the query to the SIA service. composition pos : ( Multiplicity : 0..1 )

    • size

      @VoDml(id="SIA:Query.size", role=composition, type="SIA:SkySize", typeRole=objectType) protected SkySize size
      the rectangular size of the region that should be used as part of the query to the SIA service. composition size : ( Multiplicity : 0..1 )

    • verb

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

    • extras

      @VoDml(id="SIA:Query.extras", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String extras
      any extra (particularly 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(SkyPos pos, SkySize size, Integer verb, String extras)
      full parameter constructor.
      Parameters:
      pos - the center position of the rectangular region that should be used as part of the query to the SIA service.
      size - the rectangular size of the region that should be used as part of the query to the SIA service.
      verb - the verbosity level to use where 0 means the bare minimum set of columns and 3 means the full set of available columns.
      extras - any extra (particularly 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.

    • getPos

      public SkyPos getPos()
      Returns pos Attribute.
      Returns:
      pos Attribute

    • setPos

      public void setPos(SkyPos pPos)
      Set pos Attribute.
      Parameters:
      pPos - value to set

    • withPos

      public Query withPos(SkyPos pPos)
      fluent setter for pos Attribute.
      Parameters:
      pPos - value to set
      Returns:
      Query

    • getSize

      public SkySize getSize()
      Returns size Attribute.
      Returns:
      size Attribute

    • setSize

      public void setSize(SkySize pSize)
      Set size Attribute.
      Parameters:
      pSize - value to set

    • withSize

      public Query withSize(SkySize pSize)
      fluent setter for size Attribute.
      Parameters:
      pSize - 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

    • 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>