Class DefaultCitation
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.citation.DefaultCitation
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.citation.Citation
@TitleProperty(name="title")
public class DefaultCitation
extends ISOMetadata
implements org.opengis.metadata.citation.Citation
Standardized resource reference.
The following properties are mandatory in a well-formed metadata according ISO 19115:
CI_Citation
├─title………………………
Name by which the cited resource is known.
└─date…………………………
Reference date for the cited resource.Unified identifiers view
The ISO 19115 model provides specific attributes for the ISBN and ISSN codes. However, the SIS library handles those codes like any other identifiers. Consequently, the ISBN and ISSN codes are included in the collection returned bygetIdentifiers()
, except at XML marshalling time (for ISO 19115-3 compliance).
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.util.InternationalString> Short name or other language name by which the cited information is known.private Collection
<org.opengis.metadata.citation.ResponsibleParty> Roles, Name, contact, and position information for an individual or organization that is responsible for the resource.private org.opengis.util.InternationalString
Deprecated.Removed as of ISO 19115:2014.private Collection
<org.opengis.metadata.citation.CitationDate> Reference date for the cited resource.private org.opengis.util.InternationalString
Version of the cited resource.private long
Date of the edition in milliseconds elapsed sine January 1st, 1970, orLong.MIN_VALUE
if none.private Collection
<org.opengis.metadata.identification.BrowseGraphic> Citation graphic or logo for cited party.private Collection
<org.opengis.metadata.citation.OnlineResource> Online references to the cited resource.private org.opengis.util.InternationalString
Other information required to complete the citation that is not recorded elsewhere.private Collection
<org.opengis.metadata.citation.PresentationForm> Mode in which the resource is represented, or an empty collection if none.private static final long
Serial number for inter-operability with different versions.private org.opengis.metadata.citation.Series
Information about the series, or aggregate dataset, of which the dataset is a part.private org.opengis.util.InternationalString
Name by which the cited resource is known.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty citation.DefaultCitation
(CharSequence title) Constructs a citation with the specified title.DefaultCitation
(org.opengis.metadata.citation.Citation object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultCitation
castOrCopy
(org.opengis.metadata.citation.Citation object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Collection
<org.opengis.util.InternationalString> Returns short name or other language name by which the cited information is known.Collection
<org.opengis.metadata.citation.ResponsibleParty> Returns the role, name, contact and position information for an individual or organization that is responsible for the resource.org.opengis.util.InternationalString
Deprecated.Removed as of ISO 19115:2014.Collection
<org.opengis.metadata.citation.CitationDate> getDates()
Returns the reference date for the cited resource.org.opengis.util.InternationalString
Returns the version of the cited resource.Returns the date of the edition.private Collection
<org.opengis.metadata.identification.BrowseGraphic> Collection
<org.opengis.metadata.identification.BrowseGraphic> Returns citation graphics or logo for cited party.private String
getIdentifier
(org.opengis.metadata.citation.Citation authority) Returns the ISBN or ISSN identifier for the given authority, ornull
if none.Collection
<org.opengis.metadata.Identifier> Returns the unique identifier for the resource.getISBN()
Returns the International Standard Book Number.getISSN()
Returns the International Standard Serial Number.private Collection
<org.opengis.metadata.citation.OnlineResource> Invoked by JAXB at both marshalling and unmarshalling time.Collection
<org.opengis.metadata.citation.OnlineResource> Returns online references to the cited resource.org.opengis.util.InternationalString
Returns other information required to complete the citation that is not recorded elsewhere.Collection
<org.opengis.metadata.citation.PresentationForm> Returns the mode in which the resource is represented.org.opengis.metadata.citation.Series
Returns the information about the series, or aggregate dataset, of which the dataset is a part.org.opengis.util.InternationalString
getTitle()
Returns the name by which the cited resource is known.void
setAlternateTitles
(Collection<? extends org.opengis.util.InternationalString> newValues) Sets the short name or other language name by which the cited information is known.void
setCitedResponsibleParties
(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the role, name, contact and position information for an individual or organization that is responsible for the resource.void
setCollectiveTitle
(org.opengis.util.InternationalString newValue) Deprecated.Removed as of ISO 19115:2014.void
setDates
(Collection<? extends org.opengis.metadata.citation.CitationDate> newValues) Sets the reference date for the cited resource.void
setEdition
(org.opengis.util.InternationalString newValue) Sets the version of the cited resource.void
setEditionDate
(Date newValue) Sets the date of the edition.void
setGraphics
(Collection<? extends org.opengis.metadata.identification.BrowseGraphic> newValues) Sets citation graphics or logo for cited party.void
setIdentifiers
(Collection<? extends org.opengis.metadata.Identifier> newValues) Sets the unique identifier for the resource.void
Sets the International Standard Book Number.void
Sets the International Standard Serial Number.void
setOnlineResources
(Collection<? extends org.opengis.metadata.citation.OnlineResource> newValues) Sets online references to the cited resource.void
setOtherCitationDetails
(org.opengis.util.InternationalString newValue) Sets other information required to complete the citation that is not recorded elsewhere.void
setPresentationForms
(Collection<? extends org.opengis.metadata.citation.PresentationForm> newValues) Sets the mode in which the resource is represented.void
setSeries
(org.opengis.metadata.citation.Series newValue) Sets the information about the series, or aggregate dataset, of which the dataset is a part.void
setTitle
(org.opengis.util.InternationalString newValue) Sets the name by which the cited resource is known.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, 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 inter-operability with different versions.- See Also:
-
title
private org.opengis.util.InternationalString titleName by which the cited resource is known. -
alternateTitles
Short name or other language name by which the cited information is known. Example: "DCW" as an alternative title for "Digital Chart of the World. -
dates
Reference date for the cited resource. -
edition
private org.opengis.util.InternationalString editionVersion of the cited resource. -
editionDate
private long editionDateDate of the edition in milliseconds elapsed sine January 1st, 1970, orLong.MIN_VALUE
if none. -
citedResponsibleParties
Roles, Name, contact, and position information for an individual or organization that is responsible for the resource. -
presentationForms
Mode in which the resource is represented, or an empty collection if none. -
series
private org.opengis.metadata.citation.Series seriesInformation about the series, or aggregate dataset, of which the dataset is a part. May benull
if none. -
otherCitationDetails
private org.opengis.util.InternationalString otherCitationDetailsOther information required to complete the citation that is not recorded elsewhere. May benull
if none. -
collectiveTitle
Deprecated.Removed as of ISO 19115:2014.Common title with holdings note. Note: title identifies elements of a series collectively, combined with information about what volumes are available at the source cited. May benull
if there is no title. -
onlineResources
Online references to the cited resource. -
graphics
Citation graphic or logo for cited party.
-
-
Constructor Details
-
DefaultCitation
public DefaultCitation()Constructs an initially empty citation. -
DefaultCitation
Constructs a citation with the specified title.- Parameters:
title
- the title as aString
or anInternationalString
object, ornull
if none.
-
DefaultCitation
public DefaultCitation(org.opengis.metadata.citation.Citation 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
DefaultCitation
, then it is returned unchanged. - Otherwise a new
DefaultCitation
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
-
getTitle
public org.opengis.util.InternationalString getTitle()Returns the name by which the cited resource is known.- Specified by:
getTitle
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- the cited resource name, or
null
.
-
setTitle
public void setTitle(org.opengis.util.InternationalString newValue) Sets the name by which the cited resource is known.- Parameters:
newValue
- the new title, ornull
if none.
-
getAlternateTitles
Returns short name or other language name by which the cited information is known.Example: "DCW" as an alternative title for "Digital Chart of the World".- Specified by:
getAlternateTitles
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- other names for the resource, or an empty collection if none.
-
setAlternateTitles
public void setAlternateTitles(Collection<? extends org.opengis.util.InternationalString> newValues) Sets the short name or other language name by which the cited information is known.- Parameters:
newValues
- the new alternate titles, ornull
if none.
-
getDates
Returns the reference date for the cited resource.- Specified by:
getDates
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- the reference date.
-
setDates
Sets the reference date for the cited resource.- Parameters:
newValues
- the new dates, ornull
if none.
-
getEdition
public org.opengis.util.InternationalString getEdition()Returns the version of the cited resource.- Specified by:
getEdition
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- the version, or
null
if none.
-
setEdition
public void setEdition(org.opengis.util.InternationalString newValue) Sets the version of the cited resource.- Parameters:
newValue
- the new edition, ornull
if none.
-
getEditionDate
Returns the date of the edition.- Specified by:
getEditionDate
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- the edition date, or
null
if none.
-
setEditionDate
Sets the date of the edition.- Parameters:
newValue
- the new edition date, ornull
if none.
-
getIdentifiers
Returns the unique identifier for the resource.Example: Universal Product Code (UPC), National Stock Number (NSN).Unified identifiers view
In this SIS implementation, the collection returned by this method includes the XML identifiers (ID, UUID, etc.), as well as the ISBN and ISSN codes, thus providing a unified view of every kind of identifiers associated to this citation.XML note: The<cit:identifier>
element marshalled to XML will exclude all the above cited identifiers, for ISO 19115-3 compliance. Those identifiers will appear in other XML elements or attributes.- Specified by:
getIdentifiers
in interfaceorg.opengis.metadata.citation.Citation
- Specified by:
getIdentifiers
in interfaceIdentifiedObject
- Overrides:
getIdentifiers
in classISOMetadata
- Returns:
- the identifiers, or an empty collection if none.
- See Also:
-
setIdentifiers
Sets the unique identifier for the resource. Example: Universal Product Code (UPC), National Stock Number (NSN).XML identifiers (ID, UUID, etc.), ISBN and ISSN codes are not affected by this method, unless they are explicitly provided in the given collection.
- Parameters:
newValues
- the new identifiers, ornull
if none.- See Also:
-
getCitedResponsibleParties
Returns the role, name, contact and position information for an individual or organization that is responsible for the resource.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:
getCitedResponsibleParties
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- the individual or organization that is responsible, or an empty collection if none.
-
setCitedResponsibleParties
public void setCitedResponsibleParties(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the role, name, contact and position information for an individual or organization that is responsible for the resource.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 cited responsible parties, ornull
if none.
-
getPresentationForms
Returns the mode in which the resource is represented.- Specified by:
getPresentationForms
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- the presentation modes, or an empty collection if none.
-
setPresentationForms
public void setPresentationForms(Collection<? extends org.opengis.metadata.citation.PresentationForm> newValues) Sets the mode in which the resource is represented.- Parameters:
newValues
- the new presentation form, ornull
if none.
-
getSeries
public org.opengis.metadata.citation.Series getSeries()Returns the information about the series, or aggregate dataset, of which the dataset is a part.- Specified by:
getSeries
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- the series of which the dataset is a part, or
null
if none.
-
setSeries
public void setSeries(org.opengis.metadata.citation.Series newValue) Sets the information about the series, or aggregate dataset, of which the dataset is a part.- Parameters:
newValue
- the new series.
-
getOtherCitationDetails
public org.opengis.util.InternationalString getOtherCitationDetails()Returns other information required to complete the citation that is not recorded elsewhere.Upcoming API change — multiplicity
As of ISO 19115:2014, this singleton has been replaced by a collection. This change may be applied in GeoAPI 4.0.- Specified by:
getOtherCitationDetails
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- other details, or
null
if none.
-
setOtherCitationDetails
public void setOtherCitationDetails(org.opengis.util.InternationalString newValue) Sets other information required to complete the citation that is not recorded elsewhere.Upcoming API change — multiplicity
As of ISO 19115:2014, this singleton has been replaced by a collection. This change may be applied in GeoAPI 4.0.- Parameters:
newValue
- Other citations details, ornull
if none.
-
getCollectiveTitle
Deprecated.Removed as of ISO 19115:2014.Returns the common title with holdings note.- Specified by:
getCollectiveTitle
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- the common title, or
null
if none.
-
setCollectiveTitle
Deprecated.Removed as of ISO 19115:2014.Sets the common title with holdings note. This title identifies elements of a series collectively, combined with information about what volumes are available at the source cited.- Parameters:
newValue
- the new collective title, ornull
if none.
-
getIdentifier
Returns the ISBN or ISSN identifier for the given authority, ornull
if none. -
getISBN
Returns the International Standard Book Number. In this SIS implementation, invoking this method is equivalent to:- Specified by:
getISBN
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- the ISBN, or
null
if none. - See Also:
-
setISBN
Sets the International Standard Book Number. In this SIS implementation, invoking this method is equivalent to:- Parameters:
newValue
- the new ISBN, ornull
if none.- See Also:
-
getISSN
Returns the International Standard Serial Number. In this SIS implementation, invoking this method is equivalent to:- Specified by:
getISSN
in interfaceorg.opengis.metadata.citation.Citation
- Returns:
- the ISSN, or
null
if none. - See Also:
-
setISSN
Sets the International Standard Serial Number. In this SIS implementation, invoking this method is equivalent to:- Parameters:
newValue
- the new ISSN.- See Also:
-
getOnlineResources
@UML(identifier="onlineResource", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.OnlineResource> getOnlineResources()Returns online references to the cited resource.- Returns:
- online references to the cited resource, or an empty collection if there is none.
- Since:
- 0.5
-
setOnlineResources
public void setOnlineResources(Collection<? extends org.opengis.metadata.citation.OnlineResource> newValues) Sets online references to the cited resource.- Parameters:
newValues
- the new online references to the cited resource.- Since:
- 0.5
-
getGraphics
@UML(identifier="graphic", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.identification.BrowseGraphic> getGraphics()Returns citation graphics or logo for cited party.- Returns:
- graphics or logo for cited party, or an empty collection if there is none.
- Since:
- 0.5
-
setGraphics
public void setGraphics(Collection<? extends org.opengis.metadata.identification.BrowseGraphic> newValues) Sets citation graphics or logo for cited party.- Parameters:
newValues
- the new citation graphics or logo for cited party.- Since:
- 0.5
-
getOnlineResource
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. -
getGraphic
-