Class DefaultServiceIdentification

  • All Implemented Interfaces:
    Serializable, Emptiable, Lenient­Comparable, Identified­Object, Identification, Service­Identification

    public class DefaultServiceIdentification
    extends AbstractIdentification
    implements ServiceIdentification
    Identification of capabilities which a service provider makes available to a service user through a set of interfaces that define a behaviour. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:
    SV_Service­Identification   ├─citation……………………………………… Citation data for the resource(s).   │   ├─title…………………………………… Name by which the cited resource is known.   │   └─date……………………………………… Reference date for the cited resource.   ├─abstract……………………………………… Brief narrative summary of the content of the resource(s).   ├─service­Type……………………………… A service type name. For example: "view", "download", or "invoke".   ├─coupled­Resource…………………… Further description of the data coupling in the case of tightly coupled services.   ├─coupling­Type…………………………… Type of coupling between service and associated data (if exist).   ├─extent…………………………………………… Bounding polygon, vertical, and temporal extent of the dataset.   │   ├─description…………………… The spatial and temporal extent for the referring object.   │   ├─geographic­Element…… Geographic component of the extent of the referring object.   │   ├─temporal­Element………… Temporal component of the extent of the referring object.   │   └─vertical­Element………… Vertical component of the extent of the referring object.   └─topic­Category………………………… Main theme(s) of the dataset.

    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

      • DefaultServiceIdentification

        public DefaultServiceIdentification()
        Constructs an initially empty service identification.
      • DefaultServiceIdentification

        public DefaultServiceIdentification​(GenericName serviceType,
                                            Citation citation,
                                            CharSequence abstracts)
        Constructs a service identification initialized to the specified values.
        Parameters:
        service­Type - service type name.
        citation - citation data for the resource(s).
        abstracts - brief narrative summary of the content of the resource(s).
      • DefaultServiceIdentification

        public DefaultServiceIdentification​(ServiceIdentification 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.
        See Also:
        cast­Or­Copy(Service­Identification)
    • Method Detail

      • castOrCopy

        public static DefaultServiceIdentification castOrCopy​(ServiceIdentification object)
        Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:
        • If the given object is null, then this method returns null.
        • Otherwise if the given object is already an instance of Default­Service­Identification, then it is returned unchanged.
        • Otherwise a new Default­Service­Identification instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since the other metadata contained in the given object are not recursively copied.
        Parameters:
        object - the object to get as a SIS implementation, or null if none.
        Returns:
        a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.
      • setServiceType

        public void setServiceType​(GenericName newValue)
        Sets the service type name.
        Parameters:
        new­Value - the new service type name.
      • setServiceTypeVersions

        public void setServiceTypeVersions​(Collection<? extends String> newValues)
        Sets the versions of the service.
        Parameters:
        new­Values - the new versions of the service.
      • setAccessProperties

        public void setAccessProperties​(StandardOrderProcess newValue)
        Sets information about the availability of the service.
        Parameters:
        new­Value - the new information about the availability of the service.
        Since:
        0.5
      • getCouplingType

        @UML(identifier="couplingType",
             obligation=CONDITIONAL,
             specification=ISO_19115)
        public CodeList<?> getCouplingType()
        Returns type of coupling between service and associated data (if exist).
        Upcoming API change — specialization
        The return type will be changed to the Coupling­Type code list when GeoAPI will provide it (tentatively in GeoAPI 3.1).
        Returns:
        type of coupling between service and associated data, or null if none.
      • setCouplingType

        public void setCouplingType​(CodeList<?> newValue)
        Sets the type of coupling between service and associated data.
        Upcoming API change — specialization
        The argument type will be changed to the Coupling­Type 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­Value - the new type of coupling between service and associated data.
      • getCoupledResources

        @UML(identifier="coupledResource",
             obligation=CONDITIONAL,
             specification=ISO_19115)
        public Collection<DefaultCoupledResource> getCoupledResources()
        Returns further description(s) of the data coupling in the case of tightly coupled services.
        Upcoming API change — generalization
        The element type will be changed to the Coupled­Resource interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).
        Returns:
        further description(s) of the data coupling in the case of tightly coupled services.
      • setCoupledResources

        public void setCoupledResources​(Collection<? extends DefaultCoupledResource> newValues)
        Sets further description(s) of the data coupling in the case of tightly coupled services.
        Upcoming API change — generalization
        The element type will be changed to the Coupled­Resource interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).
        Parameters:
        new­Values - the new further description(s) of the data coupling.
      • setOperatedDatasets

        public void setOperatedDatasets​(Collection<? extends Citation> newValues)
        Sets the reference(s) to the resource on which the service operates.
        Parameters:
        new­Values - the new reference(s) to the resource on which the service operates.
        Since:
        0.5
      • setProfiles

        public void setProfiles​(Collection<? extends Citation> newValues)
        Sets the profile(s) to which the service adheres.
        Parameters:
        new­Values - the new profile(s) to which the service adheres.
      • setServiceStandards

        public void setServiceStandards​(Collection<? extends Citation> newValues)
        Sets the standard(s) to which the service adheres.
        Parameters:
        new­Values - the new standard(s) to which the service adheres.
        Since:
        0.5
      • getContainsOperations

        @UML(identifier="containsOperations",
             obligation=OPTIONAL,
             specification=ISO_19115)
        public Collection<DefaultOperationMetadata> getContainsOperations()
        Provides information about the operations that comprise the service.
        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:
        information about the operations that comprise the service.
      • setContainsOperations

        public void setContainsOperations​(Collection<? extends DefaultOperationMetadata> newValues)
        Sets information(s) about the operations that comprise the service.
        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 information(s) about the operations that comprise the service.
      • setOperatesOn

        public void setOperatesOn​(Collection<? extends DataIdentification> newValues)
        Sets the information on the resources that the service operates on.
        Parameters:
        new­Values - the new information on the resources that the service operates on.
      • getContainsChain

        @UML(identifier="containsChain",
             obligation=OPTIONAL,
             specification=ISO_19115)
        public Collection<DefaultOperationChainMetadata> getContainsChain()
        Provides information about the chain applied by the service.
        Upcoming API change — generalization
        The element type will be changed to the Operation­Chain­Metadata interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).
        Returns:
        information about the chain applied by the service.
        Since:
        0.5
      • setContainsChain

        public void setContainsChain​(Collection<? extends DefaultOperationChainMetadata> newValues)
        Sets the information about the chain applied by the service.
        Upcoming API change — generalization
        The element type will be changed to the Operation­Chain­Metadata interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).
        Parameters:
        new­Values - the new information about the chain applied by the service.
        Since:
        0.5