Package org.ivoa.dm.registry.vodataservice

Class ServiceReference

java.lang.Object

org.ivoa.dm.registry.vodataservice.ServiceReference

All Implemented Interfaces:

org.ivoa.vodml.jpa.JPAManipulations

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

The service URL for a potentially registered service. That is, if an IVOA identifier is also provided, then the service is described in a registry. dataType: ServiceReference

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected IdentifierURI	ivoid	The URI form of the IVOA identifier for the service describing the capability refered to by this element.
protected String	value	.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ServiceReference	createServiceReference(Consumer<ServiceReference.ServiceReferenceBuilder> f)	create a ServiceReference 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(ServiceReference other)	Update this object with the content of the given object.
ServiceReference	withIvoid(IdentifierURI pIvoid)	fluent setter for ivoid Attribute.
ServiceReference	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="VODataService:ServiceReference.value",
       role=attribute,
       type="ivoa:anyURI",
       typeRole=primitiveType)
protected String value

. : Attribute value : multiplicity 1

ivoid

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

The URI form of the IVOA identifier for the service describing the capability refered to by this element. : Attribute ivoid : multiplicity 1

Constructor Details

ServiceReference

public ServiceReference()

Creates a new ServiceReference

ServiceReference

public ServiceReference(String value,
 IdentifierURI ivoid)

full parameter constructor.

Parameters:

value - .

ivoid - The URI form of the IVOA identifier for the service describing the capability refered to by this element.

ServiceReference

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

fluent setter for value Attribute.

Parameters:

pValue - value to set

Returns:

ServiceReference

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 ServiceReference withIvoid(IdentifierURI pIvoid)

fluent setter for ivoid Attribute.

Parameters:

pIvoid - value to set

Returns:

ServiceReference

createServiceReference

public static ServiceReference createServiceReference(Consumer<ServiceReference.ServiceReferenceBuilder> f)

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