Module org.apache.sis.metadata

Package org.apache.sis.metadata.iso.identification

Class DefaultCoupledResource

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultCoupledResource

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object

@UML(identifier="SV_CoupledResource",
     specification=ISO_19115)
public class DefaultCoupledResource
extends ISOMetadata

Links a given operation name with a resource identified by an "identifier".

Note on International Standard versions
This class is derived from a new type defined in the ISO 19115 international standard published in 2014, while GeoAPI 3.0 is based on the version published in 2003. Consequently this implementation class does not yet implement a GeoAPI interface, but is expected to do so after the next GeoAPI releases. When the interface will become available, all references to this implementation class in Apache SIS will be replaced be references to the Coupled­Resource interface.

Limitations

• Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
• Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.

Since:

0.5

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor	Description
Default­Coupled­Resource()	Constructs an initially empty coupled resource.
Default­Coupled­Resource(Default­Coupled­Resource object)	Constructs a new instance initialized with the values from the specified metadata object.
Default­Coupled­Resource(Scoped­Name name, Citation reference, Data­Identification resource, Default­Operation­Metadata operation)	Constructs a new coupled resource initialized to the specified values.

Method Summary

Modifier and Type	Method	Description
Default­Operation­Metadata	get­Operation()	Returns the service operation.
Collection<Citation>	get­Resource­References()	Returns references to the resource on which the services operates.
Collection<Data­Identification>	get­Resources()	Returns the tightly coupled resources.
Scoped­Name	get­Scoped­Name()	Returns scoped identifier of the resource in the context of the given service instance.
void	set­Operation(Default­Operation­Metadata new­Value)	Sets a new service operation.
void	set­Resource­References(Collection<? extends Citation> new­Values)	Sets references to the resource on which the services operates.
void	set­Resources(Collection<? extends Data­Identification> new­Values)	Sets the tightly coupled resources.
void	set­Scoped­Name(Scoped­Name new­Value)	Sets the identifier of the resource in the context of the given service instance.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier, transition­To

Methods inherited from class ModifiableMetadata

check­Write­Permission, collection­Type, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultCoupledResource

public DefaultCoupledResource()

Constructs an initially empty coupled resource.

DefaultCoupledResource

public DefaultCoupledResource(ScopedName name,
 Citation reference,
 DataIdentification resource,
 DefaultOperationMetadata operation)

Constructs a new coupled resource initialized to the specified values.

Parameters:

name - scoped identifier of the resource in the context of the given service instance.

reference - reference to the reference to the resource on which the services operates.

resource - the tightly coupled resource.

operation - the service operation.

DefaultCoupledResource

public DefaultCoupledResource(DefaultCoupledResource object)

Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.

Parameters:

object - the metadata to copy values from, or null if none.

Method Details

getScopedName

@UML(identifier="scopedName",
     obligation=OPTIONAL,
     specification=ISO_19115)
public ScopedName getScopedName()

Returns scoped identifier of the resource in the context of the given service instance.

Returns:

identifier of the resource, or null if none.

setScopedName

public void setScopedName(ScopedName newValue)

Sets the identifier of the resource in the context of the given service instance.

Parameters:

new­Value - the new identifier of the resource.

getResourceReferences

@UML(identifier="resourceReference",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<Citation> getResourceReferences()

Returns references to the resource on which the services operates.

Returns:

references to the resource on which the services operates.

setResourceReferences

public void setResourceReferences(Collection<? extends Citation> newValues)

Sets references to the resource on which the services operates.

Parameters:

new­Values - the new references to the resource on which the services operates.

getResources

@UML(identifier="resource",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<DataIdentification> getResources()

Returns the tightly coupled resources.

Returns:

tightly coupled resources.

setResources

public void setResources(Collection<? extends DataIdentification> newValues)

Sets the tightly coupled resources.

Parameters:

new­Values - the new tightly coupled resources.

getOperation

@UML(identifier="operation",
     obligation=OPTIONAL,
     specification=ISO_19115)
public DefaultOperationMetadata getOperation()

Returns the service operation.

Upcoming API change — generalization
The return type will be changed to the Operation­Metadata interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).

Returns:

the service operation, or null if none.

setOperation

public void setOperation(DefaultOperationMetadata newValue)

Sets a new service operation.

Upcoming API change — generalization
The argument type will be changed to the Operation­Metadata interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).

Parameters:

new­Value - the new service operation.