Package org.apache.sis.math
Class StatisticsFormat
- All Implemented Interfaces:
- Serializable,- Cloneable,- Localized
Formats a 
Statistics object.
 By default, newly created StatisticsFormat instances will format statistical values
 in a tabular format using spaces as the column separator.
 Example:
 
 Number of values: 8726 Minimum value: 6.853 Maximum value: 8.259 Mean value: 7.421 Root Mean Square: 7.846 Standard deviation: 6.489
Limitations
- The current implementation can only format features — parsing is not yet implemented.
- StatisticsFormat, like most- java.text.Formatsubclasses, is not thread-safe.
- Since:
- 0.3
- See Also:
Defined in the sis-utility module
- 
Nested Class SummaryNested classes/interfaces inherited from class FormatFormat.Field
- 
Field SummaryFields inherited from class TabularFormatbeforeFill, columnSeparator, fillCharacter, lineSeparator, omitTrailingNulls
- 
Constructor SummaryConstructorsConstructorDescriptionStatisticsFormat(Locale locale, Locale headerLocale, TimeZone timezone) Constructs a new format for the given numeric and header locales.
- 
Method SummaryModifier and TypeMethodDescriptionclone()Returns a clone of this format.format(Object object, StringBuffer toAppendTo, FieldPosition pos) Formats the given statistics.voidformat(Statistics[] stats, Appendable toAppendTo) Formats the given statistics in a tabular format.voidformat(Statistics stats, Appendable toAppendTo) Formats a localized string representation of the given statistics.intReturns the "width" of the border to drawn around the table, in number of lines.static StatisticsFormatReturns an instance for the current system default locale.static StatisticsFormatgetInstance(Locale locale) Returns an instance for the given locale.getLocale(Locale.Category category) Returns the locale for the given category.final Class<Statistics>Returns the type of objects formatted by this class.booleanReturnstrueif this formatter shall consider that the statistics where computed using the totality of the populations under study.parse(CharSequence text, ParsePosition pos) Not yet supported.voidsetBorderWidth(int borderWidth) Sets the "width" of the border to drawn around the table, in number of lines.voidsetForAllPopulation(boolean allPopulation) Sets whether this formatter shall consider that the statistics where computed using the totality of the populations under study.Methods inherited from class TabularFormatgetColumnSeparatorMatcher, getColumnSeparatorPattern, getLineSeparator, setColumnSeparatorPattern, setLineSeparatorMethods inherited from class CompoundFormatcreateFormat, getFormat, getLocale, getTimeZone, parseObject, parseObjectMethods inherited from class Formatformat, formatToCharacterIterator
- 
Constructor Details- 
StatisticsFormatConstructs a new format for the given numeric and header locales. The timezone is used only if the values added to theStatisticsare dates.- Parameters:
- locale- the locale to use for numbers, dates and angles formatting, or- nullfor the root locale.
- headerLocale- the locale for row and column headers. Usually same as- locale.
- timezone- the timezone, or- nullfor UTC.
 
 
- 
- 
Method Details- 
getInstanceReturns an instance for the current system default locale.- Returns:
- a statistics format instance for the current default locale.
 
- 
getInstanceReturns an instance for the given locale.- Parameters:
- locale- the locale for which to get a- StatisticsFormatinstance.
- Returns:
- a statistics format instance for the given locale.
 
- 
getLocaleReturns the locale for the given category. This method implements the following mapping:- Locale.Category.DISPLAY— the- headerLocalegiven at construction time.
- Locale.Category.FORMAT— the- localegiven at construction time, used for all values below the header row.
 - Overrides:
- getLocalein class- CompoundFormat<Statistics>
- Parameters:
- category- the category for which a locale is desired.
- Returns:
- the locale for the given category (never null).
- Since:
- 0.4
 
- 
getValueTypeReturns the type of objects formatted by this class.- Specified by:
- getValueTypein class- CompoundFormat<Statistics>
- Returns:
- Statistics.class
 
- 
isForAllPopulationpublic boolean isForAllPopulation()Returnstrueif this formatter shall consider that the statistics where computed using the totality of the populations under study. This information impacts the standard deviation values to be formatted.- Returns:
- trueif the statistics to format where computed using the totality of the populations under study.
- See Also:
 
- 
setForAllPopulationpublic void setForAllPopulation(boolean allPopulation) Sets whether this formatter shall consider that the statistics where computed using the totality of the populations under study. The default value isfalse.- Parameters:
- allPopulation-- trueif the statistics to format where computed using the totality of the populations under study.
- See Also:
 
- 
getBorderWidthpublic int getBorderWidth()Returns the "width" of the border to drawn around the table, in number of lines. The default width is 0, which stands for no border.- Returns:
- the border "width" in number of lines.
 
- 
setBorderWidthpublic void setBorderWidth(int borderWidth) Sets the "width" of the border to drawn around the table, in number of lines. The value can be any of the following:- 0 (the default) for no border
- 1 for single line (│,─)
- 2 for double lines (║,═)
 - Parameters:
- borderWidth- the border width, in number of lines.
 
- 
parseNot yet supported.- Specified by:
- parsein class- CompoundFormat<Statistics>
- 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.
 
- 
formatFormats the given statistics. This method will delegates to one of the following methods, depending on the type of the given object:- Overrides:
- formatin class- CompoundFormat<Statistics>
- Parameters:
- object- the object to format.
- toAppendTo- where to format the object.
- pos- ignored in current implementation.
- Returns:
- the given buffer, returned for convenience.
 
- 
formatFormats a localized string representation of the given statistics. If statistics on differences are associated to the given object, they will be formatted too.- Specified by:
- formatin class- CompoundFormat<Statistics>
- Parameters:
- stats- the statistics to format.
- toAppendTo- where to format the statistics.
- Throws:
- IOException- if an error occurred while writing to the given appendable.
 
- 
formatFormats the given statistics in a tabular format. This method does not check for the statistics on differences - if such statistics are wanted, they must be included in the given array.- Parameters:
- stats- the statistics to format.
- toAppendTo- where to format the statistics.
- Throws:
- IOException- if an error occurred while writing to the given appendable.
 
- 
cloneReturns a clone of this format.- Overrides:
- clonein class- TabularFormat<Statistics>
- Returns:
- a clone of this format.
 
 
-