Class LocationFormat

Object

Format

CompoundFormat<AbstractLocation>

TabularFormat<AbstractLocation>

LocationFormat

All Implemented Interfaces:

Serializable, Cloneable, Localized

public class LocationFormat
extends TabularFormat<AbstractLocation>

Formats Location instances in a tabular format. This format assumes a monospaced font and an encoding supporting drawing box characters (e.g. UTF-8).

Example

The location identified by "32TNL83" in the military grid reference system can be represented by the following string formatted using Locale.ENGLISH:

  ┌─────────────────────────────────────────────────────────────┐
  │ Location type:               Grid zone designator           │
  │ Geographic identifier:       32TNL83                        │
  │ West bound:                    580,000 m    —     9°57′00″E │
  │ Representative value:          585,000 m    —    10°00′36″E │
  │ East bound:                    590,000 m    —    10°04′13″E │
  │ South bound:                 4,530,000 m    —    40°54′58″N │
  │ Representative value:        4,535,000 m    —    40°57′42″N │
  │ North bound:                 4,540,000 m    —    41°00′27″N │
  │ Coordinate reference system: WGS 84 / UTM zone 32N          │
  └─────────────────────────────────────────────────────────────┘

Limitations

• The current implementation can only format features — parsing is not yet implemented.
• Location­Format, like most java.text.Format subclasses, is not thread-safe.

Since:

0.8

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class Format

Format.Field

Field Summary

Fields inherited from class TabularFormat

before­Fill, column­Separator, fill­Character, line­Separator, omit­Trailing­Nulls

Modifier and Type	Field	Description
protected String	before­Fill	The string to write before the Tabular­Format.fill­Character, or an empty string if none.
protected String	column­Separator	The string to write after the Tabular­Format.fill­Character, or an empty string if none.
protected char	fill­Character	The character to repeat after the content of a cell for alignment with the next column.
protected String	line­Separator	The line separator to use for formatting the tree.
protected boolean	omit­Trailing­Nulls	true if the trailing null values shall be omitted at formatting time.

Constructor Summary

Constructors

Constructor	Description
Location­Format(Locale locale, Time­Zone timezone)	Creates a new format for the given locale.

Method Summary

Modifier and Type	Method	Description
Location­Format	clone()	Returns a clone of this format.
protected Format	create­Format(Class<?> value­Type)	Creates the format to use for formatting a latitude, longitude or projected coordinate.
void	format(Abstract­Location location, Appendable to­Append­To)	Writes a textual representation of the given location in the given stream or buffer.
Class<Abstract­Location>	get­Value­Type()	Returns the type of values formatted by this Format instance.
Abstract­Location	parse(Char­Sequence text, Parse­Position pos)	Unsupported operation.

Methods inherited from class TabularFormat

get­Column­Separator­Matcher, get­Column­Separator­Pattern, get­Line­Separator, set­Column­Separator­Pattern, set­Line­Separator

Modifier and Type	Method	Description
protected Matcher	get­Column­Separator­Matcher(Char­Sequence text)	Returns a matcher for the column separators in the given text.
String	get­Column­Separator­Pattern()	Returns the pattern of characters used in column separators.
String	get­Line­Separator()	Returns the current line separator.
void	set­Column­Separator­Pattern(String pattern)	Sets the pattern of the characters to insert between the columns.
void	set­Line­Separator(String separator)	Sets the line separator.

Methods inherited from class CompoundFormat

format, format, format­Object, get­Format, get­Locale, get­Locale, get­Temporal­Style, get­Time­Zone, parse­Object, parse­Object

Modifier and Type	Method	Description
String­Buffer	format(Object object, String­Buffer to­Append­To, Field­Position pos)	Writes a textual representation of the specified object in the given buffer.
void	format(Abstract­Location object, String­Builder to­Append­To)	Writes a textual representation of the given object in the given buffer.
void	format­Object(Object object, Appendable to­Append­To)	Writes a textual representation of an object of arbitrary class in the given stream or buffer.
protected Format	get­Format(Class<?> value­Type)	Returns the format to use for parsing and formatting values of the given type.
Locale	get­Locale()	Returns the locale used by this format.
Locale	get­Locale(Locale.Category category)	Returns the locale for the given category.
protected Format­Style	get­Temporal­Style(boolean dates)	Returns the style to use for formatting dates or times.
Time­Zone	get­Time­Zone()	Returns the timezone used by this format.
Abstract­Location	parse­Object(String text)	Creates an object from the given string representation.
Abstract­Location	parse­Object(String text, Parse­Position pos)	Creates an object from the given string representation, or returns null if an error occurred while parsing.

Methods inherited from class Format

format, format­To­Character­Iterator

Methods inherited from class Object

equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Constructor Details

LocationFormat

public LocationFormat(Locale locale,
 TimeZone timezone)

Creates a new format for the given locale. The given locale can be null or Locale.ROOT if this format shall format "unlocalized" strings.

Parameters:

locale - the locale for the new Format, or null for Locale.ROOT.

timezone - the timezone, or null for UTC.

Method Details

getValueType

public Class<AbstractLocation> getValueType()

Returns the type of values formatted by this Format instance.

Specified by:

get­Value­Type in class Compound­Format<Abstract­Location>

Returns:

the type of values formatted by this Format instance.

format

public void format(AbstractLocation location,
 Appendable toAppendTo)
            throws IOException

Writes a textual representation of the given location in the given stream or buffer.

Upcoming API change — generalization
in a future SIS version, the type of location parameter may be generalized to the org.opengis.referencing.gazetteer.Location interface. This change is pending GeoAPI revision.

Specified by:

format in class Compound­Format<Abstract­Location>

Parameters:

location - the location to format.

to­Append­To - where to format the location.

Throws:

IOException - if an error occurred while writing to the given appendable.

createFormat

protected Format createFormat(Class<?> valueType)

Creates the format to use for formatting a latitude, longitude or projected coordinate. This method is invoked by format(Location, Appendable) when first needed.

Overrides:

create­Format in class Compound­Format<Abstract­Location>

Parameters:

value­Type - Angle.class. Number.class or Unit.class.

Returns:

a new Angle­Format, Number­Format or Unit­Format instance depending on the argument value.

parse

public AbstractLocation parse(CharSequence text,
 ParsePosition pos)
                       throws ParseException

Unsupported operation.

Specified by:

parse in class Compound­Format<Abstract­Location>

Parameters:

text - the character sequence for the location to parse.

pos - the position where to start the parsing.

Returns:

the parsed location, or null if the text is not recognized.

Throws:

Parse­Exception - if an error occurred while parsing the location.

clone

public LocationFormat clone()

Returns a clone of this format.

Overrides:

clone in class Tabular­Format<Abstract­Location>

Returns:

a clone of this format.