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, ornull
if none.Returns the unique identifier for the resource.getISBN()
Returns the International Standard Book Number, ornull
if none.getISSN()
Returns the International Standard Serial Number, ornull
if 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.void
setAlternateTitles
(Collection<? extends InternationalString> newValues) Set the short name or other language name by which the cited information is known.void
setCitedResponsibleParties
(Collection<? extends ResponsibleParty> newValues) Set the name and position information for an individual or organization that is responsible for the resource.void
setCollectiveTitle
(InternationalString newValue) Set the common title with holdings note.void
setEdition
(InternationalString newValue) Set the version of the cited resource.void
setEditionDate
(Date newValue) Set the date of the edition, ornull
if none.void
setIdentifiers
(Collection<? extends Identifier> newValues) Set the unique identifier for the resource.void
Set the International Standard Book Number, ornull
if none.void
Set the International Standard Serial Number, ornull
if none.void
setOtherCitationDetails
(InternationalString newValue) Set other information required to complete the citation that is not recorded elsewhere.void
setPresentationForm
(Collection<? extends PresentationForm> newValues) Set the mode in which the resource is represented, or an empty string if none.void
setTitle
(InternationalString newValue) Set the name by which the cited resource is known.Methods inherited from class MetadataEntity
ensureNonNull, getStandard
Methods inherited from class ModifiableMetadata
checkWritePermission, clone, copyCollection, copyList, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, unmodifiable
Methods 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 aString
or anInternationalString
object.
-
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:
getAlternateTitles
in 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:
getEdition
in interfaceCitation
- Returns:
- The version, or
null
if none.
-
setEdition
Set the version of the cited resource. -
getEditionDate
Returns the date of the edition, ornull
if none.- Specified by:
getEditionDate
in interfaceCitation
- Returns:
- The edition date, or
null
if none.
-
setEditionDate
Set the date of the edition, ornull
if none. -
getIdentifiers
Returns the unique identifier for the resource. Example: Universal Product Code (UPC), National Stock Number (NSN).- Specified by:
getIdentifiers
in 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:
getCitedResponsibleParties
in 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:
getPresentationForm
in 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. Returnsnull
if none.- Specified by:
getOtherCitationDetails
in interfaceCitation
- Returns:
- Other details, or
null
if none.
-
setOtherCitationDetails
Set other information required to complete the citation that is not recorded elsewhere. Set tonull
if 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. Returnsnull
if there is no title.- Specified by:
getCollectiveTitle
in interfaceCitation
- Returns:
- The common title, or
null
if 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 tonull
if there is no title. -
getISBN
Returns the International Standard Book Number, ornull
if none. -
setISBN
Set the International Standard Book Number, ornull
if none. -
getISSN
Returns the International Standard Serial Number, ornull
if none. -
setISSN
Set the International Standard Serial Number, ornull
if none.
-