Package org.openstreetmap.josm.actions.search

Class SearchAction

java.lang.Object

javax.swing.AbstractAction

org.openstreetmap.josm.actions.JosmAction

org.openstreetmap.josm.actions.search.SearchAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, AdaptableAction, ParameterizedAction, Destroyable

public class SearchAction
extends JosmAction
implements ParameterizedAction

The search action allows the user to search the data layer using a complex search string.

See Also:

SearchCompiler, SearchDialog, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SearchAction.CapturingSearchReceiver	This class stores the result of the search in a local variable.
(package private) static interface	SearchAction.SearchReceiver	Interfaces implementing this may receive the result of the current search.
static class	SearchAction.SearchSettingsActionParameter	ActionParameter implementation with SearchSetting as value type.
(package private) static class	SearchAction.SearchTask
private static class	SearchAction.SelectSearchReceiver	Select the search result and display a status text for it.

Nested classes/interfaces inherited from class org.openstreetmap.josm.actions.JosmAction

JosmAction.ActiveLayerChangeAdapter, JosmAction.LayerChangeAdapter, JosmAction.SelectionChangeAdapter

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_SEARCH_HISTORY_SIZE	The default size of the search history
private static SearchSetting	lastSearch
static int	MAX_LENGTH_SEARCH_EXPRESSION_DISPLAY	Maximum number of characters before the search expression is shortened for display purposes.
private static AutoCompComboBoxModel<SearchSetting>	model
private static JosmComboBoxModel.Preferences	prefs	preferences reader/writer with automatic transmogrification to and from String
private static java.lang.String	SEARCH_EXPRESSION

Fields inherited from class org.openstreetmap.josm.actions.JosmAction

sc

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor	Description
SearchAction()	Constructs a new SearchAction.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(java.awt.event.ActionEvent e)
void	actionPerformed(java.awt.event.ActionEvent e, java.util.Map<java.lang.String,java.lang.Object> parameters)	Invoke action using the given parameters.
java.util.List<ActionParameter<?>>	getActionParameters()	Get the list of parameters that describe the action.
static java.util.List<java.lang.String>	getSearchExpressionHistory()	Gets a list of all texts that were recently used in the search
static java.util.Collection<SearchSetting>	getSearchHistory()	Gets the search history
protected boolean	listenToSelectionChange()	Overwrite this if JosmAction.updateEnabledState() should be called when the selection changed.
private static void	loadPrefs()	Load preference values into the model
static void	saveToHistory(SearchSetting s)	Saves a search to the search history.
static void	search()	Launches the dialog for specifying search criteria and runs a search
static void	search(java.lang.String search, SearchMode mode)	Performs the search specified by the search string search and the search mode mode.
static java.util.Collection<IPrimitive>	searchAndReturn(java.lang.String search, SearchMode mode)	Performs the search specified by the search string search and the search mode mode and returns the result of the search.
static void	searchStateless(SearchSetting s)	Performs a stateless search specified by the settings in s.
static void	searchWithHistory(SearchSetting s)	Adds the search specified by the settings in s to the search history and performs the search.
static void	searchWithoutHistory(SearchSetting s)	Performs the search specified by the settings in s without saving it to search history.
static SearchSetting	showSearchDialog(SearchSetting initialValues)	Builds and shows the search dialog.
protected void	updateEnabledState()	Refreshes the enabled state

Methods inherited from class org.openstreetmap.josm.actions.JosmAction

buildActiveLayerChangeAdapter, buildLayerChangeAdapter, checkAndConfirmOutlyingOperation, destroy, getLayerManager, getShortcut, initEnabledState, installAdapters, listenToLayerChange, setHelpId, setToolbarId, setTooltip, updateEnabledState, updateEnabledStateOnCurrentSelection, updateEnabledStateOnCurrentSelection, updateEnabledStateOnModifiableSelection, waitFuture

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.Action

accept, addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Field Detail

DEFAULT_SEARCH_HISTORY_SIZE

public static final int DEFAULT_SEARCH_HISTORY_SIZE

The default size of the search history

See Also:

Constant Field Values

MAX_LENGTH_SEARCH_EXPRESSION_DISPLAY

public static final int MAX_LENGTH_SEARCH_EXPRESSION_DISPLAY

Maximum number of characters before the search expression is shortened for display purposes.

See Also:

Constant Field Values

SEARCH_EXPRESSION

private static final java.lang.String SEARCH_EXPRESSION

See Also:

Constant Field Values

model

private static final AutoCompComboBoxModel<SearchSetting> model

prefs

private static final JosmComboBoxModel.Preferences prefs

preferences reader/writer with automatic transmogrification to and from String

lastSearch

private static volatile SearchSetting lastSearch

Constructor Detail

SearchAction

public SearchAction()

Constructs a new SearchAction.

Method Detail

getSearchHistory

public static java.util.Collection<SearchSetting> getSearchHistory()

Gets the search history

Returns:

The last searched terms.

saveToHistory

public static void saveToHistory(SearchSetting s)

Saves a search to the search history.

Parameters:

s - The search to save

getSearchExpressionHistory

public static java.util.List<java.lang.String> getSearchExpressionHistory()

Gets a list of all texts that were recently used in the search

Returns:

The list of search texts.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e,
                            java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: ParameterizedAction

Invoke action using the given parameters.

Specified by:

actionPerformed in interface ParameterizedAction

Parameters:

e - the ActionEvent

parameters - parameter map

showSearchDialog

public static SearchSetting showSearchDialog(SearchSetting initialValues)

Builds and shows the search dialog.

Parameters:

initialValues - A set of initial values needed in order to initialize the search dialog. If is null, then default settings are used.

Returns:

Returns new SearchSetting object containing parameters of the search.

search

public static void search()

Launches the dialog for specifying search criteria and runs a search

loadPrefs

private static void loadPrefs()

Load preference values into the model

searchWithHistory

public static void searchWithHistory(SearchSetting s)

Adds the search specified by the settings in s to the search history and performs the search.

Parameters:

s - search settings

searchWithoutHistory

public static void searchWithoutHistory(SearchSetting s)

Performs the search specified by the settings in s without saving it to search history.

Parameters:

s - search settings

search

public static void search(java.lang.String search,
                          SearchMode mode)

Performs the search specified by the search string search and the search mode mode.

Parameters:

search - the search string to use

mode - the search mode to use

searchStateless

public static void searchStateless(SearchSetting s)

Performs a stateless search specified by the settings in s.

Parameters:

s - search settings

Since:

15356

searchAndReturn

public static java.util.Collection<IPrimitive> searchAndReturn(java.lang.String search,
                                                               SearchMode mode)

Performs the search specified by the search string search and the search mode mode and returns the result of the search.

Parameters:

search - the search string to use

mode - the search mode to use

Returns:

The result of the search.

Since:

10457, 13950 (signature)

listenToSelectionChange

protected boolean listenToSelectionChange()

Description copied from class: JosmAction

Overwrite this if JosmAction.updateEnabledState() should be called when the selection changed. Default is true.

Overrides:

listenToSelectionChange in class JosmAction

Returns:

true if a DataSelectionListener should be registered.

updateEnabledState

protected void updateEnabledState()

Refreshes the enabled state

Overrides:

updateEnabledState in class JosmAction

See Also:

JosmAction.updateEnabledState(Collection), JosmAction.initEnabledState(), JosmAction.listenToLayerChange()

getActionParameters

public java.util.List<ActionParameter<?>> getActionParameters()

Description copied from interface: ParameterizedAction

Get the list of parameters that describe the action.

Specified by:

getActionParameters in interface ParameterizedAction

Returns:

the list of parameters that describe the action