|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectFormattable
public class Formattable
Base class for all object formattable as Well Known Text (WKT).
modules/library/referencing (gt-referencing.jar)
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 | |
---|---|
static void |
cleanupThreadLocals()
Cleans up the thread local set in this thread. |
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 |
---|
public static final int SINGLE_LINE
toWKT(int)
method for formatting the complete
object on a single line.
Constructor Detail |
---|
protected Formattable()
Method Detail |
---|
public String toString()
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.]"
.
toString
in class Object
public String toWKT() throws UnformattableObjectException
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.public String toWKT(int indentation) throws UnformattableObjectException
indentation
- The amount of spaces to use in indentation for WKT formatting,
or SINGLE_LINE
for formatting the whole WKT on a single line.
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.public String toWKT(Citation authority, int indentation) throws UnformattableObjectException
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.
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.protected String formatWKT(Formatter formatter)
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.
formatter
- The formatter to use.
"GEOGCS"
).toWKT()
,
toString()
public static void cleanupThreadLocals()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |