org.geolatte.geom.codec

Class WktVariant

java.lang.Object

org.geolatte.geom.codec.WktVariant

Direct Known Subclasses:

CrsWktVariant, PostgisWktVariant

abstract class WktVariant
extends java.lang.Object

The punctuation characters and keywords for a particular dialect of WKT.

There exist several dailects for WKT (e.g. postgis EWKT, SFS version 1.2.1 WKT). Instances of WktVariant capture these differences. This allows easy customization of the WktTokenizer for particular WKT variants or dialects.

Field Summary

Fields

Modifier and Type	Field and Description
private WktPunctuationToken	closeList
private WktPunctuationToken	elementSeparator
private WktPunctuationToken	end
private WktPunctuationToken	openList

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WktVariant(char openList, char closeList, char elementSeparator) Constructs an instance with the specified punctuation tokens.

Method Summary

Modifier and Type	Method and Description
WktPunctuationToken	end()
WktPunctuationToken	getCloseList()
char	getCloseListChar()
WktPunctuationToken	getElementSeparator()
char	getElemSepChar()
WktPunctuationToken	getOpenList()
char	getOpenListChar()
protected abstract java.util.Set<WktKeywordToken>	getWktKeywords() Returns all WktPatternTokens in this instance.
WktKeywordToken	matchKeyword(java.lang.CharSequence wkt, int currentPos, int endPos) Attempts to match the specified subsequence of a CharSequence to a keyword for the this WktVariant.

Methods inherited from class java.lang.Object

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

Field Detail

openList

private final WktPunctuationToken openList

closeList

private final WktPunctuationToken closeList

elementSeparator

private final WktPunctuationToken elementSeparator

end

private final WktPunctuationToken end

Constructor Detail

WktVariant

protected WktVariant(char openList,
                     char closeList,
                     char elementSeparator)

Constructs an instance with the specified punctuation tokens.

Parameters:

openList - the character that indicates the start of a list, e.g. '(' or '['

closeList - the character that indicates the end of a list, e.g. ')' or ']'

elementSeparator - the character that separates individual elements in a structure (usually ',')

Method Detail

matchKeyword

public WktKeywordToken matchKeyword(java.lang.CharSequence wkt,
                                    int currentPos,
                                    int endPos)

Attempts to match the specified subsequence of a CharSequence to a keyword for the this WktVariant.

Parameters:

wkt - the input text

currentPos - the start position for the match

endPos - the end position for the match

Returns:

a matching WktKeywordToken

Throws:

WktDecodeException - if nothing matches at the specified substring.

getWktKeywords

protected abstract java.util.Set<WktKeywordToken> getWktKeywords()

Returns all WktPatternTokens in this instance.

Returns:

getOpenList

public WktPunctuationToken getOpenList()

getCloseList

public WktPunctuationToken getCloseList()

getElementSeparator

public WktPunctuationToken getElementSeparator()

end

public WktPunctuationToken end()

getOpenListChar

public char getOpenListChar()

getCloseListChar

public char getCloseListChar()

getElemSepChar

public char getElemSepChar()