public interface SearchInterface
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ID |
static java.lang.String |
IGNORE_FILTER_UPDATES_NAME |
static java.lang.String |
MAX_LATITUDE_FIELDNAME |
static java.lang.String |
MAX_LONG_FIELDNAME |
static java.lang.String |
MAX_LSUBS_FIELDNAME |
static java.lang.String |
MIN_LATITUDE_FIELDNAME |
static java.lang.String |
MIN_LONG_FIELDNAME |
static java.lang.String |
MIN_LSUBS_FIELDNAME |
static java.lang.String |
PRIORITY_LISTNAME |
static java.lang.String |
ROW_LIMIT_ENABLENAME |
static java.lang.String |
ROW_LIMIT_FIELDNAME |
static java.lang.String |
SCIENCE_THEME_LISTNAME |
static java.lang.String |
SPECIAL_TARGETS_ADDED_PROPERTY |
static java.lang.String |
SPECIAL_TARGETS_REMOVED_PROPERTY |
static java.lang.String |
THEME_COUNT_FIELDNAME |
Modifier and Type | Method and Description |
---|---|
java.util.Vector<java.lang.Integer> |
addedSuggestionsNotFound()
If any of the suggestions ID's found in the list passed to the
addSuggestions(Vector) were not found, they will be in the Vector
of Integers returned by this method. |
void |
addSuggestions(java.util.Vector<java.lang.Integer> add_list)
A list of suggestions that should be included in the list.
|
java.lang.String |
constructSearchQuery()
Constructs the base search query specific to the list being generated.
|
java.lang.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.
|
java.util.Vector<java.util.Vector<java.lang.String>> |
executeAddedSuggestionsSearch(java.util.Vector<java.util.Vector<java.lang.String>> dataTable)
This method executes a secondary database search for special targets.
|
java.util.Vector<java.util.Vector<java.lang.String>> |
executeSearch()
A method executing a database search for suggested targets, and will
usually execure the query returned by the
constructSearchQuery()
method. |
java.util.Vector<java.lang.Integer> |
getAddedSuggestions()
Returns the list of specially added suggestions.
|
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.
|
boolean |
getRetrieveNearestNeighborList()
Indicates if the nearest neighbor list should be generated.
|
int |
getRowLimit()
Get the current row limit setting.
|
java.util.Vector<PriorityList> |
getSelectedPriorities()
The list of priorities currently selected for the list.
|
java.util.Vector<java.lang.String> |
getSelectedScienceThemes()
Get the list of science themes currently selected for the list.
|
int |
getSuggestionsPerThemeLimit()
Get the current suggestions per theme limit
|
boolean |
hasRowLimitsEnabled()
Indicates if row limits have been enabled.
|
void |
initOrderingSettings(PIRL.Configuration.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.
|
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(java.util.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(java.util.Vector<java.lang.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.
|
java.util.Vector<java.util.Vector<java.lang.String>> |
updateAddedSuggestions(java.util.Vector<java.util.Vector<java.lang.String>> dataTable)
Update the input dataTable with additional targets.
|
static final java.lang.String ID
static final java.lang.String PRIORITY_LISTNAME
static final java.lang.String SCIENCE_THEME_LISTNAME
static final java.lang.String MIN_LATITUDE_FIELDNAME
static final java.lang.String MAX_LATITUDE_FIELDNAME
static final java.lang.String MIN_LONG_FIELDNAME
static final java.lang.String MAX_LONG_FIELDNAME
static final java.lang.String MIN_LSUBS_FIELDNAME
static final java.lang.String MAX_LSUBS_FIELDNAME
static final java.lang.String ROW_LIMIT_FIELDNAME
static final java.lang.String ROW_LIMIT_ENABLENAME
static final java.lang.String IGNORE_FILTER_UPDATES_NAME
static final java.lang.String THEME_COUNT_FIELDNAME
static final java.lang.String SPECIAL_TARGETS_ADDED_PROPERTY
static final java.lang.String SPECIAL_TARGETS_REMOVED_PROPERTY
java.lang.String constructSearchQuery()
Note: Many of the setters defined in this search interface are search criteria that are used to construct this query.
setMinimumLongitude(double)
,
setMaximumLongitude(double)
,
setMinimumLatitude(double)
,
setMaximumLatitude(double)
,
setMinimumLs(double)
,
setMaximumLs(double)
,
setPriorities(Vector)
,
setScienceThemes(Vector)
,
setSuggestionsPerThemeLimit(int)
,
enableRowLimits(boolean)
,
setRowLimit(int)
,
setRetrieveNearestNeighborList(boolean)
java.lang.String constructSecondaryQuery()
java.util.Vector<java.util.Vector<java.lang.String>> executeSearch() throws PIRL.Database.Database_Exception
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 criteriaPIRL.Database.Database_Exception
- if an error occurs during query executionjava.util.Vector<java.util.Vector<java.lang.String>> executeAddedSuggestionsSearch(java.util.Vector<java.util.Vector<java.lang.String>> dataTable) throws PIRL.Database.Database_Exception
dataTable
- - the dataTable to add the suggestion records toPIRL.Database.Database_Exception
java.util.Vector<java.util.Vector<java.lang.String>> updateAddedSuggestions(java.util.Vector<java.util.Vector<java.lang.String>> dataTable) throws PIRL.Database.Database_Exception
dataTable
- - the dataTable to updatePIRL.Database.Database_Exception
- if an error occurs during the database interactionvoid setMinimumLongitude(double min_longitude)
min_longitude
- constructSearchQuery()
double getMinimumLongitude()
void setMaximumLongitude(double max_longitude)
max_longitude
- constructSearchQuery()
double getMaximumLongitude()
void setMinimumLatitude(double min_latitude)
min_latitude
- constructSearchQuery()
double getMinimumLatitude()
void setMaximumLatitude(double max_latitude)
max_latitude
- constructSearchQuery()
double getMaximumLatitude()
void setMinimumLs(double minLs)
minLs
- constructSearchQuery()
double getMinimumLs()
void setMaximumLs(double maxLs)
maxLs
- constructSearchQuery()
double getMaximumLs()
void setSuggestionsPerThemeLimit(int suggestions_per_theme)
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.
suggestions_per_theme
- - an integer value, Default 0.constructSearchQuery()
,
initOrderingSettings(Configuration)
,
enableRowLimits(boolean)
,
setRowLimit(int)
int getSuggestionsPerThemeLimit()
setSuggestionsPerThemeLimit(int)
void setRowLimit(int row_limit)
row_limit
- - an integerconstructSearchQuery()
int getRowLimit()
void enableRowLimits(boolean enable_row_limits)
enable_row_limits
- constructSearchQuery()
,
setRowLimit(int)
boolean hasRowLimitsEnabled()
getRowLimit()
method will be passed to the database to determine the
total number of targets retrieved from the database.setRowLimit(int)
void setScienceThemes(java.util.Vector<java.lang.String> theme_list)
theme_list
- a Vector of Strings containing the list of allowed science
themes.constructSearchQuery()
java.util.Vector<java.lang.String> getSelectedScienceThemes()
void setPriorities(java.util.Vector<PriorityList> priorities)
Note: if priority 10 is included, targets with priorities greater than 10 will also be included.
priorities
- - A Vector of Strings holding the set of priorities to
include.constructSearchQuery()
java.util.Vector<PriorityList> getSelectedPriorities()
void initOrderingSettings(PIRL.Configuration.Configuration config) throws PIRL.Configuration.Configuration_Exception
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
config
- A configuration that may contain column ordering information.PIRL.Configuration.Configuration_Exception
constructSearchQuery()
,
TargetList.OrderingFields
void setRetrieveNearestNeighborList(boolean include_nearest)
include_nearest
- a boolean value to indicate if the nearest neighbor list
should be created and added to the data table.boolean getRetrieveNearestNeighborList()
void addSuggestions(java.util.Vector<java.lang.Integer> add_list)
addedSuggestionsNotFound()
method after the call to executeSearch()
has completed.add_list
- A Vector of Integer suggestion IDs.addedSuggestionsNotFound()
java.util.Vector<java.lang.Integer> getAddedSuggestions()
addSuggestions(Vector)
java.util.Vector<java.lang.Integer> addedSuggestionsNotFound()
addSuggestions(Vector)
were not found, they will be in the Vector
of Integers returned by this method.addSuggestions(Vector)
list
that weren't included in the final list.addSuggestions(Vector)
Copyright \ (C) Arizona Board of Regents on behalf of the \ Planetary Image Research Laboratory, Lunar and \ Planetary Laboratory at the University of Arizona