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
Modifier and TypeClassDescriptionstatic class
A builder class for CelestialTarget, mainly for use in the functional builder pattern. -
Field Summary
Modifier and TypeFieldDescriptionprotected org.ivoa.dm.ivoa.RealQuantity
.protected org.ivoa.dm.ivoa.RealQuantity
.protected org.ivoa.dm.ivoa.RealQuantity
.protected org.ivoa.dm.stc.coords.Epoch
the epoch at which the position was measured.protected org.ivoa.dm.stc.coords.EquatorialPoint
.protected org.ivoa.dm.ivoa.RealQuantity
.Fields inherited from class org.ivoa.dm.proposal.prop.Target
_id, sourceName
-
Constructor Summary
ConstructorDescriptionCreates a new CelestialTargetCelestialTarget
(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 TypeMethodDescriptioncopyMe()
static CelestialTarget
create a CelestialTarget in functional builder style.void
org.ivoa.dm.ivoa.RealQuantity
Returns parallax Attributeorg.ivoa.dm.ivoa.RealQuantity
getPmDec()
Returns pmDec Attributeorg.ivoa.dm.ivoa.RealQuantity
getPmRA()
Returns pmRA Attributeorg.ivoa.dm.stc.coords.Epoch
Returns positionEpoch Attributeorg.ivoa.dm.stc.coords.EquatorialPoint
Returns sourceCoordinates Attributeorg.ivoa.dm.ivoa.RealQuantity
Returns sourceVelocity Attributevoid
jpaClone
(jakarta.persistence.EntityManager em) void
persistRefs
(jakarta.persistence.EntityManager _em) void
setParallax
(org.ivoa.dm.ivoa.RealQuantity pParallax) Defines parallax Attributevoid
setPmDec
(org.ivoa.dm.ivoa.RealQuantity pPmDec) Defines pmDec Attributevoid
setPmRA
(org.ivoa.dm.ivoa.RealQuantity pPmRA) Defines pmRA Attributevoid
setPositionEpoch
(org.ivoa.dm.stc.coords.Epoch pPositionEpoch) Defines positionEpoch Attributevoid
setSourceCoordinates
(org.ivoa.dm.stc.coords.EquatorialPoint pSourceCoordinates) Defines sourceCoordinates Attributevoid
setSourceVelocity
(org.ivoa.dm.ivoa.RealQuantity pSourceVelocity) Defines sourceVelocity Attributevoid
updateUsing
(CelestialTarget other) Update this object with the content of the given object.withParallax
(org.ivoa.dm.ivoa.RealQuantity pParallax) withPmDec
(org.ivoa.dm.ivoa.RealQuantity pPmDec) withPmRA
(org.ivoa.dm.ivoa.RealQuantity pPmRA) withPositionEpoch
(org.ivoa.dm.stc.coords.Epoch pPositionEpoch) withSourceCoordinates
(org.ivoa.dm.stc.coords.EquatorialPoint pSourceCoordinates) withSourceVelocity
(org.ivoa.dm.ivoa.RealQuantity pSourceVelocity) 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 positionEpochthe 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
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
-
updateUsing
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) Defines sourceCoordinates Attribute- Parameters:
pSourceCoordinates
- value to set
-
withSourceCoordinates
public CelestialTarget withSourceCoordinates(org.ivoa.dm.stc.coords.EquatorialPoint pSourceCoordinates) -
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) Defines positionEpoch Attribute- Parameters:
pPositionEpoch
- value to set
-
withPositionEpoch
-
getPmRA
public org.ivoa.dm.ivoa.RealQuantity getPmRA()Returns pmRA Attribute- Returns:
- pmRA Attribute
-
setPmRA
public void setPmRA(org.ivoa.dm.ivoa.RealQuantity pPmRA) Defines pmRA Attribute- Parameters:
pPmRA
- value to set
-
withPmRA
-
getPmDec
public org.ivoa.dm.ivoa.RealQuantity getPmDec()Returns pmDec Attribute- Returns:
- pmDec Attribute
-
setPmDec
public void setPmDec(org.ivoa.dm.ivoa.RealQuantity pPmDec) Defines pmDec Attribute- Parameters:
pPmDec
- value to set
-
withPmDec
-
getParallax
public org.ivoa.dm.ivoa.RealQuantity getParallax()Returns parallax Attribute- Returns:
- parallax Attribute
-
setParallax
public void setParallax(org.ivoa.dm.ivoa.RealQuantity pParallax) Defines parallax Attribute- Parameters:
pParallax
- value to set
-
withParallax
-
getSourceVelocity
public org.ivoa.dm.ivoa.RealQuantity getSourceVelocity()Returns sourceVelocity Attribute- Returns:
- sourceVelocity Attribute
-
setSourceVelocity
public void setSourceVelocity(org.ivoa.dm.ivoa.RealQuantity pSourceVelocity) Defines sourceVelocity Attribute- Parameters:
pSourceVelocity
- value to set
-
withSourceVelocity
-
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() -
jpaClone
public void jpaClone(jakarta.persistence.EntityManager em) -
persistRefs
public void persistRefs(jakarta.persistence.EntityManager _em) - Specified by:
persistRefs
in interfaceorg.ivoa.vodml.jpa.JPAManipulations
- Overrides:
persistRefs
in classTarget
-