Package org.ivoa.dm.registry.standard

Class Standard

java.lang.Object

org.ivoa.dm.registry.voresource.Resource

org.ivoa.dm.registry.standard.Standard

All Implemented Interfaces:

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

Direct Known Subclasses:

ServiceStandard

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

a description of a standard specification. This typically refers to an IVOA standard but is not limited to such. objectType: Standard

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Standard.StandardBuilder	A builder class for Standard, 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 String	deprecated	when present, this element indicates that all versions of the standard are considered deprecated by the publisher.
protected List<EndorsedVersion>	endorsedVersion	the version of the standard that is recommended for use.
protected List<StandardKey>	key	a defined key associated with this standard.
protected List<Schema>	schema	a description and pointer to a schema document defined by this standard.

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
Standard()	Creates a new Standard
Standard(List<EndorsedVersion> endorsedVersion, List<Schema> schema, String deprecated, 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.
Standard(Standard other)	Copy Constructor.
Standard(Resource superinstance, List<EndorsedVersion> endorsedVersion, List<Schema> schema, String deprecated, 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.
void	addToSchema(Schema p)	Add a org.ivoa.dm.registry.standard.Schema to the composition.
Resource	copyMe()	make a clone of the object taking into account current polymorhic type.
static Standard	createStandard(Consumer<Standard.StandardBuilder> f)	create a Standard in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
String	getDeprecated()	Returns deprecated Attribute.
List<EndorsedVersion>	getEndorsedVersion()	Returns endorsedVersion Attribute.
List<StandardKey>	getKey()	Returns key composition as an immutable list.
List<Schema>	getSchema()	Returns schema composition as an immutable list.
void	removeFromKey(StandardKey p)	Remove a org.ivoa.dm.registry.standard.StandardKey from the composition.
void	removeFromSchema(Schema p)	Remove a org.ivoa.dm.registry.standard.Schema from the composition.
void	replaceInKey(StandardKey _p)	update a org.ivoa.dm.registry.standard.StandardKey in the composition.
void	replaceInSchema(Schema _p)	update a org.ivoa.dm.registry.standard.Schema in the composition.
void	setDeprecated(String pDeprecated)	Set deprecated Attribute.
void	setEndorsedVersion(List<EndorsedVersion> pEndorsedVersion)	Set endorsedVersion Attribute.
void	setKey(List<StandardKey> pKey)	Defines whole key composition.
void	setSchema(List<Schema> pSchema)	Defines whole schema composition.
void	updateUsing(Standard other)	Update this object with the content of the given object.
Standard	withDeprecated(String pDeprecated)	fluent setter for deprecated Attribute.
Standard	withEndorsedVersion(List<EndorsedVersion> pEndorsedVersion)	fluent setter for endorsedVersion Attribute.

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

endorsedVersion

@VoDml(id="StandardsRegExt:Standard.endorsedVersion",
       role=attribute,
       type="StandardsRegExt:EndorsedVersion",
       typeRole=dataType)
protected List<EndorsedVersion> endorsedVersion

the version of the standard that is recommended for use. More than one version can be listed, indicating that any of these versions are recognized as acceptable for use. : Attribute endorsedVersion : multiplicity 1..*

schema

@VoDml(id="StandardsRegExt:Standard.schema",
       role=composition,
       type="StandardsRegExt:Schema",
       typeRole=objectType)
protected List<Schema> schema

a description and pointer to a schema document defined by this standard. This is most typically an XML Schema, but it need not be strictly. composition schema : ( Multiplicity : 0..* )

deprecated

@VoDml(id="StandardsRegExt:Standard.deprecated",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String deprecated

when present, this element indicates that all versions of the standard are considered deprecated by the publisher. The value is a human-readable explanation for the designation. The explanation should indicate if another standard should be preferred. : Attribute deprecated : multiplicity 0..1

key

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

a defined key associated with this standard. composition key : ( Multiplicity : 0..* )

Constructor Details

Standard

public Standard()

Creates a new Standard

Standard

public Standard(List<EndorsedVersion> endorsedVersion,
 List<Schema> schema,
 String deprecated,
 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:

endorsedVersion - the version of the standard that is recommended for use. More than one version can be listed, indicating that any of these versions are recognized as acceptable for use.

schema - a description and pointer to a schema document defined by this standard. This is most typically an XML Schema, but it need not be strictly.

deprecated - when present, this element indicates that all versions of the standard are considered deprecated by the publisher. The value is a human-readable explanation for the designation. The explanation should indicate if another standard should be preferred.

key - a defined key associated with this standard.

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.

Standard

public Standard(Standard other)

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

Parameters:

other - the object to be copied.

Standard

public Standard(Resource superinstance,
 List<EndorsedVersion> endorsedVersion,
 List<Schema> schema,
 String deprecated,
 List<StandardKey> key)

Constructor from supertype instance.

Parameters:

superinstance - The supertype.

endorsedVersion - the version of the standard that is recommended for use. More than one version can be listed, indicating that any of these versions are recognized as acceptable for use.

schema - a description and pointer to a schema document defined by this standard. This is most typically an XML Schema, but it need not be strictly.

deprecated - when present, this element indicates that all versions of the standard are considered deprecated by the publisher. The value is a human-readable explanation for the designation. The explanation should indicate if another standard should be preferred.

key - a defined key associated with this standard.

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(Standard 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.

getEndorsedVersion

public List<EndorsedVersion> getEndorsedVersion()

Returns endorsedVersion Attribute.

Returns:

endorsedVersion Attribute

setEndorsedVersion

public void setEndorsedVersion(List<EndorsedVersion> pEndorsedVersion)

Set endorsedVersion Attribute.

Parameters:

pEndorsedVersion - value to set

withEndorsedVersion

public Standard withEndorsedVersion(List<EndorsedVersion> pEndorsedVersion)

fluent setter for endorsedVersion Attribute.

Parameters:

pEndorsedVersion - value to set

Returns:

Standard

getSchema

public List<Schema> getSchema()

Returns schema composition as an immutable list.

Returns:

schema composition.

setSchema

public void setSchema(List<Schema> pSchema)

Defines whole schema composition.

Parameters:

pSchema - composition to set.

addToSchema

public void addToSchema(Schema p)

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

Parameters:

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

removeFromSchema

public void removeFromSchema(Schema p)

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

Parameters:

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

replaceInSchema

public void replaceInSchema(Schema _p)

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

Parameters:

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

getDeprecated

public String getDeprecated()

Returns deprecated Attribute.

Returns:

deprecated Attribute

setDeprecated

public void setDeprecated(String pDeprecated)

Set deprecated Attribute.

Parameters:

pDeprecated - value to set

withDeprecated

public Standard withDeprecated(String pDeprecated)

fluent setter for deprecated Attribute.

Parameters:

pDeprecated - value to set

Returns:

Standard

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

createStandard

public static Standard createStandard(Consumer<Standard.StandardBuilder> f)

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