Package org.ivoa.dm.registry.ssa

Class Query

java.lang.Object

org.ivoa.dm.registry.ssa.Query

All Implemented Interfaces:

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

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

A query to be sent to the service. objectType: Query

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	_id	inserted database key
protected PosParam	pos	the center position the search cone given in decimal degrees.
protected String	queryDataCmd	Fully specified test query formatted as an URL argument list in the syntax specified by the SSA standard.
protected Double	size	the size of the search radius.

Constructor Summary

Constructors

Constructor	Description
Query()	Creates a new Query
Query(PosParam pos, Double size, String queryDataCmd)	full parameter constructor.
Query(Query other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
static Query	createQuery(Consumer<Query.QueryBuilder> f)	create a Query in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
Long	getId()
PosParam	getPos()	Returns pos Attribute.
String	getQueryDataCmd()	Returns queryDataCmd Attribute.
Double	getSize()	Returns size Attribute.
void	setPos(PosParam pPos)	Set pos Attribute.
void	setQueryDataCmd(String pQueryDataCmd)	Set queryDataCmd Attribute.
void	setSize(Double pSize)	Set size Attribute.
void	updateUsing(Query other)	Update this object with the content of the given object.
Query	withPos(PosParam pPos)	fluent setter for pos Attribute.
Query	withQueryDataCmd(String pQueryDataCmd)	fluent setter for queryDataCmd Attribute.
Query	withSize(Double pSize)	fluent setter for size 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

pos

@VoDml(id="SSA:Query.pos",
       role=composition,
       type="SSA:PosParam",
       typeRole=objectType)
protected PosParam pos

the center position the search cone given in decimal degrees. composition pos : ( Multiplicity : 0..1 )

size

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

the size of the search radius. : Attribute size : multiplicity 0..1

queryDataCmd

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

Fully specified test query formatted as an URL argument list in the syntax specified by the SSA standard. The list must exclude the REQUEST argument which is assumed to be set to 'queryData'. This value must be in the form of name=value pairs delimited with ampersands. A query may then be formed by appending to the base URL the request argument, 'REQUEST=queryData', followed by the contents of this element. : Attribute queryDataCmd : multiplicity 0..1

Constructor Details

Query

public Query()

Creates a new Query

Query

public Query(PosParam pos,
 Double size,
 String queryDataCmd)

full parameter constructor.

Parameters:

pos - the center position the search cone given in decimal degrees.

size - the size of the search radius.

queryDataCmd - Fully specified test query formatted as an URL argument list in the syntax specified by the SSA standard. The list must exclude the REQUEST argument which is assumed to be set to 'queryData'. This value must be in the form of name=value pairs delimited with ampersands. A query may then be formed by appending to the base URL the request argument, 'REQUEST=queryData', followed by the contents of this element.

Query

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

getPos

public PosParam getPos()

Returns pos Attribute.

Returns:

pos Attribute

setPos

public void setPos(PosParam pPos)

Set pos Attribute.

Parameters:

pPos - value to set

withPos

public Query withPos(PosParam pPos)

fluent setter for pos Attribute.

Parameters:

pPos - value to set

Returns:

Query

getSize

public Double getSize()

Returns size Attribute.

Returns:

size Attribute

setSize

public void setSize(Double pSize)

Set size Attribute.

Parameters:

pSize - value to set

withSize

public Query withSize(Double pSize)

fluent setter for size Attribute.

Parameters:

pSize - value to set

Returns:

Query

getQueryDataCmd

public String getQueryDataCmd()

Returns queryDataCmd Attribute.

Returns:

queryDataCmd Attribute

setQueryDataCmd

public void setQueryDataCmd(String pQueryDataCmd)

Set queryDataCmd Attribute.

Parameters:

pQueryDataCmd - value to set

withQueryDataCmd

public Query withQueryDataCmd(String pQueryDataCmd)

fluent setter for queryDataCmd Attribute.

Parameters:

pQueryDataCmd - value to set

Returns:

Query

createQuery

public static Query createQuery(Consumer<Query.QueryBuilder> f)

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