Package org.ivoa.dm.registry.ssa

Class PosParam

java.lang.Object

org.ivoa.dm.registry.ssa.PosParam

All Implemented Interfaces:

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

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

a position in the sky to search. objectType: PosParam

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	_id	inserted database key
protected Double	lat	The latitude (e.g.
protected Double	long_	The longitude (e.g.
protected String	refframe	the coordinate system reference frame name indicating the frame to assume for the given position.

Constructor Summary

Constructors

Constructor	Description
PosParam()	Creates a new PosParam
PosParam(Double long_, Double lat, String refframe)	full parameter constructor.
PosParam(PosParam other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
static PosParam	createPosParam(Consumer<PosParam.PosParamBuilder> f)	create a PosParam in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
Long	getId()
Double	getLat()	Returns lat Attribute.
Double	getLong()	Returns long Attribute.
String	getRefframe()	Returns refframe Attribute.
void	setLat(Double pLat)	Set lat Attribute.
void	setLong(Double pLong)	Set long Attribute.
void	setRefframe(String pRefframe)	Set refframe Attribute.
void	updateUsing(PosParam other)	Update this object with the content of the given object.
PosParam	withLat(Double pLat)	fluent setter for lat Attribute.
PosParam	withLong(Double pLong)	fluent setter for long Attribute.
PosParam	withRefframe(String pRefframe)	fluent setter for refframe 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

long_

@VoDml(id="SSA:PosParam.long",
       role=attribute,
       type="ivoa:real",
       typeRole=primitiveType)
protected Double long_

The longitude (e.g. Right Ascension) of the center of the search position in decimal degrees. : Attribute long_ : multiplicity 1

lat

@VoDml(id="SSA:PosParam.lat",
       role=attribute,
       type="ivoa:real",
       typeRole=primitiveType)
protected Double lat

The latitude (e.g. Declination) of the center of the search position in decimal degrees. : Attribute lat : multiplicity 1

refframe

@VoDml(id="SSA:PosParam.refframe",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String refframe

the coordinate system reference frame name indicating the frame to assume for the given position. If not provided, ICRS is assumed. : Attribute refframe : multiplicity 0..1

Constructor Details

PosParam

public PosParam()

Creates a new PosParam

PosParam

public PosParam(Double long_,
 Double lat,
 String refframe)

full parameter constructor.

Parameters:

long_ - The longitude (e.g. Right Ascension) of the center of the search position in decimal degrees.

lat - The latitude (e.g. Declination) of the center of the search position in decimal degrees.

refframe - the coordinate system reference frame name indicating the frame to assume for the given position. If not provided, ICRS is assumed.

PosParam

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

getLong

public Double getLong()

Returns long Attribute.

Returns:

long Attribute

setLong

public void setLong(Double pLong)

Set long Attribute.

Parameters:

pLong - value to set

withLong

public PosParam withLong(Double pLong)

fluent setter for long Attribute.

Parameters:

pLong - value to set

Returns:

PosParam

getLat

public Double getLat()

Returns lat Attribute.

Returns:

lat Attribute

setLat

public void setLat(Double pLat)

Set lat Attribute.

Parameters:

pLat - value to set

withLat

public PosParam withLat(Double pLat)

fluent setter for lat Attribute.

Parameters:

pLat - value to set

Returns:

PosParam

getRefframe

public String getRefframe()

Returns refframe Attribute.

Returns:

refframe Attribute

setRefframe

public void setRefframe(String pRefframe)

Set refframe Attribute.

Parameters:

pRefframe - value to set

withRefframe

public PosParam withRefframe(String pRefframe)

fluent setter for refframe Attribute.

Parameters:

pRefframe - value to set

Returns:

PosParam

createPosParam

public static PosParam createPosParam(Consumer<PosParam.PosParamBuilder> f)

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