Class DefaultUsage
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.identification.DefaultUsage
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.identification.Usage
@TitleProperty(name="specificUsage")
public class DefaultUsage
extends ISOMetadata
implements org.opengis.metadata.identification.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
XML
instead.
- Since:
- 0.3
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Collection<org.opengis.metadata.citation.Citation>
Publication that describe usage of data.private Collection<org.opengis.metadata.citation.Citation>
Citation of a description of known issues associated with the resource along with proposed solutions if available.private Collection<org.opengis.util.InternationalString>
Responses to the user-determined limitations.private static final long
Serial number for compatibility with different versions.private org.opengis.util.InternationalString
Brief description of the resource and/or resource series usage.private long
Date and time of the first use or range of uses of the resource and/or resource series.private Collection<org.opengis.metadata.citation.ResponsibleParty>
Identification of and means of communicating with person(s) and organization(s) using the resource(s).private org.opengis.util.InternationalString
Applications, determined by the user for which the resource and/or resource series is not suitable.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty usage.DefaultUsage
(CharSequence specificUsage, org.opengis.metadata.citation.ResponsibleParty userContactInfo) Creates an usage initialized to the specified values.DefaultUsage
(org.opengis.metadata.identification.Usage object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultUsage
castOrCopy
(org.opengis.metadata.identification.Usage object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Collection<org.opengis.metadata.citation.Citation>
Publications that describe usage of data.private Collection<org.opengis.metadata.citation.Citation>
Collection<org.opengis.metadata.citation.Citation>
Citation of a description of known issues associated with the resource along with proposed solutions if available.private Collection<org.opengis.metadata.citation.Citation>
private Collection<org.opengis.util.InternationalString>
Invoked by JAXB at both marshalling and unmarshalling time.Collection<org.opengis.util.InternationalString>
Responses to the user-determined limitations.org.opengis.util.InternationalString
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.Collection<org.opengis.metadata.citation.ResponsibleParty>
Returns identification of and means of communicating with person(s) and organization(s) using the resource(s).org.opengis.util.InternationalString
Returns applications, determined by the user for which the resource and/or resource series is not suitable.void
setAdditionalDocumentation
(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Sets the publications that describe usage of data.void
setIdentifiedIssues
(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Sets a new citation of a description of known issues associated with the resource along with proposed solutions if available.void
setResponses
(Collection<? extends org.opengis.util.InternationalString> newValues) Sets a new response to the user-determined limitations.void
setSpecificUsage
(org.opengis.util.InternationalString newValue) Sets a brief description of the resource and/or resource series usage.void
setUsageDate
(Date newValue) Sets the date and time of the first use.void
setUserContactInfo
(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets identification of and means of communicating with person(s) and organization(s) using the resource(s).void
setUserDeterminedLimitations
(org.opengis.util.InternationalString newValue) Sets applications, determined by the user for which the resource and/or resource series is not suitable.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for compatibility with different versions.- See Also:
-
specificUsage
private org.opengis.util.InternationalString specificUsageBrief description of the resource and/or resource series usage. -
usageDate
private long usageDateDate and time of the first use or range of uses of the resource and/or resource series. Values are milliseconds elapsed since January 1st, 1970, orLong.MIN_VALUE
if this value is not set. -
userDeterminedLimitations
private org.opengis.util.InternationalString userDeterminedLimitationsApplications, determined by the user for which the resource and/or resource series is not suitable. -
userContactInfo
Identification of and means of communicating with person(s) and organization(s) using the resource(s). -
responses
Responses to the user-determined limitations. -
additionalDocumentation
Publication that describe usage of data. -
identifiedIssues
Citation of a description of known issues associated with the resource along with proposed solutions if available.
-
-
Constructor Details
-
DefaultUsage
public DefaultUsage()Constructs an initially empty usage. -
DefaultUsage
public DefaultUsage(CharSequence specificUsage, org.opengis.metadata.citation.ResponsibleParty userContactInfo) Creates an usage initialized to the specified values.- Parameters:
specificUsage
- brief description of the resource and/or resource series usage, ornull
if none.userContactInfo
- means of communicating with person(s) and organization(s), ornull
if none.
-
DefaultUsage
public DefaultUsage(org.opengis.metadata.identification.Usage 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, ornull
if 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
DefaultUsage
instance 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, ornull
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.
- If the given object is
-
getSpecificUsage
public org.opengis.util.InternationalString getSpecificUsage()Returns a brief description of the resource and/or resource series usage.- Specified by:
getSpecificUsage
in interfaceorg.opengis.metadata.identification.Usage
- Returns:
- description of the resource usage, or
null
.
-
setSpecificUsage
public void setSpecificUsage(org.opengis.util.InternationalString newValue) 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:
getUsageDate
in interfaceorg.opengis.metadata.identification.Usage
- 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
public org.opengis.util.InternationalString getUserDeterminedLimitations()Returns applications, determined by the user for which the resource and/or resource series is not suitable.- Specified by:
getUserDeterminedLimitations
in interfaceorg.opengis.metadata.identification.Usage
- Returns:
- applications for which the resource and/or resource series is not suitable, or
null
.
-
setUserDeterminedLimitations
public void setUserDeterminedLimitations(org.opengis.util.InternationalString newValue) 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,ResponsibleParty
is replaced by theResponsibility
parent interface. This change may be applied in GeoAPI 4.0.- Specified by:
getUserContactInfo
in interfaceorg.opengis.metadata.identification.Usage
- Returns:
- means of communicating with person(s) and organization(s) using the resource(s).
-
setUserContactInfo
public void setUserContactInfo(Collection<? extends org.opengis.metadata.citation.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,ResponsibleParty
is replaced by theResponsibility
parent 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<org.opengis.util.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<org.opengis.metadata.citation.Citation> getAdditionalDocumentation()Publications that describe usage of data.- Returns:
- publications that describe usage of data.
- Since:
- 0.5
-
setAdditionalDocumentation
public void setAdditionalDocumentation(Collection<? extends org.opengis.metadata.citation.Citation> newValues) 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<org.opengis.metadata.citation.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 org.opengis.metadata.citation.Citation> newValues) 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
-
getResponse
Invoked by JAXB at both marshalling and unmarshalling time. This attribute has been added by ISO 19115:2014 standard. If (and only if) marshalling an older standard version, we omit this attribute. -
getAdditionalDocumentations
-
getIssues
-