org.das2.datum.format

Class TimeDatumFormatter

java.lang.Object

org.das2.datum.format.DatumFormatter

org.das2.datum.format.TimeDatumFormatter

public class TimeDatumFormatter
extends DatumFormatter

Formatter is configured with strings of SimpleDateFormat (yyyy-MM-DD) or % percent format (%Y-%m-%d) specifiers. SimpleDateFormat is discouraged because most other parts of das2 use the shorter form. This does not support formats with seconds but no hours and minutes, like "$Y $j $S"

Field Summary

Fields

Modifier and Type	Field and Description
static TimeDatumFormatter	DAY_OF_YEAR yyyy-JJJ
static TimeDatumFormatter	DAYS yyyy-MM-dd
static TimeDatumFormatter	DEFAULT yyyy-MM-dd'T'HH:mm:ss.SSS'Z
static TimeDatumFormatter	DOY_DAYS yyyy-MM-dd (JJJ)
static TimeDatumFormatter	HOURS yyyy-MM-dd HH:'00'
static TimeDatumFormatter	MICROSECONDS HH:mm:ss.SSSSSS
static TimeDatumFormatter	MILLISECONDS HH:mm:ss.SSS
static TimeDatumFormatter	MINUTES HH:mm
static TimeDatumFormatter	MONTHS yyyy-MM
static TimeDatumFormatter	NANOSECONDS HH:mm:ss.SSSSSSSSS
static TimeDatumFormatter	SECONDS HH:mm:ss
static TimeDatumFormatter	YEARS yyyy

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

logger

Constructor Summary

Constructors

Constructor and Description
TimeDatumFormatter(java.lang.String formatString) Creates a new instance of TimeDatumFormatter

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(Datum datum)
static TimeDatumFormatter	formatterForScale(int scale, DatumRange context) returns a TimeDatumFormatter suitable for the specified scale and context.
static TimeDatumFormatter	formatterForScale(int scale, DatumRange context, boolean useDOY) returns a TimeDatumFormatter suitable for the specified scale and context.
protected java.text.Format	getFormat()
static TimeDatumFormatter	guessFormatter(DatumVector ticks, DatumRange context) guess formatted based on the two ticks given
protected java.lang.String	parseTimeFormatString(java.lang.String input) parse message format strings like yyyy-MM-DD
protected java.lang.String	parseTimeFormatStringPercent(java.lang.String format) create the message format, based on %Y, %m, %d format specification of the UNIX date command.
java.lang.String	toString()

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

axisFormat, format, grannyFormat, grannyFormat

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final TimeDatumFormatter DEFAULT

yyyy-MM-dd'T'HH:mm:ss.SSS'Z

DAYS

public static final TimeDatumFormatter DAYS

yyyy-MM-dd

DAY_OF_YEAR

public static final TimeDatumFormatter DAY_OF_YEAR

yyyy-JJJ

DOY_DAYS

public static final TimeDatumFormatter DOY_DAYS

yyyy-MM-dd (JJJ)

YEARS

public static final TimeDatumFormatter YEARS

yyyy

MONTHS

public static final TimeDatumFormatter MONTHS

yyyy-MM

HOURS

public static final TimeDatumFormatter HOURS

yyyy-MM-dd HH:'00'

MINUTES

public static final TimeDatumFormatter MINUTES

HH:mm

SECONDS

public static final TimeDatumFormatter SECONDS

HH:mm:ss

MILLISECONDS

public static final TimeDatumFormatter MILLISECONDS

HH:mm:ss.SSS

MICROSECONDS

public static final TimeDatumFormatter MICROSECONDS

HH:mm:ss.SSSSSS

NANOSECONDS

public static final TimeDatumFormatter NANOSECONDS

HH:mm:ss.SSSSSSSSS

Constructor Detail

TimeDatumFormatter

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

Creates a new instance of TimeDatumFormatter

Parameters:

formatString -

Throws:

java.text.ParseException

Method Detail

formatterForScale

public static TimeDatumFormatter formatterForScale(int scale,
                                                   DatumRange context)

returns a TimeDatumFormatter suitable for the specified scale and context. Context may be null to indicate that the formatted string will be interpreted outside of any context.

Parameters:

scale - the length we wish to represent, such as TimeUtil.HOUR

context - the context for the formatter, or null if the formatted string will be interpreted outside of any context.

Returns:

the formatter.

Throws:

java.lang.IllegalArgumentException - if the scale is TimeUtil.NANOS or is not found in TimeUtil.

guessFormatter

public static TimeDatumFormatter guessFormatter(DatumVector ticks,
                                                DatumRange context)

guess formatted based on the two ticks given

Parameters:

ticks - values to represent

context - null or the external context where the data is interpreted.

Returns:

the formatter

See Also:

DateTimeDatumFormatter.axisFormat(org.das2.datum.DatumVector, org.das2.datum.DatumRange)

formatterForScale

public static TimeDatumFormatter formatterForScale(int scale,
                                                   DatumRange context,
                                                   boolean useDOY)

returns a TimeDatumFormatter suitable for the specified scale and context. Context may be null to indicate that the formatted string will be interpreted outside of any context.

Parameters:

scale - the length we wish to represent, such as TimeUtil.HOUR

context - the context for the formatter, or null if the formatted string will be interpreted outside of any context.

useDOY - if true then use day-of-year rather than separate month and day.

Returns:

the formatter.

Throws:

java.lang.IllegalArgumentException - if the scale is TimeUtil.NANOS or is not found in TimeUtil.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

format

public java.lang.String format(Datum datum)

Specified by:

format in class DatumFormatter

getFormat

protected java.text.Format getFormat()

parseTimeFormatString

protected final java.lang.String parseTimeFormatString(java.lang.String input)
                                                throws java.text.ParseException

parse message format strings like yyyy-MM-DD

Parameters:

input -

Returns:

Throws:

java.text.ParseException

parseTimeFormatStringPercent

protected final java.lang.String parseTimeFormatStringPercent(java.lang.String format)
                                                       throws java.text.ParseException

create the message format, based on %Y, %m, %d format specification of the UNIX date command.

Parameters:

format - the format spec, such as %Y%m%dT%H%M

Returns:

a SimpleDateFormat string.

Throws:

java.text.ParseException