org.geotools.referencing.wkt
Class Formattable

Object
  extended by Formattable
Direct Known Subclasses:
AbstractIdentifiedObject, AbstractMathTransform, AbstractParameter, BursaWolfParameters

public class Formattable
extends Object

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

Since:
2.0
Author:
Martin Desruisseaux (IRD)
See Also:
Well Know Text specification, OGC WKT Coordinate System Issues
Module:

Field Summary
static int SINGLE_LINE
          The indentation value to give to toWKT(int) method for formatting the complete object on a single line.
 
Constructor Summary
protected Formattable()
          Default constructor.
 
Method Summary
protected  String formatWKT(Formatter formatter)
          Format the inner part of a Well Known Text (WKT) element.
 String toString()
          Returns a string representation for this object.
 String toWKT()
          Returns a Well Known Text (WKT) using a default indentation.
 String toWKT(Citation authority, int indentation)
          Returns a Well Known Text (WKT) for this object using the specified indentation and authority.
 String toWKT(int indentation)
          Returns a Well Known Text (WKT) for this object using the specified indentation.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SINGLE_LINE

public static final int SINGLE_LINE
The indentation value to give to toWKT(int) method for formatting the complete object on a single line.

Since:
2.6
See Also:
Constant Field Values
Constructor Detail

Formattable

protected Formattable()
Default constructor.

Method Detail

toString

public 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.]".

Overrides:
toString in class Object

toWKT

public String toWKT()
             throws UnformattableObjectException
Returns a Well Known Text (WKT) using a default indentation. The default indentation is read from user preferences.

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 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 SINGLE_LINE 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 String toWKT(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 SINGLE_LINE 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 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 GEOGCS 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 declares that this object produces an invalid WKT. Subclasses must override this method for proper WKT formatting and should not invoke super.formatWKT(formatter) if they can use a valid WKT syntax.

Parameters:
formatter - The formatter to use.
Returns:
The name of the WKT element type (e.g. "GEOGCS").
See Also:
toWKT(), toString()


Copyright © 1996-2009 Geotools. All Rights Reserved.