Class DefaultCitation
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultCitation
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty citation.DefaultCitation(CharSequence title) Constructs a citation with the specified title.DefaultCitation(Citation object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultCitationcastOrCopy(Citation object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns short name or other language name by which the cited information is known.Returns the role, name, contact and position information for an individual or organization that is responsible for the resource.Deprecated.Removed as of ISO 19115:2014.Returns the reference date for the cited resource.Returns the version of the cited resource.Returns the date of the edition.Returns citation graphics or logo for cited party.Returns the unique identifier for the resource.getISBN()Returns the International Standard Book Number.getISSN()Returns the International Standard Serial Number.Returns online references to the cited resource.Returns other information required to complete the citation that is not recorded elsewhere.Returns the mode in which the resource is represented.Returns the information about the series, or aggregate dataset, of which the dataset is a part.Returns the name by which the cited resource is known.voidsetAlternateTitles(Collection<? extends InternationalString> newValues) Sets the short name or other language name by which the cited information is known.voidsetCitedResponsibleParties(Collection<? extends ResponsibleParty> newValues) Sets the role, name, contact and position information for an individual or organization that is responsible for the resource.voidsetCollectiveTitle(InternationalString newValue) Deprecated.Removed as of ISO 19115:2014.voidsetDates(Collection<? extends CitationDate> newValues) Sets the reference date for the cited resource.voidsetEdition(InternationalString newValue) Sets the version of the cited resource.voidsetEditionDate(Date newValue) Sets the date of the edition.voidsetGraphics(Collection<? extends BrowseGraphic> newValues) Sets citation graphics or logo for cited party.voidsetIdentifiers(Collection<? extends Identifier> newValues) Sets the unique identifier for the resource.voidSets the International Standard Book Number.voidSets the International Standard Serial Number.voidsetOnlineResources(Collection<? extends OnlineResource> newValues) Sets online references to the cited resource.voidsetOtherCitationDetails(InternationalString newValue) Sets other information required to complete the citation that is not recorded elsewhere.voidsetPresentationForms(Collection<? extends PresentationForm> newValues) Sets the mode in which the resource is represented.voidsetSeries(Series newValue) Sets the information about the series, or aggregate dataset, of which the dataset is a part.voidsetTitle(InternationalString newValue) Sets the name by which the cited resource is known.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultCitationpublic DefaultCitation()Constructs an initially empty citation.
- 
DefaultCitationConstructs a citation with the specified title.- Parameters:
- title- the title as a- Stringor an- InternationalStringobject, or- nullif none.
 
- 
DefaultCitationConstructs 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, or- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 DefaultCitationinstance 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, or- nullif 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 
- 
getTitleReturns the name by which the cited resource is known.
- 
setTitleSets the name by which the cited resource is known.- Parameters:
- newValue- the new title, or- nullif none.
 
- 
getAlternateTitlesReturns 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:
- getAlternateTitlesin interface- Citation
- Returns:
- other names for the resource, or an empty collection if none.
 
- 
setAlternateTitlesSets the short name or other language name by which the cited information is known.- Parameters:
- newValues- the new alternate titles, or- nullif none.
 
- 
getDatesReturns the reference date for the cited resource.
- 
setDatesSets the reference date for the cited resource.- Parameters:
- newValues- the new dates, or- nullif none.
 
- 
getEditionReturns the version of the cited resource.- Specified by:
- getEditionin interface- Citation
- Returns:
- the version, or nullif none.
 
- 
setEditionSets the version of the cited resource.- Parameters:
- newValue- the new edition, or- nullif none.
 
- 
getEditionDateReturns the date of the edition.- Specified by:
- getEditionDatein interface- Citation
- Returns:
- the edition date, or nullif none.
 
- 
setEditionDateSets the date of the edition.- Parameters:
- newValue- the new edition date, or- nullif none.
 
- 
getIdentifiersReturns the unique identifier for the resource.Example: Universal Product Code (UPC), National Stock Number (NSN).Unified identifiers viewIn 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:
- getIdentifiersin interface- Citation
- Specified by:
- getIdentifiersin interface- IdentifiedObject
- Overrides:
- getIdentifiersin class- ISOMetadata
- Returns:
- the identifiers, or an empty collection if none.
- See Also:
 
- 
setIdentifiersSets 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, or- nullif none.
- See Also:
 
- 
getCitedResponsiblePartiesReturns 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,ResponsiblePartyis replaced by theResponsibilityparent interface. This change may be applied in GeoAPI 4.0.- Specified by:
- getCitedResponsiblePartiesin interface- Citation
- Returns:
- the individual or organization that is responsible, or an empty collection if none.
 
- 
setCitedResponsiblePartiesSets 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,ResponsiblePartyis replaced by theResponsibilityparent interface. This change may be applied in GeoAPI 4.0.- Parameters:
- newValues- the new cited responsible parties, or- nullif none.
 
- 
getPresentationFormsReturns the mode in which the resource is represented.- Specified by:
- getPresentationFormsin interface- Citation
- Returns:
- the presentation modes, or an empty collection if none.
 
- 
setPresentationFormsSets the mode in which the resource is represented.- Parameters:
- newValues- the new presentation form, or- nullif none.
 
- 
getSeriesReturns the information about the series, or aggregate dataset, of which the dataset is a part.- Specified by:
- getSeriesin interface- Citation
- Returns:
- the series of which the dataset is a part, or nullif none.
 
- 
setSeriesSets the information about the series, or aggregate dataset, of which the dataset is a part.- Parameters:
- newValue- the new series.
 
- 
getOtherCitationDetailsReturns 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:
- getOtherCitationDetailsin interface- Citation
- Returns:
- other details, or nullif none.
 
- 
setOtherCitationDetailsSets 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, or- nullif none.
 
- 
getCollectiveTitleDeprecated.Removed as of ISO 19115:2014.Returns the common title with holdings note.- Specified by:
- getCollectiveTitlein interface- Citation
- Returns:
- the common title, or nullif none.
 
- 
setCollectiveTitleDeprecated.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, or- nullif none.
 
- 
getISBNReturns the International Standard Book Number. In this SIS implementation, invoking this method is equivalent to:return getIdentifierMap().getSpecialized(Citations.ISBN); 
- 
setISBNSets the International Standard Book Number. In this SIS implementation, invoking this method is equivalent to:getIdentifierMap().putSpecialized(Citations.ISBN, newValue); - Parameters:
- newValue- the new ISBN, or- nullif none.
- See Also:
 
- 
getISSNReturns the International Standard Serial Number. In this SIS implementation, invoking this method is equivalent to:return getIdentifierMap().getSpecialized(Citations.ISSN); 
- 
setISSNSets the International Standard Serial Number. In this SIS implementation, invoking this method is equivalent to:getIdentifierMap().putSpecialized(Citations.ISSN, newValue); - Parameters:
- newValue- the new ISSN.
- See Also:
 
- 
getOnlineResources@UML(identifier="onlineResource", obligation=OPTIONAL, specification=ISO_19115) public Collection<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
 
- 
setOnlineResourcesSets 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<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
 
- 
setGraphicsSets citation graphics or logo for cited party.- Parameters:
- newValues- the new citation graphics or logo for cited party.
- Since:
- 0.5
 
 
-