Package org.ivoa.dm.registry.voresource

Class Rights

java.lang.Object

org.ivoa.dm.registry.voresource.Rights

All Implemented Interfaces:

org.ivoa.vodml.jpa.JPAManipulations

@Embeddable
@VoDml(id="VOResource:Rights",
       role=dataType)
public class Rights
extends Object
implements org.ivoa.vodml.jpa.JPAManipulations

A statement of usage conditions. This will typically include a license, which should be given as a full string (e.g., Creative Commons Attribution 3.0 International). Further free-text information, e.g., on how to attribute or on embargo periods is allowed. dataType: Rights

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected String	rightsURI	A URI identifier for a license Where formal licenses are available, this URI can reference the full license text.
protected String	value	.

Constructor Summary

Constructors

Constructor	Description
Rights()	Creates a new Rights
Rights(String value, String rightsURI)	full parameter constructor.
Rights(Rights other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
static Rights	createRights(Consumer<Rights.RightsBuilder> f)	create a Rights in functional builder style.
void	forceLoad()
String	getRightsURI()	Returns rightsURI Attribute.
String	getValue()	Returns value Attribute.
void	setRightsURI(String pRightsURI)	Set rightsURI Attribute.
void	setValue(String pValue)	Set value Attribute.
void	updateUsing(Rights other)	Update this object with the content of the given object.
Rights	withRightsURI(String pRightsURI)	fluent setter for rightsURI Attribute.
Rights	withValue(String pValue)	fluent setter for value Attribute.

Methods inherited from class java.lang.Object

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

Field Details

value

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

. : Attribute value : multiplicity 1

rightsURI

@VoDml(id="VOResource:Rights.rightsURI",
       role=attribute,
       type="ivoa:anyURI",
       typeRole=primitiveType)
protected String rightsURI

A URI identifier for a license Where formal licenses are available, this URI can reference the full license text. The IVOA may define standard URIs for a set of recommended licenses, in which case these should be used here. : Attribute rightsURI : multiplicity 1

Constructor Details

Rights

public Rights()

Creates a new Rights

Rights

public Rights(String value,
 String rightsURI)

full parameter constructor.

Parameters:

value - .

rightsURI - A URI identifier for a license Where formal licenses are available, this URI can reference the full license text. The IVOA may define standard URIs for a set of recommended licenses, in which case these should be used here.

Rights

public Rights(Rights other)

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

Parameters:

other - the object to be copied.

Method Details

updateUsing

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

getValue

public String getValue()

Returns value Attribute.

Returns:

value Attribute

setValue

public void setValue(String pValue)

Set value Attribute.

Parameters:

pValue - value to set

withValue

public Rights withValue(String pValue)

fluent setter for value Attribute.

Parameters:

pValue - value to set

Returns:

Rights

getRightsURI

public String getRightsURI()

Returns rightsURI Attribute.

Returns:

rightsURI Attribute

setRightsURI

public void setRightsURI(String pRightsURI)

Set rightsURI Attribute.

Parameters:

pRightsURI - value to set

withRightsURI

public Rights withRightsURI(String pRightsURI)

fluent setter for rightsURI Attribute.

Parameters:

pRightsURI - value to set

Returns:

Rights

createRights

public static Rights createRights(Consumer<Rights.RightsBuilder> f)

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