Class CitationImpl
Object
AbstractMetadata
ModifiableMetadata
MetadataEntity
CitationImpl
- All Implemented Interfaces:
Serializable,Cloneable,Citation
Standardized resource reference.
- Since:
- 2.1
- Author:
- Martin Desruisseaux (IRD), Jody Garnett
- See Also:
-
Field Summary
Fields inherited from class AbstractMetadata
LOGGER -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty citation.CitationImpl(CharSequence title) Constructs a citation with the specified title.CitationImpl(Citation source) Constructs a new citation initialized to the values specified by the given object.CitationImpl(ResponsibleParty party) Constructs a citation with the specified responsible party. -
Method Summary
Modifier and TypeMethodDescriptionReturns the short name or other language name by which the cited information is known.Returns the name and position information for an individual or organization that is responsible for the resource.Returns the common title with holdings note.Returns the version of the cited resource.Returns the date of the edition, ornullif none.Returns the unique identifier for the resource.getISBN()Returns the International Standard Book Number, ornullif none.getISSN()Returns the International Standard Serial Number, ornullif none.Returns other information required to complete the citation that is not recorded elsewhere.Returns the mode in which the resource is represented, or an empty string if none.getTitle()Returns the name by which the cited resource is known.voidsetAlternateTitles(Collection<? extends InternationalString> newValues) Set the short name or other language name by which the cited information is known.voidsetCitedResponsibleParties(Collection<? extends ResponsibleParty> newValues) Set the name and position information for an individual or organization that is responsible for the resource.voidsetCollectiveTitle(InternationalString newValue) Set the common title with holdings note.voidsetEdition(InternationalString newValue) Set the version of the cited resource.voidsetEditionDate(Date newValue) Set the date of the edition, ornullif none.voidsetIdentifiers(Collection<? extends Identifier> newValues) Set the unique identifier for the resource.voidSet the International Standard Book Number, ornullif none.voidSet the International Standard Serial Number, ornullif none.voidsetOtherCitationDetails(InternationalString newValue) Set other information required to complete the citation that is not recorded elsewhere.voidsetPresentationForm(Collection<? extends PresentationForm> newValues) Set the mode in which the resource is represented, or an empty string if none.voidsetTitle(InternationalString newValue) Set the name by which the cited resource is known.Methods inherited from class MetadataEntity
ensureNonNull, getStandardMethods inherited from class ModifiableMetadata
checkWritePermission, clone, copyCollection, copyList, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, unmodifiableMethods inherited from class AbstractMetadata
asMap, asTree, equals, getInterface, hashCode, toString
-
Constructor Details
-
CitationImpl
public CitationImpl()Constructs an initially empty citation. -
CitationImpl
Constructs a new citation initialized to the values specified by the given object. This constructor performs a shallow copy (i.e. each source attributes are reused without copying them). -
CitationImpl
Constructs a citation with the specified title.- Parameters:
title- The title, as aStringor anInternationalStringobject.
-
CitationImpl
Constructs a citation with the specified responsible party. This convenience constructor initialize the citation title to the first non-null of the following properties: organisation name, position name or individual name.- Since:
- 2.2
-
-
Method Details
-
getTitle
Returns the name by which the cited resource is known. -
setTitle
Set the name by which the cited resource is known. -
getAlternateTitles
Returns the 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 interfaceCitation- Returns:
- Other names for the resource, or an empty collection if none.
-
setAlternateTitles
Set the short name or other language name by which the cited information is known. -
getEdition
Returns the version of the cited resource.- Specified by:
getEditionin interfaceCitation- Returns:
- The version, or
nullif none.
-
setEdition
Set the version of the cited resource. -
getEditionDate
Returns the date of the edition, ornullif none.- Specified by:
getEditionDatein interfaceCitation- Returns:
- The edition date, or
nullif none.
-
setEditionDate
Set the date of the edition, ornullif none. -
getIdentifiers
Returns the unique identifier for the resource. Example: Universal Product Code (UPC), National Stock Number (NSN).- Specified by:
getIdentifiersin interfaceCitation- Returns:
- The identifiers, or an empty collection if none.
-
setIdentifiers
Set the unique identifier for the resource. Example: Universal Product Code (UPC), National Stock Number (NSN). -
getCitedResponsibleParties
Returns the name and position information for an individual or organization that is responsible for the resource. Returns an empty string if there is none.- Specified by:
getCitedResponsiblePartiesin interfaceCitation- Returns:
- The individual or organization that is responsible, or an empty collection if none.
-
setCitedResponsibleParties
Set the name and position information for an individual or organization that is responsible for the resource. Returns an empty string if there is none. -
getPresentationForm
Returns the mode in which the resource is represented, or an empty string if none.- Specified by:
getPresentationFormin interfaceCitation- Returns:
- The presentation mode, or an empty collection if none.
-
setPresentationForm
Set the mode in which the resource is represented, or an empty string if none. -
getOtherCitationDetails
Returns other information required to complete the citation that is not recorded elsewhere. Returnsnullif none.- Specified by:
getOtherCitationDetailsin interfaceCitation- Returns:
- Other details, or
nullif none.
-
setOtherCitationDetails
Set other information required to complete the citation that is not recorded elsewhere. Set tonullif none. -
getCollectiveTitle
Returns the 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. Returnsnullif there is no title.- Specified by:
getCollectiveTitlein interfaceCitation- Returns:
- The common title, or
nullif none.
-
setCollectiveTitle
Set the 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. Set tonullif there is no title. -
getISBN
Returns the International Standard Book Number, ornullif none. -
setISBN
Set the International Standard Book Number, ornullif none. -
getISSN
Returns the International Standard Serial Number, ornullif none. -
setISSN
Set the International Standard Serial Number, ornullif none.
-