HiRISE

HiRISE.HiReport.form
Class HiSearchForm

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

public class HiSearchForm
extends OrbitCycleForm

Form for observation-based listings. This captures any and all information pertaining to a query that could return zero or more observations. It internally has a TimeRangeModel. Upon validation, this will be updated to contain the min and max time for the query.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class HiRISE.HiReport.form.OrbitCycleForm
OrbitCycleForm.RangeUnit
 
Field Summary
protected  boolean active
          If true, include the not retired
protected  boolean cap
          If true, include captioned observations
protected  String description
          description or comment text
protected  boolean highStability
          If true, include high stability
static String ID
          CVS ID
protected  boolean nadir
          If true, include roll angle == 0
protected  boolean nocap
          If true, include uncaptioned observations
protected  boolean nonstereo
          If true, include non-stereo
protected  boolean nopub
          If true, include unreleased observations
protected  boolean normStability
          If true, include norm stability
protected  String observation
          observation pattern, may or may not be full observation ID
protected  boolean offnadir
          If true, include roll angle != 0
protected  String[] phase
          Mission phases
static String[] PHASES
          Options array for mission phases
protected  String planner
          Name of planner
protected  String[] product
          Product (has) values
protected  boolean pub
          If true, include publicly released observations
protected  boolean retired
          If true, include retired
protected  boolean sc
          If true, search comment
protected  boolean sd
          If true, search description
protected  boolean sn
          If true, search notes
protected  boolean sp
          If true, search planner's note
protected  boolean sr
          If true, search science rationale
protected  boolean ss
          If true, search stl_description
protected  String[] status
          Status values
static String[] STATUSES
          Options array for status values
protected  boolean stereo
          If true, include stereo
protected  String suggester
          User name from People table
protected  int suggestion
          Suggestion id
protected  boolean sw
          If true, search web caption (English)
protected  String[] tag
          Tag values
protected  String tagger
          Tagger username
static String[] TARGETS
          Options array for target names
protected  String[] theme
          science theme array
static String[] THEMES
          Options array for science themes
protected  String username
          User name of the suggester
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
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
HiSearchForm()
           
 
Method Summary
 boolean getActive()
           
 boolean getCap()
          Returns true if captioned observations will be included, false if excluded
 String getDescription()
          Get the description being searched on
 boolean getHighStability()
          Get the high stability search option
 boolean getNadir()
           
 boolean getNocap()
          Returns true if non-captioned observations will be included, false if excluded
 boolean getNonstereo()
           
 boolean getNopub()
          Returns true if non-public observations will be included, false if excluded
 boolean getNormStability()
          Get the normal stability search option
 String getObservation()
          Get the observation ID (or null if unset)
 boolean getOffnadir()
           
 String[] getPhase()
          Get the mission phase names
 String[] getPhases()
          Get the array of possible (abbreviated) mission phase names.
 String getPlanner()
          Get the planner name
 String[] getProduct()
          Get the product names
 boolean getPub()
          Returns true if public observations will be included, false if excluded
 boolean getRetired()
           
 boolean getSc()
           
 boolean getSd()
           
 boolean getSn()
           
 boolean getSp()
           
 boolean getSr()
           
 boolean getSs()
           
 String[] getStatus()
          Get the status values
 String[] getStatuses()
          Get the array of possible status values.
 boolean getStereo()
           
 String getSuggester()
           
 int getSuggestion()
          Get the suggestion ID (or zero if unset)
 boolean getSw()
           
 String[] getTag()
          Get the tag names
 String getTagger()
           
 String[] getTargets()
          Get the array of possible target names.
 String[] getTheme()
          Get the science theme.
 String[] getThemes()
          Get the array of possible science themes.
 String getUsername()
           
 boolean getWord()
          Get the whole word search option.
 void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest req)
          Reset parameters
 void setActive(boolean active)
           
 void setCap(boolean cap)
          Set to true to include captioned observations, false to exclude non-captioned observations
 void setDescription(String description)
          Set the description being searched on
 void setHighStability(boolean highStability)
          Set the high stability search option
 void setNadir(boolean nadir)
           
 void setNocap(boolean nocap)
          Set to true to include non-captioned observations, false to exclude non-captioned observations
 void setNonstereo(boolean nonstereo)
           
 void setNopub(boolean nopub)
          Set to true to include non-public observations, false to exclude non-public observations
 void setNormStability(boolean normStability)
          Set the normal stability search option
 void setObservation(String observation)
          Set an observation ID for search
 void setOffnadir(boolean offnadir)
           
 void setPhase(String... phase)
          Set the mission phase names
 void setPlanner(String planner)
          Set the planner name
 void setProduct(String... product)
          Set products
 void setPub(boolean pub)
          Set to true to include public observations, false to exclude non-public observations
 void setRetired(boolean retired)
           
 void setSc(boolean sc)
          Search comment options
 void setSd(boolean sd)
          Search description
 void setSn(boolean sn)
          Search special notes
 void setSp(boolean sp)
          Search planner's notes
 void setSr(boolean sr)
          Search rationale option
 void setSs(boolean ss)
          Search STL descriptions
 void setStatus(String... status)
          Set the status values
 void setStereo(boolean stereo)
           
 void setSuggester(String suggester)
           
 void setSuggestion(int suggestion)
          Set a suggestion ID for search
 void setSw(boolean sw)
          Search web captions (English)
 void setTag(String... tag)
          Set tag names
 void setTagger(String tagger)
           
 void setTheme(String... theme)
          Set the science theme
 void setUsername(String username)
           
 void setWord(boolean word)
          Set to true to search for whole words, false for partials
 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, getTarget, isMartian, setBy, setCenLat, setCenLon, setMaxCycle, setMaxLat, setMaxLon, setMaxLs, setMaxMy, setMaxOrbit, setMinCycle, setMinLat, setMinLon, setMinLs, setMinMy, setMinOrbit, 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, 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

ID

public static final String ID
CVS ID

See Also:
Constant Field Values

PHASES

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


TARGETS

public static String[] TARGETS
Options array for target names


STATUSES

public static final String[] STATUSES
Options array for status values


THEMES

public static final String[] THEMES
Options array for science themes


phase

protected String[] phase
Mission phases


status

protected String[] status
Status values


product

protected String[] product
Product (has) values


tag

protected String[] tag
Tag values


tagger

protected String tagger
Tagger username


description

protected String description
description or comment text


theme

protected String[] theme
science theme array


suggestion

protected int suggestion
Suggestion id


planner

protected String planner
Name of planner


observation

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


highStability

protected boolean highStability
If true, include high stability


normStability

protected boolean normStability
If true, include norm stability


stereo

protected boolean stereo
If true, include stereo


nonstereo

protected boolean nonstereo
If true, include non-stereo


nadir

protected boolean nadir
If true, include roll angle == 0


offnadir

protected boolean offnadir
If true, include roll angle != 0


sc

protected boolean sc
If true, search comment


sd

protected boolean sd
If true, search description


ss

protected boolean ss
If true, search stl_description


sr

protected boolean sr
If true, search science rationale


sn

protected boolean sn
If true, search notes


sp

protected boolean sp
If true, search planner's note


sw

protected boolean sw
If true, search web caption (English)


suggester

protected String suggester
User name from People table


username

protected String username
User name of the suggester


retired

protected boolean retired
If true, include retired


active

protected boolean active
If true, include the not retired


word

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


pub

protected boolean pub
If true, include publicly released observations


nopub

protected boolean nopub
If true, include unreleased observations


cap

protected boolean cap
If true, include captioned observations


nocap

protected boolean nocap
If true, include uncaptioned observations

Constructor Detail

HiSearchForm

public HiSearchForm()
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

getThemes

public String[] getThemes()
Get the array of possible science themes.

Returns:
science themes

getStatuses

public String[] getStatuses()
Get the array of possible status values.

Returns:
status values

getPlanner

public String getPlanner()
Get the planner name

Returns:
planner name

setPlanner

public void setPlanner(String planner)
Set the planner name

Parameters:
planner - name of planner

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

setPhase

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

Parameters:
phase - mission phases

setProduct

public void setProduct(String... product)
Set products

Parameters:
product - product IDs

setTag

public void setTag(String... tag)
Set tag names

Parameters:
tag - Tag names

setStatus

public void setStatus(String... status)
Set the status values

Parameters:
status - values for status

getPhase

public String[] getPhase()
Get the mission phase names

Returns:
phase names

getStatus

public String[] getStatus()
Get the status values

Returns:
status values

getTag

public String[] getTag()
Get the tag names

Returns:
tag names

getProduct

public String[] getProduct()
Get the product names

Returns:
product names

getTheme

public String[] getTheme()
Get the science theme.

Returns:
science theme

setTheme

public void setTheme(String... theme)
Set the science theme

Parameters:
theme - theme

getSuggestion

public int getSuggestion()
Get the suggestion ID (or zero if unset)

Returns:
suggestion ID

setSuggestion

public void setSuggestion(int suggestion)
Set a suggestion ID for search

Parameters:
suggestion - ID

getObservation

public String getObservation()
Get the observation ID (or null if unset)

Returns:
observation ID

setObservation

public void setObservation(String observation)
Set an observation ID for search

Parameters:
observation - ID

getHighStability

public boolean getHighStability()
Get the high stability search option

Returns:
true to query for high stability

setHighStability

public void setHighStability(boolean highStability)
Set the high stability search option

Parameters:
highStability - true if high stability constraint will be used

getNormStability

public boolean getNormStability()
Get the normal stability search option

Returns:
true to query for normal stability

setNormStability

public void setNormStability(boolean normStability)
Set the normal stability search option

Parameters:
normStability - true if normal stability constraint will be used

getStereo

public boolean getStereo()

setStereo

public void setStereo(boolean stereo)

getNonstereo

public boolean getNonstereo()

setNonstereo

public void setNonstereo(boolean nonstereo)

getNadir

public boolean getNadir()

setNadir

public void setNadir(boolean nadir)

getOffnadir

public boolean getOffnadir()

setOffnadir

public void setOffnadir(boolean offnadir)

setSc

public void setSc(boolean sc)
Search comment options

Parameters:
sc - true to search comments

setSd

public void setSd(boolean sd)
Search description

Parameters:
sd - true to search description

setSs

public void setSs(boolean ss)
Search STL descriptions

Parameters:
ss - true to search STL descriptions

setSr

public void setSr(boolean sr)
Search rationale option

Parameters:
sr - true to search rationales

setSn

public void setSn(boolean sn)
Search special notes

Parameters:
sn - true to search special notes

setSp

public void setSp(boolean sp)
Search planner's notes

Parameters:
sp - true to search notes

setSw

public void setSw(boolean sw)
Search web captions (English)

Parameters:
sw - true to search web captions

getSc

public boolean getSc()

getSd

public boolean getSd()

getSs

public boolean getSs()

getSr

public boolean getSr()

getSn

public boolean getSn()

getSp

public boolean getSp()

getSw

public boolean getSw()

getSuggester

public String getSuggester()

setSuggester

public void setSuggester(String suggester)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getTagger

public String getTagger()

setTagger

public void setTagger(String tagger)

getActive

public boolean getActive()

setActive

public void setActive(boolean active)

getRetired

public boolean getRetired()

setRetired

public void setRetired(boolean retired)

getWord

public boolean getWord()
Get the whole word search option.

Returns:
true for whole words, false for partial

setWord

public void setWord(boolean word)
Set to true to search for whole words, false for partials

Parameters:
word - search option

getPub

public boolean getPub()
Returns true if public observations will be included, false if excluded

Returns:
true = include public, false = exclude

setPub

public void setPub(boolean pub)
Set to true to include public observations, false to exclude non-public observations

Parameters:
pub - true = include public, false = exclude

getNopub

public boolean getNopub()
Returns true if non-public observations will be included, false if excluded

Returns:
true = include non-public, false = exclude

setNopub

public void setNopub(boolean nopub)
Set to true to include non-public observations, false to exclude non-public observations

Parameters:
nopub - true = include non-public, false = exclude

getCap

public boolean getCap()
Returns true if captioned observations will be included, false if excluded

Returns:
true = include captioned, false = exclude

setCap

public void setCap(boolean cap)
Set to true to include captioned observations, false to exclude non-captioned observations

Parameters:
cap - true = include captioned, false = exclude

getNocap

public boolean getNocap()
Returns true if non-captioned observations will be included, false if excluded

Returns:
true = include non-captioned, false = exclude

setNocap

public void setNocap(boolean nocap)
Set to true to include non-captioned observations, false to exclude non-captioned observations

Parameters:
nocap - true = include non-captioned, false = exclude

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest req)
Description copied from class: PageSortForm
Reset parameters

Overrides:
reset in class PageSortForm

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