org.opengis.cs
Interface CS_Info

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

CS_AngularUnit, CS_CompoundCoordinateSystem, CS_CoordinateSystem, CS_Datum, CS_Ellipsoid, CS_FittedCoordinateSystem, CS_GeocentricCoordinateSystem, CS_GeographicCoordinateSystem, CS_HorizontalCoordinateSystem, CS_HorizontalDatum, CS_LinearUnit, CS_LocalCoordinateSystem, CS_LocalDatum, CS_PrimeMeridian, CS_ProjectedCoordinateSystem, CS_Projection, CS_Unit, CS_VerticalCoordinateSystem, CS_VerticalDatum

All Known Implementing Classes:

CompoundCoordinateSystem.Export, CoordinateSystem.Export, Datum.Export, Ellipsoid.Export, GeocentricCoordinateSystem.Export, GeographicCoordinateSystem.Export, HorizontalCoordinateSystem.Export, HorizontalDatum.Export, Info.AngularUnit, Info.Export, Info.LinearUnit, LocalCoordinateSystem.Export, LocalDatum.Export, PrimeMeridian.Export, ProjectedCoordinateSystem.Export, Projection.Export, VerticalCoordinateSystem.Export, VerticalDatum.Export

public interface CS_Info

extends java.rmi.Remote

A base interface 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 CS_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 CS_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.

Since:

1.00

Version:

1.01

Author:

Martin Daly

Method Summary

java.lang.String	getAbbreviation() Gets the abbreviation.
java.lang.String	getAlias() Gets the alias.
java.lang.String	getAuthority() Gets the authority name.
java.lang.String	getAuthorityCode() Gets the authority-specific identification code.
java.lang.String	getName() Gets the name.
java.lang.String	getRemarks() Gets the provider-supplied remarks.
java.lang.String	getWKT() Gets a Well-Known text representation of this object.
java.lang.String	getXML() Gets an XML representation of this object.

Method Detail

getName

public java.lang.String getName()
                         throws java.rmi.RemoteException

Gets the name.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getAuthority

public java.lang.String getAuthority()
                              throws java.rmi.RemoteException

Gets the authority name. 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'.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getAuthorityCode

public java.lang.String getAuthorityCode()
                                  throws java.rmi.RemoteException

Gets the authority-specific identification code. 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'. An empty string is used for no code.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getAlias

public java.lang.String getAlias()
                          throws java.rmi.RemoteException

Gets the alias.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getAbbreviation

public java.lang.String getAbbreviation()
                                 throws java.rmi.RemoteException

Gets the abbreviation.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getRemarks

public java.lang.String getRemarks()
                            throws java.rmi.RemoteException

Gets the provider-supplied remarks.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getWKT

public java.lang.String getWKT()
                        throws java.rmi.RemoteException

Gets a Well-Known text representation of this object.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getXML

public java.lang.String getXML()
                        throws java.rmi.RemoteException

Gets an XML representation of this object.

Throws:

java.rmi.RemoteException - if a remote method call failed.