Package org.opengis.metadata.citation
Interface Citation
-
@Classifier(DATATYPE) @UML(identifier="CI_Citation", specification=ISO_19115) public interface Citation
Standardized resource reference.- Since:
- 1.0
-
-
Method Summary
Modifier and Type Method Description default Collection<? extends InternationalString>
getAlternateTitles()
Short names or other language names by which the cited information is known.default Collection<? extends ResponsibleParty>
getCitedResponsibleParties()
Role, name, contact and position information for individuals or organisations that are responsible for the resource.default InternationalString
getCollectiveTitle()
Deprecated.Removed as of ISO 19115:2014.default Collection<? extends CitationDate>
getDates()
Reference dates for the cited resource.default InternationalString
getEdition()
Version of the cited resource.default Date
getEditionDate()
Date of the edition, ornull
if none.default Collection<? extends BrowseGraphic>
getGraphics()
Citation graphics or logo for cited party.default Collection<? extends Identifier>
getIdentifiers()
Unique identifier for the resource.default String
getISBN()
International Standard Book Number.default String
getISSN()
International Standard Serial Number.default Collection<? extends OnlineResource>
getOnlineResources()
Online references to the cited resource.default InternationalString
getOtherCitationDetails()
Other information required to complete the citation that is not recorded elsewhere.default Collection<PresentationForm>
getPresentationForms()
Mode in which the resource is represented.default Series
getSeries()
Information about the series, or aggregate dataset, of which the dataset is a part.InternationalString
getTitle()
Name by which the cited resource is known.
-
-
-
Method Detail
-
getTitle
@Profile(level=CORE) @UML(identifier="title", obligation=MANDATORY, specification=ISO_19115) InternationalString getTitle()
Name by which the cited resource is known.- Returns:
- the cited resource name.
-
getAlternateTitles
@UML(identifier="alternateTitle", obligation=OPTIONAL, specification=ISO_19115) default Collection<? extends InternationalString> getAlternateTitles()
Short names or other language names by which the cited information is known. Returns an empty collection if there is none.Example: "DCW" as an alternative title for "Digital Chart of the World".- Returns:
- other names for the resource, or an empty collection if none.
-
getDates
@Profile(level=CORE) @UML(identifier="date", obligation=OPTIONAL, specification=ISO_19115) default Collection<? extends CitationDate> getDates()
Reference dates for the cited resource.- Returns:
- reference dates for the cited resource.
-
getEdition
@UML(identifier="edition", obligation=OPTIONAL, specification=ISO_19115) default InternationalString getEdition()
Version of the cited resource.- Returns:
- the version, or
null
if none.
-
getEditionDate
@UML(identifier="editionDate", obligation=OPTIONAL, specification=ISO_19115) default Date getEditionDate()
Date of the edition, ornull
if none.Upcoming API change — temporal schema
The return type of this method may change in GeoAPI 4.0 release. It may be replaced by a type matching more closely either ISO 19108 (Temporal Schema) or ISO 19103.- Returns:
- the edition date, or
null
if none.
-
getIdentifiers
@UML(identifier="identifier", obligation=OPTIONAL, specification=ISO_19115) default Collection<? extends Identifier> getIdentifiers()
Unique identifier for the resource. Returns an empty collection if there is none.Example: Universal Product Code (UPC), National Stock Number (NSN).- Returns:
- the identifiers, or an empty collection if none.
-
getCitedResponsibleParties
@UML(identifier="citedResponsibleParty", obligation=OPTIONAL, specification=ISO_19115, version=2003) default Collection<? extends ResponsibleParty> getCitedResponsibleParties()
Role, name, contact and position information for individuals or organisations that are responsible for the resource. Returns an empty collection if there is none.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.- Returns:
- the information for individuals or organisations that are responsible for the resource, or an empty collection if none.
-
getPresentationForms
@UML(identifier="presentationForm", obligation=OPTIONAL, specification=ISO_19115) default Collection<PresentationForm> getPresentationForms()
Mode in which the resource is represented. Returns an empty collection if there is none.- Returns:
- the presentation mode, or an empty collection if none.
-
getSeries
@UML(identifier="series", obligation=OPTIONAL, specification=ISO_19115) default Series getSeries()
Information about the series, or aggregate dataset, of which the dataset is a part. Returnsnull
if there is none.- Returns:
- the series or aggregate dataset of which the dataset is a part, or
null
if none.
-
getOtherCitationDetails
@UML(identifier="otherCitationDetails", obligation=OPTIONAL, specification=ISO_19115, version=2003) default InternationalString getOtherCitationDetails()
Other information required to complete the citation that is not recorded elsewhere. Returnsnull
if none.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.- Returns:
- other details, or
null
if none.
-
getCollectiveTitle
@Deprecated @UML(identifier="collectiveTitle", obligation=OPTIONAL, specification=ISO_19115, version=2003) default InternationalString getCollectiveTitle()
Deprecated.Removed as of ISO 19115:2014.Common title with holdings note. Title identifies elements of a series collectively, combined with information about what volumes are available at the source cited.- Returns:
- the common title, or
null
if none.
-
getISBN
@UML(identifier="ISBN", obligation=OPTIONAL, specification=ISO_19115) default String getISBN()
International Standard Book Number. Returnsnull
if there is none.- Returns:
- the International Standard Book Number, or
null
if none.
-
getISSN
@UML(identifier="ISSN", obligation=OPTIONAL, specification=ISO_19115) default String getISSN()
International Standard Serial Number. Returnsnull
if there is none.- Returns:
- the International Standard Serial Number, or
null
if none.
-
getOnlineResources
@UML(identifier="onlineResource", obligation=OPTIONAL, specification=ISO_19115) default Collection<? extends OnlineResource> getOnlineResources()
Online references to the cited resource. Returns an empty collection if there is none.- Returns:
- online references to the cited resource, or an empty collection if none.
- Since:
- 3.1
-
getGraphics
@UML(identifier="graphic", obligation=OPTIONAL, specification=ISO_19115) default Collection<? extends BrowseGraphic> getGraphics()
Citation graphics or logo for cited party. Returns an empty collection if there is none.- Returns:
- graphics or logo for cited party, or an empty collection if none.
- Since:
- 3.1
-
-