<h2>org.das2.datum.TimeParser.FieldHandler</h2><p>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).</p>
<hr>
<a name="configure"></a>
<h2>configure</h2>
configure( <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a> args ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a>

<p>arguments for the parser are passed in.</p>

<h3>Parameters</h3>
args - map of arguments.  $(t,a1=v1,a2=v2,a3=v3)

<h3>Returns:</h3>
null if the string is parseable, an error message otherwise.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=configure&unscoped_q=configure">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/TimeParser.FieldHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/TimeParser.FieldHandler.html#configure">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/TimeParser.FieldHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="format"></a>
<h2>format</h2>
format( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/TimeUtil/TimeStruct.html'>org.das2.datum.TimeUtil.TimeStruct</a> startTime, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/TimeUtil/TimeStruct.html'>org.das2.datum.TimeUtil.TimeStruct</a> timeWidth, int length, <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a> extra ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a>

<p>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.</p>

<h3>Parameters</h3>
startTime - a TimeUtil.TimeStruct
<br>
timeWidth - a TimeUtil.TimeStruct
<br>
length - an int
<br>
extra - extra data, such as version numbers, are passed in here.

<h3>Returns:</h3>
the string representing the time range specified.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=format&unscoped_q=format">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/TimeParser.FieldHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/TimeParser.FieldHandler.html#format">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/TimeParser.FieldHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="getRegex"></a>
<h2>getRegex</h2>
getRegex(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a>

<p>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.</p>

<h3>Returns:</h3>
null to match anything, or a regular expression matching valid entries.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getRegex&unscoped_q=getRegex">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/TimeParser.FieldHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/TimeParser.FieldHandler.html#getRegex">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/TimeParser.FieldHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="parse"></a>
<h2>parse</h2>
parse( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> fieldContent, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/TimeUtil/TimeStruct.html'>org.das2.datum.TimeUtil.TimeStruct</a> startTime, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/TimeUtil/TimeStruct.html'>org.das2.datum.TimeUtil.TimeStruct</a> timeWidth, <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a> extra ) &rarr; void

<p>parse the field to interpret as a time range.</p>

<h3>Parameters</h3>
fieldContent - the field to parse, for example "2014" for $Y
<br>
startTime - the current startTime
<br>
timeWidth - the current timeWidth
<br>
extra - extra data, such as version numbers, are passed out here.

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=parse&unscoped_q=parse">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/TimeParser.FieldHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/TimeParser.FieldHandler.html#parse">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/TimeParser.FieldHandler.java">[view source]</a>
<br>
<br>