org.das2.datum

Class Orbits.OrbitFieldHandler

java.lang.Object

org.das2.datum.Orbits.OrbitFieldHandler

All Implemented Interfaces:

TimeParser.FieldHandler

Enclosing class:

Orbits

public static class Orbits.OrbitFieldHandler
extends java.lang.Object
implements TimeParser.FieldHandler

allow orbits to be used in file names

Constructor Summary

Constructors

Constructor and Description
OrbitFieldHandler()

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.
OrbitDatumRange	getOrbitRange()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrbitFieldHandler

public OrbitFieldHandler()

Method Detail

configure

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

Description copied from interface: TimeParser.FieldHandler

arguments for the parser are passed in.

Specified by:

configure in interface TimeParser.FieldHandler

Parameters:

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

Returns:

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

getRegex

public java.lang.String getRegex()

Description copied from interface: TimeParser.FieldHandler

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.

Specified by:

getRegex in interface TimeParser.FieldHandler

Returns:

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

parse

public 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

Description copied from interface: TimeParser.FieldHandler

parse the field to interpret as a time range.

Specified by:

parse in interface TimeParser.FieldHandler

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.

getOrbitRange

public OrbitDatumRange getOrbitRange()

format

public 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

Description copied from interface: TimeParser.FieldHandler

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.

Specified by:

format in interface TimeParser.FieldHandler

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

Returns:

the string representing the time range specified.

Throws:

java.lang.IllegalArgumentException