Class CitationImpl
- Object
-
- AbstractMetadata
-
- ModifiableMetadata
-
- MetadataEntity
-
- CitationImpl
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Citation
public class CitationImpl extends MetadataEntity implements Citation
Standardized resource reference.- Since:
- 2.1
- Author:
- Martin Desruisseaux (IRD), Jody Garnett
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class AbstractMetadata
LOGGER
-
-
Constructor Summary
Constructors Constructor Description CitationImpl()
Constructs 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Collection<InternationalString>
getAlternateTitles()
Returns the short name or other language name by which the cited information is known.Collection<ResponsibleParty>
getCitedResponsibleParties()
Returns the name and position information for an individual or organization that is responsible for the resource.InternationalString
getCollectiveTitle()
Returns the common title with holdings note.InternationalString
getEdition()
Returns the version of the cited resource.Date
getEditionDate()
Returns the date of the edition, ornull
if none.Collection<Identifier>
getIdentifiers()
Returns the unique identifier for the resource.String
getISBN()
Returns the International Standard Book Number, ornull
if none.String
getISSN()
Returns the International Standard Serial Number, ornull
if none.InternationalString
getOtherCitationDetails()
Returns other information required to complete the citation that is not recorded elsewhere.Collection<PresentationForm>
getPresentationForm()
Returns the mode in which the resource is represented, or an empty string if none.InternationalString
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
setISBN(String newValue)
Set the International Standard Book Number, ornull
if none.void
setISSN(String newValue)
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 Detail
-
CitationImpl
public CitationImpl()
Constructs an initially empty citation.
-
CitationImpl
public CitationImpl(Citation source)
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
public CitationImpl(CharSequence title)
Constructs a citation with the specified title.- Parameters:
title
- The title, as aString
or anInternationalString
object.
-
CitationImpl
public CitationImpl(ResponsibleParty party)
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 Detail
-
getTitle
public InternationalString getTitle()
Returns the name by which the cited resource is known.
-
setTitle
public void setTitle(InternationalString newValue)
Set the name by which the cited resource is known.
-
getAlternateTitles
public Collection<InternationalString> 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
public void setAlternateTitles(Collection<? extends InternationalString> newValues)
Set the short name or other language name by which the cited information is known.
-
getEdition
public InternationalString getEdition()
Returns the version of the cited resource.- Specified by:
getEdition
in interfaceCitation
- Returns:
- The version, or
null
if none.
-
setEdition
public void setEdition(InternationalString newValue)
Set the version of the cited resource.
-
getEditionDate
public Date getEditionDate()
Returns the date of the edition, ornull
if none.- Specified by:
getEditionDate
in interfaceCitation
- Returns:
- The edition date, or
null
if none.
-
setEditionDate
public void setEditionDate(Date newValue)
Set the date of the edition, ornull
if none.
-
getIdentifiers
public Collection<Identifier> 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
public void setIdentifiers(Collection<? extends Identifier> newValues)
Set the unique identifier for the resource. Example: Universal Product Code (UPC), National Stock Number (NSN).
-
getCitedResponsibleParties
public Collection<ResponsibleParty> 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
public void setCitedResponsibleParties(Collection<? extends ResponsibleParty> newValues)
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
public Collection<PresentationForm> 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
public void setPresentationForm(Collection<? extends PresentationForm> newValues)
Set the mode in which the resource is represented, or an empty string if none.
-
getOtherCitationDetails
public InternationalString 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
public void setOtherCitationDetails(InternationalString newValue)
Set other information required to complete the citation that is not recorded elsewhere. Set tonull
if none.
-
getCollectiveTitle
public InternationalString 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
public void setCollectiveTitle(InternationalString newValue)
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
public String getISBN()
Returns the International Standard Book Number, ornull
if none.
-
setISBN
public void setISBN(String newValue)
Set the International Standard Book Number, ornull
if none.
-
getISSN
public String getISSN()
Returns the International Standard Serial Number, ornull
if none.
-
setISSN
public void setISSN(String newValue)
Set the International Standard Serial Number, ornull
if none.
-
-