Module org.apache.sis.metadata
Class DefaultUsage
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultUsage
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,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
├─specificUsage………… Brief description of the resource and/or resource series usage.
└─userContactInfo…… 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
XMLinstead.
- Since:
- 0.3
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty usage.DefaultUsage(CharSequence specificUsage, ResponsibleParty userContactInfo) Creates an usage initialized to the specified values.DefaultUsage(Usage object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultUsagecastOrCopy(Usage object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Publications that describe usage of data.Citation of a description of known issues associated with the resource along with proposed solutions if available.Responses to the user-determined limitations.Returns a brief description of the resource and/or resource series usage.Returns the date and time of the first use or range of uses of the resource and/or resource series.Returns identification of and means of communicating with person(s) and organization(s) using the resource(s).Returns applications, determined by the user for which the resource and/or resource series is not suitable.voidsetAdditionalDocumentation(Collection<? extends Citation> newValues) Sets the publications that describe usage of data.voidsetIdentifiedIssues(Collection<? extends Citation> newValues) Sets a new citation of a description of known issues associated with the resource along with proposed solutions if available.voidsetResponses(Collection<? extends InternationalString> newValues) Sets a new response to the user-determined limitations.voidsetSpecificUsage(InternationalString newValue) Sets a brief description of the resource and/or resource series usage.voidsetUsageDate(Date newValue) Sets the date and time of the first use.voidsetUserContactInfo(Collection<? extends ResponsibleParty> newValues) Sets identification of and means of communicating with person(s) and organization(s) using the resource(s).voidSets applications, determined by the user for which the resource and/or resource series is not suitable.Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultUsage
public DefaultUsage()Constructs an initially empty usage. -
DefaultUsage
Creates an usage initialized to the specified values.- Parameters:
specificUsage- brief description of the resource and/or resource series usage, ornullif none.userContactInfo- means of communicating with person(s) and organization(s), ornullif none.
-
DefaultUsage
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, ornullif none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull. - Otherwise if the given object is already an instance of
DefaultUsage, then it is returned unchanged. - Otherwise a new
DefaultUsageinstance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
- Parameters:
object- the object to get as a SIS implementation, ornullif none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif the argument was null.
- If the given object is
-
getSpecificUsage
Returns a brief description of the resource and/or resource series usage.- Specified by:
getSpecificUsagein interfaceUsage- Returns:
- description of the resource usage, or
null.
-
setSpecificUsage
Sets a brief description of the resource and/or resource series usage.- Parameters:
newValue- the new specific usage.
-
getUsageDate
Returns the date and time of the first use or range of uses of the resource and/or resource series.- Specified by:
getUsageDatein interfaceUsage- Returns:
- date of the first use of the resource, or
null.
-
setUsageDate
Sets the date and time of the first use.- Parameters:
newValue- the new usage date.
-
getUserDeterminedLimitations
Returns applications, determined by the user for which the resource and/or resource series is not suitable.- Specified by:
getUserDeterminedLimitationsin interfaceUsage- Returns:
- applications for which the resource and/or resource series is not suitable, or
null.
-
setUserDeterminedLimitations
Sets applications, determined by the user for which the resource and/or resource series is not suitable.- Parameters:
newValue- the new user determined limitations.
-
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,ResponsiblePartyis replaced by theResponsibilityparent interface. This change may be applied in GeoAPI 4.0.- Specified by:
getUserContactInfoin interfaceUsage- Returns:
- means of communicating with person(s) and organization(s) using the resource(s).
-
setUserContactInfo
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,ResponsiblePartyis replaced by theResponsibilityparent interface. This change may be applied in GeoAPI 4.0.- Parameters:
newValues- the new user contact info.
-
getResponses
@UML(identifier="response", obligation=OPTIONAL, specification=ISO_19115) public Collection<InternationalString> getResponses()Responses to the user-determined limitations.- Returns:
- response to the user-determined limitations.
- Since:
- 0.5
-
setResponses
Sets a new response to the user-determined limitations.- Parameters:
newValues- the new response to the user-determined limitations.- Since:
- 0.5
-
getAdditionalDocumentation
@UML(identifier="additionalDocumentation", obligation=OPTIONAL, specification=ISO_19115) public Collection<Citation> getAdditionalDocumentation()Publications that describe usage of data.- Returns:
- publications that describe usage of data.
- Since:
- 0.5
-
setAdditionalDocumentation
Sets the publications that describe usage of data.- Parameters:
newValues- 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
Sets a new citation of a description of known issues associated with the resource along with proposed solutions if available.- Parameters:
newValues- the new citation of a description.- Since:
- 0.5
-