HiRISE

HiRISE.HiPlan.HiWeb
Class Suggestion

java.lang.Object
  extended by HiRISE.HiPlan.HiWeb.Suggestion
All Implemented Interfaces:
Cloneable, Comparable<Suggestion>

public class Suggestion
extends Object
implements Cloneable, Comparable<Suggestion>

A data model for a HiRISE observation suggestion. A suggestion includes the fields from the Suggested_Observations table, plus data from related tables.

Note: This class has a natural ordering that is highly inconsistent with equals. Furthermore, the equals(Object) method and the hashCode() method both disregard the getRelatedSuggestions() map.

Warning The API for this class is currently in flux.

Version:
1.9
Author:
Guy McArthur, Christian Schaller - UA/PIRL

Nested Class Summary
static class Suggestion.ApprovalStatus
          An enumeration of the possible values of the suggestion's approval status.
static class Suggestion.Priority
          An enumeration of the suggestion priority values.
static class Suggestion.RelationType
          An enumeration of the possible relation types between suggestions.
static class Suggestion.ScienceTheme
          An enumeration of the many HiRISE science themes.
static class Suggestion.TargetName
          An enumeration of the possible values for the suggestion's target.
 
Field Summary
static String APPROVAL_STATUS
           
static String CENTER_LATITUDE
           
static String CENTER_LONGITUDE
           
static String CRISM_COORDINATION
           
static String DATE_PRIORITIZED
           
static String DATE_SUCCESS
           
static String DESCRIPTION
           
static String EXACT_AREA_REQUESTED
           
static String ID
          Class identification name with source code version and date.
static int INVALID_ID
          The value for an invalid suggestion ID.
static String KEY_ID
          The key ID for the suggested observation record.
static String LAST_UPDATE
           
static String MAX_BINNING
           
static String MAX_EMISSION_ANGLE
           
static String MAX_INCIDENCE_ANGLE
           
static String MAX_LATITUDE
           
static String MAX_LONGITUDE
           
static String MAX_LSUBS
           
static String MAX_PHASE_ANGLE
           
static String MIN_EMISSION_ANGLE
           
static String MIN_INCIDENCE_ANGLE
           
static String MIN_LATITUDE
           
static String MIN_LONGITUDE
           
static String MIN_LSUBS
           
static String MIN_PHASE_ANGLE
           
static String NEED_COLOR
           
static String NEED_STEREO
           
static String NO
           
static String NUMBER_OF_OBSERVATIONS
           
static String PRIORITY
           
static String PRIORITY_COLOR
           
static String PRIORITY_HIGHRES
           
static String PRIORITY_OVERALL
           
static String PRIORITY_STEREO
           
static String RETIRING_OBSERVATION_ID
           
static String ROI_VERTICES
           
static String SCIENCE_RATIONALE
           
static String SPECIAL_NOTES
           
static String STL_CRISM_COORDINATION
           
static String STL_DESCRIPTION
           
static String STL_EDIT_DATE
           
static String STL_HIGH_STABILITY_NADIR
           
static String STL_MAX_BINNING
           
static String STL_MAX_EMISSION_ANGLE
           
static String STL_MAX_INCIDENCE_ANGLE
           
static String STL_MAX_LSUBS
           
static String STL_MAX_PHASE_ANGLE
           
static String STL_MIN_EMISSION_ANGLE
           
static String STL_MIN_INCIDENCE_ANGLE
           
static String STL_MIN_LSUBS
           
static String STL_MIN_PHASE_ANGLE
           
static String STL_MUST_HAVE
           
static String STL_NONINTERACTIVE
           
static String STL_NUMBER_OF_OBSERVATIONS
           
static String STL_OFF_NADIR_IO
           
static String STL_STEREO
           
static String SUCCESS_VALIDATOR_USERNAME
           
static String SUGGESTION_DATE
           
static String TARGET_NAME
           
static String UNRETIREMENT_REQUEST_FLAG
           
static String VERSION
           
static String YES
           
 
Constructor Summary
Suggestion()
           
 
Method Summary
 void addRelatedSuggestion(Suggestion suggestion, Suggestion.RelationType relationType)
          Adds a related suggestion to this suggestion.
static Integer booleanToInt(Boolean bool)
          Converts a boolean into an integer token.
static String booleanToYesNo(Boolean bool)
          Converts a boolean into a text token.
 Object clone()
          Returns a clone of this suggestion.
 int compareTo(Suggestion s)
          Compares this suggestion with the specified suggestion for order.
 boolean equals(Object o)
          Indicates whether some other object is equal to this suggestion.
 Suggestion.ApprovalStatus getApprovalStatus()
          Gets the xxx of this suggestion.
 Double getCenterLatitude()
          Gets the xxx of this suggestion.
 Double getCenterLongitude()
          Gets the xxx of this suggestion.
 Boolean getCrismCoordination()
          Gets the xxx of this suggestion.
 Date getDatePrioritized()
          Gets the xxx of this suggestion.
 Date getDateSuccess()
          Gets the xxx of this suggestion.
 String getDescription()
          Gets the xxx of this suggestion.
 Boolean getExactAreaRequested()
          Gets the xxx of this suggestion.
 int getId()
          Gets the xxx of this suggestion.
 Date getLastUpdate()
          Gets the xxx of this suggestion.
 Integer getMaxBinning()
          Gets the xxx of this suggestion.
 Double getMaxEmissionAngle()
          Gets the xxx of this suggestion.
 Double getMaxIncidenceAngle()
          Gets the xxx of this suggestion.
 Double getMaxLatitude()
          Gets the xxx of this suggestion.
 Double getMaxLongitude()
          Gets the xxx of this suggestion.
 Double getMaxLsubs()
          Gets the xxx of this suggestion.
 Double getMaxPhaseAngle()
          Gets the xxx of this suggestion.
 Double getMinEmissionAngle()
          Gets the xxx of this suggestion.
 Double getMinIncidenceAngle()
          Gets the xxx of this suggestion.
 Double getMinLatitude()
          Gets the xxx of this suggestion.
 Double getMinLongitude()
          Gets the xxx of this suggestion.
 Double getMinLsubs()
          Gets the xxx of this suggestion.
 Double getMinPhaseAngle()
          Gets the xxx of this suggestion.
 Boolean getNeedColor()
          Gets the xxx of this suggestion.
 Boolean getNeedStereo()
          Gets the xxx of this suggestion.
 Integer getNumberOfObservations()
          Gets the xxx of this suggestion.
 Suggestion.ScienceTheme getPrimaryScienceTheme()
          Gets the xxx of this suggestion.
 Suggestion.Priority getPriority()
          Gets the xxx of this suggestion.
 Integer getPriorityColor()
          Gets the xxx of this suggestion.
 Integer getPriorityHighres()
          Gets the xxx of this suggestion.
 Integer getPriorityOverall()
          Gets the xxx of this suggestion.
 Integer getPriorityStereo()
          Gets the xxx of this suggestion.
 Map<Suggestion,Suggestion.RelationType> getRelatedSuggestions()
          Gets all suggestions related to this suggestion.
 Set<Suggestion> getRelatedSuggestions(Suggestion.RelationType relationType)
          Gets all suggestions of a given type that are related to this suggestion.
 String getRetiringObservationId()
          Gets the xxx of this suggestion.
 String getRoiVertices()
          Gets the xxx of this suggestion.
 String getScienceRationale()
          Gets the xxx of this suggestion.
 Suggestion.ScienceTheme getSecondaryScienceTheme()
          Gets the xxx of this suggestion.
 String getSpecialNotes()
          Gets the xxx of this suggestion.
 Boolean getStlCrismCoordination()
          Gets the xxx of this suggestion.
 String getStlDescription()
          Gets the xxx of this suggestion.
 Date getStlEditDate()
          Gets the xxx of this suggestion.
 Boolean getStlHighStabilityNadir()
          Gets the xxx of this suggestion.
 Integer getStlMaxBinning()
          Gets the xxx of this suggestion.
 Double getStlMaxEmissionAngle()
          Gets the xxx of this suggestion.
 Double getStlMaxIncidenceAngle()
          Gets the xxx of this suggestion.
 Double getStlMaxLsubs()
          Gets the xxx of this suggestion.
 Double getStlMaxPhaseAngle()
          Gets the xxx of this suggestion.
 Double getStlMinEmissionAngle()
          Gets the xxx of this suggestion.
 Double getStlMinIncidenceAngle()
          Gets the xxx of this suggestion.
 Double getStlMinLsubs()
          Gets the xxx of this suggestion.
 Double getStlMinPhaseAngle()
          Gets the xxx of this suggestion.
 Boolean getStlMustHave()
          Gets the xxx of this suggestion.
 Boolean getStlNoninteractive()
          Gets the xxx of this suggestion.
 Integer getStlNumberOfObservations()
          Gets the xxx of this suggestion.
 Boolean getStlOffNadirIo()
          Gets the xxx of this suggestion.
 Boolean getStlStereo()
          Gets the xxx of this suggestion.
 String getSuccessValidatorUsername()
          Gets the xxx of this suggestion.
 String getSuggester()
          Gets the xxx of this suggestion.
 Date getSuggestionDate()
          Gets the xxx of this suggestion.
 Suggestion.TargetName getTargetName()
          Gets the xxx of this suggestion.
 Boolean getUnretirementRequestFlag()
          Gets the xxx of this suggestion.
 String getVersion()
          Gets the xxx of this suggestion.
 int hashCode()
          Returns the hash code value for this suggestion.
static Boolean intToBoolean(Integer integer)
          Converts an integer token into a boolean value.
 Suggestion.RelationType removeRelatedSuggestion(Suggestion suggestion)
          Removes a given suggestion from this suggestion's set of related suggestions.
 void setApprovalStatus(Suggestion.ApprovalStatus approvalStatus)
          Sets the xxx for this suggestion.
 void setCenterLatitude(Double centerLatitude)
          Sets the xxx for this suggestion.
 void setCenterLongitude(Double centerLongitude)
          Sets the xxx for this suggestion.
 void setCrismCoordination(Boolean crismCoordination)
          Sets the xxx for this suggestion.
 void setDatePrioritized(Date datePrioritized)
          Sets the xxx for this suggestion.
 void setDateSuccess(Date dateSuccess)
          Sets the xxx for this suggestion.
 void setDescription(String description)
          Sets the xxx for this suggestion.
 void setExactAreaRequested(Boolean exactAreaRequested)
          Sets the xxx for this suggestion.
 void setId(int id)
          Sets the xxx for this suggestion.
 void setLastUpdate(Date lastUpdate)
          Sets the xxx for this suggestion.
 void setMaxBinning(Integer maxBinning)
          Sets the xxx for this suggestion.
 void setMaxEmissionAngle(Double maxEmissionAngle)
          Sets the xxx for this suggestion.
 void setMaxIncidenceAngle(Double maxIncidenceAngle)
          Sets the xxx for this suggestion.
 void setMaxLatitude(Double maxLatitude)
          Sets the xxx for this suggestion.
 void setMaxLongitude(Double maxLongitude)
          Sets the xxx for this suggestion.
 void setMaxLsubs(Double maxLsubs)
          Sets the xxx for this suggestion.
 void setMaxPhaseAngle(Double maxPhaseAngle)
          Sets the xxx for this suggestion.
 void setMinEmissionAngle(Double minEmissionAngle)
          Sets the xxx for this suggestion.
 void setMinIncidenceAngle(Double minIncidenceAngle)
          Sets the xxx for this suggestion.
 void setMinLatitude(Double minLatitude)
          Sets the xxx for this suggestion.
 void setMinLongitude(Double minLongitude)
          Sets the xxx for this suggestion.
 void setMinLsubs(Double minLsubs)
          Sets the xxx for this suggestion.
 void setMinPhaseAngle(Double minPhaseAngle)
          Sets the xxx for this suggestion.
 void setNeedColor(Boolean needColor)
          Sets the xxx for this suggestion.
 void setNeedStereo(Boolean needStereo)
          Sets the xxx for this suggestion.
 void setNumberOfObservations(Integer numberOfObservations)
          Sets the xxx for this suggestion.
 void setPrimaryScienceTheme(Suggestion.ScienceTheme primaryScienceTheme)
          Sets the xxx for this suggestion.
 void setPriority(Suggestion.Priority priority)
          Sets the xxx for this suggestion.
 void setPriorityColor(Integer priorityColor)
          Sets the xxx for this suggestion.
 void setPriorityHighres(Integer priorityHighres)
          Sets the xxx for this suggestion.
 void setPriorityOverall(Integer priorityOverall)
          Sets the xxx for this suggestion.
 void setPriorityStereo(Integer priorityStereo)
          Sets the xxx for this suggestion.
 void setRelatedSuggestions(Map<Suggestion,Suggestion.RelationType> relatedSuggestions)
          Replaces the map of related suggestions with another one.
 void setRetiringObservationId(String retiringObservationId)
          Sets the xxx for this suggestion.
 void setRoiVertices(String roiVertices)
          Sets the xxx for this suggestion.
 void setScienceRationale(String scienceRationale)
          Sets the xxx for this suggestion.
 void setSecondaryScienceTheme(Suggestion.ScienceTheme secondaryScienceTheme)
          Sets the xxx for this suggestion.
 void setSpecialNotes(String specialNotes)
          Sets the xxx for this suggestion.
 void setStlCrismCoordination(Boolean stlCrismCoordination)
          Sets the xxx for this suggestion.
 void setStlDescription(String stlDescription)
          Sets the xxx for this suggestion.
 void setStlEditDate(Date stlEditDate)
          Sets the xxx for this suggestion.
 void setStlHighStabilityNadir(Boolean stlHighStabilityNadir)
          Sets the xxx for this suggestion.
 void setStlMaxBinning(Integer stlMaxBinning)
          Sets the xxx for this suggestion.
 void setStlMaxEmissionAngle(Double stlMaxEmissionAngle)
          Sets the xxx for this suggestion.
 void setStlMaxIncidenceAngle(Double stlMaxIncidenceAngle)
          Sets the xxx for this suggestion.
 void setStlMaxLsubs(Double stlMaxLsubs)
          Sets the xxx for this suggestion.
 void setStlMaxPhaseAngle(Double stlMaxPhaseAngle)
          Sets the xxx for this suggestion.
 void setStlMinEmissionAngle(Double stlMinEmissionAngle)
          Sets the xxx for this suggestion.
 void setStlMinIncidenceAngle(Double stlMinIncidenceAngle)
          Sets the xxx for this suggestion.
 void setStlMinLsubs(Double stlMinLsubs)
          Sets the xxx for this suggestion.
 void setStlMinPhaseAngle(Double stlMinPhaseAngle)
          Sets the xxx for this suggestion.
 void setStlMustHave(Boolean stlMustHave)
          Sets the xxx for this suggestion.
 void setStlNoninteractive(Boolean stlNoninteractive)
          Sets the xxx for this suggestion.
 void setStlNumberOfObservations(Integer stlNumberOfObservations)
          Sets the xxx for this suggestion.
 void setStlOffNadirIo(Boolean stlOffNadirIo)
          Sets the xxx for this suggestion.
 void setStlStereo(Boolean stlStereo)
          Sets the xxx for this suggestion.
 void setSuccessValidatorUsername(String successValidatorUsername)
          Sets the xxx for this suggestion.
 void setSuggester(String suggester)
          Sets the xxx for this suggestion.
 void setSuggestionDate(Date suggestionDate)
          Sets the xxx for this suggestion.
 void setTargetName(Suggestion.TargetName targetName)
          Sets the xxx for this suggestion.
 void setUnretirementRequestFlag(Boolean unretirementRequestFlag)
          Sets the xxx for this suggestion.
 void setVersion(String version)
          Sets the xxx for this suggestion.
static List<String> suggestedObservationsFields()
          Returns the list of field names in the Suggested_Observations table.
static Boolean yesNoToBoolean(String yesNo)
          Converts a text token into boolean value.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final String ID
Class identification name with source code version and date.

See Also:
Constant Field Values

KEY_ID

public static final String KEY_ID
The key ID for the suggested observation record. The field is called ID in the database, but the constant KEY_ID is used to distinguish it from the constant ID.

See Also:
Constant Field Values

VERSION

public static final String VERSION
See Also:
Constant Field Values

CENTER_LATITUDE

public static final String CENTER_LATITUDE
See Also:
Constant Field Values

CENTER_LONGITUDE

public static final String CENTER_LONGITUDE
See Also:
Constant Field Values

MAX_LATITUDE

public static final String MAX_LATITUDE
See Also:
Constant Field Values

MIN_LATITUDE

public static final String MIN_LATITUDE
See Also:
Constant Field Values

MAX_LONGITUDE

public static final String MAX_LONGITUDE
See Also:
Constant Field Values

MIN_LONGITUDE

public static final String MIN_LONGITUDE
See Also:
Constant Field Values

ROI_VERTICES

public static final String ROI_VERTICES
See Also:
Constant Field Values

EXACT_AREA_REQUESTED

public static final String EXACT_AREA_REQUESTED
See Also:
Constant Field Values

NEED_STEREO

public static final String NEED_STEREO
See Also:
Constant Field Values

PRIORITY_STEREO

public static final String PRIORITY_STEREO
See Also:
Constant Field Values

NEED_COLOR

public static final String NEED_COLOR
See Also:
Constant Field Values

PRIORITY_COLOR

public static final String PRIORITY_COLOR
See Also:
Constant Field Values

PRIORITY_HIGHRES

public static final String PRIORITY_HIGHRES
See Also:
Constant Field Values

CRISM_COORDINATION

public static final String CRISM_COORDINATION
See Also:
Constant Field Values

MAX_BINNING

public static final String MAX_BINNING
See Also:
Constant Field Values

MAX_LSUBS

public static final String MAX_LSUBS
See Also:
Constant Field Values

MIN_LSUBS

public static final String MIN_LSUBS
See Also:
Constant Field Values

MAX_PHASE_ANGLE

public static final String MAX_PHASE_ANGLE
See Also:
Constant Field Values

MIN_PHASE_ANGLE

public static final String MIN_PHASE_ANGLE
See Also:
Constant Field Values

MAX_INCIDENCE_ANGLE

public static final String MAX_INCIDENCE_ANGLE
See Also:
Constant Field Values

MIN_INCIDENCE_ANGLE

public static final String MIN_INCIDENCE_ANGLE
See Also:
Constant Field Values

MAX_EMISSION_ANGLE

public static final String MAX_EMISSION_ANGLE
See Also:
Constant Field Values

MIN_EMISSION_ANGLE

public static final String MIN_EMISSION_ANGLE
See Also:
Constant Field Values

PRIORITY_OVERALL

public static final String PRIORITY_OVERALL
See Also:
Constant Field Values

PRIORITY

public static final String PRIORITY
See Also:
Constant Field Values

DATE_PRIORITIZED

public static final String DATE_PRIORITIZED
See Also:
Constant Field Values

SCIENCE_RATIONALE

public static final String SCIENCE_RATIONALE
See Also:
Constant Field Values

DESCRIPTION

public static final String DESCRIPTION
See Also:
Constant Field Values

APPROVAL_STATUS

public static final String APPROVAL_STATUS
See Also:
Constant Field Values

SUGGESTION_DATE

public static final String SUGGESTION_DATE
See Also:
Constant Field Values

SUCCESS_VALIDATOR_USERNAME

public static final String SUCCESS_VALIDATOR_USERNAME
See Also:
Constant Field Values

DATE_SUCCESS

public static final String DATE_SUCCESS
See Also:
Constant Field Values

RETIRING_OBSERVATION_ID

public static final String RETIRING_OBSERVATION_ID
See Also:
Constant Field Values

UNRETIREMENT_REQUEST_FLAG

public static final String UNRETIREMENT_REQUEST_FLAG
See Also:
Constant Field Values

SPECIAL_NOTES

public static final String SPECIAL_NOTES
See Also:
Constant Field Values

TARGET_NAME

public static final String TARGET_NAME
See Also:
Constant Field Values

NUMBER_OF_OBSERVATIONS

public static final String NUMBER_OF_OBSERVATIONS
See Also:
Constant Field Values

STL_DESCRIPTION

public static final String STL_DESCRIPTION
See Also:
Constant Field Values

STL_MUST_HAVE

public static final String STL_MUST_HAVE
See Also:
Constant Field Values

STL_STEREO

public static final String STL_STEREO
See Also:
Constant Field Values

STL_CRISM_COORDINATION

public static final String STL_CRISM_COORDINATION
See Also:
Constant Field Values

STL_OFF_NADIR_IO

public static final String STL_OFF_NADIR_IO
See Also:
Constant Field Values

STL_HIGH_STABILITY_NADIR

public static final String STL_HIGH_STABILITY_NADIR
See Also:
Constant Field Values

STL_NONINTERACTIVE

public static final String STL_NONINTERACTIVE
See Also:
Constant Field Values

STL_MAX_BINNING

public static final String STL_MAX_BINNING
See Also:
Constant Field Values

STL_MAX_PHASE_ANGLE

public static final String STL_MAX_PHASE_ANGLE
See Also:
Constant Field Values

STL_MIN_PHASE_ANGLE

public static final String STL_MIN_PHASE_ANGLE
See Also:
Constant Field Values

STL_MAX_INCIDENCE_ANGLE

public static final String STL_MAX_INCIDENCE_ANGLE
See Also:
Constant Field Values

STL_MIN_INCIDENCE_ANGLE

public static final String STL_MIN_INCIDENCE_ANGLE
See Also:
Constant Field Values

STL_MAX_EMISSION_ANGLE

public static final String STL_MAX_EMISSION_ANGLE
See Also:
Constant Field Values

STL_MIN_EMISSION_ANGLE

public static final String STL_MIN_EMISSION_ANGLE
See Also:
Constant Field Values

STL_MAX_LSUBS

public static final String STL_MAX_LSUBS
See Also:
Constant Field Values

STL_MIN_LSUBS

public static final String STL_MIN_LSUBS
See Also:
Constant Field Values

STL_NUMBER_OF_OBSERVATIONS

public static final String STL_NUMBER_OF_OBSERVATIONS
See Also:
Constant Field Values

STL_EDIT_DATE

public static final String STL_EDIT_DATE
See Also:
Constant Field Values

LAST_UPDATE

public static final String LAST_UPDATE
See Also:
Constant Field Values

INVALID_ID

public static final int INVALID_ID
The value for an invalid suggestion ID.

See Also:
Constant Field Values

YES

public static final String YES
See Also:
Constant Field Values

NO

public static final String NO
See Also:
Constant Field Values
Constructor Detail

Suggestion

public Suggestion()
Method Detail

getId

public int getId()
Gets the xxx of this suggestion.

Returns:
xxx.

setId

public void setId(int id)
Sets the xxx for this suggestion.

Parameters:
id - the xxx.

getVersion

public String getVersion()
Gets the xxx of this suggestion.

Returns:
xxx.

setVersion

public void setVersion(String version)
Sets the xxx for this suggestion.

Parameters:
version - the xxx.

getCenterLatitude

public Double getCenterLatitude()
Gets the xxx of this suggestion.

Returns:
xxx.

setCenterLatitude

public void setCenterLatitude(Double centerLatitude)
Sets the xxx for this suggestion.

Parameters:
centerLatitude - the xxx.

getCenterLongitude

public Double getCenterLongitude()
Gets the xxx of this suggestion.

Returns:
xxx.

setCenterLongitude

public void setCenterLongitude(Double centerLongitude)
Sets the xxx for this suggestion.

Parameters:
centerLongitude - the xxx.

getMaxLatitude

public Double getMaxLatitude()
Gets the xxx of this suggestion.

Returns:
xxx.

setMaxLatitude

public void setMaxLatitude(Double maxLatitude)
Sets the xxx for this suggestion.

Parameters:
maxLatitude - the xxx.

getMinLatitude

public Double getMinLatitude()
Gets the xxx of this suggestion.

Returns:
xxx.

setMinLatitude

public void setMinLatitude(Double minLatitude)
Sets the xxx for this suggestion.

Parameters:
minLatitude - the xxx.

getMaxLongitude

public Double getMaxLongitude()
Gets the xxx of this suggestion.

Returns:
xxx.

setMaxLongitude

public void setMaxLongitude(Double maxLongitude)
Sets the xxx for this suggestion.

Parameters:
maxLongitude - the xxx.

getMinLongitude

public Double getMinLongitude()
Gets the xxx of this suggestion.

Returns:
xxx.

setMinLongitude

public void setMinLongitude(Double minLongitude)
Sets the xxx for this suggestion.

Parameters:
minLongitude - the xxx.

getRoiVertices

public String getRoiVertices()
Gets the xxx of this suggestion.

Returns:
xxx.

setRoiVertices

public void setRoiVertices(String roiVertices)
Sets the xxx for this suggestion.

Parameters:
roiVertices - the xxx.

getExactAreaRequested

public Boolean getExactAreaRequested()
Gets the xxx of this suggestion.

Returns:
xxx.

setExactAreaRequested

public void setExactAreaRequested(Boolean exactAreaRequested)
Sets the xxx for this suggestion.

Parameters:
exactAreaRequested - the xxx.

getNeedStereo

public Boolean getNeedStereo()
Gets the xxx of this suggestion.

Returns:
xxx.

setNeedStereo

public void setNeedStereo(Boolean needStereo)
Sets the xxx for this suggestion.

Parameters:
needStereo - the xxx.

getPriorityStereo

public Integer getPriorityStereo()
Gets the xxx of this suggestion.

Returns:
xxx.

setPriorityStereo

public void setPriorityStereo(Integer priorityStereo)
Sets the xxx for this suggestion.

Parameters:
priorityStereo - the xxx.

getNeedColor

public Boolean getNeedColor()
Gets the xxx of this suggestion.

Returns:
xxx.

setNeedColor

public void setNeedColor(Boolean needColor)
Sets the xxx for this suggestion.

Parameters:
needColor - the xxx.

getPriorityColor

public Integer getPriorityColor()
Gets the xxx of this suggestion.

Returns:
xxx.

setPriorityColor

public void setPriorityColor(Integer priorityColor)
Sets the xxx for this suggestion.

Parameters:
priorityColor - the xxx.

getPriorityHighres

public Integer getPriorityHighres()
Gets the xxx of this suggestion.

Returns:
xxx.

setPriorityHighres

public void setPriorityHighres(Integer priorityHighres)
Sets the xxx for this suggestion.

Parameters:
priorityHighres - the xxx.

getCrismCoordination

public Boolean getCrismCoordination()
Gets the xxx of this suggestion.

Returns:
xxx.

setCrismCoordination

public void setCrismCoordination(Boolean crismCoordination)
Sets the xxx for this suggestion.

Parameters:
crismCoordination - the xxx.

getMaxBinning

public Integer getMaxBinning()
Gets the xxx of this suggestion.

Returns:
xxx.

setMaxBinning

public void setMaxBinning(Integer maxBinning)
Sets the xxx for this suggestion.

Parameters:
maxBinning - the xxx.

getMaxLsubs

public Double getMaxLsubs()
Gets the xxx of this suggestion.

Returns:
xxx.

setMaxLsubs

public void setMaxLsubs(Double maxLsubs)
Sets the xxx for this suggestion.

Parameters:
maxLsubs - the xxx.

getMinLsubs

public Double getMinLsubs()
Gets the xxx of this suggestion.

Returns:
xxx.

setMinLsubs

public void setMinLsubs(Double minLsubs)
Sets the xxx for this suggestion.

Parameters:
minLsubs - the xxx.

getMaxPhaseAngle

public Double getMaxPhaseAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setMaxPhaseAngle

public void setMaxPhaseAngle(Double maxPhaseAngle)
Sets the xxx for this suggestion.

Parameters:
maxPhaseAngle - the xxx.

getMinPhaseAngle

public Double getMinPhaseAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setMinPhaseAngle

public void setMinPhaseAngle(Double minPhaseAngle)
Sets the xxx for this suggestion.

Parameters:
minPhaseAngle - the xxx.

getMaxIncidenceAngle

public Double getMaxIncidenceAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setMaxIncidenceAngle

public void setMaxIncidenceAngle(Double maxIncidenceAngle)
Sets the xxx for this suggestion.

Parameters:
maxIncidenceAngle - the xxx.

getMinIncidenceAngle

public Double getMinIncidenceAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setMinIncidenceAngle

public void setMinIncidenceAngle(Double minIncidenceAngle)
Sets the xxx for this suggestion.

Parameters:
minIncidenceAngle - the xxx.

getMaxEmissionAngle

public Double getMaxEmissionAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setMaxEmissionAngle

public void setMaxEmissionAngle(Double maxEmissionAngle)
Sets the xxx for this suggestion.

Parameters:
maxEmissionAngle - the xxx.

getMinEmissionAngle

public Double getMinEmissionAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setMinEmissionAngle

public void setMinEmissionAngle(Double minEmissionAngle)
Sets the xxx for this suggestion.

Parameters:
minEmissionAngle - the xxx.

getPriorityOverall

public Integer getPriorityOverall()
Gets the xxx of this suggestion.

Returns:
xxx.

setPriorityOverall

public void setPriorityOverall(Integer priorityOverall)
Sets the xxx for this suggestion.

Parameters:
priorityOverall - the xxx.

getPriority

public Suggestion.Priority getPriority()
Gets the xxx of this suggestion.

Returns:
xxx.

setPriority

public void setPriority(Suggestion.Priority priority)
Sets the xxx for this suggestion.

Parameters:
priority - the xxx.

getDatePrioritized

public Date getDatePrioritized()
Gets the xxx of this suggestion.

Returns:
xxx.

setDatePrioritized

public void setDatePrioritized(Date datePrioritized)
Sets the xxx for this suggestion.

Parameters:
datePrioritized - the xxx.

getScienceRationale

public String getScienceRationale()
Gets the xxx of this suggestion.

Returns:
xxx.

setScienceRationale

public void setScienceRationale(String scienceRationale)
Sets the xxx for this suggestion.

Parameters:
scienceRationale - the xxx.

getDescription

public String getDescription()
Gets the xxx of this suggestion.

Returns:
xxx.

setDescription

public void setDescription(String description)
Sets the xxx for this suggestion.

Parameters:
description - the xxx.

getApprovalStatus

public Suggestion.ApprovalStatus getApprovalStatus()
Gets the xxx of this suggestion.

Returns:
xxx.

setApprovalStatus

public void setApprovalStatus(Suggestion.ApprovalStatus approvalStatus)
Sets the xxx for this suggestion.

Parameters:
approvalStatus - the xxx.

getSuggestionDate

public Date getSuggestionDate()
Gets the xxx of this suggestion.

Returns:
xxx.

setSuggestionDate

public void setSuggestionDate(Date suggestionDate)
Sets the xxx for this suggestion.

Parameters:
suggestionDate - the xxx.

getSuccessValidatorUsername

public String getSuccessValidatorUsername()
Gets the xxx of this suggestion.

Returns:
xxx.

setSuccessValidatorUsername

public void setSuccessValidatorUsername(String successValidatorUsername)
Sets the xxx for this suggestion.

Parameters:
successValidatorUsername - the xxx.

getDateSuccess

public Date getDateSuccess()
Gets the xxx of this suggestion.

Returns:
xxx.

setDateSuccess

public void setDateSuccess(Date dateSuccess)
Sets the xxx for this suggestion.

Parameters:
dateSuccess - the xxx.

getRetiringObservationId

public String getRetiringObservationId()
Gets the xxx of this suggestion.

Returns:
xxx.

setRetiringObservationId

public void setRetiringObservationId(String retiringObservationId)
Sets the xxx for this suggestion.

Parameters:
retiringObservationId - the xxx.

getUnretirementRequestFlag

public Boolean getUnretirementRequestFlag()
Gets the xxx of this suggestion.

Returns:
xxx.

setUnretirementRequestFlag

public void setUnretirementRequestFlag(Boolean unretirementRequestFlag)
Sets the xxx for this suggestion.

Parameters:
unretirementRequestFlag - the xxx.

getSpecialNotes

public String getSpecialNotes()
Gets the xxx of this suggestion.

Returns:
xxx.

setSpecialNotes

public void setSpecialNotes(String specialNotes)
Sets the xxx for this suggestion.

Parameters:
specialNotes - the xxx.

getTargetName

public Suggestion.TargetName getTargetName()
Gets the xxx of this suggestion.

Returns:
xxx.

setTargetName

public void setTargetName(Suggestion.TargetName targetName)
Sets the xxx for this suggestion.

Parameters:
targetName - the xxx.

getNumberOfObservations

public Integer getNumberOfObservations()
Gets the xxx of this suggestion.

Returns:
xxx.

setNumberOfObservations

public void setNumberOfObservations(Integer numberOfObservations)
Sets the xxx for this suggestion.

Parameters:
numberOfObservations - the xxx.

getStlDescription

public String getStlDescription()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlDescription

public void setStlDescription(String stlDescription)
Sets the xxx for this suggestion.

Parameters:
stlDescription - the xxx.

getStlMustHave

public Boolean getStlMustHave()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlMustHave

public void setStlMustHave(Boolean stlMustHave)
Sets the xxx for this suggestion.

Parameters:
stlMustHave - the xxx.

getStlStereo

public Boolean getStlStereo()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlStereo

public void setStlStereo(Boolean stlStereo)
Sets the xxx for this suggestion.

Parameters:
stlStereo - the xxx.

getStlCrismCoordination

public Boolean getStlCrismCoordination()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlCrismCoordination

public void setStlCrismCoordination(Boolean stlCrismCoordination)
Sets the xxx for this suggestion.

Parameters:
stlCrismCoordination - the xxx.

getStlOffNadirIo

public Boolean getStlOffNadirIo()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlOffNadirIo

public void setStlOffNadirIo(Boolean stlOffNadirIo)
Sets the xxx for this suggestion.

Parameters:
stlOffNadirIo - the xxx.

getStlHighStabilityNadir

public Boolean getStlHighStabilityNadir()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlHighStabilityNadir

public void setStlHighStabilityNadir(Boolean stlHighStabilityNadir)
Sets the xxx for this suggestion.

Parameters:
stlHighStabilityNadir - the xxx.

getStlNoninteractive

public Boolean getStlNoninteractive()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlNoninteractive

public void setStlNoninteractive(Boolean stlNoninteractive)
Sets the xxx for this suggestion.

Parameters:
stlNoninteractive - the xxx.

getStlMaxBinning

public Integer getStlMaxBinning()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlMaxBinning

public void setStlMaxBinning(Integer stlMaxBinning)
Sets the xxx for this suggestion.

Parameters:
stlMaxBinning - the xxx.

getStlMaxPhaseAngle

public Double getStlMaxPhaseAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlMaxPhaseAngle

public void setStlMaxPhaseAngle(Double stlMaxPhaseAngle)
Sets the xxx for this suggestion.

Parameters:
stlMaxPhaseAngle - the xxx.

getStlMinPhaseAngle

public Double getStlMinPhaseAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlMinPhaseAngle

public void setStlMinPhaseAngle(Double stlMinPhaseAngle)
Sets the xxx for this suggestion.

Parameters:
stlMinPhaseAngle - the xxx.

getStlMaxIncidenceAngle

public Double getStlMaxIncidenceAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlMaxIncidenceAngle

public void setStlMaxIncidenceAngle(Double stlMaxIncidenceAngle)
Sets the xxx for this suggestion.

Parameters:
stlMaxIncidenceAngle - the xxx.

getStlMinIncidenceAngle

public Double getStlMinIncidenceAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlMinIncidenceAngle

public void setStlMinIncidenceAngle(Double stlMinIncidenceAngle)
Sets the xxx for this suggestion.

Parameters:
stlMinIncidenceAngle - the xxx.

getStlMaxEmissionAngle

public Double getStlMaxEmissionAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlMaxEmissionAngle

public void setStlMaxEmissionAngle(Double stlMaxEmissionAngle)
Sets the xxx for this suggestion.

Parameters:
stlMaxEmissionAngle - the xxx.

getStlMinEmissionAngle

public Double getStlMinEmissionAngle()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlMinEmissionAngle

public void setStlMinEmissionAngle(Double stlMinEmissionAngle)
Sets the xxx for this suggestion.

Parameters:
stlMinEmissionAngle - the xxx.

getStlMaxLsubs

public Double getStlMaxLsubs()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlMaxLsubs

public void setStlMaxLsubs(Double stlMaxLsubs)
Sets the xxx for this suggestion.

Parameters:
stlMaxLsubs - the xxx.

getStlMinLsubs

public Double getStlMinLsubs()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlMinLsubs

public void setStlMinLsubs(Double stlMinLsubs)
Sets the xxx for this suggestion.

Parameters:
stlMinLsubs - the xxx.

getStlNumberOfObservations

public Integer getStlNumberOfObservations()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlNumberOfObservations

public void setStlNumberOfObservations(Integer stlNumberOfObservations)
Sets the xxx for this suggestion.

Parameters:
stlNumberOfObservations - the xxx.

getStlEditDate

public Date getStlEditDate()
Gets the xxx of this suggestion.

Returns:
xxx.

setStlEditDate

public void setStlEditDate(Date stlEditDate)
Sets the xxx for this suggestion.

Parameters:
stlEditDate - the xxx.

getLastUpdate

public Date getLastUpdate()
Gets the xxx of this suggestion.

Returns:
xxx.

setLastUpdate

public void setLastUpdate(Date lastUpdate)
Sets the xxx for this suggestion.

Parameters:
lastUpdate - the xxx.

getPrimaryScienceTheme

public Suggestion.ScienceTheme getPrimaryScienceTheme()
Gets the xxx of this suggestion.

Returns:
xxx.

setPrimaryScienceTheme

public void setPrimaryScienceTheme(Suggestion.ScienceTheme primaryScienceTheme)
Sets the xxx for this suggestion.

Parameters:
primaryScienceTheme - the xxx.

getSecondaryScienceTheme

public Suggestion.ScienceTheme getSecondaryScienceTheme()
Gets the xxx of this suggestion.

Returns:
xxx.

setSecondaryScienceTheme

public void setSecondaryScienceTheme(Suggestion.ScienceTheme secondaryScienceTheme)
Sets the xxx for this suggestion.

Parameters:
secondaryScienceTheme - the xxx.

getSuggester

public String getSuggester()
Gets the xxx of this suggestion.

Returns:
xxx.

setSuggester

public void setSuggester(String suggester)
Sets the xxx for this suggestion.

Parameters:
suggester - the xxx.

getRelatedSuggestions

public Map<Suggestion,Suggestion.RelationType> getRelatedSuggestions()
Gets all suggestions related to this suggestion.

If there are no related suggestions, an empty map is returned.

Returns:
the related suggestions mapped to this suggestion, regardless of type.

getRelatedSuggestions

public Set<Suggestion> getRelatedSuggestions(Suggestion.RelationType relationType)
Gets all suggestions of a given type that are related to this suggestion.

If there are no related suggestions of the given type, an empty set is returned.

Note: Although via policy there are only two suggestions in a stereo pair, there is no effort to maintain this policy in the Suggestion class.

Parameters:
relationType - the relation type of interest.
Returns:
the related suggestions of the given type that are mapped to this suggestion.

addRelatedSuggestion

public void addRelatedSuggestion(Suggestion suggestion,
                                 Suggestion.RelationType relationType)
Adds a related suggestion to this suggestion.

Note: Although via policy there are only two suggestions in a stereo pair, there is no effort to maintain this policy in the Suggestion class.

Parameters:
suggestion - the related suggestion to add.
relationType - the type of relation shared between this suggestion and the added suggestion.

removeRelatedSuggestion

public Suggestion.RelationType removeRelatedSuggestion(Suggestion suggestion)
Removes a given suggestion from this suggestion's set of related suggestions.

Parameters:
suggestion - the suggestion to remove.
Returns:
the relation type of the removed suggestion or null if the suggestion was not a member of the set of related suggestions.

setRelatedSuggestions

public void setRelatedSuggestions(Map<Suggestion,Suggestion.RelationType> relatedSuggestions)
Replaces the map of related suggestions with another one.

Warning: The new map of related suggestions should not be null, but no effort is currently made to enforce that condition.

Parameters:
relatedSuggestions - the new map of related suggestions.

clone

public Object clone()
Returns a clone of this suggestion.

Overrides:
clone in class Object
Returns:
a clone of this suggestion.

compareTo

public int compareTo(Suggestion s)
Compares this suggestion with the specified suggestion for order. Returns a negative integer, zero, or a positive integer as this suggestion is less than, equal to, or greater than the specified suggestion.

This method only compares the suggestion's key ID, as determined by getId(). It is therefore highly inconsistent with equals!

Specified by:
compareTo in interface Comparable<Suggestion>
Parameters:
s - the suggestion to be compared.
Returns:
a negative integer, zero, or a positive integer as this suggestion's ID is less than, equal to, or greater than the specified suggestion.

equals

public boolean equals(Object o)
Indicates whether some other object is equal to this suggestion. This method returns true if and only if the following are true:
  1. the given object is also a Suggestion, and
  2. each suggestion has the same value for each field.

If any of these is false, this method returns false.

NOTE: getRelatedSuggestions() map is not included in the test for equality. Two suggestions with identical fields but with different related suggestions maps therefore will evaluate as equal.

Overrides:
equals in class Object
Parameters:
o - the reference object with which to compare.
Returns:
true if this object is the same as the object argument (see above); false otherwise.

hashCode

public int hashCode()
Returns the hash code value for this suggestion.

NOTE: getRelatedSuggestions() map is not included in the hashcode calculation. Two suggestions with identical fields but with different related suggestions maps therefore will have the same hashcode.

Overrides:
hashCode in class Object

yesNoToBoolean

public static Boolean yesNoToBoolean(String yesNo)
Converts a text token into boolean value. If yesNo is YES, this method returns Boolean.TRUE; otherwise it returns Boolean.FALSE or null, the latter if yesNo is also null.

The tests are not case-sensitive.

Parameters:
yesNo - the text, presumed to be either YES or NO, but not required to be so. May be null.
Returns:
a boolean or tt.

booleanToYesNo

public static String booleanToYesNo(Boolean bool)
Converts a boolean into a text token. If bool is Boolean.TRUE, this method returns YES; if Boolean.FALSE, it returns NO; if null, it returns a null.

Parameters:
bool - a boolean. May be null.
Returns:
YES, NO, or null.

intToBoolean

public static Boolean intToBoolean(Integer integer)
Converts an integer token into a boolean value. If integer is an integer of value 1, this method returns Boolean.TRUE; otherwise it returns Boolean.FALSE or null, the latter if integer is null.

Parameters:
integer - an integer value indicating true or false. May be null.
Returns:
a boolean or null.

booleanToInt

public static Integer booleanToInt(Boolean bool)
Converts a boolean into an integer token. If bool is Boolean.TRUE, this method returns an integer of value 1; if Boolean.FALSE, it returns an integer of value 0; if null, it returns a null.

Parameters:
bool - a boolean. May be null.
Returns:
an integer of value 0 or 1, or null.

suggestedObservationsFields

public static List<String> suggestedObservationsFields()
Returns the list of field names in the Suggested_Observations table.

Returns:
the suggested observations table field names.

HiRISE

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