HiRISE

HiRISE.HiReport.form
Class ProductStatusForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by HiRISE.HiReport.form.PageSortForm
          extended by HiRISE.HiReport.form.TimeRangeForm
              extended by HiRISE.HiReport.form.OrbitCycleForm
                  extended by HiRISE.HiReport.form.ProductStatusForm
All Implemented Interfaces:
Serializable

public class ProductStatusForm
extends OrbitCycleForm

Collects and validates user information for the product status report

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class HiRISE.HiReport.form.OrbitCycleForm
OrbitCycleForm.RangeUnit
 
Field Summary
 
Fields inherited from class HiRISE.HiReport.form.OrbitCycleForm
by, cenLat, cenLon, maxCycle, maxLat, maxLon, maxLs, maxMy, maxOrbit, minCycle, minLat, minLon, minLs, minMy, minOrbit, range, season, target
 
Fields inherited from class HiRISE.HiReport.form.TimeRangeForm
ID, maxDate, minDate, plus, TIME_FORMATS, timeFormatters, timeUnits, unit
 
Fields inherited from class HiRISE.HiReport.form.PageSortForm
EXPORT_MAX_ROWS
 
Fields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet
 
Constructor Summary
ProductStatusForm()
           
 
Method Summary
 HiProduct[] getHiProductIDs()
          Get the complete set of product IDs
 String getId()
          Get the observation ID
 String[] getIgnorable()
          Get the ignorable product types
 int getMaxOrbit()
          Get the maximum orbit number
 int getMinOrbit()
          Get the minimum orbit number
 boolean isActive()
          True if there has been input (an orbit range or observation ID)
 boolean isAll()
           
 boolean isRange()
          Return true if the form corresponds to a query over an orbit range
 void setAll(boolean all)
           
 void setId(String id)
          Set the observation ID
 void setIgnorable(String... ignorable)
          Set the ignorable product types
 void setMaxOrbit(int maxOrbit)
          Set the maximum orbit number
 void setMinOrbit(int minOrbit)
          Set the minimum orbit number
 org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping map, javax.servlet.http.HttpServletRequest req)
          Validate parameters
 
Methods inherited from class HiRISE.HiReport.form.OrbitCycleForm
checkArray, getBy, getCenLat, getCenLon, getMartianSeason, getMaxCycle, getMaxDate, getMaxLat, getMaxLon, getMaxLs, getMaxMy, getMinCycle, getMinDate, getMinLat, getMinLon, getMinLs, getMinMy, getNextMaxCycle, getNextMaxOrbit, getNextMinCycle, getNextMinOrbit, getPrevMaxCycle, getPrevMaxOrbit, getPrevMinCycle, getPrevMinOrbit, getRange, getSeason, getSeasons, getTarget, isMartian, setBy, setCenLat, setCenLon, setMaxCycle, setMaxLat, setMaxLon, setMaxLs, setMaxMy, setMinCycle, setMinLat, setMinLon, setMinLs, setMinMy, setRange, setSeason, setTarget
 
Methods inherited from class HiRISE.HiReport.form.TimeRangeForm
getPlus, getTimeRange, getTimeUnit, getTimeUnits, parseDate, setMaxDate, setMinDate, setPlus, setTimeRange, setTimeUnit
 
Methods inherited from class HiRISE.HiReport.form.PageSortForm
getDir, getPage, getSize, getSort, isAscending, reset, setDir, setPage, setSize, setSort
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProductStatusForm

public ProductStatusForm()
Method Detail

getHiProductIDs

public HiProduct[] getHiProductIDs()
Get the complete set of product IDs

Returns:
array of possible Product IDs

setIgnorable

public void setIgnorable(String... ignorable)
Set the ignorable product types

Parameters:
ignorable - HiProductIDs

getIgnorable

public String[] getIgnorable()
Get the ignorable product types

Returns:
HiProductIDs

isActive

public boolean isActive()
True if there has been input (an orbit range or observation ID)

Returns:
true if active input

getMinOrbit

public int getMinOrbit()
Description copied from class: OrbitCycleForm
Get the minimum orbit number

Overrides:
getMinOrbit in class OrbitCycleForm
Returns:
the minOrbit

setMinOrbit

public void setMinOrbit(int minOrbit)
Description copied from class: OrbitCycleForm
Set the minimum orbit number

Overrides:
setMinOrbit in class OrbitCycleForm
Parameters:
minOrbit - the minOrbit to set

getMaxOrbit

public int getMaxOrbit()
Description copied from class: OrbitCycleForm
Get the maximum orbit number

Overrides:
getMaxOrbit in class OrbitCycleForm
Returns:
the maxOrbit

setMaxOrbit

public void setMaxOrbit(int maxOrbit)
Description copied from class: OrbitCycleForm
Set the maximum orbit number

Overrides:
setMaxOrbit in class OrbitCycleForm
Parameters:
maxOrbit - the maxOrbit to set

isAll

public boolean isAll()
Returns:
the all

setAll

public void setAll(boolean all)
Parameters:
all - the all to set

setId

public void setId(String id)
Set the observation ID

Parameters:
id - observation

getId

public String getId()
Get the observation ID

Returns:
observation ID

validate

public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping map,
                                                      javax.servlet.http.HttpServletRequest req)
Validate parameters

Overrides:
validate in class OrbitCycleForm

isRange

public boolean isRange()
Return true if the form corresponds to a query over an orbit range

Returns:
true for range queries

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona