Class DefaultOperationMetadata

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultOperationMetadata

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object

@TitleProperty(name="operationName")
@UML(identifier="SV_OperationMetadata",
     specification=ISO_19115)
public class DefaultOperationMetadata
extends ISOMetadata

Parameter information. The following properties are mandatory in a well-formed metadata according ISO 19115:

SV_Operation­Metadata ├─operation­Name…………………………………………… A unique identifier for this interface. ├─distributed­Computing­Platform…… Distributed computing platforms on which the operation has been implemented. └─connect­Point……………………………………………… Handle for accessing the service interface. └─linkage………………………………………………… Location for on-line access using a URL address or similar addressing scheme.

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 Operation­Metadata 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

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Operation­Metadata()	Constructs an initially empty operation metadata.
Default­Operation­Metadata(Default­Operation­Metadata object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
Collection<Online­Resource>	get­Connect­Points()	Returns the handle for accessing the service interface.
List<Default­Operation­Metadata>	get­Depends­On()	Returns the list of operation that must be completed immediately before current operation is invoked.
Collection<Code­List<?>>	get­Distributed­Computing­Platforms()	Returns the distributed computing platforms (DCPs) on which the operation has been implemented.
International­String	get­Invocation­Name()	Returns the name used to invoke this interface within the context of the DCP.
International­String	get­Operation­Description()	Returns free text description of the intent of the operation and the results of the operation.
String	get­Operation­Name()	Returns an unique identifier for this interface.
Collection<Parameter­Descriptor<?>>	get­Parameters()	Returns the parameters that are required for this interface.
void	set­Connect­Points(Collection<? extends Online­Resource> new­Value)	Sets the handle for accessing the service interface.
void	set­Depends­On(List<? extends Default­Operation­Metadata> new­Values)	Sets the list of operation that must be completed before current operation is invoked.
void	set­Distributed­Computing­Platforms(Collection<? extends Code­List<?>> new­Values)	Sets the distributed computing platforms on which the operation has been implemented.
void	set­Invocation­Name(International­String new­Value)	Sets the name used to invoke this interface within the context of the DCP.
void	set­Operation­Description(International­String new­Value)	Sets free text description of the intent of the operation and the results of the operation.
void	set­Operation­Name(String new­Value)	Sets the unique identifier for this interface.
void	set­Parameters(Collection<? extends Parameter­Descriptor<?>> new­Values)	Sets the parameters that are required for this interface.

Methods inherited from class ISOMetadata

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

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

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

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

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

Constructor Details

DefaultOperationMetadata

public DefaultOperationMetadata()

Constructs an initially empty operation metadata.

DefaultOperationMetadata

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

getOperationName

@UML(identifier="operationName",
     obligation=MANDATORY,
     specification=ISO_19115)
public String getOperationName()

Returns an unique identifier for this interface.

Returns:

an unique identifier for this interface.

setOperationName

public void setOperationName(String newValue)

Sets the unique identifier for this interface.

Parameters:

new­Value - the new unique identifier for this interface.

getDistributedComputingPlatforms

@UML(identifier="distributedComputingPlatform",
     obligation=MANDATORY,
     specification=ISO_19115)
public Collection<CodeList<?>> getDistributedComputingPlatforms()

Returns the distributed computing platforms (DCPs) on which the operation has been implemented.

Upcoming API change — specialization
The element type will be changed to the Distributed­Computing­Platform code list when GeoAPI will provide it (tentatively in GeoAPI 3.1).

Returns:

distributed computing platforms on which the operation has been implemented.

setDistributedComputingPlatforms

public void setDistributedComputingPlatforms(Collection<? extends CodeList<?>> newValues)

Sets the distributed computing platforms on which the operation has been implemented.

Upcoming API change — specialization
The element type will be changed to the Distributed­Computing­Platform code list when GeoAPI will provide it (tentatively in GeoAPI 3.1). In the meantime, users can define their own code list class as below:

final class UnsupportedCodeList extends CodeList<UnsupportedCodeList> {
    private static final List<UnsupportedCodeList> VALUES = new ArrayList<UnsupportedCodeList>();

    // Need to declare at least one code list element.
    public static final UnsupportedCodeList MY_CODE_LIST = new UnsupportedCodeList("MY_CODE_LIST");

    private UnsupportedCodeList(String name) {
        super(name, VALUES);
    }

    public static UnsupportedCodeList valueOf(String code) {
        return valueOf(UnsupportedCodeList.class, code);
    }

    &#64;Override
    public UnsupportedCodeList[] family() {
        synchronized (VALUES) {
            return VALUES.toArray(new UnsupportedCodeList[VALUES.size()]);
        }
    }
}

Parameters:

new­Values - the new distributed computing platforms on which the operation has been implemented.

getOperationDescription

@UML(identifier="operationDescription",
     obligation=OPTIONAL,
     specification=ISO_19115)
public InternationalString getOperationDescription()

Returns free text description of the intent of the operation and the results of the operation.

Returns:

free text description of the intent of the operation and the results of the operation, or null if none.

setOperationDescription

public void setOperationDescription(InternationalString newValue)

Sets free text description of the intent of the operation and the results of the operation.

Parameters:

new­Value - the new free text description of the intent of the operation and the results of the operation.

getInvocationName

@UML(identifier="invocationName",
     obligation=OPTIONAL,
     specification=ISO_19115)
public InternationalString getInvocationName()

Returns the name used to invoke this interface within the context of the DCP.

Returns:

the name used to invoke this interface within the context of the distributed computing platforms, or null if none.

setInvocationName

public void setInvocationName(InternationalString newValue)

Sets the name used to invoke this interface within the context of the DCP.

Parameters:

new­Value - the new name used to invoke this interface within the context of the DCP.

getConnectPoints

@UML(identifier="connectPoint",
     obligation=MANDATORY,
     specification=ISO_19115)
public Collection<OnlineResource> getConnectPoints()

Returns the handle for accessing the service interface.

Returns:

handle for accessing the service interface.

setConnectPoints

public void setConnectPoints(Collection<? extends OnlineResource> newValue)

Sets the handle for accessing the service interface.

Parameters:

new­Value - the new handle for accessing the service interface.

getParameters

@UML(identifier="parameters",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<ParameterDescriptor<?>> getParameters()

Returns the parameters that are required for this interface.

Unified parameter API

In GeoAPI, the SV_Parameter type defined by ISO 19115 is replaced by Parameter­Descriptor in order to provide a single parameter API. See org.opengis.parameter for more information.

Returns:

the parameters that are required for this interface, or an empty collection if none.

setParameters

public void setParameters(Collection<? extends ParameterDescriptor<?>> newValues)

Sets the parameters that are required for this interface.

Parameters:

new­Values - the new set of parameters that are required for this interface.

getDependsOn

@UML(identifier="dependsOn",
     obligation=OPTIONAL,
     specification=ISO_19115)
public List<DefaultOperationMetadata> getDependsOn()

Returns the list of operation that must be completed immediately before current operation is invoked.

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

Returns:

list of operation that must be completed immediately, or an empty list if none.

setDependsOn

public void setDependsOn(List<? extends DefaultOperationMetadata> newValues)

Sets the list of operation that must be completed before current operation is invoked.

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

Parameters:

new­Values - the new list of operation.