Class LocationFormat
- All Implemented Interfaces:
- Serializable,- Cloneable,- Localized
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.
- LocationFormat, like most- java.text.Formatsubclasses, is not thread-safe.
- Since:
- 0.8
- See Also:
Defined in the sis-referencing-by-identifiers module
- 
Nested Class SummaryNested classes/interfaces inherited from class FormatFormat.Field
- 
Field SummaryFields inherited from class TabularFormatbeforeFill, columnSeparator, fillCharacter, lineSeparator, omitTrailingNulls
- 
Constructor SummaryConstructorsConstructorDescriptionLocationFormat(Locale locale, TimeZone timezone) Creates a new format for the given locale.
- 
Method SummaryModifier and TypeMethodDescriptionclone()Returns a clone of this format.protected FormatcreateFormat(Class<?> valueType) Creates the format to use for formatting a latitude, longitude or projected coordinate.voidformat(AbstractLocation location, Appendable toAppendTo) Writes a textual representation of the given location in the given stream or buffer.Returns the type of values formatted by thisFormatinstance.parse(CharSequence text, ParsePosition pos) Unsupported operation.Methods inherited from class TabularFormatgetColumnSeparatorMatcher, getColumnSeparatorPattern, getLineSeparator, setColumnSeparatorPattern, setLineSeparatorMethods inherited from class CompoundFormatformat, getFormat, getLocale, getLocale, getTimeZone, parseObject, parseObjectMethods inherited from class Formatformat, formatToCharacterIterator
- 
Constructor Details- 
LocationFormatCreates a new format for the given locale. The given locale can benullorLocale.ROOTif this format shall format "unlocalized" strings.- Parameters:
- locale- the locale for the new- Format, or- nullfor- Locale.ROOT.
- timezone- the timezone, or- nullfor UTC.
 
 
- 
- 
Method Details- 
getValueTypeReturns the type of values formatted by thisFormatinstance.- Specified by:
- getValueTypein class- CompoundFormat<AbstractLocation>
- Returns:
- the type of values formatted by this Formatinstance.
 
- 
formatWrites a textual representation of the given location in the given stream or buffer.Upcoming API change — generalization
 in a future SIS version, the type oflocationparameter may be generalized to theorg.opengis.referencing.gazetteer.Locationinterface. This change is pending GeoAPI revision.- Specified by:
- formatin class- CompoundFormat<AbstractLocation>
- Parameters:
- location- the location to format.
- toAppendTo- where to format the location.
- Throws:
- IOException- if an error occurred while writing to the given appendable.
 
- 
createFormatCreates the format to use for formatting a latitude, longitude or projected coordinate. This method is invoked byformat(Location, Appendable)when first needed.- Overrides:
- createFormatin class- CompoundFormat<AbstractLocation>
- Parameters:
- valueType-- Angle.class.- Number.classor- Unit.class.
- Returns:
- a new AngleFormat,NumberFormatorUnitFormatinstance depending on the argument value.
 
- 
parseUnsupported operation.- Specified by:
- parsein class- CompoundFormat<AbstractLocation>
- Parameters:
- text- the character sequence for the location to parse.
- pos- the position where to start the parsing.
- Returns:
- the parsed location, or nullif the text is not recognized.
- Throws:
- ParseException- if an error occurred while parsing the location.
 
- 
cloneReturns a clone of this format.- Overrides:
- clonein class- TabularFormat<AbstractLocation>
- Returns:
- a clone of this format.
 
 
-