Package org.apache.sis.coverage.grid

Class GridGeometry.Formatter

java.lang.Object

org.apache.sis.coverage.grid.GridGeometry.Formatter

Enclosing class:

GridGeometry

private final class GridGeometry.Formatter
extends Object

Helper class for formatting a GridGeometry instance.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	bitmask	Combination of GridGeometry.EXTENT, GridGeometry.ENVELOPE, GridGeometry.CRS, GridGeometry.GRID_TO_CRS, GridGeometry.RESOLUTION, GridGeometry.GEOGRAPHIC_EXTENT and GridGeometry.TEMPORAL_EXTENT.
private final StringBuilder	buffer	Temporary buffer for formatting node values.
private final org.opengis.referencing.crs.CoordinateReferenceSystem	crs	The coordinate reference system, or null if none.
private final org.opengis.referencing.cs.CoordinateSystem	cs	The coordinate system, or null if none.
private final Locale	locale	The locale for the texts, numbers (except grid extent) and dates.
private final TreeTable.Node	root	Where to write the GridGeometry string representation.
private TreeTable.Node	section	The section under the root where to write elements.
private final Vocabulary	vocabulary	Localized words.

Constructor Summary

Constructors

Constructor	Description
Formatter(Locale locale, Vocabulary vocabulary, int bitmask, TreeTable.Node out)	Creates a new formatter for the given combination of GridGeometry.EXTENT, GridGeometry.ENVELOPE, GridGeometry.CRS, GridGeometry.GRID_TO_CRS and GridGeometry.RESOLUTION.

Method Summary

Modifier and Type	Method	Description
private void	appendResolution(Appendable out, NumberFormat nf, double res, int dim)	Appends a single value on the resolution line, together with its unit of measurement.
(package private) final void	format()	Formats a string representation of the enclosing GridGeometry instance in the buffer specified at construction time.
private boolean	section(int property, short title, boolean mandatory, boolean cellCenter)	Starts a new section for the given property.
private void	writeNode()	Appends a node with current buffer content as a single line, then clears the buffer.
private void	writeNode(CharSequence line)	Appends a single line as a node in the current section.
private void	writeNodes()	Appends nodes with current buffer content as multi-lines text, then clears the buffer.

Methods inherited from class java.lang.Object

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

Field Details

bitmask

private final int bitmask

Combination of GridGeometry.EXTENT, GridGeometry.ENVELOPE, GridGeometry.CRS, GridGeometry.GRID_TO_CRS, GridGeometry.RESOLUTION, GridGeometry.GEOGRAPHIC_EXTENT and GridGeometry.TEMPORAL_EXTENT.

buffer

private final StringBuilder buffer

Temporary buffer for formatting node values.

root

private final TreeTable.Node root

Where to write the GridGeometry string representation.

section

private TreeTable.Node section

The section under the root where to write elements. This is updated when section(int, short, boolean, boolean) is invoked.

vocabulary

private final Vocabulary vocabulary

Localized words.

locale

private final Locale locale

The locale for the texts, numbers (except grid extent) and dates.

crs

private final org.opengis.referencing.crs.CoordinateReferenceSystem crs

The coordinate reference system, or null if none.

cs

private final org.opengis.referencing.cs.CoordinateSystem cs

The coordinate system, or null if none.

Constructor Details

Formatter

Formatter(Locale locale,
 Vocabulary vocabulary,
 int bitmask,
 TreeTable.Node out)

Creates a new formatter for the given combination of GridGeometry.EXTENT, GridGeometry.ENVELOPE, GridGeometry.CRS, GridGeometry.GRID_TO_CRS and GridGeometry.RESOLUTION.

Method Details

format

final void format()
           throws IOException

Formats a string representation of the enclosing GridGeometry instance in the buffer specified at construction time.

Throws:

IOException

section

private boolean section(int property,
 short title,
 boolean mandatory,
 boolean cellCenter)

Starts a new section for the given property.

Parameters:

property - one of GridGeometry.EXTENT, GridGeometry.ENVELOPE, GridGeometry.CRS, GridGeometry.GRID_TO_CRS and GridGeometry.RESOLUTION.

title - the Vocabulary key for the title to show for this section, if formatted.

mandatory - whether to write "undefined" if the property is undefined.

cellCenter - whether to add a "origin in cell center" text in the title. This is relevant only for conversion.

Returns:

true if the caller shall format the value.

writeNode

private void writeNode(CharSequence line)

Appends a single line as a node in the current section.

writeNode

private void writeNode()

Appends a node with current buffer content as a single line, then clears the buffer.

writeNodes

private void writeNodes()

Appends nodes with current buffer content as multi-lines text, then clears the buffer.

appendResolution

private void appendResolution(Appendable out,
 NumberFormat nf,
 double res,
 int dim)
                       throws IOException

Appends a single value on the resolution line, together with its unit of measurement.

Parameters:

out - where to write the resolution.

nf - number format to use for writing the number.

res - the resolution to write, or Double.NaN.

dim - index of the coordinate system axis of the resolution.

Throws:

IOException