Citations (Geotools modules 21.0 API)

Object
- Citations

```
public final class Citations
extends Object
```
A set of pre-defined constants and static methods working on citations. Pre-defined metadata constants are usually declared in implementation classes like ResponsiblePartyImpl. But citations are an exception since they are extensively referenced in the Geotools library, and handling citations requires some convenience methods. They are factored out in this Citations class for clarity.
Citations may be about an organisation (e.g. OpenGIS), a specification (e.g. WMS) or an authority that maintains definitions of codes (e.g. EPSG). In the later case, the citation contains an identifier which is the namespace of the codes maintained by the authority. For example the identifier for the EPSG citation is "EPSG", and EPSG codes look like "EPSG:4326".

Since:

2.2

Author:

Martin Desruisseaux (IRD), Jody Garnett

Field Summary

Fields
Modifier and Type	Field and Description
`static Citation`	`AUTO` The WMS 1.1.1 "Automatic Projections" authority.
`static Citation`	`AUTO2` The WMS 1.3.0 "Automatic Projections" authority.
`static Citation`	`CRS` The WMS 1.3.0 "CRS" authority.
`static Citation`	`EPSG` The European Petroleum Survey Group authority.
`static Citation`	`ESRI` The ESRI organisation.
`static Citation`	`GEOTIFF` The GeoTIFF specification.
`static Citation`	`GEOTOOLS` The Geotools project.
`static Citation`	`HTTP_OGC` URL in the OGC namespace.
`static Citation`	`HTTP_URI_OGC` HTTP URI in the OGC namespace.
`static Citation`	`JAI` The Java Advanced Imaging library.
`static Citation`	`OGC` The Open Geospatial consortium organisation.
`static Citation`	`OPEN_GIS` The OpenGIS consortium organisation.
`static Citation`	`ORACLE` The Oracle organisation.
`static Citation`	`POSTGIS` The PostGIS project.
`static Citation`	`URN_OGC` URN in the OGC namespace.
`static Citation`	`WMS` The Web Map Service specification.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Citation`	`fromName(String title)` Returns a citation of the given name.
`static String`	`getIdentifier(Citation citation)` Returns the shortest identifier for the specified citation, or the title if there is no identifier.
`static boolean`	`identifierMatches(Citation c1, Citation c2)` Returns `true` if at least one identifier in `c1` is equals to an identifier in `c2`.
`static boolean`	`identifierMatches(Citation citation, String identifier)` Returns `true` if any identifiers in the given citation matches the given string.
`static boolean`	`titleMatches(Citation c1, Citation c2)` Returns `true` if at least one title or alternate title in `c1` is equals to a title or alternate title in `c2`.
`static boolean`	`titleMatches(Citation citation, String title)` Returns `true` if the title or any alternate title in the given citation matches the given string.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OGC
```
public static final Citation OGC
```
    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).
    
    See Also:
    
    ResponsiblePartyImpl.OGC, OPEN_GIS
  - OPEN_GIS
```
public static final Citation OPEN_GIS
```
    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).
    
    See Also:
    
    ResponsiblePartyImpl.OPEN_GIS, OGC
  - ESRI
```
public static final Citation ESRI
```
    The ESRI organisation.
    
    See Also:
    
    ResponsiblePartyImpl.ESRI
  - ORACLE
```
public static final Citation ORACLE
```
    The Oracle organisation.
    
    See Also:
    
    ResponsiblePartyImpl.ORACLE
  - POSTGIS
```
public static final Citation POSTGIS
```
    The PostGIS project.
    
    Since:
    
    2.4
    
    See Also:
    
    ResponsiblePartyImpl.POSTGIS
  - GEOTOOLS
```
public static final Citation GEOTOOLS
```
    The Geotools project.
    
    See Also:
    
    ResponsiblePartyImpl.GEOTOOLS
  - WMS
```
public static final Citation WMS
```
    The Web Map Service specification. Alternate titles for this citation are "WMS", "WMS 1.3.0", "OGC 04-024" and "ISO 19128". Note that the version numbers may be upgrated in future Geotools versions.
    
    See Also:
    
    Open Geospatial Consortium, WMS 1.1.1 specification, WMS 1.3.0 specification, ResponsiblePartyImpl.OGC, OnLineResourceImpl.WMS
  - GEOTIFF
```
public static final Citation GEOTIFF
```
    The GeoTIFF specification.
    
    See Also:
    
    ResponsiblePartyImpl.GEOTIFF
  - JAI
```
public static final Citation JAI
```
    The Java Advanced Imaging library. An alternate title for this citation is "JAI" (according ISO 19115, alternate titles often contain abreviations).
    
    See Also:
    
    ResponsiblePartyImpl.SUN_MICROSYSTEMS
  - EPSG
```
public static final Citation EPSG
```
    The European Petroleum Survey Group authority. An alternate title for this citation is "EPSG" (according ISO 19115, alternate titles often contain abreviations). In addition, this citation contains the "EPSG" identifier for the "Authority name" identifier type.
    This citation is used as an authority for coordinate reference system identifiers. When searching an CRS authority factory on EPSG data, Geotools compares the "EPSG" string against the identifiers (or against the title and alternate titles if there is no identifier) using the identifierMatches method.
    
    See Also:
    
    ResponsiblePartyImpl.EPSG, AUTO, AUTO2, CRS
  - AUTO
```
public static final Citation AUTO
```
    The WMS 1.1.1 "Automatic Projections" authority. An alternate title for this citation is "AUTO" (according ISO 19115, alternate titles often contain abreviations). In addition, this citation contains the "AUTO" identifier for the "Authority name" identifier type.
    Warning: AUTO is different from AUTO2 used for WMS 1.3.0.
    This citation is used as an authority for coordinate reference system identifiers. When searching an CRS authority factory on AUTO data, Geotools compares the "AUTO" string against the identifiers (or against the title and alternate titles if there is no identifier) using the identifierMatches method.
    
    See Also:
    
    Open Geospatial Consortium, WMS 1.1.1 specification, WMS, AUTO2, CRS, EPSG
  - AUTO2
```
public static final Citation AUTO2
```
    The WMS 1.3.0 "Automatic Projections" authority. An alternate title for this citation is "AUTO2" (according ISO 19115, alternate titles often contain abreviations). In addition, this citation contains the "AUTO2" identifier for the "Authority name" identifier type.
    Warning: AUTO2 is different from AUTO used for WMS 1.1.1 and earlier.
    This citation is used as an authority for coordinate reference system identifiers. When searching an CRS authority factory on AUTO2 data, Geotools compares the "AUTO2" string against the identifiers (or against the title and alternate titles if there is no identifier) using the identifierMatches method.
    
    See Also:
    
    Open Geospatial Consortium, WMS 1.3.0 specification, WMS, AUTO, CRS, EPSG
  - CRS
```
public static final Citation CRS
```
    The WMS 1.3.0 "CRS" authority. This is defined in the same document than AUTO2.
    
    See Also:
    
    WMS, AUTO, AUTO2, CRS, EPSG
  - URN_OGC
```
public static final Citation URN_OGC
```
    URN in the OGC namespace. This citation contains the "urn:ogc:def" and "urn:x-ogc:def" identifiers for the "Authority name" identifier type.
    
    Since:
    
    2.4
  - HTTP_OGC
```
public static final Citation HTTP_OGC
```
    URL in the OGC namespace. This citation contains the "http://www.opengis.net/gml" identifiers for the "Authority name" identifier type.
    
    Since:
    
    2.4
  - HTTP_URI_OGC
```
public static final Citation HTTP_URI_OGC
```
    HTTP URI in the OGC namespace. This citation contains the "http://www.opengis.net/def" identifiers for the "Authority name" identifier type.
    
    Since:
    
    9
- Method Detail
  - fromName
```
public static Citation fromName(String title)
```
    Returns a citation of the given name. If the given name matches a title or an alternate titles of one of the pre-defined constants (EPSG, GEOTIFF, etc.), then this constant is returned. Otherwise, a new citation is created with the specified name as the title.
    
    Parameters:
    
    title - The citation title (or alternate title).
    
    Returns:
    
    A citation using the specified name
  - titleMatches
```
public static boolean titleMatches(Citation c1,
                                   Citation c2)
```
    Returns true if at least one title or alternate title in c1 is equals to a title or alternate title in c2. The comparaison is case-insensitive and ignores leading and trailing spaces. The titles ordering is not significant.
    
    Parameters:
    
    c1 - The first citation to compare.
    
    c2 - the second citation to compare.
    
    Returns:
    
    true if at least one title or alternate title matches.
  - titleMatches
```
public static boolean titleMatches(Citation citation,
                                   String title)
```
    Returns true 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:
    
    true if the title or alternate title matches the given string.
  - identifierMatches
```
public static boolean identifierMatches(Citation c1,
                                        Citation c2)
```
    Returns true if at least one identifier in c1 is equals to an identifier in c2. The comparaison is case-insensitive and ignores leading and trailing spaces. The identifier ordering is not significant.
    If (and only if) the citations do not contains any identifier, then this method fallback on titles comparaison using the titleMatches method. This fallback exists for compatibility with client codes using citation titles without identifiers.
    
    Parameters:
    
    c1 - The first citation to compare.
    
    c2 - the second citation to compare.
    
    Returns:
    
    true if at least one identifier, title or alternate title matches.
  - identifierMatches
```
public static boolean identifierMatches(Citation citation,
                                        String identifier)
```
    Returns true if any identifiers in the given citation matches the given string. The comparaison is case-insensitive and ignores leading and trailing spaces. If (and only if) the citation do not contains any identifier, then this method fallback on titles comparaison using the titleMatches method. This fallback exists for compatibility with client codes using citation titles without identifiers.
    
    Parameters:
    
    citation - The citation to check for.
    
    identifier - The identifier to compare.
    
    Returns:
    
    true if the title or alternate title matches the given string.
  - getIdentifier
```
public static String getIdentifier(Citation citation)
```
    Returns the shortest identifier for the specified citation, or the title if there is no identifier. This method is useful for extracting the namespace from an authority, for example "EPSG".
    
    Parameters:
    
    citation - The citation for which to get the identifier.
    
    Returns:
    
    The shortest identifier of the given citation.
    
    Since:
    
    2.4

Class Citations

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

OGC

OPEN_GIS

ESRI

ORACLE

POSTGIS

GEOTOOLS

WMS

GEOTIFF

JAI

EPSG

AUTO

AUTO2

CRS

URN_OGC

HTTP_OGC

HTTP_URI_OGC

Method Detail

fromName

titleMatches

titleMatches

identifierMatches

identifierMatches

getIdentifier