Introduction

This document lists changes made to the Search API.

Index of APIs

Search API

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

All changes by date

(Sep 2 '11) Added method SearchGroup.onStopSearch
(Jan 13 '09) Added utility class Utils
(Jan 13 '09) Added interface SearchInfo.Files
(Jun 10 '07) Added method createCompoundSearchInfo(...) to class SearchInfoFactory
(Jan 12 '07) SearchInfo objects contained in Projects' lookups are now taken into account by action Find in Projects...
(Feb 15 '05) Added ADD_TO_HISTORY field
(Jan 7 '05) Added SearchHistory and SearchPattern classes
(Aug 13 '04) Added SearchInfo interface together with a factory class SearchInfoFactory and interface FileObjectFilter

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.openidex.util/3 > 1.20

(3.31) Added method SearchGroup.onStopSearch
(3.20) Added utility class Utils
(3.20) Added interface SearchInfo.Files
(3.13) Added method createCompoundSearchInfo(...) to class SearchInfoFactory
(3.11) SearchInfo objects contained in Projects' lookups are now taken into account by action Find in Projects...
(3.6) Added ADD_TO_HISTORY field
(3.5) Added SearchHistory and SearchPattern classes
(3.3) Added SearchInfo interface together with a factory class SearchInfoFactory and interface FileObjectFilter

Changes by affected class

`org.openidex.search.FileObjectFilter`

(Aug 13 '04) Added SearchInfo interface together with a factory class SearchInfoFactory and interface FileObjectFilter

`org.openidex.search.SearchGroup`

(Sep 2 '11) Added method SearchGroup.onStopSearch

`org.openidex.search.SearchHistory`

(Feb 15 '05) Added ADD_TO_HISTORY field
(Jan 7 '05) Added SearchHistory and SearchPattern classes

`org.openidex.search.SearchInfo`

(Jan 13 '09) Added interface SearchInfo.Files
(Aug 13 '04) Added SearchInfo interface together with a factory class SearchInfoFactory and interface FileObjectFilter

`org.openidex.search.SearchInfoFactory`

(Jun 10 '07) Added method createCompoundSearchInfo(...) to class SearchInfoFactory
(Aug 13 '04) Added SearchInfo interface together with a factory class SearchInfoFactory and interface FileObjectFilter

`org.openidex.search.SearchPattern`

(Jan 7 '05) Added SearchHistory and SearchPattern classes

`org.openidex.search.Utils`

(Jan 13 '09) Added utility class Utils

Details of all changes by API and date

Search API

Added method `SearchGroup.onStopSearch`

Sep 2 '11; API spec. version: 3.31; affected top-level classes: SearchGroup; made by: jhavlin; issues: #193361

Class SearchGroup now contains method onStopSearch, that can be overriden in subclasses to perform some custom operations that are needed to stop the search, e.g. terminate internal tasks.

Added utility class `Utils`

Jan 13 '09; API spec. version: 3.20; affected top-level classes: Utils; made by: kaktus

Class Utils made public with one public static method getFileObjectsIterator(SearchInfo si). This utility method returns Iterator of FileObjects for the provided SearchInfo. This change simplifies the work with SearchInfo implementations.

Added interface `SearchInfo.Files`

Jan 13 '09; API spec. version: 3.20; affected top-level classes: SearchInfo; made by: kaktus; issues: #134558

Added SearchInfo.Files interface which extends SearchInfo interface. It adds method filesToSearch() to provide FileObjects which should be searched. This change allows to operate FileObjects in the search mechanism instead of DataObjects and as a result improves search performance.

Added method `createCompoundSearchInfo(...)` to class `SearchInfoFactory`

Jun 10 '07; API spec. version: 3.13; affected top-level classes: SearchInfoFactory; made by: mpetras

Compound SearchInfo is a useful functionality that has been present in the package since the SearchInfo interface had been introduced. It just was not available from outside the org.openidex.search package. This change makes it available through a public factory method.

`SearchInfo` objects contained in `Project`s' lookups are now taken into account by action Find in Projects...

Jan 12 '07; API spec. version: 3.11; made by: mpetras; issues: #64392
The change is not in the API itself but in the range of its usage. Before the change, action Find in Projects... did not look for SearchInfo objects – it always searched projects' SourceGroups. Now the action first checks the project's Lookup for presence of a SearchInfo object. If some SearchInfo is present, it is used for the search, and only if there is no SearchInfo, the project's SourceGroups are searched.

Added `ADD_TO_HISTORY` field

Feb 15 '05; API spec. version: 3.6; affected top-level classes: SearchHistory; made by: mroskanin; issues: #54028 #54451

It is necessary to fire further PropertyChangeEvent to fix it. (Details in the issue #54028)It is event ADD_TO_HISTORY, that will be fired after adding new SearchPattern to history. Old value of event would be null, new value would be added pattern. Also pattern checking before adding to history is a subject of the API change.

Added `SearchHistory` and `SearchPattern` classes

Jan 7 '05; API spec. version: 3.5; affected top-level classes: SearchHistory SearchPattern; made by: mroskanin; issues: #51964

Editor find and replace dialog and search over files in explorer should have one and shareable history. Editor module should be notified about last selected search expression to highlight(in yellow) the matched patterns.

Added `SearchInfo` interface together with a factory class `SearchInfoFactory` and interface `FileObjectFilter`

Aug 13 '04; API spec. version: 3.3; affected top-level classes: SearchInfo SearchInfoFactory FileObjectFilter; made by: mpetras; issues: #42540 #43940

In NetBeans 3.6, only nodes representing file folders were searchable. In NetBeans 4.0, there are several special views and nodes not representing folders. But many of these nodes still need to be searchable. Interface SearchInfo allows to specify how a particular node should be searched - simply by putting a SearchInfo object to the node's lookup.