Class 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

    Defined in the sis-metadata module

    • Constructor Detail

      • 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, since 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 Detail

      • 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);
            }
        
            @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.
      • 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.
      • 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.
      • 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.