org.geotools.referencing.wkt
Class Formattable

java.lang.Object
  org.geotools.referencing.wkt.Formattable

Direct Known Subclasses:

AbstractIdentifiedObject, AbstractMathTransform, AbstractParameter, BursaWolfParameters

public class Formattable

extends java.lang.Object

Base class for all object formattable as Well Known Text (WKT).

Since:

2.0

Version:

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

Author:

Martin Desruisseaux

See Also:

Well Know Text specification, OGC WKT Coordinate System Issues

Constructor Summary

protected

Formattable() Default constructor.

Method Summary

protected java.lang.String	formatWKT(Formatter formatter) Format the inner part of a Well Known Text (WKT) element.
java.lang.String	toString() Returns a string representation for this object.
java.lang.String	toWKT() Returns a Well Known Text (WKT) using a default indentation.
java.lang.String	toWKT(org.opengis.metadata.citation.Citation authority, int indentation) Returns a Well Known Text (WKT) for this object using the specified indentation and authority.
java.lang.String	toWKT(int indentation) Returns a Well Known Text (WKT) for this object using the specified indentation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Formattable

protected Formattable()

Default constructor.

Method Detail

toString

public java.lang.String toString()

Returns a string representation for this object. The default implementation returns the same string similar than toWKT(), except that no exception is thrown if the string contains non-standard keywords. For example the WKT specification do not defines any keyword for coordinate system objects. If this object is an instance of DefaultCartesianCS, then the WKT will be formatted as "CartesianCS[AXIS["..."], AXIS["..."], etc.]".

toWKT

public java.lang.String toWKT()
                       throws UnformattableObjectException

Returns a Well Known Text (WKT) using a default indentation. The default indentation is read from user preferences. It can be set from the command line using the following syntax:

<preferred indentation>

Returns:

The Well Know Text for this object.

Throws:

UnformattableObjectException - If this object can't be formatted as WKT. A formatting may fails because an object is too complex for the WKT format capability (for example an engineering CRS with different unit for each axis), or because only some specific implementations can be formatted as WKT.

toWKT

public java.lang.String toWKT(int indentation)
                       throws UnformattableObjectException

Returns a Well Known Text (WKT) for this object using the specified indentation.

Parameters:

indentation - The amount of spaces to use in indentation for WKT formatting, or 0 for formatting the whole WKT on a single line.

Returns:

The Well Know Text for this object.

Throws:

UnformattableObjectException - If this object can't be formatted as WKT. A formatting may fails because an object is too complex for the WKT format capability (for example an engineering CRS with different unit for each axis), or because only some specific implementations can be formatted as WKT.

toWKT

public java.lang.String toWKT(org.opengis.metadata.citation.Citation authority,
                              int indentation)
                       throws UnformattableObjectException

Returns a Well Known Text (WKT) for this object using the specified indentation and authority.

Parameters:

authority - The authority to prefer when choosing WKT entities names.

indentation - The amount of spaces to use in indentation for WKT formatting, or 0 for formatting the whole WKT on a single line.

Returns:

The Well Know Text for this object.

Throws:

UnformattableObjectException - If this object can't be formatted as WKT. A formatting may fails because an object is too complex for the WKT format capability (for example an engineering CRS with different unit for each axis), or because only some specific implementations can be formatted as WKT.

formatWKT

protected java.lang.String formatWKT(Formatter formatter)

Format the inner part of a Well Known Text (WKT) element. This method is automatically invoked by Formatter.append(Formattable). Element name and authority code must not be formatted here. For example for a element (DefaultGeographicCRS), the formatter will invokes this method for completing the WKT at the insertion point show below:

      GEOGCS["WGS 84", AUTHORITY["EPSG","4326"]]
                     |
             (insertion point)
 

The default implementation declare that this object produces an invalid WKT. Subclasses must override this method for proper WKT formatting.

Parameters:

formatter - The formatter to use.

Returns:

The WKT element name (e.g. "GEOGCS").

See Also:

toWKT(), toString()