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

Class DefaultUsage

  • All Implemented Interfaces:
    Serializable, Emptiable, Lenient­Comparable, Identified­Object, Usage
    @TitleProperty(name="specificUsage")
public class DefaultUsage
extends ISOMetadata
implements Usage
    Brief description of ways in which the resource(s) is/are currently or has been used. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:
    MD_Usage   ├─specific­Usage………… Brief description of the resource and/or resource series usage.   └─user­Contact­Info…… Identification of and means of communicating with person(s) and organisation(s).       ├─party…………………… Information about the parties.       │   └─name…………… Name of the party.       └─role……………………… Function performed by the responsible party.

    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.3
    See Also:
    Serialized Form

    Defined in the sis-metadata module

    • Constructor Detail

      • DefaultUsage

        public DefaultUsage()
        Constructs an initially empty usage.

      • DefaultUsage

        public DefaultUsage​(CharSequence specificUsage,
                    ResponsibleParty userContactInfo)
        Creates an usage initialized to the specified values.
        Parameters:
        specific­Usage - brief description of the resource and/or resource series usage, or null if none.
        user­Contact­Info - means of communicating with person(s) and organization(s), or null if none.

      • DefaultUsage

        public DefaultUsage​(Usage 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(Usage)

    • Method Detail

      • castOrCopy

        public static DefaultUsage castOrCopy​(Usage 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­Usage, then it is returned unchanged.
        • Otherwise a new Default­Usage 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.

      • getSpecificUsage

        public InternationalString getSpecificUsage()
        Returns a brief description of the resource and/or resource series usage.
        Specified by:
        get­Specific­Usage in interface Usage
        Returns:
        description of the resource usage, or null.

      • setSpecificUsage

        public void setSpecificUsage​(InternationalString newValue)
        Sets a brief description of the resource and/or resource series usage.
        Parameters:
        new­Value - the new specific usage.

      • getUsageDate

        public Date getUsageDate()
        Returns the date and time of the first use or range of uses of the resource and/or resource series.
        Specified by:
        get­Usage­Date in interface Usage
        Returns:
        date of the first use of the resource, or null.

      • setUsageDate

        public void setUsageDate​(Date newValue)
        Sets the date and time of the first use.
        Parameters:
        new­Value - the new usage date.

      • getUserDeterminedLimitations

        public InternationalString getUserDeterminedLimitations()
        Returns applications, determined by the user for which the resource and/or resource series is not suitable.
        Specified by:
        get­User­Determined­Limitations in interface Usage
        Returns:
        applications for which the resource and/or resource series is not suitable, or null.

      • setUserDeterminedLimitations

        public void setUserDeterminedLimitations​(InternationalString newValue)
        Sets applications, determined by the user for which the resource and/or resource series is not suitable.
        Parameters:
        new­Value - the new user determined limitations.

      • getUserContactInfo

        public Collection<ResponsibleParty> getUserContactInfo()
        Returns identification of and means of communicating with person(s) and organization(s) using the resource(s).
        Upcoming API change — generalization
        As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.
        Specified by:
        get­User­Contact­Info in interface Usage
        Returns:
        means of communicating with person(s) and organization(s) using the resource(s).

      • setUserContactInfo

        public void setUserContactInfo​(Collection<? extends ResponsibleParty> newValues)
        Sets identification of and means of communicating with person(s) and organization(s) using the resource(s).
        Upcoming API change — generalization
        As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.
        Parameters:
        new­Values - the new user contact info.

      • setResponses

        public void setResponses​(Collection<? extends InternationalString> newValues)
        Sets a new response to the user-determined limitations.
        Parameters:
        new­Values - the new response to the user-determined limitations.
        Since:
        0.5

      • setAdditionalDocumentation

        public void setAdditionalDocumentation​(Collection<? extends Citation> newValues)
        Sets the publications that describe usage of data.
        Parameters:
        new­Values - the new publications.
        Since:
        0.5

      • getIdentifiedIssues

        @UML(identifier="identifiedIssues",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<Citation> getIdentifiedIssues()
        Citation of a description of known issues associated with the resource along with proposed solutions if available.
        Returns:
        citation of a description of known issues associated with the resource.
        Since:
        0.5

      • setIdentifiedIssues

        public void setIdentifiedIssues​(Collection<? extends Citation> newValues)
        Sets a new citation of a description of known issues associated with the resource along with proposed solutions if available.
        Parameters:
        new­Values - the new citation of a description.
        Since:
        0.5