Package org.ivoa.dm.proposal.prop

Class CelestialPosition

java.lang.Object
org.ivoa.dm.proposal.prop.CelestialPosition
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations
@Embeddable @VoDml(id="proposal:CelestialPosition", role=dataType) public class CelestialPosition extends Object implements org.ivoa.vodml.jpa.JPAManipulations
a point on the celestial sphere.

dataType: CelestialPosition

  • Field Details

    • sourceCoordinates

      @VoDml(id="proposal:CelestialPosition.sourceCoordinates", role=attribute, type="adqlgeom:Point", typeRole=dataType) protected org.javastro.ivoacore.pgsphere.types.Point sourceCoordinates
      The actual position. : Attribute sourceCoordinates type adqlgeom:Point : multiplicity 1

    • referenceFrame

      @VoDml(id="proposal:CelestialPosition.referenceFrame", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String referenceFrame
      the reference frame. : Attribute referenceFrame type ivoa:string : multiplicity 1

    • equinox

      @VoDml(id="proposal:CelestialPosition.equinox", role=attribute, type="proposal:coords.mjd", typeRole=primitiveType) protected Mjd equinox
      the equinox when needed - not for modern reference frames. : Attribute equinox type proposal:coords.mjd : multiplicity 0..1

  • Constructor Details

    • CelestialPosition

      public CelestialPosition()
      Creates a new CelestialPosition

    • CelestialPosition

      public CelestialPosition(org.javastro.ivoacore.pgsphere.types.Point sourceCoordinates, String referenceFrame, Mjd equinox)
      full parameter constructor.
      Parameters:
      sourceCoordinates - The actual position.
      referenceFrame - the reference frame.
      equinox - the equinox when needed - not for modern reference frames.

    • CelestialPosition

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

  • Method Details

    • updateUsing

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

    • getSourceCoordinates

      public org.javastro.ivoacore.pgsphere.types.Point getSourceCoordinates()
      Returns sourceCoordinates Attribute.
      Returns:
      sourceCoordinates Attribute

    • setSourceCoordinates

      public void setSourceCoordinates(org.javastro.ivoacore.pgsphere.types.Point pSourceCoordinates)
      Set sourceCoordinates Attribute.
      Parameters:
      pSourceCoordinates - value to set

    • withSourceCoordinates

      public CelestialPosition withSourceCoordinates(org.javastro.ivoacore.pgsphere.types.Point pSourceCoordinates)
      fluent setter for sourceCoordinates Attribute.
      Parameters:
      pSourceCoordinates - value to set
      Returns:
      CelestialPosition

    • getReferenceFrame

      public String getReferenceFrame()
      Returns referenceFrame Attribute.
      Returns:
      referenceFrame Attribute

    • setReferenceFrame

      public void setReferenceFrame(String pReferenceFrame)
      Set referenceFrame Attribute.
      Parameters:
      pReferenceFrame - value to set

    • withReferenceFrame

      public CelestialPosition withReferenceFrame(String pReferenceFrame)
      fluent setter for referenceFrame Attribute.
      Parameters:
      pReferenceFrame - value to set
      Returns:
      CelestialPosition

    • getEquinox

      public Mjd getEquinox()
      Returns equinox Attribute.
      Returns:
      equinox Attribute

    • setEquinox

      public void setEquinox(Mjd pEquinox)
      Set equinox Attribute.
      Parameters:
      pEquinox - value to set

    • withEquinox

      public CelestialPosition withEquinox(Mjd pEquinox)
      fluent setter for equinox Attribute.
      Parameters:
      pEquinox - value to set
      Returns:
      CelestialPosition

    • createCelestialPosition

      public static CelestialPosition createCelestialPosition(Consumer<CelestialPosition.CelestialPositionBuilder> f)
      create a CelestialPosition 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

    • equals

      public boolean equals(Object o_)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object