Package org.ivoa.dm.caom2

Class Algorithm

java.lang.Object

org.ivoa.dm.caom2.Algorithm

All Implemented Interfaces:

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

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

the algorithm that was responsible for creating the observation; for a DerivedObservation this is the algorithm that defines the intended set of members to include . objectType: Algorithm

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	_id	inserted database key
protected String	name	common name of the algorithm; the value 'exposure' is reserved for use in SimpleObservation; TBD: publish a list of acceptable values as a machine-readable vocabulary?.

Constructor Summary

Constructors

Constructor	Description
Algorithm()	Creates a new Algorithm
Algorithm(String name)	full parameter constructor.
Algorithm(Algorithm other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
static Algorithm	createAlgorithm(Consumer<Algorithm.AlgorithmBuilder> f)	create a Algorithm in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
Long	getId()
String	getName()	Returns name Attribute.
void	setName(String pName)	Set name Attribute.
void	updateUsing(Algorithm other)	Update this object with the content of the given object.
Algorithm	withName(String pName)	fluent setter for name 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

name

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

common name of the algorithm; the value 'exposure' is reserved for use in SimpleObservation; TBD: publish a list of acceptable values as a machine-readable vocabulary?. : Attribute name : multiplicity 1

Constructor Details

Algorithm

public Algorithm()

Creates a new Algorithm

Algorithm

public Algorithm(String name)

full parameter constructor.

Parameters:

name - common name of the algorithm; the value 'exposure' is reserved for use in SimpleObservation; TBD: publish a list of acceptable values as a machine-readable vocabulary?.

Algorithm

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

getName

public String getName()

Returns name Attribute.

Returns:

name Attribute

setName

public void setName(String pName)

Set name Attribute.

Parameters:

pName - value to set

withName

public Algorithm withName(String pName)

fluent setter for name Attribute.

Parameters:

pName - value to set

Returns:

Algorithm

createAlgorithm

public static Algorithm createAlgorithm(Consumer<Algorithm.AlgorithmBuilder> f)

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