org.geotools.cs
Class Info

java.lang.Object
  org.geotools.cs.Info

All Implemented Interfaces:

org.opengis.referencing.IdentifiedObject, java.io.Serializable

Direct Known Subclasses:

CoordinateSystem, CoordinateTransformation, Datum, Ellipsoid, PrimeMeridian, Projection

Deprecated. Replaced by AbstractIdentifiedObject and NamedIdentifier.

public class Info

extends java.lang.Object

implements org.opengis.referencing.IdentifiedObject, java.io.Serializable

A base class for metadata applicable to coordinate system objects. The metadata items "Abbreviation", "Alias", "Authority", "AuthorityCode", "Name" and "Remarks" were specified in the Simple Features interfaces, so they have been kept here. This specification does not dictate what the contents of these items should be. However, the following guidelines are suggested:

• When CoordinateSystemAuthorityFactory is used to create an object, the "Authority" and "AuthorityCode" values should be set to the authority name of the factory object, and the authority code supplied by the client, respectively. The other values may or may not be set. (If the authority is EPSG, the implementer may consider using the corresponding metadata values in the EPSG tables.)
• When CoordinateSystemFactory creates an object, the "Name" should be set to the value supplied by the client. All of the other metadata items should be left empty.

Version:

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

Author:

OpenGIS (www.opengis.org), Martin Desruisseaux

See Also:

CS_Info, Serialized Form

Field Summary

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Info(java.lang.CharSequence name)
Deprecated. Creates an object with the specified name.

Method Summary

protected static void	ensureNonNull(java.lang.String name, java.lang.Object object) Deprecated. Makes sure an argument is non-null.
boolean	equals(Info object, boolean compareNames) Deprecated. Compare this object with the specified object for equality.
boolean	equals(java.lang.Object object) Deprecated. Compares the specified object with this info for equality.
java.lang.String	getAbbreviation(java.util.Locale locale) Deprecated. No replacement.
java.util.Collection	getAlias() Deprecated. For compatibility with GeoAPI interfaces.
java.lang.String	getAlias(java.util.Locale locale) Deprecated. Replaced by AbstractIdentifiedObject.getIdentifiers().
java.lang.String	getAuthority(java.util.Locale locale) Deprecated. Gets the authority name, or null if unspecified.
java.lang.String	getAuthorityCode(java.util.Locale locale) Deprecated. Replaced by NamedIdentifier#getCode.
java.util.Set	getIdentifiers() Deprecated. For compatibility with GeoAPI interfaces.
org.opengis.metadata.Identifier	getName() Deprecated. Gets the name of this object.
org.opengis.util.InternationalString	getRemarks() Deprecated. Gets the provider-supplied remarks, or null if there is none.
int	hashCode() Deprecated. Returns a hash value for this info.
java.lang.String	toString() Deprecated. Returns a Well Known Text (WKT) for this info.
java.lang.String	toWKT() Deprecated. For compatibility with GeoAPI interfaces.

Methods inherited from class java.lang.Object

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

Constructor Detail

Info

public Info(java.lang.CharSequence name)

Deprecated.

Creates an object with the specified name. If name implements the Map interface, then its values will be copied for the following keys:

• "authority"
• "authorityCode"
• "alias"
• "abbreviation"
• "remarks"

Parameters:

name - This object name.

Method Detail

getName

public org.opengis.metadata.Identifier getName()

Deprecated.

Gets the name of this object. The default implementation returns the non-localized name given at construction time.

Specified by:

getName in interface org.opengis.referencing.IdentifiedObject

See Also:

CS_Info.getName()

getAuthority

public java.lang.String getAuthority(java.util.Locale locale)

Deprecated.

Gets the authority name, or null if unspecified. An Authority is an organization that maintains definitions of Authority Codes. For example the European Petroleum Survey Group (EPSG) maintains a database of coordinate systems, and other spatial referencing objects, where each object has a code number ID. For example, the EPSG code for a WGS84 Lat/Lon coordinate system is '4326'.

Parameters:

locale - The desired locale, or null for the default locale. If no string is available for the specified locale, an arbitrary locale is used.

See Also:

CS_Info.getAuthority()

getAuthorityCode

public java.lang.String getAuthorityCode(java.util.Locale locale)

Deprecated. Replaced by NamedIdentifier#getCode.

Gets the authority-specific identification code, or null if unspecified. The AuthorityCode is a compact string defined by an Authority to reference a particular spatial reference object. For example, the European Survey Group (EPSG) authority uses 32 bit integers to reference coordinate systems, so all their code strings will consist of a few digits. The EPSG code for WGS84 Lat/Lon is '4326'

Parameters:

locale - The desired locale, or null for the default locale. If no string is available for the specified locale, an arbitrary locale is used.

See Also:

CS_Info.getAuthorityCode()

getAlias

public java.lang.String getAlias(java.util.Locale locale)

Deprecated. Replaced by AbstractIdentifiedObject.getIdentifiers().

Gets the alias, or null if there is none.

Parameters:

locale - The desired locale, or null for the default locale. If no string is available for the specified locale, an arbitrary locale is used.

See Also:

CS_Info.getAlias()

getAlias

public java.util.Collection getAlias()

Deprecated.

For compatibility with GeoAPI interfaces.

Specified by:

getAlias in interface org.opengis.referencing.IdentifiedObject

getAbbreviation

public java.lang.String getAbbreviation(java.util.Locale locale)

Deprecated. No replacement.

Gets the abbreviation, or null if there is none.

Parameters:

locale - The desired locale, or null for the default locale. If no string is available for the specified locale, an arbitrary locale is used.

See Also:

CS_Info.getAbbreviation()

getRemarks

public org.opengis.util.InternationalString getRemarks()

Deprecated.

Gets the provider-supplied remarks, or null if there is none.

Specified by:

getRemarks in interface org.opengis.referencing.IdentifiedObject

See Also:

CS_Info.getRemarks()

equals

public boolean equals(Info object,
                      boolean compareNames)

Deprecated.

Compare this object with the specified object for equality. If compareNames is true, then all available properties are compared including name, alias, authority code, etc. If compareNames is false, then this method compare only the properties needed for computing transformations. In other words, sourceCS.equals(targetCS, false) returns true if the transformation from sourceCS to targetCS is the identity transform, no matter what getName() saids.

Parameters:

object - The object to compare to this.

compareNames - true for performing a strict comparaison, or false for comparing only properties relevant to transformations.

Returns:

true if both objects are equal.

equals

public final boolean equals(java.lang.Object object)

Deprecated.

Compares the specified object with this info for equality. The default implementation invokes equals(Info, boolean).

Parameters:

object - The other object (may be null).

Returns:

true if both objects are equal.

hashCode

public int hashCode()

Deprecated.

Returns a hash value for this info. Name, alias, authority code and the like are not taken in account. In other words, two info objects will return the same hash value if they are equal in the sense of equals(Info, false).

Returns:

The hash code value. This value doesn't need to be the same in past or future versions of this class.

toString

public java.lang.String toString()

Deprecated.

Returns a Well Known Text (WKT) for this info. "Well known text" are part of OpenGIS's specification.

See Also:

CS_Info.getWKT()

ensureNonNull

protected static void ensureNonNull(java.lang.String name,
                                    java.lang.Object object)
                             throws java.lang.IllegalArgumentException

Deprecated.

Makes sure an argument is non-null. This is a convenience method for subclass constructors.

Parameters:

name - Argument name.

object - User argument.

Throws:

IllegalArgumentException - if object is null.

getIdentifiers

public java.util.Set getIdentifiers()

Deprecated.

For compatibility with GeoAPI interfaces.

Specified by:

getIdentifiers in interface org.opengis.referencing.IdentifiedObject

toWKT

public java.lang.String toWKT()

Deprecated.

For compatibility with GeoAPI interfaces.

Specified by:

toWKT in interface org.opengis.referencing.IdentifiedObject