org.das2.datum

Interface TimeParser.FieldHandler

All Known Implementing Classes:

Orbits.OrbitFieldHandler, TimeParser.EnumFieldHandler, TimeParser.HrintervalFieldHandler, TimeParser.IgnoreFieldHandler, TimeParser.PeriodicFieldHandler, TimeParser.SubsecFieldHandler

Enclosing class:

TimeParser

public static interface TimeParser.FieldHandler

Interface to add custom handlers for strings with unique formats. For example, the RPWS group had files with two-hex digits indicating the ten-minute interval covered by the file name. This is also used for orbits. TODO: FieldHandler needs to report its affect on the LSD. (Autoplot gets versioning).

Method Summary

Modifier and Type	Method and Description
java.lang.String	configure(java.util.Map<java.lang.String,java.lang.String> args) arguments for the parser are passed in.
java.lang.String	format(TimeUtil.TimeStruct startTime, TimeUtil.TimeStruct timeWidth, int length, java.util.Map<java.lang.String,java.lang.String> extra) create a string given the times, when this is possible.
java.lang.String	getRegex() return a regular expression that matches valid field entries.
void	parse(java.lang.String fieldContent, TimeUtil.TimeStruct startTime, TimeUtil.TimeStruct timeWidth, java.util.Map<java.lang.String,java.lang.String> extra) parse the field to interpret as a time range.

Method Detail

configure

java.lang.String configure(java.util.Map<java.lang.String,java.lang.String> args)

arguments for the parser are passed in.

Parameters:

args - map of arguments. $(t,a1=v1,a2=v2,a3=v3)

Returns:

null if the string is parseable, an error message otherwise.

getRegex

java.lang.String getRegex()

return a regular expression that matches valid field entries. ".*" can be used to match anything, but this limits use. TODO: where is this used? I added it because it's easy and I saw a TODO to add it.

Returns:

null to match anything, or a regular expression matching valid entries.

parse

void parse(java.lang.String fieldContent,
           TimeUtil.TimeStruct startTime,
           TimeUtil.TimeStruct timeWidth,
           java.util.Map<java.lang.String,java.lang.String> extra)
    throws java.text.ParseException

parse the field to interpret as a time range.

Parameters:

fieldContent - the field to parse, for example "2014" for $Y

startTime - the current startTime

timeWidth - the current timeWidth

extra - extra data, such as version numbers, are passed out here.

Throws:

java.text.ParseException - when the field is not consistent with the spec.

format

java.lang.String format(TimeUtil.TimeStruct startTime,
                        TimeUtil.TimeStruct timeWidth,
                        int length,
                        java.util.Map<java.lang.String,java.lang.String> extra)
                 throws java.lang.IllegalArgumentException

create a string given the times, when this is possible. An IllegalArgumentException should be thrown when this is not possible, but be loose so this can be composed with other field handlers. For example, imagine the $Y field handler. This should not throw an exception when 2012-03-29 is passed in because it's not 2012-01-01, because the $m and $d might be used later. However if a time is specified for a year before the first orbit of a spacecraft, then an exception should be thrown because there is an error that the developer is going to have to deal with.

Parameters:

startTime -

timeWidth -

length, - -1 or the length of the field.

extra - extra data, such as version numbers, are passed in here.

Returns:

the string representing the time range specified.

Throws:

java.lang.IllegalArgumentException