HiRISE

HiRISE.HiCat.HiTList
Class TargetList

java.lang.Object
  extended by HiRISE.HiCat.HiTList.TargetList
All Implemented Interfaces:
SearchInterface, ItemListener, PropertyChangeListener, EventListener, ChangeListener, ListSelectionListener
Direct Known Subclasses:
AllTargetsList, FirstHalfStereoList, HighStabilityNadirList, HighStabilityNIOList, NoninteractiveObservationsList, OffNadirIOList, SecondHalfStereoList

public abstract class TargetList
extends Object
implements SearchInterface, ListSelectionListener, ChangeListener, PropertyChangeListener, ItemListener

The TargetList is the abstract base list class that implements common methods of the SearchInterface. New target lists should subclass this class and implement the remaining search interface methods. Subclasses are effectively data models for the SearchComponent

Version:
1.27
Author:
Rodney Heyd UA/HiRISE
See Also:
SearchInterface, SearchComponent

Nested Class Summary
static class TargetList.ColumnComparatorSettings
          Defines the list of columns and the comparators to use for them.
static class TargetList.ConfigurationParameter
           
static class TargetList.ListTypes
          An enumerated list of the different target lists and their associated precedence values.
static class TargetList.OrderingFields
          This enumeration defines the default ordering configuration for the search queries.
static class TargetList.TableAliases
          An enumeration defining the tables and their alases that are to be used in the target search queries, the tables that are actually included will depend on the type of target list being generated.
 
Field Summary
static String DEBUG_EVENTS_PROPERTY
           
static String DEBUG_INIT_PROPERTY
           
static String DEBUG_LSUBS_FILTER_PROPERTY
           
static String DEBUG_NEARBY_LIST_PROPERTY
           
static String DEBUG_PRIORITIES_PROPERT
           
static String DEBUG_QUERY_PROPERTY
           
static String DEBUG_RED9_SHIFTS_PROPERTY
           
static String DEBUG_SEASONAL_PROPERTY
           
static String DEFAULT_CONFIGURATION_FILE
          Default configuration file
static double DEFAULT_MAXIMUM_LATITUDE
           
static double DEFAULT_MAXIMUM_LONGITUDE
           
static double DEFAULT_MAXIMUM_LSUBS
           
static double DEFAULT_MINIMUM_LATITUDE
           
static double DEFAULT_MINIMUM_LONGITUDE
           
static double DEFAULT_MINIMUM_LSUBS
           
static int DEFAULT_ROW_LIMIT
           
static String ID
          Class identifier
 
Fields inherited from interface HiRISE.HiCat.HiTList.SearchInterface
IGNORE_FILTER_UPDATES_NAME, MAX_LATITUDE_FIELDNAME, MAX_LONG_FIELDNAME, MAX_LSUBS_FIELDNAME, MIN_LATITUDE_FIELDNAME, MIN_LONG_FIELDNAME, MIN_LSUBS_FIELDNAME, PRIORITY_LISTNAME, ROW_LIMIT_ENABLENAME, ROW_LIMIT_FIELDNAME, SCIENCE_THEME_LISTNAME, SPECIAL_TARGETS_ADDED_PROPERTY, SPECIAL_TARGETS_REMOVED_PROPERTY, THEME_COUNT_FIELDNAME
 
Constructor Summary
TargetList()
           
 
Method Summary
abstract  Vector<Integer> addedSuggestionsNotFound()
          If any of the suggestions ID's found in the list passed to the SearchInterface.addSuggestions(Vector) were not found, they will be in the Vector of Integers returned by this method.
protected  Vector<Vector<String>> addNearbyObservationsColumn(Vector<Vector<String>> data_table)
           
protected  Vector<Vector<String>> addSeasonalColumn(Vector<Vector<String>> data_table)
           
 void addSuggestions(Vector<Integer> add_list)
          A list of suggestions that should be included in the list.
protected  Vector<Vector<String>> applyScienceThemeCountRestrictions(Vector<Vector<String>> data_table)
           
abstract  String constructSearchQuery()
          Constructs the base search query specific to the list being generated.
abstract  String constructSecondaryQuery()
          Constructs the secondary query that will query for special target requests to add to the search list.
 void enableRowLimits(boolean enable_row_limits)
          Enable or disable row limits.
abstract  Vector<Vector<String>> executeSearch()
          A method executing a database search for suggested targets, and will usually execure the query returned by the SearchInterface.constructSearchQuery() method.
 Vector<String> exportSelectedPriorites()
           
protected  Vector<Integer> findMissingSuggestions(Vector<Vector<String>> data_table)
           
 Vector<Integer> getAddedSuggestions()
          Returns the list of specially added suggestions.
protected  String getAddedSuggestionsSQL(String suggestion_table_alias)
           
 Vector<String> getColumnNames()
           
protected  String getColumnOrderingSQL()
           
protected  String getCoordinateRestrictionsSQL(String first_suggestion_table_alias, String min_lon_column_name, String max_lon_column_name)
           
protected  Database getDatabase(Configuration config)
           
protected  String getLsubSRestrictionsSQL(String first_suggestion_table_alias, String min_lsubs_column_name, String max_lsubs_column_name)
           
 double getMaximumLatitude()
          Get the current setting of the maximum latitude
 double getMaximumLongitude()
          Get the current maximum longitude setting.
 double getMaximumLs()
          Get the current maximum solar longitude setting.
 double getMinimumLatitude()
          Get the current minimum latitude setting.
 double getMinimumLongitude()
          Get the current minimum longitude setting
 double getMinimumLs()
          Get the current minimum solar longitude setting.
 HashMap<Integer,TargetWarning> getMissingSuggestionWarnings()
          Get the set of warnings generated for each missing suggestion.
protected  String getPrioritySQL(String priority_alias)
           
 boolean getRetrieveNearestNeighborList()
          Indicates if the nearest neighbor list should be generated.
 int getRowLimit()
          Get the current row limit setting.
 Vector<String> getScienceThemesList()
           
protected  String getScienceThemesRestricionsSQL(String primary_theme_table_alias)
           
protected  Vector<String> getSeasonalData(int suggestion_id)
          Retrieves the seasonal information for the specified suggestion id.
 Vector<PriorityList> getSelectedPriorities()
          The list of priorities currently selected for the list.
 Vector<String> getSelectedScienceThemes()
          Get the list of science themes currently selected for the list.
protected  Vector<Vector<String>> getSuggestionData(int suggestion_id)
           
 int getSuggestionsPerThemeLimit()
          Get the current suggestions per theme limit
 boolean hasRowLimitsEnabled()
          Indicates if row limits have been enabled.
protected  void initializeScienceThemesList(Configuration config)
           
 void initOrderingSettings(Configuration config)
          The column ordering controls are expected to be set for the entire session based on the hard-coded defaults, or by reading the settings from a configuration.
protected  void initPriorities()
           
protected  boolean isInList(String suggestion_id, Vector<Vector<String>> list)
           
 void itemStateChanged(ItemEvent event)
           
abstract  TargetList.ListTypes precedence()
          The precedence value for the list.
protected  void prepareDbQueries()
           
 void propertyChange(PropertyChangeEvent event)
           
 void setColumnNames(Vector<String> columnNames)
           
protected  void setConfiguration(Configuration config)
           
protected  void setListType(TargetList.ListTypes type)
           
 void setMaximumLatitude(double max_latitude)
          Sets the maximum latitude of the search region.
 void setMaximumLongitude(double max_longitude)
          Sets the maximum longitude of the search region for which targets will be searched for in the search query.
 void setMaximumLs(double maxLs)
          Sets the maximum solar longitude that targets must overlap or be less than to be included in the list.
 void setMinimumLatitude(double min_latitude)
          Sets the minimum latitude of the search region for which targets will be searched for in the search query.
 void setMinimumLongitude(double min_longitude)
          Sets the minimum longitude of the search region for which targets will be searched for in the search query.
 void setMinimumLs(double minLs)
          Sets the minimum solar longitude that targets must overlap to be included in the list.
 void setPriorities(Vector<PriorityList> priorities)
          The list of priorities to be included in the list.
 void setRetrieveNearestNeighborList(boolean include_nearest)
          Setting to optionally include the nearest neighbor list.
 void setRowLimit(int row_limit)
          Set the maximum number of records (targets) to retrieve from the database.
 void setScienceThemes(Vector<String> theme_list)
          Sets the science themes to be included in the search.
 void setSuggestionsPerThemeLimit(int suggestions_per_theme)
          Sets the maximum number of suggestions per science theme that can appear in the list.
 void setTabConfig(Configuration config)
          Looks for any search parameters found and the configuration and will use these to set the parameters for the TargetList.
 void stateChanged(ChangeEvent event)
           
 void valueChanged(ListSelectionEvent event)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface HiRISE.HiCat.HiTList.SearchInterface
executeAddedSuggestionsSearch, updateAddedSuggestions
 

Field Detail

ID

public static final String ID
Class identifier

See Also:
Constant Field Values

DEFAULT_CONFIGURATION_FILE

public static final String DEFAULT_CONFIGURATION_FILE
Default configuration file

See Also:
Constant Field Values

DEFAULT_MINIMUM_LONGITUDE

public static final double DEFAULT_MINIMUM_LONGITUDE
See Also:
Constant Field Values

DEFAULT_MAXIMUM_LONGITUDE

public static final double DEFAULT_MAXIMUM_LONGITUDE
See Also:
Constant Field Values

DEFAULT_MINIMUM_LATITUDE

public static final double DEFAULT_MINIMUM_LATITUDE
See Also:
Constant Field Values

DEFAULT_MAXIMUM_LATITUDE

public static final double DEFAULT_MAXIMUM_LATITUDE
See Also:
Constant Field Values

DEFAULT_MINIMUM_LSUBS

public static final double DEFAULT_MINIMUM_LSUBS
See Also:
Constant Field Values

DEFAULT_MAXIMUM_LSUBS

public static final double DEFAULT_MAXIMUM_LSUBS
See Also:
Constant Field Values

DEFAULT_ROW_LIMIT

public static final int DEFAULT_ROW_LIMIT
See Also:
Constant Field Values

DEBUG_INIT_PROPERTY

public static final String DEBUG_INIT_PROPERTY
See Also:
Constant Field Values

DEBUG_QUERY_PROPERTY

public static final String DEBUG_QUERY_PROPERTY
See Also:
Constant Field Values

DEBUG_SEASONAL_PROPERTY

public static final String DEBUG_SEASONAL_PROPERTY
See Also:
Constant Field Values

DEBUG_PRIORITIES_PROPERT

public static final String DEBUG_PRIORITIES_PROPERT
See Also:
Constant Field Values

DEBUG_NEARBY_LIST_PROPERTY

public static final String DEBUG_NEARBY_LIST_PROPERTY
See Also:
Constant Field Values

DEBUG_EVENTS_PROPERTY

public static final String DEBUG_EVENTS_PROPERTY
See Also:
Constant Field Values

DEBUG_LSUBS_FILTER_PROPERTY

public static final String DEBUG_LSUBS_FILTER_PROPERTY
See Also:
Constant Field Values

DEBUG_RED9_SHIFTS_PROPERTY

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

TargetList

public TargetList()
Method Detail

setConfiguration

protected void setConfiguration(Configuration config)

setListType

protected void setListType(TargetList.ListTypes type)

initPriorities

protected void initPriorities()

getDatabase

protected Database getDatabase(Configuration config)
                        throws Database_Exception,
                               Configuration_Exception
Throws:
Database_Exception
Configuration_Exception

prepareDbQueries

protected void prepareDbQueries()
                         throws Database_Exception
Throws:
Database_Exception

initializeScienceThemesList

protected void initializeScienceThemesList(Configuration config)
                                    throws Database_Exception,
                                           Configuration_Exception
Throws:
Database_Exception
Configuration_Exception

getPrioritySQL

protected String getPrioritySQL(String priority_alias)

getCoordinateRestrictionsSQL

protected String getCoordinateRestrictionsSQL(String first_suggestion_table_alias,
                                              String min_lon_column_name,
                                              String max_lon_column_name)

getLsubSRestrictionsSQL

protected String getLsubSRestrictionsSQL(String first_suggestion_table_alias,
                                         String min_lsubs_column_name,
                                         String max_lsubs_column_name)

getScienceThemesRestricionsSQL

protected String getScienceThemesRestricionsSQL(String primary_theme_table_alias)

getAddedSuggestionsSQL

protected String getAddedSuggestionsSQL(String suggestion_table_alias)

findMissingSuggestions

protected Vector<Integer> findMissingSuggestions(Vector<Vector<String>> data_table)
                                          throws Database_Exception
Throws:
Database_Exception

getSeasonalData

protected Vector<String> getSeasonalData(int suggestion_id)
                                  throws Database_Exception
Retrieves the seasonal information for the specified suggestion id. If the suggestion is a member of a seasonal series, the first element of the return vector is the text string that should be inserted into the ptf, and the additional elements are the observation ids of any observations that have already been acquired for the given seasonal set.

Parameters:
suggestion_id -
Returns:
a Vector of seasonal information or null if the suggestion is not a member of a seasonal series.
Throws:
Database_Exception

addSeasonalColumn

protected Vector<Vector<String>> addSeasonalColumn(Vector<Vector<String>> data_table)
                                            throws Database_Exception
Throws:
Database_Exception

addNearbyObservationsColumn

protected Vector<Vector<String>> addNearbyObservationsColumn(Vector<Vector<String>> data_table)
                                                      throws Database_Exception
Throws:
Database_Exception

applyScienceThemeCountRestrictions

protected Vector<Vector<String>> applyScienceThemeCountRestrictions(Vector<Vector<String>> data_table)

getSuggestionData

protected Vector<Vector<String>> getSuggestionData(int suggestion_id)
                                            throws Database_Exception
Throws:
Database_Exception

getColumnOrderingSQL

protected String getColumnOrderingSQL()

isInList

protected boolean isInList(String suggestion_id,
                           Vector<Vector<String>> list)

precedence

public abstract TargetList.ListTypes precedence()
The precedence value for the list. This value determines which list a given suggestion will be pulled from if it is in more than one list simultaneously. Targets in a lists with a lower precendence value will be included in favor of the duplicate id in a list with a higher precedence value.

Returns:
the ListPrecedunce enum value for the list.
See Also:
TargetList.ListTypes

setTabConfig

public void setTabConfig(Configuration config)
Looks for any search parameters found and the configuration and will use these to set the parameters for the TargetList.

Parameters:
config - a Configuration holding search parameters

getScienceThemesList

public Vector<String> getScienceThemesList()

constructSearchQuery

public abstract String constructSearchQuery()
Description copied from interface: SearchInterface
Constructs the base search query specific to the list being generated.

Note: Many of the setters defined in this search interface are search criteria that are used to construct this query.

Specified by:
constructSearchQuery in interface SearchInterface
Returns:
An SQL search query string
See Also:
SearchInterface.setMinimumLongitude(double), SearchInterface.setMaximumLongitude(double), SearchInterface.setMinimumLatitude(double), SearchInterface.setMaximumLatitude(double), SearchInterface.setMinimumLs(double), SearchInterface.setMaximumLs(double), SearchInterface.setPriorities(Vector), SearchInterface.setScienceThemes(Vector), SearchInterface.setSuggestionsPerThemeLimit(int), SearchInterface.enableRowLimits(boolean), SearchInterface.setRowLimit(int), SearchInterface.setRetrieveNearestNeighborList(boolean)

constructSecondaryQuery

public abstract String constructSecondaryQuery()
Description copied from interface: SearchInterface
Constructs the secondary query that will query for special target requests to add to the search list. This query is similar to the primary search query, however, all of the various restrictions on location, season, priority, theme, etc are ignored.

Specified by:
constructSecondaryQuery in interface SearchInterface
Returns:
An SQL search query string

executeSearch

public abstract Vector<Vector<String>> executeSearch()
                                              throws Database_Exception
Description copied from interface: SearchInterface
A method executing a database search for suggested targets, and will usually execure the query returned by the SearchInterface.constructSearchQuery() method. Note that many of the getter and setters defined as part of the search interface are used as parameters to define the search criteria

Specified by:
executeSearch in interface SearchInterface
Returns:
A vector of vector strings representing the data table.
Throws:
Database_Exception - if an error occurs during query execution

initOrderingSettings

public void initOrderingSettings(Configuration config)
                          throws Configuration_Exception
Description copied from interface: SearchInterface
The column ordering controls are expected to be set for the entire session based on the hard-coded defaults, or by reading the settings from a configuration. If the configuration doesn't not contain the appropriate parameters, then the hard-coded defaults will be used.

To override this ordering, add a HiTList group to the configuration file, and specify the ordering fields as defined in the OrderingFields enum in the order that the columns should be ordered, eg:

GROUP = HiTList
GROUP = ORDERING_COLUMNS
THEME=ASC
PRIORITY_SECOND=DESC
ID_SECOND=ASC
END_GROUP
END_GROUP

Specified by:
initOrderingSettings in interface SearchInterface
Parameters:
config - A configuration that may contain column ordering information.
Throws:
Configuration_Exception
See Also:
SearchInterface.constructSearchQuery(), TargetList.OrderingFields

setColumnNames

public void setColumnNames(Vector<String> columnNames)

getColumnNames

public Vector<String> getColumnNames()

setMinimumLongitude

public void setMinimumLongitude(double min_longitude)
Description copied from interface: SearchInterface
Sets the minimum longitude of the search region for which targets will be searched for in the search query. Defaults to 0.

Specified by:
setMinimumLongitude in interface SearchInterface
See Also:
SearchInterface.constructSearchQuery()

getMinimumLongitude

public double getMinimumLongitude()
Description copied from interface: SearchInterface
Get the current minimum longitude setting

Specified by:
getMinimumLongitude in interface SearchInterface
Returns:
the current minimum longitude as a double

setMaximumLongitude

public void setMaximumLongitude(double max_longitude)
Description copied from interface: SearchInterface
Sets the maximum longitude of the search region for which targets will be searched for in the search query. Defaults to 360.

Specified by:
setMaximumLongitude in interface SearchInterface
See Also:
SearchInterface.constructSearchQuery()

getMaximumLongitude

public double getMaximumLongitude()
Description copied from interface: SearchInterface
Get the current maximum longitude setting.

Specified by:
getMaximumLongitude in interface SearchInterface
Returns:
the current maximum longitude as a double.

setMinimumLatitude

public void setMinimumLatitude(double min_latitude)
Description copied from interface: SearchInterface
Sets the minimum latitude of the search region for which targets will be searched for in the search query. Defaults to -90.

Specified by:
setMinimumLatitude in interface SearchInterface
See Also:
SearchInterface.constructSearchQuery()

getMinimumLatitude

public double getMinimumLatitude()
Description copied from interface: SearchInterface
Get the current minimum latitude setting.

Specified by:
getMinimumLatitude in interface SearchInterface
Returns:
the minimum latitidue as a double.

setMaximumLatitude

public void setMaximumLatitude(double max_latitude)
Description copied from interface: SearchInterface
Sets the maximum latitude of the search region. Defaults to +90

Specified by:
setMaximumLatitude in interface SearchInterface
See Also:
SearchInterface.constructSearchQuery()

getMaximumLatitude

public double getMaximumLatitude()
Description copied from interface: SearchInterface
Get the current setting of the maximum latitude

Specified by:
getMaximumLatitude in interface SearchInterface
Returns:
the current maximum latitude as a double.

setMinimumLs

public void setMinimumLs(double minLs)
Description copied from interface: SearchInterface
Sets the minimum solar longitude that targets must overlap to be included in the list. Defaults to 0.

Specified by:
setMinimumLs in interface SearchInterface
See Also:
SearchInterface.constructSearchQuery()

getMinimumLs

public double getMinimumLs()
Description copied from interface: SearchInterface
Get the current minimum solar longitude setting.

Specified by:
getMinimumLs in interface SearchInterface
Returns:
the current minimum longitude as a double.

setMaximumLs

public void setMaximumLs(double maxLs)
Description copied from interface: SearchInterface
Sets the maximum solar longitude that targets must overlap or be less than to be included in the list. Defaults to 360.

Specified by:
setMaximumLs in interface SearchInterface
See Also:
SearchInterface.constructSearchQuery()

getMaximumLs

public double getMaximumLs()
Description copied from interface: SearchInterface
Get the current maximum solar longitude setting.

Specified by:
getMaximumLs in interface SearchInterface
Returns:
the current maximum solar longitude as a double.

setSuggestionsPerThemeLimit

public void setSuggestionsPerThemeLimit(int suggestions_per_theme)
Description copied from interface: SearchInterface
Sets the maximum number of suggestions per science theme that can appear in the list. If set to a value of 0, no limits to the number of targets per theme will be enforced.

When the search results contain more than this number of targets in a theme, the additional targets will be discarded. Note that precisely which targets will be included may be significantly impacted by the order at which they come out of the database and any limits placed on the total number of targets to retrieve.

Specified by:
setSuggestionsPerThemeLimit in interface SearchInterface
Parameters:
suggestions_per_theme - - an integer value, Default 0.
See Also:
SearchInterface.constructSearchQuery(), SearchInterface.initOrderingSettings(Configuration), SearchInterface.enableRowLimits(boolean), SearchInterface.setRowLimit(int)

getSuggestionsPerThemeLimit

public int getSuggestionsPerThemeLimit()
Description copied from interface: SearchInterface
Get the current suggestions per theme limit

Specified by:
getSuggestionsPerThemeLimit in interface SearchInterface
Returns:
An integer value indicating the current limit
See Also:
SearchInterface.setSuggestionsPerThemeLimit(int)

setRowLimit

public void setRowLimit(int row_limit)
Description copied from interface: SearchInterface
Set the maximum number of records (targets) to retrieve from the database.

Specified by:
setRowLimit in interface SearchInterface
Parameters:
row_limit - - an integer
See Also:
SearchInterface.constructSearchQuery()

getRowLimit

public int getRowLimit()
Description copied from interface: SearchInterface
Get the current row limit setting.

Specified by:
getRowLimit in interface SearchInterface
Returns:
- an integer containing the row limit setting.

enableRowLimits

public void enableRowLimits(boolean enable_row_limits)
Description copied from interface: SearchInterface
Enable or disable row limits. Set to true to enable row limits. If set to false, the row limit setting will be ignored. Default: true

Specified by:
enableRowLimits in interface SearchInterface
See Also:
SearchInterface.constructSearchQuery(), SearchInterface.setRowLimit(int)

hasRowLimitsEnabled

public boolean hasRowLimitsEnabled()
Description copied from interface: SearchInterface
Indicates if row limits have been enabled. If true the value of the SearchInterface.getRowLimit() method will be passed to the database to determine the total number of targets retrieved from the database.

Specified by:
hasRowLimitsEnabled in interface SearchInterface
Returns:
true if enabled, false otherwise.
See Also:
SearchInterface.setRowLimit(int)

setScienceThemes

public void setScienceThemes(Vector<String> theme_list)
Description copied from interface: SearchInterface
Sets the science themes to be included in the search. Only targets with primary themes that appear on this will be included in the search results.

Specified by:
setScienceThemes in interface SearchInterface
Parameters:
theme_list - a Vector of Strings containing the list of allowed science themes.
See Also:
SearchInterface.constructSearchQuery()

getSelectedScienceThemes

public Vector<String> getSelectedScienceThemes()
Description copied from interface: SearchInterface
Get the list of science themes currently selected for the list.

Specified by:
getSelectedScienceThemes in interface SearchInterface
Returns:
a Vector of Strings containing the selected science themes.

setPriorities

public void setPriorities(Vector<PriorityList> priorities)
Description copied from interface: SearchInterface
The list of priorities to be included in the list. Only targets having priorities that match those in the list will be included in the search results.

Note: if priority 10 is included, targets with priorities greater than 10 will also be included.

Specified by:
setPriorities in interface SearchInterface
Parameters:
priorities - - A Vector of Strings holding the set of priorities to include.
See Also:
SearchInterface.constructSearchQuery()

getSelectedPriorities

public Vector<PriorityList> getSelectedPriorities()
Description copied from interface: SearchInterface
The list of priorities currently selected for the list.

Specified by:
getSelectedPriorities in interface SearchInterface
Returns:
a Vector of PriorityList items

exportSelectedPriorites

public Vector<String> exportSelectedPriorites()

setRetrieveNearestNeighborList

public void setRetrieveNearestNeighborList(boolean include_nearest)
Description copied from interface: SearchInterface
Setting to optionally include the nearest neighbor list. If set to true, this list will be one of the columns in the "CIPP" spreadsheet, but will not be included in the PTF. If set to false, the list will not be included, and the time to process the search results should improve by about 30%. Defaults to false.

Specified by:
setRetrieveNearestNeighborList in interface SearchInterface
Parameters:
include_nearest - a boolean value to indicate if the nearest neighbor list should be created and added to the data table.

getRetrieveNearestNeighborList

public boolean getRetrieveNearestNeighborList()
Description copied from interface: SearchInterface
Indicates if the nearest neighbor list should be generated.

Specified by:
getRetrieveNearestNeighborList in interface SearchInterface
Returns:
true if enabled, false otherwise. Defaults to false.

addSuggestions

public void addSuggestions(Vector<Integer> add_list)
Description copied from interface: SearchInterface
A list of suggestions that should be included in the list. The target ids found in this list will be included in the list even if they are outside of any latitude, longitude, LS, Priority, or Science Theme limits set. However, the listed targets may still not appear if they do not match the criteria for being included in the particular list type, or if the targets have been retired. In such cases, the targets that were not included can be determined by checking the vector returned by the SearchInterface.addedSuggestionsNotFound() method after the call to SearchInterface.executeSearch() has completed.

Specified by:
addSuggestions in interface SearchInterface
Parameters:
add_list - A Vector of Integer suggestion IDs.
See Also:
SearchInterface.addedSuggestionsNotFound()

getAddedSuggestions

public Vector<Integer> getAddedSuggestions()
Description copied from interface: SearchInterface
Returns the list of specially added suggestions.

Specified by:
getAddedSuggestions in interface SearchInterface
Returns:
a Vector of Integer suggestion Ids.
See Also:
SearchInterface.addSuggestions(Vector)

addedSuggestionsNotFound

public abstract Vector<Integer> addedSuggestionsNotFound()
Description copied from interface: SearchInterface
If any of the suggestions ID's found in the list passed to the SearchInterface.addSuggestions(Vector) were not found, they will be in the Vector of Integers returned by this method.

Specified by:
addedSuggestionsNotFound in interface SearchInterface
Returns:
A Vector of Integers found in the SearchInterface.addSuggestions(Vector) list that weren't included in the final list.
See Also:
SearchInterface.addSuggestions(Vector)

valueChanged

public void valueChanged(ListSelectionEvent event)
Specified by:
valueChanged in interface ListSelectionListener

getMissingSuggestionWarnings

public HashMap<Integer,TargetWarning> getMissingSuggestionWarnings()
Get the set of warnings generated for each missing suggestion.

Returns:
A HashMap with the suggestion ID's as keys to the warnings.

stateChanged

public void stateChanged(ChangeEvent event)
Specified by:
stateChanged in interface ChangeListener

propertyChange

public void propertyChange(PropertyChangeEvent event)
Specified by:
propertyChange in interface PropertyChangeListener

itemStateChanged

public void itemStateChanged(ItemEvent event)
Specified by:
itemStateChanged in interface ItemListener

HiRISE

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