| java.lang.Object
 org.geotools.referencing.wkt.Element
| Element | | final public class Element (Code) | | An element in a Well Know Text (WKT). A
Element is
made of
String ,
Number and other
Element . For example:
PRIMEM["Greenwich", 0.0, AUTHORITY["some authority", "Greenwich"]]
Each
Element object can contains an arbitrary amount of other elements.
The result is a tree, which can be printed with
Element.print .
Elements can be pull in a first in, first out order.
since:
2.0
version:
$Id: Element.java 21289 2006-08-30 10:52:24Z desruisseaux $
author:
Remi Eve
author:
Martin Desruisseaux |
| keyword | | final public String keyword(Code) | | Keyword of this entity. For example: "PRIMEM".
|
| Element | | Element(Element singleton)(Code) | | Constructs a root element.
Parameters:
singleton - The only children for this root. |
| Element | | Element(AbstractParser parser, String text, ParsePosition position) throws ParseException(Code) | | Constructs a new
Element .
Parameters:
text - The text to parse.
Parameters:
position - In input, the position where to start parsing from.In output, the first character after the separator. |
| isRoot | | public boolean isRoot()(Code) | | Returns
true if this element is the root element. For example in a WKT like
"GEOGCS["name", DATUM["name, ...]]" , this is true for
"GEOGCS" and
false for all other elements inside, like
"DATUM" .
since:
2.3 |
| parseFailed | | public ParseException parseFailed(Exception cause, String message)(Code) | | Returns a
ParseException with the specified cause. A localized string
"Error in <
Element.keyword >" will be prepend to the message.
The error index will be the starting index of this
Element .
Parameters:
cause - The cause of the failure, or null if none.
Parameters:
message - The message explaining the cause of the failure, or null for reusing the same message than cause . The exception to be thrown. |
| peek | | public Object peek()(Code) | | Returns the next element, or
null if there is no more
element. The element is not removed from the list.
|
| print | | public void print(PrintWriter out, int level)(Code) | | Print this
Element as a tree.
This method is used for debugging purpose only.
Parameters:
out - The output stream.
Parameters:
level - The indentation level (usually 0). |
| pullDouble | | public double pullDouble(String key) throws ParseException(Code) | | Removes the next
Number from the list and returns it.
Parameters:
key - The parameter name. Used for formattingan error message if no number are found. The next Number on the list as a double .
throws:
ParseException - if no more number is available. |
| pullInteger | | public int pullInteger(String key) throws ParseException(Code) | | Removes the next
Number from the list and returns it
as an integer.
Parameters:
key - The parameter name. Used for formattingan error message if no number are found. The next Number on the list as an int .
throws:
ParseException - if no more number is available, or the numberis not an integer. |
| pullOptionalElement | | public Element pullOptionalElement(String key)(Code) | | Removes the next
Element from the list and returns it.
Parameters:
key - The element name (e.g. "PRIMEM"). The next Element on the list,or null if no more element is available. |
| pullString | | public String pullString(String key) throws ParseException(Code) | | Removes the next
String from the list and returns it.
Parameters:
key - The parameter name. Used for formattingan error message if no number are found. The next String on the list.
throws:
ParseException - if no more string is available. |
| pullVoidElement | | public Element pullVoidElement(String key) throws ParseException(Code) | | Removes and returns the next
Element with no bracket.
The key is used only for only for formatting an error message.
Parameters:
key - The parameter name. Used only for formatting an error message. The next Element in the list, with no bracket.
throws:
ParseException - if no more void element is available. |
| toString | | public String toString()(Code) | | Returns the keyword. This overriding is needed for correct
formatting of the error message in
Element.close .
|
|
|