org.das2.datum.format

Class FormatStringFormatter

java.lang.Object

org.das2.datum.format.DatumFormatter

org.das2.datum.format.DefaultDatumFormatter

org.das2.datum.format.FormatStringFormatter

public class FormatStringFormatter
extends DefaultDatumFormatter

This is based on the C-style format strings introduced in Java 5 that we can now use. When used with times, the format should be specified using URI_Templates like $Y$m$dT$H:$M:$S. TODO: See Autoplot's DataSetUtil.toString, which shows use with Calendar objects. Here is a table showing some examples:

%9.2f	decimal with two fractional places
%9.2e	decimal in scientific notation
%.2f	decimal with two fractional places, and some number of total spaces
%5d	integer in five spaces.
$Y$m$dZ	time specification.

Constructor Summary

Constructors

Constructor and Description
FormatStringFormatter(java.lang.String formatStr, boolean units) create a new instance based on the Java format string.

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(Datum datum)
java.lang.String	format(Datum datum, Units units)
java.lang.String	toString()

Methods inherited from class org.das2.datum.format.DefaultDatumFormatter

axisFormat, grannyFormat, grannyFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatStringFormatter

public FormatStringFormatter(java.lang.String formatStr,
                             boolean units)

create a new instance based on the Java format string.

Parameters:

formatStr - see http://download.oracle.com/javase/1.5.0/docs/api/java/util/Formatter.html#syntax

units - if true, append the units after the formatted string

Method Detail

format

public java.lang.String format(Datum datum)

Overrides:

format in class DefaultDatumFormatter

format

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

Overrides:

format in class DefaultDatumFormatter

toString

public java.lang.String toString()

Overrides:

toString in class DefaultDatumFormatter