HiRISE

HiRISE.HiReport.form
Class CtxSearchForm

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.CtxSearchForm
All Implemented Interfaces:
Serializable

public class CtxSearchForm
extends OrbitCycleForm

Holds information for CTX search

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class HiRISE.HiReport.form.OrbitCycleForm
OrbitCycleForm.RangeUnit
 
Field Summary
protected  String description
          description or comment text
protected  String id
          id pattern, may or may not be full observation ID
protected  String[] phase
          Phase array
static String[] PHASES
          Options array for mission phases
static String[] TARGETS
          Options array for target names
protected  boolean word
          If true, do a whole-word search
 
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
CtxSearchForm()
           
 
Method Summary
 String getDescription()
          Get the description being searched on
 String getId()
          Get the CTX product ID input
 String[] getPhase()
          Get the phase abbreviations being searched on
 String[] getPhases()
          Get the array of possible (abbreviated) mission phase names.
 String[] getTarget()
          Get the target names
 String[] getTargets()
          Get the array of possible target names.
 boolean getWord()
          If true, will do whole-word matching
 void setDescription(String description)
          Set the description being searched on
 void setId(String id)
          Set the CTX product ID for query
 void setPhase(String... phase)
          Set the mission phase names
 void setTarget(String... target)
          Set the target names
 void setWord(boolean word)
          Set to true to match on whole words (default false)
 org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest req)
          Validate the form input
 
Methods inherited from class HiRISE.HiReport.form.OrbitCycleForm
checkArray, getBy, getCenLat, getCenLon, getMartianSeason, getMaxCycle, getMaxDate, getMaxLat, getMaxLon, getMaxLs, getMaxMy, getMaxOrbit, getMinCycle, getMinDate, getMinLat, getMinLon, getMinLs, getMinMy, getMinOrbit, getNextMaxCycle, getNextMaxOrbit, getNextMinCycle, getNextMinOrbit, getPrevMaxCycle, getPrevMaxOrbit, getPrevMinCycle, getPrevMinOrbit, getRange, getSeason, getSeasons, isMartian, setBy, setCenLat, setCenLon, setMaxCycle, setMaxLat, setMaxLon, setMaxLs, setMaxMy, setMaxOrbit, setMinCycle, setMinLat, setMinLon, setMinLs, setMinMy, setMinOrbit, setRange, setSeason
 
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
 

Field Detail

PHASES

public static final String[] PHASES
Options array for mission phases


TARGETS

public static String[] TARGETS
Options array for target names


phase

protected String[] phase
Phase array


id

protected String id
id pattern, may or may not be full observation ID


description

protected String description
description or comment text


word

protected boolean word
If true, do a whole-word search

Constructor Detail

CtxSearchForm

public CtxSearchForm()
Method Detail

getPhases

public String[] getPhases()
Get the array of possible (abbreviated) mission phase names.

Returns:
phase names

getTargets

public String[] getTargets()
Get the array of possible target names.

Returns:
target names

getDescription

public String getDescription()
Get the description being searched on

Returns:
description text

setDescription

public void setDescription(String description)
Set the description being searched on

Parameters:
description - text

setTarget

public void setTarget(String... target)
Set the target names

Overrides:
setTarget in class OrbitCycleForm
Parameters:
target - name of targets

getTarget

public String[] getTarget()
Description copied from class: OrbitCycleForm
Get the target names

Overrides:
getTarget in class OrbitCycleForm
Returns:
target names

setPhase

public void setPhase(String... phase)
Set the mission phase names

Parameters:
phase - mission phases

getPhase

public String[] getPhase()
Get the phase abbreviations being searched on

Returns:
abbreviations

getId

public String getId()
Get the CTX product ID input

Returns:
ID

setId

public void setId(String id)
Set the CTX product ID for query

Parameters:
id - CTX product ID

getWord

public boolean getWord()
If true, will do whole-word matching

Returns:
whole-word match setting

setWord

public void setWord(boolean word)
Set to true to match on whole words (default false)

Parameters:
word - whole-word setting

validate

public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping,
                                                      javax.servlet.http.HttpServletRequest req)
Validate the form input

Overrides:
validate in class OrbitCycleForm

HiRISE

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