Package org.ivoa.dm.registry.voresource

Class Resource

java.lang.Object

org.ivoa.dm.registry.voresource.Resource

All Implemented Interfaces:

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

Direct Known Subclasses:

DataCollection, Organisation, Service, Standard, StandardKeyEnumeration

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

Any entity or component of a VO application that is describable and identifiable by an IVOA Identifier. objectType: Resource

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	_id	inserted database key
protected List<String>	altIdentifier	A reference to this resource in a non-IVOA identifier scheme, e.g., DOI or bibcode.
protected Content	content	Information regarding the general content of the resource .
protected UTCTimestamp	created	The UTC date and time this resource metadata description was created.
protected Curation	curation	Information regarding the general curation of the resource .
protected IdentifierURI	identifier	Unambiguous reference to the resource conforming to the IVOA standard for identifiers .
protected ShortName	shortName	A short name or abbreviation given to the resource.
protected Resource_status	status	a tag indicating whether this resource is believed to be still actively maintained.
protected String	title	the full name given to the resource .
protected UTCTimestamp	updated	The UTC date this resource metadata description was last updated.
protected List<Validation>	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.
protected String	version	The VOResource XML schema version against which this instance was written.

Constructor Summary

Constructors

Constructor	Description
Resource()	Creates a new Resource
Resource(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.
Resource(Resource other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
Resource	copyMe()	make a clone of the object taking into account current polymorhic type.
static Resource	createResource(Consumer<Resource.ResourceBuilder> f)	create a Resource in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
List<String>	getAltIdentifier()	Returns altIdentifier Attribute.
Content	getContent()	Returns content Attribute.
UTCTimestamp	getCreated()	Returns created Attribute.
Curation	getCuration()	Returns curation Attribute.
Long	getId()
IdentifierURI	getIdentifier()	Returns identifier Attribute.
ShortName	getShortName()	Returns shortName Attribute.
Resource_status	getStatus()	Returns status Attribute.
String	getTitle()	Returns title Attribute.
UTCTimestamp	getUpdated()	Returns updated Attribute.
List<Validation>	getValidationLevel()	Returns validationLevel Attribute.
String	getVersion()	Returns version Attribute.
void	setAltIdentifier(List<String> pAltIdentifier)	Set altIdentifier Attribute.
void	setContent(Content pContent)	Set content Attribute.
void	setCreated(UTCTimestamp pCreated)	Set created Attribute.
void	setCuration(Curation pCuration)	Set curation Attribute.
void	setIdentifier(IdentifierURI pIdentifier)	Set identifier Attribute.
void	setShortName(ShortName pShortName)	Set shortName Attribute.
void	setStatus(Resource_status pStatus)	Set status Attribute.
void	setTitle(String pTitle)	Set title Attribute.
void	setUpdated(UTCTimestamp pUpdated)	Set updated Attribute.
void	setValidationLevel(List<Validation> pValidationLevel)	Set validationLevel Attribute.
void	setVersion(String pVersion)	Set version Attribute.
void	updateUsing(Resource other)	Update this object with the content of the given object.
Resource	withAltIdentifier(List<String> pAltIdentifier)	fluent setter for altIdentifier Attribute.
Resource	withContent(Content pContent)	fluent setter for content Attribute.
Resource	withCreated(UTCTimestamp pCreated)	fluent setter for created Attribute.
Resource	withCuration(Curation pCuration)	fluent setter for curation Attribute.
Resource	withIdentifier(IdentifierURI pIdentifier)	fluent setter for identifier Attribute.
Resource	withShortName(ShortName pShortName)	fluent setter for shortName Attribute.
Resource	withStatus(Resource_status pStatus)	fluent setter for status Attribute.
Resource	withTitle(String pTitle)	fluent setter for title Attribute.
Resource	withUpdated(UTCTimestamp pUpdated)	fluent setter for updated Attribute.
Resource	withValidationLevel(List<Validation> pValidationLevel)	fluent setter for validationLevel Attribute.
Resource	withVersion(String pVersion)	fluent setter for version 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

validationLevel

@VoDml(id="VOResource:Resource.validationLevel",
       role=attribute,
       type="VOResource:Validation",
       typeRole=dataType)
protected List<Validation> 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). : Attribute validationLevel : multiplicity 0..*

title

@VoDml(id="VOResource:Resource.title",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String title

the full name given to the resource . : Attribute title : multiplicity 1

shortName

@VoDml(id="VOResource:Resource.shortName",
       role=attribute,
       type="VOResource:ShortName",
       typeRole=primitiveType)
protected ShortName 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. : Attribute shortName : multiplicity 0..1

identifier

@VoDml(id="VOResource:Resource.identifier",
       role=attribute,
       type="VOResource:IdentifierURI",
       typeRole=primitiveType)
protected IdentifierURI identifier

Unambiguous reference to the resource conforming to the IVOA standard for identifiers . : Attribute identifier : multiplicity 1

altIdentifier

@VoDml(id="VOResource:Resource.altIdentifier",
       role=attribute,
       type="ivoa:anyURI",
       typeRole=primitiveType)
protected List<String> 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. : Attribute altIdentifier : multiplicity 0..*

curation

@VoDml(id="VOResource:Resource.curation",
       role=composition,
       type="VOResource:Curation",
       typeRole=objectType)
protected Curation curation

Information regarding the general curation of the resource . composition curation : ( Multiplicity : 1 )

content

@VoDml(id="VOResource:Resource.content",
       role=composition,
       type="VOResource:Content",
       typeRole=objectType)
protected Content content

Information regarding the general content of the resource . composition content : ( Multiplicity : 1 )

created

@VoDml(id="VOResource:Resource.created",
       role=attribute,
       type="VOResource:UTCTimestamp",
       typeRole=primitiveType)
protected UTCTimestamp 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. : Attribute created : multiplicity 1

updated

@VoDml(id="VOResource:Resource.updated",
       role=attribute,
       type="VOResource:UTCTimestamp",
       typeRole=primitiveType)
protected UTCTimestamp 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. : Attribute updated : multiplicity 1

status

@VoDml(id="VOResource:Resource.status",
       role=attribute,
       type="VOResource:Resource_status",
       typeRole=enumeration)
protected Resource_status status

a tag indicating whether this resource is believed to be still actively maintained. : Attribute status : multiplicity 1

version

@VoDml(id="VOResource:Resource.version",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String 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. : Attribute version : multiplicity 1

Constructor Details

Resource

public Resource()

Creates a new Resource

Resource

public Resource(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:

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.

Resource

public Resource(Resource 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

copyMe

public Resource copyMe()

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

Returns:

the cloned object.

updateUsing

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

getValidationLevel

public List<Validation> getValidationLevel()

Returns validationLevel Attribute.

Returns:

validationLevel Attribute

setValidationLevel

public void setValidationLevel(List<Validation> pValidationLevel)

Set validationLevel Attribute.

Parameters:

pValidationLevel - value to set

withValidationLevel

public Resource withValidationLevel(List<Validation> pValidationLevel)

fluent setter for validationLevel Attribute.

Parameters:

pValidationLevel - value to set

Returns:

Resource

getTitle

public String getTitle()

Returns title Attribute.

Returns:

title Attribute

setTitle

public void setTitle(String pTitle)

Set title Attribute.

Parameters:

pTitle - value to set

withTitle

public Resource withTitle(String pTitle)

fluent setter for title Attribute.

Parameters:

pTitle - value to set

Returns:

Resource

getShortName

public ShortName getShortName()

Returns shortName Attribute.

Returns:

shortName Attribute

setShortName

public void setShortName(ShortName pShortName)

Set shortName Attribute.

Parameters:

pShortName - value to set

withShortName

public Resource withShortName(ShortName pShortName)

fluent setter for shortName Attribute.

Parameters:

pShortName - value to set

Returns:

Resource

getIdentifier

public IdentifierURI getIdentifier()

Returns identifier Attribute.

Returns:

identifier Attribute

setIdentifier

public void setIdentifier(IdentifierURI pIdentifier)

Set identifier Attribute.

Parameters:

pIdentifier - value to set

withIdentifier

public Resource withIdentifier(IdentifierURI pIdentifier)

fluent setter for identifier Attribute.

Parameters:

pIdentifier - value to set

Returns:

Resource

getAltIdentifier

public List<String> getAltIdentifier()

Returns altIdentifier Attribute.

Returns:

altIdentifier Attribute

setAltIdentifier

public void setAltIdentifier(List<String> pAltIdentifier)

Set altIdentifier Attribute.

Parameters:

pAltIdentifier - value to set

withAltIdentifier

public Resource withAltIdentifier(List<String> pAltIdentifier)

fluent setter for altIdentifier Attribute.

Parameters:

pAltIdentifier - value to set

Returns:

Resource

getCuration

public Curation getCuration()

Returns curation Attribute.

Returns:

curation Attribute

setCuration

public void setCuration(Curation pCuration)

Set curation Attribute.

Parameters:

pCuration - value to set

withCuration

public Resource withCuration(Curation pCuration)

fluent setter for curation Attribute.

Parameters:

pCuration - value to set

Returns:

Resource

getContent

public Content getContent()

Returns content Attribute.

Returns:

content Attribute

setContent

public void setContent(Content pContent)

Set content Attribute.

Parameters:

pContent - value to set

withContent

public Resource withContent(Content pContent)

fluent setter for content Attribute.

Parameters:

pContent - value to set

Returns:

Resource

getCreated

public UTCTimestamp getCreated()

Returns created Attribute.

Returns:

created Attribute

setCreated

public void setCreated(UTCTimestamp pCreated)

Set created Attribute.

Parameters:

pCreated - value to set

withCreated

public Resource withCreated(UTCTimestamp pCreated)

fluent setter for created Attribute.

Parameters:

pCreated - value to set

Returns:

Resource

getUpdated

public UTCTimestamp getUpdated()

Returns updated Attribute.

Returns:

updated Attribute

setUpdated

public void setUpdated(UTCTimestamp pUpdated)

Set updated Attribute.

Parameters:

pUpdated - value to set

withUpdated

public Resource withUpdated(UTCTimestamp pUpdated)

fluent setter for updated Attribute.

Parameters:

pUpdated - value to set

Returns:

Resource

getStatus

public Resource_status getStatus()

Returns status Attribute.

Returns:

status Attribute

setStatus

public void setStatus(Resource_status pStatus)

Set status Attribute.

Parameters:

pStatus - value to set

withStatus

public Resource withStatus(Resource_status pStatus)

fluent setter for status Attribute.

Parameters:

pStatus - value to set

Returns:

Resource

getVersion

public String getVersion()

Returns version Attribute.

Returns:

version Attribute

setVersion

public void setVersion(String pVersion)

Set version Attribute.

Parameters:

pVersion - value to set

withVersion

public Resource withVersion(String pVersion)

fluent setter for version Attribute.

Parameters:

pVersion - value to set

Returns:

Resource

createResource

public static Resource createResource(Consumer<Resource.ResourceBuilder> f)

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