Package org.ivoa.dm.registry.standard

Class StandardKeyEnumeration

java.lang.Object

org.ivoa.dm.registry.voresource.Resource

org.ivoa.dm.registry.standard.StandardKeyEnumeration

All Implemented Interfaces:

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

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

A registered set of related keys. Each key can be uniquely identified by combining the IVOA identifier of this resource with the key name separated by the URI fragment delimiter, #, as in: ivoa-identifier#key-name. objectType: StandardKeyEnumeration

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.ivoa.dm.registry.voresource.Resource

Resource.ResourceBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected List<StandardKey>	key	the name and definition of a key--a named concept, feature, or property.

Fields inherited from class org.ivoa.dm.registry.voresource.Resource

_id, altIdentifier, content, created, curation, identifier, shortName, status, title, updated, validationLevel, version

Constructor Summary

Constructors

Constructor	Description
StandardKeyEnumeration()	Creates a new StandardKeyEnumeration
StandardKeyEnumeration(List<StandardKey> key, List<Validation> validationLevel, String title, ShortName shortName, IdentifierURI identifier, List<String> altIdentifier, Curation curation, Content content, UTCTimestamp created, UTCTimestamp updated, Resource_status status, String version)	full parameter constructor.
StandardKeyEnumeration(StandardKeyEnumeration other)	Copy Constructor.
StandardKeyEnumeration(Resource superinstance, List<StandardKey> key)	Constructor from supertype instance.

Method Summary

Modifier and Type	Method	Description
void	addToKey(StandardKey p)	Add a org.ivoa.dm.registry.standard.StandardKey to the composition.
Resource	copyMe()	make a clone of the object taking into account current polymorhic type.
static StandardKeyEnumeration	createStandardKeyEnumeration(Consumer<StandardKeyEnumeration.StandardKeyEnumerationBuilder> f)	create a StandardKeyEnumeration in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
List<StandardKey>	getKey()	Returns key composition as an immutable list.
void	removeFromKey(StandardKey p)	Remove a org.ivoa.dm.registry.standard.StandardKey from the composition.
void	replaceInKey(StandardKey _p)	update a org.ivoa.dm.registry.standard.StandardKey in the composition.
void	setKey(List<StandardKey> pKey)	Defines whole key composition.
void	updateUsing(StandardKeyEnumeration other)	Update this object with the content of the given object.

Methods inherited from class org.ivoa.dm.registry.voresource.Resource

createResource, getAltIdentifier, getContent, getCreated, getCuration, getId, getIdentifier, getShortName, getStatus, getTitle, getUpdated, getValidationLevel, getVersion, setAltIdentifier, setContent, setCreated, setCuration, setIdentifier, setShortName, setStatus, setTitle, setUpdated, setValidationLevel, setVersion, updateUsing, withAltIdentifier, withContent, withCreated, withCuration, withIdentifier, withShortName, withStatus, withTitle, withUpdated, withValidationLevel, withVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType

getId

Field Details

key

@VoDml(id="StandardsRegExt:StandardKeyEnumeration.key",
       role=composition,
       type="StandardsRegExt:StandardKey",
       typeRole=objectType)
protected List<StandardKey> key

the name and definition of a key--a named concept, feature, or property. composition key : ( Multiplicity : 1..* )

Constructor Details

StandardKeyEnumeration

public StandardKeyEnumeration()

Creates a new StandardKeyEnumeration

StandardKeyEnumeration

public StandardKeyEnumeration(List<StandardKey> key,
 List<Validation> validationLevel,
 String title,
 ShortName shortName,
 IdentifierURI identifier,
 List<String> altIdentifier,
 Curation curation,
 Content content,
 UTCTimestamp created,
 UTCTimestamp updated,
 Resource_status status,
 String version)

full parameter constructor.

Parameters:

key - the name and definition of a key--a named concept, feature, or property.

validationLevel - A numeric grade describing the quality of the resource description, when applicable, to be used to indicate the confidence an end-user can put in the resource as part of a VO application or research study. See VOResource:Validation for an explanation of the allowed levels. Note that when this resource is a Service, this grade applies to the core set of metadata. Capability and interface metadata, as well as the compliance of the service with the interface standard, is rated by validationLevel tag in the capability element (see the VOResource:Service complex type).

title - the full name given to the resource .

shortName - A short name or abbreviation given to the resource. This name will be used where brief annotations for the resource name are required. Applications may use to refer to this resource in a compact display. One word or a few letters is recommended. No more than sixteen characters are allowed.

identifier - Unambiguous reference to the resource conforming to the IVOA standard for identifiers .

altIdentifier - A reference to this resource in a non-IVOA identifier scheme, e.g., DOI or bibcode. Always use the an URI scheme here, e.g., doi:10.1016/j.epsl.2011.11.037. For bibcodes, use a form like bibcode:2008ivoa.spec.0222P.

curation - Information regarding the general curation of the resource .

content - Information regarding the general content of the resource .

created - The UTC date and time this resource metadata description was created. This timestamp must not be in the future. This time is not required to be accurate; it should be at least accurate to the day. Any non-significant time fields should be set to zero.

updated - The UTC date this resource metadata description was last updated. This timestamp must not be in the future. This time is not required to be accurate; it should be at least accurate to the day. Any non-significant time fields should be set to zero.

status - a tag indicating whether this resource is believed to be still actively maintained.

version - The VOResource XML schema version against which this instance was written. Implementors should set this to the value of the version attribute of their schema's root (xs:schema) element. Clients may assume version 1.0 if this attribute is missing.

StandardKeyEnumeration

public StandardKeyEnumeration(StandardKeyEnumeration other)

Copy Constructor. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

StandardKeyEnumeration

public StandardKeyEnumeration(Resource superinstance,
 List<StandardKey> key)

Constructor from supertype instance.

Parameters:

superinstance - The supertype.

key - the name and definition of a key--a named concept, feature, or property.

Method Details

copyMe

public Resource copyMe()

make a clone of the object taking into account current polymorhic type.

Overrides:

copyMe in class Resource

Returns:

the cloned object.

updateUsing

public void updateUsing(StandardKeyEnumeration 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.

getKey

public List<StandardKey> getKey()

Returns key composition as an immutable list.

Returns:

key composition.

setKey

public void setKey(List<StandardKey> pKey)

Defines whole key composition.

Parameters:

pKey - composition to set.

addToKey

public void addToKey(StandardKey p)

Add a org.ivoa.dm.registry.standard.StandardKey to the composition.

Parameters:

p - org.ivoa.dm.registry.standard.StandardKey to add

removeFromKey

public void removeFromKey(StandardKey p)

Remove a org.ivoa.dm.registry.standard.StandardKey from the composition.

Parameters:

p - org.ivoa.dm.registry.standard.StandardKey to remove

replaceInKey

public void replaceInKey(StandardKey _p)

update a org.ivoa.dm.registry.standard.StandardKey in the composition.

Parameters:

_p - org.ivoa.dm.registry.standard.StandardKey to update the match is done via the database key

createStandardKeyEnumeration

public static StandardKeyEnumeration createStandardKeyEnumeration(Consumer<StandardKeyEnumeration.StandardKeyEnumerationBuilder> f)

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

Overrides:

forceLoad in class Resource

delete

public void delete(jakarta.persistence.EntityManager em)

Specified by:

delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

Overrides:

delete in class Resource