Package org.ivoa.dm.proposal.prop.coords

Class CartesianPoint

java.lang.Object

org.ivoa.dm.proposal.prop.coords.CartesianPoint

All Implemented Interfaces:

org.ivoa.vodml.jpa.JPAManipulations

@Embeddable
@VoDml(id="proposal:coords.CartesianPoint",
       role=dataType)
public class CartesianPoint
extends Object
implements org.ivoa.vodml.jpa.JPAManipulations

.

dataType: CartesianPoint

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected String	refpos	The reference position for this coordinate system.
protected org.ivoa.dm.ivoa.RealQuantity	x	x coord.
protected org.ivoa.dm.ivoa.RealQuantity	y	y coord.
protected org.ivoa.dm.ivoa.RealQuantity	z	z coord.

Constructor Summary

Constructors

Constructor	Description
CartesianPoint()	Creates a new CartesianPoint
CartesianPoint(org.ivoa.dm.ivoa.RealQuantity x, org.ivoa.dm.ivoa.RealQuantity y, org.ivoa.dm.ivoa.RealQuantity z, String refpos)	full parameter constructor.
CartesianPoint(CartesianPoint other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
static CartesianPoint	createCartesianPoint(Consumer<CartesianPoint.CartesianPointBuilder> f)	create a CartesianPoint in functional builder style.
boolean	equals(Object o_)
void	forceLoad()
String	getRefpos()	Returns refpos Attribute.
org.ivoa.dm.ivoa.RealQuantity	getX()	Returns x Attribute.
org.ivoa.dm.ivoa.RealQuantity	getY()	Returns y Attribute.
org.ivoa.dm.ivoa.RealQuantity	getZ()	Returns z Attribute.
int	hashCode()
void	setRefpos(String pRefpos)	Set refpos Attribute.
void	setX(org.ivoa.dm.ivoa.RealQuantity pX)	Set x Attribute.
void	setY(org.ivoa.dm.ivoa.RealQuantity pY)	Set y Attribute.
void	setZ(org.ivoa.dm.ivoa.RealQuantity pZ)	Set z Attribute.
void	updateUsing(CartesianPoint other)	Update this object with the content of the given object.
CartesianPoint	withRefpos(String pRefpos)	fluent setter for refpos Attribute.
CartesianPoint	withX(org.ivoa.dm.ivoa.RealQuantity pX)	fluent setter for x Attribute.
CartesianPoint	withY(org.ivoa.dm.ivoa.RealQuantity pY)	fluent setter for y Attribute.
CartesianPoint	withZ(org.ivoa.dm.ivoa.RealQuantity pZ)	fluent setter for z Attribute.

Methods inherited from class java.lang.Object

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

Field Details

x

@VoDml(id="proposal:coords.CartesianPoint.x",
       role=attribute,
       type="ivoa:RealQuantity",
       typeRole=dataType)
protected org.ivoa.dm.ivoa.RealQuantity x

x coord. : Attribute x type ivoa:RealQuantity : multiplicity 1

y

@VoDml(id="proposal:coords.CartesianPoint.y",
       role=attribute,
       type="ivoa:RealQuantity",
       typeRole=dataType)
protected org.ivoa.dm.ivoa.RealQuantity y

y coord. : Attribute y type ivoa:RealQuantity : multiplicity 1

z

@VoDml(id="proposal:coords.CartesianPoint.z",
       role=attribute,
       type="ivoa:RealQuantity",
       typeRole=dataType)
protected org.ivoa.dm.ivoa.RealQuantity z

z coord. : Attribute z type ivoa:RealQuantity : multiplicity 1

refpos

@VoDml(id="proposal:coords.CartesianPoint.refpos",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String refpos

The reference position for this coordinate system. : Attribute refpos type ivoa:string : multiplicity 1

Constructor Details

CartesianPoint

public CartesianPoint()

Creates a new CartesianPoint

CartesianPoint

public CartesianPoint(org.ivoa.dm.ivoa.RealQuantity x,
 org.ivoa.dm.ivoa.RealQuantity y,
 org.ivoa.dm.ivoa.RealQuantity z,
 String refpos)

full parameter constructor.

Parameters:

x - x coord.

y - y coord.

z - z coord.

refpos - The reference position for this coordinate system.

CartesianPoint

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

getX

public org.ivoa.dm.ivoa.RealQuantity getX()

Returns x Attribute.

Returns:

x Attribute

setX

public void setX(org.ivoa.dm.ivoa.RealQuantity pX)

Set x Attribute.

Parameters:

pX - value to set

withX

public CartesianPoint withX(org.ivoa.dm.ivoa.RealQuantity pX)

fluent setter for x Attribute.

Parameters:

pX - value to set

Returns:

CartesianPoint

getY

public org.ivoa.dm.ivoa.RealQuantity getY()

Returns y Attribute.

Returns:

y Attribute

setY

public void setY(org.ivoa.dm.ivoa.RealQuantity pY)

Set y Attribute.

Parameters:

pY - value to set

withY

public CartesianPoint withY(org.ivoa.dm.ivoa.RealQuantity pY)

fluent setter for y Attribute.

Parameters:

pY - value to set

Returns:

CartesianPoint

getZ

public org.ivoa.dm.ivoa.RealQuantity getZ()

Returns z Attribute.

Returns:

z Attribute

setZ

public void setZ(org.ivoa.dm.ivoa.RealQuantity pZ)

Set z Attribute.

Parameters:

pZ - value to set

withZ

public CartesianPoint withZ(org.ivoa.dm.ivoa.RealQuantity pZ)

fluent setter for z Attribute.

Parameters:

pZ - value to set

Returns:

CartesianPoint

getRefpos

public String getRefpos()

Returns refpos Attribute.

Returns:

refpos Attribute

setRefpos

public void setRefpos(String pRefpos)

Set refpos Attribute.

Parameters:

pRefpos - value to set

withRefpos

public CartesianPoint withRefpos(String pRefpos)

fluent setter for refpos Attribute.

Parameters:

pRefpos - value to set

Returns:

CartesianPoint

createCartesianPoint

public static CartesianPoint createCartesianPoint(Consumer<CartesianPoint.CartesianPointBuilder> f)

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