HiRISE

HiRISE.HiReport.form
Class StereoForm

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

public class StereoForm
extends PageSortForm

Collects input for stereo list reports

See Also:
Serialized Form

Field Summary
protected  boolean anaglyph
          If true, include only those with Anaglyphs
protected  boolean dtm
          If true, include only those with DTMs
static String ID
          CVS ID
protected  String[] theme
          science theme array
 
Fields inherited from class HiRISE.HiReport.form.PageSortForm
EXPORT_MAX_ROWS
 
Fields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet
 
Constructor Summary
StereoForm()
           
 
Method Summary
 boolean getAnaglyph()
          Get whether to include Anaglyphs (exclude non-Anaglyphs)
 String getDescription()
          Get the description string to search on.
 boolean getDtm()
          Get whether to include DTMs (exclude non-DTMs)
 String getObservationID()
          Get the observation ID constraint
 boolean getShowComplete()
          Get the value of showComplete.
 boolean getShowPartial()
          Get the value of showPartial.
 boolean getShowPlanned()
          Get the value of showPlanned.
 boolean getShowReleased()
          Get the value of showReleased.
 boolean getShowRetired()
          Get the value of showRetired
 boolean getShowSuggested()
          Get the value of showSuggested.
 String getSuggestionID()
          Get the suggestion ID constraint.
 String[] getTheme()
          Get the theme constraint (zero = any theme).
 String[] getThemes()
          Get the list of themes to choose from.
 void reset(org.apache.struts.action.ActionMapping map, javax.servlet.http.HttpServletRequest req)
          Handle reset, to trap unchecked checkboxen.
 void setAnaglyph(boolean anaglyph)
          Set whether to include Anaglyphs (exclude non-Anaglyphs)
 void setDescription(String description)
          Set the description to search on.
 void setDtm(boolean dtm)
          Set whether to include DTMs (exclude non-DTMs)
 void setObservationID(String observationID)
          If non-empty, set the observation ID pattern to find.
 void setShowComplete(boolean showComplete)
          Set the value of showComplete.
 void setShowPartial(boolean showPartial)
          Set the value of showPartial.
 void setShowPlanned(boolean showPlanned)
          Set the value of showPlanned.
 void setShowReleased(boolean showReleased)
          Set the value of showReleased.
 void setShowRetired(boolean showRetired)
          If true, show retired pairs.
 void setShowSuggested(boolean showSuggested)
          Set the value of showSuggested.
 void setSuggestionID(String suggestionID)
          If non-empty, set the suggestion ID to find.
 void setTheme(String... theme)
          Set the theme constraint (zero = any theme).
 org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping map, javax.servlet.http.HttpServletRequest req)
          Validate the form entry.
 
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

theme

protected String[] theme
science theme array


dtm

protected boolean dtm
If true, include only those with DTMs


anaglyph

protected boolean anaglyph
If true, include only those with Anaglyphs

Constructor Detail

StereoForm

public StereoForm()
Method Detail

getAnaglyph

public boolean getAnaglyph()
Get whether to include Anaglyphs (exclude non-Anaglyphs)

Returns:
true for Anaglyphs

getDtm

public boolean getDtm()
Get whether to include DTMs (exclude non-DTMs)

Returns:
true for DTMs

setAnaglyph

public void setAnaglyph(boolean anaglyph)
Set whether to include Anaglyphs (exclude non-Anaglyphs)

Parameters:
anaglyph - true for anaglyphs

setDtm

public void setDtm(boolean dtm)
Set whether to include DTMs (exclude non-DTMs)

Parameters:
dtm - true for DTMs

getThemes

public String[] getThemes()
Get the list of themes to choose from.

Returns:
ordered array of theme names

getTheme

public String[] getTheme()
Get the theme constraint (zero = any theme).

Returns:
Index into themes array.

setTheme

public void setTheme(String... theme)
Set the theme constraint (zero = any theme).

Parameters:
theme - Index into themes array.

getShowPlanned

public boolean getShowPlanned()
Get the value of showPlanned. If true, planned pairs will be shown.

Returns:
showPlanned

setShowPlanned

public void setShowPlanned(boolean showPlanned)
Set the value of showPlanned.

Parameters:
showPlanned - True to show planned pairs.

getShowPartial

public boolean getShowPartial()
Get the value of showPartial. If true, incomplete pairs will be shown.

Returns:
showPartial

setShowPartial

public void setShowPartial(boolean showPartial)
Set the value of showPartial.

Parameters:
showPartial - True to show partially completed pairs.

getShowComplete

public boolean getShowComplete()
Get the value of showComplete. If true, completed pairs will be shownn.

Returns:
showComplete

setShowComplete

public void setShowComplete(boolean showComplete)
Set the value of showComplete.

Parameters:
showComplete - True to show completed pairs.

getShowSuggested

public boolean getShowSuggested()
Get the value of showSuggested. If true, suggested pairs will be shown.

Returns:
showSuggested

setShowSuggested

public void setShowSuggested(boolean showSuggested)
Set the value of showSuggested.

Parameters:
showSuggested - True to show suggested pairs.

getShowReleased

public boolean getShowReleased()
Get the value of showReleased. If true, released pairs will be shown.

Returns:
showReleased

setShowReleased

public void setShowReleased(boolean showReleased)
Set the value of showReleased.

Parameters:
showReleased - True to show released pairs.

setDescription

public void setDescription(String description)
Set the description to search on. Empty strings are discarded.

Parameters:
description - Search text.

getDescription

public String getDescription()
Get the description string to search on.

Returns:
text string

getSuggestionID

public String getSuggestionID()
Get the suggestion ID constraint.

Returns:
suggestion ID

setSuggestionID

public void setSuggestionID(String suggestionID)
If non-empty, set the suggestion ID to find.

Parameters:
suggestionID - The suggestion

getObservationID

public String getObservationID()
Get the observation ID constraint

Returns:
observation ID

setObservationID

public void setObservationID(String observationID)
If non-empty, set the observation ID pattern to find.

Parameters:
observationID - The observation

getShowRetired

public boolean getShowRetired()
Get the value of showRetired

Returns:
showRetired

setShowRetired

public void setShowRetired(boolean showRetired)
If true, show retired pairs.

Parameters:
showRetired - If true, include retired pairs

validate

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

Overrides:
validate in class PageSortForm
Parameters:
map - Struts map
req - incoming request

reset

public void reset(org.apache.struts.action.ActionMapping map,
                  javax.servlet.http.HttpServletRequest req)
Handle reset, to trap unchecked checkboxen.

Overrides:
reset in class PageSortForm
Parameters:
map - Struts map
req - incoming request

HiRISE

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