Package org.ivoa.dm.registry.voresource

Class ResourceName

java.lang.Object

org.ivoa.dm.registry.voresource.ResourceName

All Implemented Interfaces:

org.ivoa.vodml.jpa.JPAManipulations

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

The name of a potentially registered resource. That is, the entity referred to may have an associated identifier. dataType: ResourceName

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected IdentifierURI	ivoid	The IVOA identifier for the resource referred to.
protected String	value	.

Constructor Summary

Constructors

Constructor	Description
ResourceName()	Creates a new ResourceName
ResourceName(String value, IdentifierURI ivoid)	full parameter constructor.
ResourceName(ResourceName other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
static ResourceName	createResourceName(Consumer<ResourceName.ResourceNameBuilder> f)	create a ResourceName in functional builder style.
void	forceLoad()
IdentifierURI	getIvoid()	Returns ivoid Attribute.
String	getValue()	Returns value Attribute.
void	setIvoid(IdentifierURI pIvoid)	Set ivoid Attribute.
void	setValue(String pValue)	Set value Attribute.
void	updateUsing(ResourceName other)	Update this object with the content of the given object.
ResourceName	withIvoid(IdentifierURI pIvoid)	fluent setter for ivoid Attribute.
ResourceName	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:ResourceName.value",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String value

. : Attribute value : multiplicity 1

ivoid

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

The IVOA identifier for the resource referred to. : Attribute ivoid : multiplicity 1

Constructor Details

ResourceName

public ResourceName()

Creates a new ResourceName

ResourceName

public ResourceName(String value,
 IdentifierURI ivoid)

full parameter constructor.

Parameters:

value - .

ivoid - The IVOA identifier for the resource referred to.

ResourceName

public ResourceName(ResourceName 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(ResourceName 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 ResourceName withValue(String pValue)

fluent setter for value Attribute.

Parameters:

pValue - value to set

Returns:

ResourceName

getIvoid

public IdentifierURI getIvoid()

Returns ivoid Attribute.

Returns:

ivoid Attribute

setIvoid

public void setIvoid(IdentifierURI pIvoid)

Set ivoid Attribute.

Parameters:

pIvoid - value to set

withIvoid

public ResourceName withIvoid(IdentifierURI pIvoid)

fluent setter for ivoid Attribute.

Parameters:

pIvoid - value to set

Returns:

ResourceName

createResourceName

public static ResourceName createResourceName(Consumer<ResourceName.ResourceNameBuilder> f)

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