Package org.apache.sis.feature
Class FeatureFormat
- All Implemented Interfaces:
- Serializable,- Cloneable,- Localized
Formats features or feature types in a tabular format.
 This format assumes a monospaced font and an encoding supporting drawing box characters (e.g. UTF-8).
 
Example: a feature named “City” and containing 3 properties (“name”, “population” and
 “twin town”) may be formatted like below. The two first properties are attributes
 while the last property is an association to another feature.
 
 City ┌────────────┬─────────┬──────────────┬───────────┐ │ Name │ Type │ Multiplicity │ Value │ ├────────────┼─────────┼──────────────┼───────────┤ │ name │ String │ [1 … 1] │ Paderborn │ │ population │ Integer │ [1 … 1] │ 143,174 │ │ twin town │ City │ [0 … ∞] │ Le Mans │ └────────────┴─────────┴──────────────┴───────────┘
Limitations
- The current implementation can only format features — parsing is not yet implemented.
- FeatureFormat, like most- java.text.Formatsubclasses, is not thread-safe.
- Since:
- 0.5
- See Also:
Defined in the sis-feature module
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic enumIdentifies the columns to include in the table formatted byFeatureFormat.Nested classes/interfaces inherited from class FormatFormat.Field
- 
Field SummaryFields inherited from class TabularFormatbeforeFill, columnSeparator, fillCharacter, lineSeparator, omitTrailingNulls
- 
Constructor SummaryConstructorsConstructorDescriptionCreates a new formatter for the default locale and timezone.FeatureFormat(Locale locale, TimeZone timezone) Creates a new formatter for the given locale and timezone.
- 
Method SummaryModifier and TypeMethodDescriptionclone()Returns a clone of this format.voidformat(Object object, Appendable toAppendTo) Formats the given object to the given stream of buffer.Returns all columns that may be shown in the tables to format.getLocale(Locale.Category category) Returns the locale for the given category.Returns the type of objects formatted by this class.parse(CharSequence text, ParsePosition pos) Not yet supported.voidsetAllowedColumns(Set<FeatureFormat.Column> inclusion) Sets all columns that may be shown in the tables to format.Methods inherited from class TabularFormatgetColumnSeparatorMatcher, getColumnSeparatorPattern, getLineSeparator, setColumnSeparatorPattern, setLineSeparatorMethods inherited from class CompoundFormatcreateFormat, format, getFormat, getLocale, getTimeZone, parseObject, parseObjectMethods inherited from class Formatformat, formatToCharacterIterator
- 
Constructor Details- 
FeatureFormatpublic FeatureFormat()Creates a new formatter for the default locale and timezone.
- 
FeatureFormatCreates a new formatter for the given locale and timezone.- Parameters:
- locale- the locale, or- nullfor- Locale.ROOT.
- timezone- the timezone, or- nullfor UTC.
 
 
- 
- 
Method Details- 
getValueTypeReturns the type of objects formatted by this class. This method has to returnObject.classsince it is the only common parent toFeatureandFeatureType.- Specified by:
- getValueTypein class- CompoundFormat<Object>
- Returns:
- Object.class
 
- 
getLocaleReturns the locale for the given category.- Locale.Category.FORMATspecifies the locale to use for values.
- Locale.Category.DISPLAYspecifies the locale to use for labels.
 - Overrides:
- getLocalein class- CompoundFormat<Object>
- Parameters:
- category- the category for which a locale is desired.
- Returns:
- the locale for the given category (never null).
 
- 
getAllowedColumnsReturns all columns that may be shown in the tables to format. The columns included in the set may be shown, but not necessarily; some columns will still be omitted if they are completely empty. However, columns not included in the set are guaranteed to be omitted.- Returns:
- all columns that may be shown in the tables to format.
- Since:
- 0.8
 
- 
setAllowedColumnsSets all columns that may be shown in the tables to format. Note that the columns specified to this method are not guaranteed to be shown; some columns will still be omitted if they are completely empty.- Parameters:
- inclusion- all columns that may be shown in the tables to format.
- Since:
- 0.8
 
- 
formatFormats the given object to the given stream of buffer. The object may be an instance of any of the following types:- Feature
- FeatureType
 - Specified by:
- formatin class- CompoundFormat<Object>
- Parameters:
- object- the object to format.
- toAppendTo- where to format the object.
- Throws:
- IOException- if an error occurred while writing to the given appendable.
 
- 
parseNot yet supported.- Specified by:
- parsein class- CompoundFormat<Object>
- Parameters:
- text- the character sequence for the object to parse.
- pos- the position where to start the parsing. On return, the position where the parsing stopped or where an error occurred.
- Returns:
- currently never return.
- Throws:
- ParseException- currently always thrown.
 
- 
cloneReturns a clone of this format.- Overrides:
- clonein class- TabularFormat<Object>
- Returns:
- a clone of this format.
 
 
-