Package org.locationtech.jts.io
Class WKTWriter
- java.lang.Object
-
- org.locationtech.jts.io.WKTWriter
-
public class WKTWriter extends Object
Writes the Well-Known Text representation of aGeometry. The Well-Known Text format is defined in the OGC Simple Features Specification for SQL. SeeWKTReaderfor a formal specification of the format syntax.The
WKTWriteroutputs coordinates rounded to the precision model. Only the maximum number of decimal places necessary to represent the ordinates to the required precision will be output.The SFS WKT spec does not define a special tag for
LinearRings. Under the spec, rings are output asLINESTRINGs. In order to allow precisely specifying constructed geometries, JTS also supports a non-standardLINEARRINGtag which is used to output LinearRings.- Version:
- 1.7
- See Also:
WKTReader
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description EnumSet<Ordinate>getOutputOrdinates()Gets a bit-pattern defining which ordinates should bevoidsetFormatted(boolean isFormatted)Sets whether the output will be formatted.voidsetMaxCoordinatesPerLine(int coordsPerLine)Sets the maximum number of coordinates per line written in formatted output.voidsetOutputOrdinates(EnumSet<Ordinate> outputOrdinates)Sets theOrdinatethat are to be written.voidsetPrecisionModel(PrecisionModel precisionModel)Sets aPrecisionModelthat should be used on the ordinates written.voidsetTab(int size)Sets the tab size to use for indenting.static StringtoLineString(Coordinate[] coord)Generates the WKT for a LINESTRING specified by aCoordinateSequence.static StringtoLineString(Coordinate p0, Coordinate p1)Generates the WKT for a LINESTRING specified by twoCoordinates.static StringtoLineString(CoordinateSequence seq)Generates the WKT for a LINESTRING specified by aCoordinateSequence.static StringtoPoint(Coordinate p0)Generates the WKT for a POINT specified by aCoordinate.Stringwrite(Geometry geometry)Converts aGeometryto its Well-known Text representation.voidwrite(Geometry geometry, Writer writer)Converts aGeometryto its Well-known Text representation.StringwriteFormatted(Geometry geometry)Same aswrite, but with newlines and spaces to make the well-known text more readable.voidwriteFormatted(Geometry geometry, Writer writer)Same aswrite, but with newlines and spaces to make the well-known text more readable.
-
-
-
Constructor Detail
-
WKTWriter
public WKTWriter()
Creates a new WKTWriter with default settings
-
WKTWriter
public WKTWriter(int outputDimension)
Creates a writer that writesGeometrys with the given output dimension (2 to 4). The output follows the following rules:- If the specified output dimension is 3 and the z is measure flag
is set to true, the Z value of coordinates will be written if it is present
(i.e. if it is not
Double.NaN) - If the specified output dimension is 3 and the z is measure flag
is set to false, the Measure value of coordinates will be written if it is present
(i.e. if it is not
Double.NaN) - If the specified output dimension is 4, the Z value of coordinates will
be written even if it is not present when the Measure value is present.The Measrue
value of coordinates will be written if it is present
(i.e. if it is not
Double.NaN)
- Parameters:
outputDimension- the coordinate dimension to output (2 to 4)
- If the specified output dimension is 3 and the z is measure flag
is set to true, the Z value of coordinates will be written if it is present
(i.e. if it is not
-
-
Method Detail
-
toPoint
public static String toPoint(Coordinate p0)
Generates the WKT for a POINT specified by aCoordinate.- Parameters:
p0- the point coordinate- Returns:
- the WKT
-
toLineString
public static String toLineString(CoordinateSequence seq)
Generates the WKT for a LINESTRING specified by aCoordinateSequence.- Parameters:
seq- the sequence to write- Returns:
- the WKT string
-
toLineString
public static String toLineString(Coordinate[] coord)
Generates the WKT for a LINESTRING specified by aCoordinateSequence.- Parameters:
coord- the sequence to write- Returns:
- the WKT string
-
toLineString
public static String toLineString(Coordinate p0, Coordinate p1)
Generates the WKT for a LINESTRING specified by twoCoordinates.- Parameters:
p0- the first coordinatep1- the second coordinate- Returns:
- the WKT
-
setFormatted
public void setFormatted(boolean isFormatted)
Sets whether the output will be formatted.- Parameters:
isFormatted- true if the output is to be formatted
-
setMaxCoordinatesPerLine
public void setMaxCoordinatesPerLine(int coordsPerLine)
Sets the maximum number of coordinates per line written in formatted output. If the provided coordinate number is <= 0, coordinates will be written all on one line.- Parameters:
coordsPerLine- the number of coordinates per line to output.
-
setTab
public void setTab(int size)
Sets the tab size to use for indenting.- Parameters:
size- the number of spaces to use as the tab string- Throws:
IllegalArgumentException- if the size is non-positive
-
setOutputOrdinates
public void setOutputOrdinates(EnumSet<Ordinate> outputOrdinates)
Sets theOrdinatethat are to be written. Possible members are: Values ofOrdinate.XandOrdinate.Yare always assumed and not particularly checked for.- Parameters:
outputOrdinates- A set ofOrdinatevalues
-
getOutputOrdinates
public EnumSet<Ordinate> getOutputOrdinates()
Gets a bit-pattern defining which ordinates should be- Returns:
- an ordinate bit-pattern
- See Also:
setOutputOrdinates(EnumSet)
-
setPrecisionModel
public void setPrecisionModel(PrecisionModel precisionModel)
Sets aPrecisionModelthat should be used on the ordinates written.If none/
nullis assigned, the precision model of theGeometry.getFactory()is used.Note: The precision model is applied to all ordinate values, not just x and y.
- Parameters:
precisionModel- the flag indicating ifCoordinate.z/{} is actually a measure value.
-
write
public String write(Geometry geometry)
Converts aGeometryto its Well-known Text representation.- Parameters:
geometry- aGeometryto process- Returns:
- a <Geometry Tagged Text> string (see the OpenGIS Simple Features Specification)
-
write
public void write(Geometry geometry, Writer writer) throws IOException
Converts aGeometryto its Well-known Text representation.- Parameters:
geometry- aGeometryto process- Throws:
IOException
-
writeFormatted
public String writeFormatted(Geometry geometry)
Same aswrite, but with newlines and spaces to make the well-known text more readable.- Parameters:
geometry- aGeometryto process- Returns:
- a <Geometry Tagged Text> string (see the OpenGIS Simple Features Specification), with newlines and spaces
-
writeFormatted
public void writeFormatted(Geometry geometry, Writer writer) throws IOException
Same aswrite, but with newlines and spaces to make the well-known text more readable.- Parameters:
geometry- aGeometryto process- Throws:
IOException
-
-