org.das2.datum.format

Class DefaultDatumFormatter

java.lang.Object

org.das2.datum.format.DatumFormatter

org.das2.datum.format.DefaultDatumFormatter

Direct Known Subclasses:

FormatStringFormatter

public class DefaultDatumFormatter
extends DatumFormatter

Formats Datum objects for printing and parses strings to Datum objects.

Field Summary

Fields inherited from class org.das2.datum.format.DatumFormatter

logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultDatumFormatter() Available for use by subclasses
	DefaultDatumFormatter(java.lang.String formatString) create a formatter

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	axisFormat(DatumVector datums, DatumRange context) format the set of Datums using a consistent and optimized format.
java.lang.String	format(Datum datum)
java.lang.String	format(Datum datum, Units units)
java.lang.String	grannyFormat(Datum datum) Returns the datum formatted as a String with special formatting characters.
java.lang.String	grannyFormat(Datum datum, Units units) formats the Datum in the context of the units.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDatumFormatter

protected DefaultDatumFormatter()

Available for use by subclasses

DefaultDatumFormatter

public DefaultDatumFormatter(java.lang.String formatString)
                      throws java.text.ParseException

create a formatter

Parameters:

formatString, - passed to DecimalFormat's applyPattern, also supporting %d, %.2f, and %.2e

Throws:

java.text.ParseException

See Also:

DecimalFormat.applyPattern(java.lang.String)

Method Detail

format

public java.lang.String format(Datum datum)

Specified by:

format in class DatumFormatter

format

public java.lang.String format(Datum datum,
                               Units units)

Overrides:

format in class DatumFormatter

grannyFormat

public java.lang.String grannyFormat(Datum datum,
                                     Units units)

Description copied from class: DatumFormatter

formats the Datum in the context of the units.

Overrides:

grannyFormat in class DatumFormatter

axisFormat

public java.lang.String[] axisFormat(DatumVector datums,
                                     DatumRange context)

Description copied from class: DatumFormatter

format the set of Datums using a consistent and optimized format. First introduced to support DasAxis, where tighter coupling between the two is required to efficiently provide context.

Overrides:

axisFormat in class DatumFormatter

context - visible range, context should be provided.

Returns:

grannyFormat

public java.lang.String grannyFormat(Datum datum)

Description copied from class: DatumFormatter

Returns the datum formatted as a String with special formatting characters. As with format, this should be out-of-context and should be tagged with the Units. The default implementation just returns the result of DatumFormatter.format(org.das2.datum.Datum)

Overrides:

grannyFormat in class DatumFormatter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object