de.cismet.commons.cismap.io.converters

Class AbstractGeometryFromTextConverter

java.lang.Object

de.cismet.commons.cismap.io.converters.AbstractRatingConverter<String,com.vividsolutions.jts.geom.Geometry>

de.cismet.commons.cismap.io.converters.AbstractGeometryFromTextConverter

All Implemented Interfaces:

GeometryConverter<String>, TextToGeometryConverter, de.cismet.commons.converter.Converter<String,com.vividsolutions.jts.geom.Geometry>, de.cismet.commons.converter.Converter.MatchRating<String>, de.cismet.commons.converter.FormatHint

Direct Known Subclasses:

BoundingBoxFromTextConverter, GeometriesFromGPXConverter, PointFromTextConverter, PointsFromTextConverter, PolygonFromTextConverter, PolylineFromTextConverter

public abstract class AbstractGeometryFromTextConverter
extends AbstractRatingConverter<String,com.vividsolutions.jts.geom.Geometry>
implements TextToGeometryConverter

Basic TextToGeometryConverter implementation that expects the given text to be separated by white space characters, ';' or ':'. Additionally it requires a parameter: the EPSG code, e.g. EPSG:4326. The code is used to interpret the given coordinates. The coordinates are expected to be provided as follows:

northing<separator>easting<separator>northing<separator>easting<separator> ...

The coordinates are parsed using the currently active Locale and thus the corresponding NumberFormat. Three-dimensional coordinates are not supported.

Version:

1.0

Author:

martin.scholl@cismet.de

Nested Class Summary

Nested classes/interfaces inherited from interface de.cismet.commons.converter.Converter

de.cismet.commons.converter.Converter.MatchRating<FROM>

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYS_PROP_DECIMAL_SEP

Constructor Summary

Constructors

Constructor and Description
AbstractGeometryFromTextConverter()

Method Summary

Modifier and Type	Method and Description
String	convertBackward(com.vividsolutions.jts.geom.Geometry to, String... params) Converts a given instance of Geometry back to the origin format FROM.
com.vividsolutions.jts.geom.Geometry	convertForward(String from, String... params) Converts a given instance FROM to a Geometry.
protected abstract com.vividsolutions.jts.geom.Geometry	createGeometry(com.vividsolutions.jts.geom.Coordinate[] coordinates, com.vividsolutions.jts.geom.GeometryFactory geomFactory) Creates a geometry from the given coordinate array and geometry factory.
protected DecimalFormat	getDecimalFormat() Creates a decimal format that uses the decimal separator of returned from getDecimalSeparator() and disabled grouping.
protected char	getDecimalSeparator() Gets the decimal separator that is used by this converter.
String	getFormatDescription()
String	getFormatHtmlDescription()
protected String	getTokenRegex() Get the token regex that is used to split the data to convert.
protected char[]	getTokenSeparators() Gets the separators that are used to build the token regex.

Methods inherited from class de.cismet.commons.cismap.io.converters.AbstractRatingConverter

rate

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cismet.commons.converter.FormatHint

getFormatDisplayName, getFormatExample, getFormatHtmlName, getFormatName

Field Detail

SYS_PROP_DECIMAL_SEP

public static final String SYS_PROP_DECIMAL_SEP

Constructor Detail

AbstractGeometryFromTextConverter

public AbstractGeometryFromTextConverter()

Method Detail

createGeometry

protected abstract com.vividsolutions.jts.geom.Geometry createGeometry(com.vividsolutions.jts.geom.Coordinate[] coordinates,
                                                                       com.vividsolutions.jts.geom.GeometryFactory geomFactory)
                                                                throws de.cismet.commons.converter.ConversionException

Creates a geometry from the given coordinate array and geometry factory. The coordinate array and the geomeetry factory shall never be null.

Parameters:

coordinates - the coordinates to create a geometry from

geomFactory - the geometry factory that may be used to create the geometry

Returns:

a geometry created using the given parameters

Throws:

de.cismet.commons.converter.ConversionException - if any error occurs during creation of the geometry

convertForward

public com.vividsolutions.jts.geom.Geometry convertForward(String from,
                                                           String... params)
                                                    throws de.cismet.commons.converter.ConversionException

Converts a given instance FROM to a Geometry. The first parameter must be the EPSG code, e.g. EPSG:4326.

Specified by:

convertForward in interface GeometryConverter<String>

Specified by:

convertForward in interface de.cismet.commons.converter.Converter<String,com.vividsolutions.jts.geom.Geometry>

Parameters:

from - the originating object that shall be converted to a Geometry

params - first parameter must be the EPSG code

Returns:

an instance of Geometry which was create from the FROM instance

Throws:

de.cismet.commons.converter.ConversionException - if any error occurs during conversion

convertBackward

public String convertBackward(com.vividsolutions.jts.geom.Geometry to,
                              String... params)
                       throws de.cismet.commons.converter.ConversionException

Description copied from interface: GeometryConverter

Converts a given instance of Geometry back to the origin format FROM. The first parameter must be the EPSG code, e.g. EPSG:4326.

Specified by:

convertBackward in interface GeometryConverter<String>

Specified by:

convertBackward in interface de.cismet.commons.converter.Converter<String,com.vividsolutions.jts.geom.Geometry>

Parameters:

to - the geometry that shall be converted back to an instance of FROM

params - no parameters needed

Returns:

an instance of FROM which was create from the Geometry instance

Throws:

de.cismet.commons.converter.ConversionException - if any error occurs during conversion

getDecimalSeparator

protected char getDecimalSeparator()

Gets the decimal separator that is used by this converter. The separator is read from the system property SYS_PROP_DECIMAL_SEP. If the property is not set or is empty or is an invalid character (any white space) or an invalid format the default separator of the default locale is returned. Supported formats are:

• those of Integer.decode(java.lang.String)
• a string starting with '\u' or '\U' followed by a hexadecimal character code

If none of these formats is used simply the first char of the given string is returned.

Returns:

the decimal separator to be used by this converter

See Also:

Character.isWhitespace(char), Integer.decode(java.lang.String)

getDecimalFormat

protected DecimalFormat getDecimalFormat()

Creates a decimal format that uses the decimal separator of returned from getDecimalSeparator() and disabled grouping.

Returns:

the decimal format used by this converter

getTokenRegex

protected String getTokenRegex()

Get the token regex that is used to split the data to convert. This regex never contains the char returned from getDecimalSeparator().

Returns:

the token regex that is used to split the data to convert

getTokenSeparators

protected char[] getTokenSeparators()

Gets the separators that are used to build the token regex. This array contains all the separators of DEFAULT_TOKEN_SEPARATORS minus the getDecimalSeparator() if it is one of the default separators.

Returns:

all token separators used to build the token regex

See Also:

getTokenRegex()

getFormatDescription

public String getFormatDescription()

Specified by:

getFormatDescription in interface de.cismet.commons.converter.FormatHint

getFormatHtmlDescription

public String getFormatHtmlDescription()

Specified by:

getFormatHtmlDescription in interface de.cismet.commons.converter.FormatHint