org.das2.datum.format

Class DatumFormatter

java.lang.Object

org.das2.datum.format.DatumFormatter

Direct Known Subclasses:

DateTimeDatumFormatter, DefaultDatumFormatter, EnumerationDatumFormatter, ExponentDatumFormatter, ExponentialDatumFormatter, LatinPrefixDatumFormatter, TimeDatumFormatter

public abstract class DatumFormatter
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.logging.Logger	logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DatumFormatter()

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.
abstract 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.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final java.util.logging.Logger logger

Constructor Detail

DatumFormatter

protected DatumFormatter()

Method Detail

format

public abstract java.lang.String format(Datum datum)

format

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

grannyFormat

public java.lang.String grannyFormat(Datum datum)

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 format(org.das2.datum.Datum)

grannyFormat

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

formats the Datum in the context of the units.

axisFormat

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

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.

Parameters:

datums -

context - visible range, context should be provided.

Returns: