Package org.ivoa.dm.proposal.prop

Class CelestialTarget

java.lang.Object
org.ivoa.dm.proposal.prop.Target
org.ivoa.dm.proposal.prop.CelestialTarget
All Implemented Interfaces:
org.ivoa.vodml.jaxb.XmlIdManagement, org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="proposal:CelestialTarget", role=objectType) public class CelestialTarget extends Target implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>, org.ivoa.vodml.jaxb.XmlIdManagement
The basic target setup for a celestial Target. objectType: CelestialTarget

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CelestialTarget.CelestialTargetBuilder
    A builder class for CelestialTarget, mainly for use in the functional builder pattern.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.ivoa.dm.ivoa.RealQuantity
    parallax
    .
    protected org.ivoa.dm.ivoa.RealQuantity
    pmDec
    .
    protected org.ivoa.dm.ivoa.RealQuantity
    pmRA
    .
    protected org.ivoa.dm.stc.coords.Epoch
    positionEpoch
    the epoch at which the position was measured.
    protected org.ivoa.dm.stc.coords.EquatorialPoint
    sourceCoordinates
    .
    protected org.ivoa.dm.ivoa.RealQuantity
    sourceVelocity
    .

    Fields inherited from class org.ivoa.dm.proposal.prop.Target

    _id, sourceName

  • Constructor Summary

    Constructors
    Constructor
    Description
    CelestialTarget()
    Creates a new CelestialTarget
    CelestialTarget(CelestialTarget other)
    Copy Constructor.
    CelestialTarget(Target superinstance, org.ivoa.dm.stc.coords.EquatorialPoint sourceCoordinates, org.ivoa.dm.stc.coords.Epoch positionEpoch, org.ivoa.dm.ivoa.RealQuantity pmRA, org.ivoa.dm.ivoa.RealQuantity pmDec, org.ivoa.dm.ivoa.RealQuantity parallax, org.ivoa.dm.ivoa.RealQuantity sourceVelocity)
    Constructor from supertype instance.
    CelestialTarget(org.ivoa.dm.stc.coords.EquatorialPoint sourceCoordinates, org.ivoa.dm.stc.coords.Epoch positionEpoch, org.ivoa.dm.ivoa.RealQuantity pmRA, org.ivoa.dm.ivoa.RealQuantity pmDec, org.ivoa.dm.ivoa.RealQuantity parallax, org.ivoa.dm.ivoa.RealQuantity sourceVelocity, String sourceName)
    full parameter constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Target
    copyMe()
    make a clone of the object taking into account current polymorhic type.
    static CelestialTarget
    createCelestialTarget(Consumer<CelestialTarget.CelestialTargetBuilder> f)
    create a CelestialTarget in functional builder style.
    void
    forceLoad()
     
    org.ivoa.dm.ivoa.RealQuantity
    getParallax()
    Returns parallax Attribute.
    org.ivoa.dm.ivoa.RealQuantity
    getPmDec()
    Returns pmDec Attribute.
    org.ivoa.dm.ivoa.RealQuantity
    getPmRA()
    Returns pmRA Attribute.
    org.ivoa.dm.stc.coords.Epoch
    getPositionEpoch()
    Returns positionEpoch Attribute.
    org.ivoa.dm.stc.coords.EquatorialPoint
    getSourceCoordinates()
    Returns sourceCoordinates Attribute.
    org.ivoa.dm.ivoa.RealQuantity
    getSourceVelocity()
    Returns sourceVelocity Attribute.
    void
    persistRefs(jakarta.persistence.EntityManager _em)
    Deprecated.
    generally better to use the model level reference persistence as only this can deal with "contained" references properly.
    void
    setParallax(org.ivoa.dm.ivoa.RealQuantity pParallax)
    Set parallax Attribute.
    void
    setPmDec(org.ivoa.dm.ivoa.RealQuantity pPmDec)
    Set pmDec Attribute.
    void
    setPmRA(org.ivoa.dm.ivoa.RealQuantity pPmRA)
    Set pmRA Attribute.
    void
    setPositionEpoch(org.ivoa.dm.stc.coords.Epoch pPositionEpoch)
    Set positionEpoch Attribute.
    void
    setSourceCoordinates(org.ivoa.dm.stc.coords.EquatorialPoint pSourceCoordinates)
    Set sourceCoordinates Attribute.
    void
    setSourceVelocity(org.ivoa.dm.ivoa.RealQuantity pSourceVelocity)
    Set sourceVelocity Attribute.
    void
    updateUsing(CelestialTarget other)
    Update this object with the content of the given object.
    CelestialTarget
    withParallax(org.ivoa.dm.ivoa.RealQuantity pParallax)
    fluent setter for parallax Attribute.
    CelestialTarget
    withPmDec(org.ivoa.dm.ivoa.RealQuantity pPmDec)
    fluent setter for pmDec Attribute.
    CelestialTarget
    withPmRA(org.ivoa.dm.ivoa.RealQuantity pPmRA)
    fluent setter for pmRA Attribute.
    CelestialTarget
    withPositionEpoch(org.ivoa.dm.stc.coords.Epoch pPositionEpoch)
    fluent setter for positionEpoch Attribute.
    CelestialTarget
    withSourceCoordinates(org.ivoa.dm.stc.coords.EquatorialPoint pSourceCoordinates)
    fluent setter for sourceCoordinates Attribute.
    CelestialTarget
    withSourceVelocity(org.ivoa.dm.ivoa.RealQuantity pSourceVelocity)
    fluent setter for sourceVelocity Attribute.

    Methods inherited from class org.ivoa.dm.proposal.prop.Target

    getId, getSourceName, getXmlId, hasNaturalKey, setSourceName, setXmlId, updateUsing, withSourceName

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType

    getId

    Methods inherited from interface org.ivoa.vodml.jaxb.XmlIdManagement

    getXmlId, hasNaturalKey, setXmlId

  • Field Details

    • sourceCoordinates

      @VoDml(id="proposal:CelestialTarget.sourceCoordinates", role=attribute, type="coords:EquatorialPoint", typeRole=dataType) protected org.ivoa.dm.stc.coords.EquatorialPoint sourceCoordinates
      . : Attribute sourceCoordinates : multiplicity 1

    • positionEpoch

      @VoDml(id="proposal:CelestialTarget.positionEpoch", role=attribute, type="coords:Epoch", typeRole=primitiveType) protected org.ivoa.dm.stc.coords.Epoch positionEpoch
      the epoch at which the position was measured. : Attribute positionEpoch : multiplicity 1

    • pmRA

      @VoDml(id="proposal:CelestialTarget.pmRA", role=attribute, type="ivoa:RealQuantity", typeRole=dataType) protected org.ivoa.dm.ivoa.RealQuantity pmRA
      . : Attribute pmRA : multiplicity 0..1

    • pmDec

      @VoDml(id="proposal:CelestialTarget.pmDec", role=attribute, type="ivoa:RealQuantity", typeRole=dataType) protected org.ivoa.dm.ivoa.RealQuantity pmDec
      . : Attribute pmDec : multiplicity 0..1

    • parallax

      @VoDml(id="proposal:CelestialTarget.parallax", role=attribute, type="ivoa:RealQuantity", typeRole=dataType) protected org.ivoa.dm.ivoa.RealQuantity parallax
      . : Attribute parallax : multiplicity 0..1

    • sourceVelocity

      @VoDml(id="proposal:CelestialTarget.sourceVelocity", role=attribute, type="ivoa:RealQuantity", typeRole=dataType) protected org.ivoa.dm.ivoa.RealQuantity sourceVelocity
      . : Attribute sourceVelocity : multiplicity 0..1

  • Constructor Details

    • CelestialTarget

      public CelestialTarget()
      Creates a new CelestialTarget

    • CelestialTarget

      public CelestialTarget(org.ivoa.dm.stc.coords.EquatorialPoint sourceCoordinates, org.ivoa.dm.stc.coords.Epoch positionEpoch, org.ivoa.dm.ivoa.RealQuantity pmRA, org.ivoa.dm.ivoa.RealQuantity pmDec, org.ivoa.dm.ivoa.RealQuantity parallax, org.ivoa.dm.ivoa.RealQuantity sourceVelocity, String sourceName)
      full parameter constructor.
      Parameters:
      sourceCoordinates - .
      positionEpoch - the epoch at which the position was measured.
      pmRA - .
      pmDec - .
      parallax - .
      sourceVelocity - .
      sourceName - A common name for the source.

    • CelestialTarget

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

    • CelestialTarget

      public CelestialTarget(Target superinstance, org.ivoa.dm.stc.coords.EquatorialPoint sourceCoordinates, org.ivoa.dm.stc.coords.Epoch positionEpoch, org.ivoa.dm.ivoa.RealQuantity pmRA, org.ivoa.dm.ivoa.RealQuantity pmDec, org.ivoa.dm.ivoa.RealQuantity parallax, org.ivoa.dm.ivoa.RealQuantity sourceVelocity)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      sourceCoordinates - .
      positionEpoch - the epoch at which the position was measured.
      pmRA - .
      pmDec - .
      parallax - .
      sourceVelocity - .

  • Method Details

    • copyMe

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

    • updateUsing

      public void updateUsing(CelestialTarget 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.ivoa.dm.stc.coords.EquatorialPoint getSourceCoordinates()
      Returns sourceCoordinates Attribute.
      Returns:
      sourceCoordinates Attribute

    • setSourceCoordinates

      public void setSourceCoordinates(org.ivoa.dm.stc.coords.EquatorialPoint pSourceCoordinates)
      Set sourceCoordinates Attribute.
      Parameters:
      pSourceCoordinates - value to set

    • withSourceCoordinates

      public CelestialTarget withSourceCoordinates(org.ivoa.dm.stc.coords.EquatorialPoint pSourceCoordinates)
      fluent setter for sourceCoordinates Attribute.
      Parameters:
      pSourceCoordinates - value to set
      Returns:
      CelestialTarget

    • getPositionEpoch

      public org.ivoa.dm.stc.coords.Epoch getPositionEpoch()
      Returns positionEpoch Attribute.
      Returns:
      positionEpoch Attribute

    • setPositionEpoch

      public void setPositionEpoch(org.ivoa.dm.stc.coords.Epoch pPositionEpoch)
      Set positionEpoch Attribute.
      Parameters:
      pPositionEpoch - value to set

    • withPositionEpoch

      public CelestialTarget withPositionEpoch(org.ivoa.dm.stc.coords.Epoch pPositionEpoch)
      fluent setter for positionEpoch Attribute.
      Parameters:
      pPositionEpoch - value to set
      Returns:
      CelestialTarget

    • getPmRA

      public org.ivoa.dm.ivoa.RealQuantity getPmRA()
      Returns pmRA Attribute.
      Returns:
      pmRA Attribute

    • setPmRA

      public void setPmRA(org.ivoa.dm.ivoa.RealQuantity pPmRA)
      Set pmRA Attribute.
      Parameters:
      pPmRA - value to set

    • withPmRA

      public CelestialTarget withPmRA(org.ivoa.dm.ivoa.RealQuantity pPmRA)
      fluent setter for pmRA Attribute.
      Parameters:
      pPmRA - value to set
      Returns:
      CelestialTarget

    • getPmDec

      public org.ivoa.dm.ivoa.RealQuantity getPmDec()
      Returns pmDec Attribute.
      Returns:
      pmDec Attribute

    • setPmDec

      public void setPmDec(org.ivoa.dm.ivoa.RealQuantity pPmDec)
      Set pmDec Attribute.
      Parameters:
      pPmDec - value to set

    • withPmDec

      public CelestialTarget withPmDec(org.ivoa.dm.ivoa.RealQuantity pPmDec)
      fluent setter for pmDec Attribute.
      Parameters:
      pPmDec - value to set
      Returns:
      CelestialTarget

    • getParallax

      public org.ivoa.dm.ivoa.RealQuantity getParallax()
      Returns parallax Attribute.
      Returns:
      parallax Attribute

    • setParallax

      public void setParallax(org.ivoa.dm.ivoa.RealQuantity pParallax)
      Set parallax Attribute.
      Parameters:
      pParallax - value to set

    • withParallax

      public CelestialTarget withParallax(org.ivoa.dm.ivoa.RealQuantity pParallax)
      fluent setter for parallax Attribute.
      Parameters:
      pParallax - value to set
      Returns:
      CelestialTarget

    • getSourceVelocity

      public org.ivoa.dm.ivoa.RealQuantity getSourceVelocity()
      Returns sourceVelocity Attribute.
      Returns:
      sourceVelocity Attribute

    • setSourceVelocity

      public void setSourceVelocity(org.ivoa.dm.ivoa.RealQuantity pSourceVelocity)
      Set sourceVelocity Attribute.
      Parameters:
      pSourceVelocity - value to set

    • withSourceVelocity

      public CelestialTarget withSourceVelocity(org.ivoa.dm.ivoa.RealQuantity pSourceVelocity)
      fluent setter for sourceVelocity Attribute.
      Parameters:
      pSourceVelocity - value to set
      Returns:
      CelestialTarget

    • createCelestialTarget

      public static CelestialTarget createCelestialTarget(Consumer<CelestialTarget.CelestialTargetBuilder> f)
      create a CelestialTarget 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 Target

    • persistRefs

      @Deprecated public void persistRefs(jakarta.persistence.EntityManager _em)
      Deprecated.
      generally better to use the model level reference persistence as only this can deal with "contained" references properly.
      Specified by:
      persistRefs in interface org.ivoa.vodml.jpa.JPAManipulations
      Overrides:
      persistRefs in class Target