Package org.ivoa.dm.caom2

Class TargetPosition

java.lang.Object

org.ivoa.dm.caom2.TargetPosition

All Implemented Interfaces:

org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

@Entity
@VoDml(id="caom2:TargetPosition",
       role=objectType)
public class TargetPosition
extends Object
implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

the intended position of the observation (not the position of the intended or actual target). objectType: TargetPosition

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TargetPosition.TargetPositionBuilder	A builder class for TargetPosition, mainly for use in the functional builder pattern.

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	_id	inserted database key
protected Point	coordinates	the coordinates.
protected String	coordsys	the coordinate system of the coordinates.
protected Double	equinox	the equinox of the coordinates.

Constructor Summary

Constructors

Constructor	Description
TargetPosition()	Creates a new TargetPosition
TargetPosition(String coordsys, Double equinox, Point coordinates)	full parameter constructor.
TargetPosition(TargetPosition other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
static TargetPosition	createTargetPosition(Consumer<TargetPosition.TargetPositionBuilder> f)	create a TargetPosition in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
Point	getCoordinates()	Returns coordinates Attribute.
String	getCoordsys()	Returns coordsys Attribute.
Double	getEquinox()	Returns equinox Attribute.
Long	getId()
void	setCoordinates(Point pCoordinates)	Set coordinates Attribute.
void	setCoordsys(String pCoordsys)	Set coordsys Attribute.
void	setEquinox(Double pEquinox)	Set equinox Attribute.
void	updateUsing(TargetPosition other)	Update this object with the content of the given object.
TargetPosition	withCoordinates(Point pCoordinates)	fluent setter for coordinates Attribute.
TargetPosition	withCoordsys(String pCoordsys)	fluent setter for coordsys Attribute.
TargetPosition	withEquinox(Double pEquinox)	fluent setter for equinox Attribute.

Methods inherited from class java.lang.Object

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

Field Details

_id

protected Long _id

inserted database key

coordsys

@VoDml(id="caom2:TargetPosition.coordsys",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String coordsys

the coordinate system of the coordinates. : Attribute coordsys : multiplicity 1

equinox

@VoDml(id="caom2:TargetPosition.equinox",
       role=attribute,
       type="ivoa:real",
       typeRole=primitiveType)
protected Double equinox

the equinox of the coordinates. : Attribute equinox : multiplicity 0..1

coordinates

@VoDml(id="caom2:TargetPosition.coordinates",
       role=composition,
       type="caom2:types.Point",
       typeRole=objectType)
protected Point coordinates

the coordinates. composition coordinates : ( Multiplicity : 1 )

Constructor Details

TargetPosition

public TargetPosition()

Creates a new TargetPosition

TargetPosition

public TargetPosition(String coordsys,
 Double equinox,
 Point coordinates)

full parameter constructor.

Parameters:

coordsys - the coordinate system of the coordinates.

equinox - the equinox of the coordinates.

coordinates - the coordinates.

TargetPosition

public TargetPosition(TargetPosition 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(TargetPosition 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.

getCoordsys

public String getCoordsys()

Returns coordsys Attribute.

Returns:

coordsys Attribute

setCoordsys

public void setCoordsys(String pCoordsys)

Set coordsys Attribute.

Parameters:

pCoordsys - value to set

withCoordsys

public TargetPosition withCoordsys(String pCoordsys)

fluent setter for coordsys Attribute.

Parameters:

pCoordsys - value to set

Returns:

TargetPosition

getEquinox

public Double getEquinox()

Returns equinox Attribute.

Returns:

equinox Attribute

setEquinox

public void setEquinox(Double pEquinox)

Set equinox Attribute.

Parameters:

pEquinox - value to set

withEquinox

public TargetPosition withEquinox(Double pEquinox)

fluent setter for equinox Attribute.

Parameters:

pEquinox - value to set

Returns:

TargetPosition

getCoordinates

public Point getCoordinates()

Returns coordinates Attribute.

Returns:

coordinates Attribute

setCoordinates

public void setCoordinates(Point pCoordinates)

Set coordinates Attribute.

Parameters:

pCoordinates - value to set

withCoordinates

public TargetPosition withCoordinates(Point pCoordinates)

fluent setter for coordinates Attribute.

Parameters:

pCoordinates - value to set

Returns:

TargetPosition

createTargetPosition

public static TargetPosition createTargetPosition(Consumer<TargetPosition.TargetPositionBuilder> f)

create a TargetPosition 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>