org.geotools.metadata.iso.citation
Class CitationImpl

java.lang.Object
  org.geotools.metadata.iso.MetadataEntity
      org.geotools.metadata.iso.citation.CitationImpl

All Implemented Interfaces:

org.opengis.metadata.citation.Citation, java.lang.Cloneable, java.io.Serializable

public class CitationImpl

extends MetadataEntity

implements org.opengis.metadata.citation.Citation

Standardized resource reference.

Since:

2.1

Version:

$Id: CitationImpl.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux, Jody Garnett

See Also:

Serialized Form

Field Summary

static org.opengis.metadata.citation.Citation	AUTO Deprecated. Moved into the Citations class.
static org.opengis.metadata.citation.Citation	AUTO2 Deprecated. Moved into the Citations class.
static org.opengis.metadata.citation.Citation	EPSG Deprecated. Moved into the Citations class.
static org.opengis.metadata.citation.Citation	ESRI Deprecated. Moved into the Citations class.
static org.opengis.metadata.citation.Citation	GEOTIFF Deprecated. Moved into the Citations class.
static org.opengis.metadata.citation.Citation	GEOTOOLS Deprecated. Moved into the Citations class.
static org.opengis.metadata.citation.Citation	JAI Deprecated. Moved into the Citations class.
static org.opengis.metadata.citation.Citation	OGC Deprecated. Moved into the Citations class.
static org.opengis.metadata.citation.Citation	OPEN_GIS Deprecated. Moved into the Citations class.
static org.opengis.metadata.citation.Citation	ORACLE Deprecated. Moved into the Citations class.

Fields inherited from class org.geotools.metadata.iso.MetadataEntity

LOGGER

Constructor Summary

CitationImpl()
Constructs an initially empty citation.

CitationImpl(java.lang.CharSequence title)
Constructs a citation with the specified title.

CitationImpl(org.opengis.metadata.citation.Citation source)
Constructs a new citation initialized to the values specified by the given object.

CitationImpl(org.opengis.metadata.citation.ResponsibleParty party)
Constructs a citation with the specified responsible party.

Method Summary

static org.opengis.metadata.citation.Citation	createCitation(java.lang.String name) Deprecated. Moved as Citations.fromName(java.lang.String).
boolean	equals(java.lang.Object object) Compare this citation with the specified object for equality.
protected void	freeze() Declare this metadata and all its attributes as unmodifiable.
java.util.Collection	getAlternateTitles() Returns the short name or other language name by which the cited information is known.
java.util.Collection	getCitedResponsibleParties() Returns the name and position information for an individual or organization that is responsible for the resource.
org.opengis.util.InternationalString	getCollectiveTitle() Returns the common title with holdings note.
java.util.Collection	getDates() Returns the reference date for the cited resource.
org.opengis.util.InternationalString	getEdition() Returns the version of the cited resource.
java.util.Date	getEditionDate() Returns the date of the edition, or if none.
java.util.Collection	getIdentifiers() Returns the unique identifier for the resource.
java.util.Collection	getIdentifierTypes() Returns the reference form of the unique identifier (ID).
java.lang.String	getISBN() Returns the International Standard Book Number, or if none.
java.lang.String	getISSN() Returns the International Standard Serial Number, or if none.
org.opengis.util.InternationalString	getOtherCitationDetails() Returns other information required to complete the citation that is not recorded elsewhere.
java.util.Collection	getPresentationForm() Returns the mode in which the resource is represented, or an empty string if none.
org.opengis.metadata.citation.Series	getSeries() Returns the information about the series, or aggregate dataset, of which the dataset is a part.
org.opengis.util.InternationalString	getTitle() Returns the name by which the cited resource is known.
int	hashCode() Returns a hash code value for this citation.
void	setAlternateTitles(java.util.Collection newValues) Set the short name or other language name by which the cited information is known.
void	setCitedResponsibleParties(java.util.Collection newValues) Set the name and position information for an individual or organization that is responsible for the resource.
void	setCollectiveTitle(org.opengis.util.InternationalString newValue) Set the common title with holdings note.
void	setDates(java.util.Collection newValues) Set the reference date for the cited resource.
void	setEdition(org.opengis.util.InternationalString newValue) Set the version of the cited resource.
void	setEditionDate(java.util.Date newValue) Set the date of the edition, or if none.
void	setIdentifiers(java.util.Collection newValues) Set the unique identifier for the resource.
void	setIdentifierTypes(java.util.Collection newValues) Set the reference form of the unique identifier (ID).
void	setISBN(java.lang.String newValue) Set the International Standard Book Number, or if none.
void	setISSN(java.lang.String newValue) Set the International Standard Serial Number, or if none.
void	setOtherCitationDetails(org.opengis.util.InternationalString newValue) Set other information required to complete the citation that is not recorded elsewhere.
void	setPresentationForm(java.util.Collection newValues) Set the mode in which the resource is represented, or an empty string if none.
void	setSeries(org.opengis.metadata.citation.Series newValue) Set the information about the series, or aggregate dataset, of which the dataset is a part.
void	setTitle(org.opengis.util.InternationalString newValue) Set the name by which the cited resource is known.
static boolean	titleMatches(org.opengis.metadata.citation.Citation c1, org.opengis.metadata.citation.Citation c2) Deprecated. Moved into the Citations class.
static boolean	titleMatches(org.opengis.metadata.citation.Citation citation, java.lang.String title) Deprecated. Moved into the Citations class.
java.lang.String	toString() Returns a string representation of this citation.

Methods inherited from class org.geotools.metadata.iso.MetadataEntity

appendLineSeparator, checkWritePermission, copyCollection, isModifiable, nonNullCollection, unmodifiable, unmodifiable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OGC

public static final org.opengis.metadata.citation.Citation OGC

Deprecated. Moved into the Citations class.

The Open Geospatial consortium organisation. "Open Geospatial consortium" is the new name for "OpenGIS consortium". An alternate title for this citation is "OGC" (according ISO 19115, alternate titles often contain abreviations).

OPEN_GIS

public static final org.opengis.metadata.citation.Citation OPEN_GIS

Deprecated. Moved into the Citations class.

The OpenGIS consortium organisation. "OpenGIS consortium" is the old name for "Open Geospatial consortium". Alternate titles for this citation are "OpenGIS" and "OGC" (according ISO 19115, alternate titles often contain abreviations).

ESRI

public static final org.opengis.metadata.citation.Citation ESRI

Deprecated. Moved into the Citations class.

The ESRI organisation.

ORACLE

public static final org.opengis.metadata.citation.Citation ORACLE

Deprecated. Moved into the Citations class.

The Oracle organisation.

GEOTOOLS

public static final org.opengis.metadata.citation.Citation GEOTOOLS

Deprecated. Moved into the Citations class.

The Geotools project.

GEOTIFF

public static final org.opengis.metadata.citation.Citation GEOTIFF

Deprecated. Moved into the Citations class.

The GeoTIFF specification.

JAI

public static final org.opengis.metadata.citation.Citation JAI

Deprecated. Moved into the Citations class.

The Java Advanced Imaging library. An alternate title for this citation is "JAI" (according ISO 19115, alternate titles often contain abreviations).

EPSG

public static final org.opengis.metadata.citation.Citation EPSG

Deprecated. Moved into the Citations class.

The European Petroleum Survey Group authority. An alternate title for this citation is "EPSG" (according ISO 19115, alternate titles often contain abreviations).

AUTO

public static final org.opengis.metadata.citation.Citation AUTO

Deprecated. Moved into the Citations class.

The WMS 1.1.1 "Automatic Projections" Authority. An alternate title for this citation is "AUTO" (according ISO 19115, alternate titles often contain abreviations).

AUTO2

public static final org.opengis.metadata.citation.Citation AUTO2

Deprecated. Moved into the Citations class.

The WMS 1.3.0 "Automatic Projections" authority. An alternate title for this citation is "AUTO2" (according ISO 19115, alternate titles often contain abreviations).

Constructor Detail

CitationImpl

public CitationImpl()

Constructs an initially empty citation.

CitationImpl

public CitationImpl(org.opengis.metadata.citation.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(java.lang.CharSequence title)

Constructs a citation with the specified title.

Parameters:

title - The title, as a String or an InternationalString object.

CitationImpl

public CitationImpl(org.opengis.metadata.citation.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

createCitation

public static org.opengis.metadata.citation.Citation createCitation(java.lang.String name)

Deprecated. Moved as Citations.fromName(java.lang.String).

Returns a citation of the given name.

titleMatches

public static boolean titleMatches(org.opengis.metadata.citation.Citation c1,
                                   org.opengis.metadata.citation.Citation c2)

Deprecated. Moved into the Citations class.

Returns if at least one title or alternate title is found equals in both citations. The comparaison is case-insensitive and ignores leading and trailing spaces. The titles ordering is ignored.

Parameters:

c1 - The first citation to compare.

c2 - the second citation to compare.

Returns:

if at least one title or alternate title matches.

titleMatches

public static boolean titleMatches(org.opengis.metadata.citation.Citation citation,
                                   java.lang.String title)

Deprecated. Moved into the Citations class.

Returns if the title or any alternate title in the given citation matches the given string. The comparaison is case-insensitive and ignores leading and trailing spaces.

Parameters:

citation - The citation to check for.

title - The title or alternate title to compare.

Returns:

if the title or alternate title matches the given string.

getTitle

public org.opengis.util.InternationalString getTitle()

Returns the name by which the cited resource is known.

Specified by:

getTitle in interface org.opengis.metadata.citation.Citation

setTitle

public void setTitle(org.opengis.util.InternationalString newValue)

Set the name by which the cited resource is known.

getAlternateTitles

public java.util.Collection 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 interface org.opengis.metadata.citation.Citation

setAlternateTitles

public void setAlternateTitles(java.util.Collection newValues)

Set the short name or other language name by which the cited information is known.

getDates

public java.util.Collection getDates()

Returns the reference date for the cited resource.

Specified by:

getDates in interface org.opengis.metadata.citation.Citation

setDates

public void setDates(java.util.Collection newValues)

Set the reference date for the cited resource.

getEdition

public org.opengis.util.InternationalString getEdition()

Returns the version of the cited resource.

Specified by:

getEdition in interface org.opengis.metadata.citation.Citation

setEdition

public void setEdition(org.opengis.util.InternationalString newValue)

Set the version of the cited resource.

getEditionDate

public java.util.Date getEditionDate()

Returns the date of the edition, or if none.

Specified by:

getEditionDate in interface org.opengis.metadata.citation.Citation

setEditionDate

public void setEditionDate(java.util.Date newValue)

Set the date of the edition, or if none.

To Do:

Use an unmodifiable Date here.

getIdentifiers

public java.util.Collection getIdentifiers()

Returns the unique identifier for the resource. Example: Universal Product Code (UPC), National Stock Number (NSN).

Specified by:

getIdentifiers in interface org.opengis.metadata.citation.Citation

setIdentifiers

public void setIdentifiers(java.util.Collection newValues)

Set the unique identifier for the resource. Example: Universal Product Code (UPC), National Stock Number (NSN).

getIdentifierTypes

public java.util.Collection getIdentifierTypes()

Returns the reference form of the unique identifier (ID). Example: Universal Product Code (UPC), National Stock Number (NSN).

Specified by:

getIdentifierTypes in interface org.opengis.metadata.citation.Citation

setIdentifierTypes

public void setIdentifierTypes(java.util.Collection newValues)

Set the reference form of the unique identifier (ID). Example: Universal Product Code (UPC), National Stock Number (NSN).

getCitedResponsibleParties

public java.util.Collection 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 interface org.opengis.metadata.citation.Citation

setCitedResponsibleParties

public void setCitedResponsibleParties(java.util.Collection 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 java.util.Collection getPresentationForm()

Returns the mode in which the resource is represented, or an empty string if none.

Specified by:

getPresentationForm in interface org.opengis.metadata.citation.Citation

setPresentationForm

public void setPresentationForm(java.util.Collection newValues)

Set the mode in which the resource is represented, or an empty string if none.

getSeries

public org.opengis.metadata.citation.Series getSeries()

Returns the information about the series, or aggregate dataset, of which the dataset is a part. Returns if none.

Specified by:

getSeries in interface org.opengis.metadata.citation.Citation

setSeries

public void setSeries(org.opengis.metadata.citation.Series newValue)

Set the information about the series, or aggregate dataset, of which the dataset is a part. Set to if none.

getOtherCitationDetails

public org.opengis.util.InternationalString getOtherCitationDetails()

Returns other information required to complete the citation that is not recorded elsewhere. Returns if none.

Specified by:

getOtherCitationDetails in interface org.opengis.metadata.citation.Citation

setOtherCitationDetails

public void setOtherCitationDetails(org.opengis.util.InternationalString newValue)

Set other information required to complete the citation that is not recorded elsewhere. Set to if none.

getCollectiveTitle

public org.opengis.util.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. Returns if there is no title.

Specified by:

getCollectiveTitle in interface org.opengis.metadata.citation.Citation

setCollectiveTitle

public void setCollectiveTitle(org.opengis.util.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 to if there is no title.

getISBN

public java.lang.String getISBN()

Returns the International Standard Book Number, or if none.

Specified by:

getISBN in interface org.opengis.metadata.citation.Citation

setISBN

public void setISBN(java.lang.String newValue)

Set the International Standard Book Number, or if none.

getISSN

public java.lang.String getISSN()

Returns the International Standard Serial Number, or if none.

Specified by:

getISSN in interface org.opengis.metadata.citation.Citation

setISSN

public void setISSN(java.lang.String newValue)

Set the International Standard Serial Number, or if none.

freeze

protected void freeze()

Declare this metadata and all its attributes as unmodifiable.

Overrides:

freeze in class MetadataEntity

equals

public boolean equals(java.lang.Object object)

Compare this citation with the specified object for equality.

hashCode

public int hashCode()

Returns a hash code value for this citation. For performance reason, this method do not uses all attributes for computing the hash code. Instead, it uses the attributes that are the most likely to be unique.

toString

public java.lang.String toString()

Returns a string representation of this citation.

To Do:

Provides a more elaborated implementation.