|
RSE Release 3.4 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.rse.services.search.AbstractSearchResultConfiguration
public abstract class AbstractSearchResultConfiguration
This class represents a search result configuration. A configuration consists of a search target and a search string, and belongs to a search result set. Once a search has been started via a subsystem, the results are stored in the configuration itself. The status of the search can also be queried from the configuration.
| Field Summary | |
|---|---|
protected Map |
_containedResults
|
protected ISearchHandler |
_searchHandler
|
protected ISearchService |
_searchService
|
protected IHostSearchResultSet |
parentResultSet
|
protected Vector |
results
|
protected SystemSearchString |
searchString
|
protected Object |
searchTarget
|
protected int |
status
|
| Constructor Summary | |
|---|---|
AbstractSearchResultConfiguration(IHostSearchResultSet resultSet,
Object searchObject,
SystemSearchString string,
ISearchService searchService)
Constructor for a result set configuration. |
|
| Method Summary | |
|---|---|
void |
addResult(Object result)
Adds a search result. |
void |
addResults(Object container,
IHostSearchResult[] results)
Adds a set of search results along their associated container |
void |
cancel()
Cancels the search if it is running. |
void |
dispose()
Cancels the search and then removes the search results. |
IHostSearchResult[] |
getContainedResults(Object resultContainer)
Gets the results contained within the resultContainer |
IHostSearchResultSet |
getParentResultSet()
Gets the parent result set. |
Object[] |
getResults()
Gets search results. |
int |
getResultsSize()
Gets the size of the results. |
ISearchHandler |
getSearchHandler()
Gets the search handler. |
ISearchService |
getSearchService()
|
SystemSearchString |
getSearchString()
Gets the search string. |
Object |
getSearchTarget()
Gets the object to be searched. |
int |
getStatus()
Gets the status of the search. |
void |
removeAndAddResult(Object oldResult,
Object newResult)
Removes the old result and adds a new result. |
void |
removeResult(Object result)
Removes a search result. |
void |
removeResults()
Removes all search results. |
void |
setParentResultSet(IHostSearchResultSet resultSet)
Sets the parent result set. |
void |
setSearchHandler(ISearchHandler searchHandler)
Sets the search handler |
void |
setSearchString(SystemSearchString string)
Sets the search string. |
void |
setSearchTarget(Object searchObject)
Sets the object to be searched. |
void |
setStatus(int status)
Sets the status of the search. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected IHostSearchResultSet parentResultSet
protected Object searchTarget
protected SystemSearchString searchString
protected Vector results
protected Map _containedResults
protected int status
protected ISearchService _searchService
protected ISearchHandler _searchHandler
| Constructor Detail |
|---|
public AbstractSearchResultConfiguration(IHostSearchResultSet resultSet,
Object searchObject,
SystemSearchString string,
ISearchService searchService)
RUNNING.
resultSet - the parent result set.searchObject - the target of the search.string - the search string.| Method Detail |
|---|
public void setParentResultSet(IHostSearchResultSet resultSet)
IHostSearchResultConfiguration
setParentResultSet in interface IHostSearchResultConfigurationresultSet - the parent result set.public IHostSearchResultSet getParentResultSet()
IHostSearchResultConfiguration
getParentResultSet in interface IHostSearchResultConfigurationpublic ISearchService getSearchService()
public void setSearchTarget(Object searchObject)
IHostSearchResultConfiguration
setSearchTarget in interface IHostSearchResultConfigurationsearchObject - the object to be searched.public Object getSearchTarget()
IHostSearchResultConfiguration
getSearchTarget in interface IHostSearchResultConfigurationpublic void setSearchString(SystemSearchString string)
IHostSearchResultConfiguration
setSearchString in interface IHostSearchResultConfigurationstring - the search string.public SystemSearchString getSearchString()
IHostSearchResultConfiguration
getSearchString in interface IHostSearchResultConfigurationpublic void addResult(Object result)
IHostSearchResultConfiguration
addResult in interface IHostSearchResultConfigurationresult - a search result.public void removeResult(Object result)
IHostSearchResultConfiguration
removeResult in interface IHostSearchResultConfigurationresult - a search result.
public void removeAndAddResult(Object oldResult,
Object newResult)
IHostSearchResultConfiguration
removeAndAddResult in interface IHostSearchResultConfigurationoldResult - the old result.newResult - the new result.public Object[] getResults()
IHostSearchResultConfiguration
getResults in interface IHostSearchResultConfigurationpublic IHostSearchResult[] getContainedResults(Object resultContainer)
IHostSearchResultConfiguration
getContainedResults in interface IHostSearchResultConfigurationpublic int getResultsSize()
IHostSearchResultConfiguration
getResultsSize in interface IHostSearchResultConfigurationpublic void removeResults()
IHostSearchResultConfiguration
removeResults in interface IHostSearchResultConfigurationpublic void setStatus(int status)
IHostSearchResultConfigurationRUNNING, FINISHED,
CANCELLED, or DISCONNECTED.
setStatus in interface IHostSearchResultConfigurationstatus - the status.public int getStatus()
IHostSearchResultConfigurationRUNNING, FINISHED,
CANCELLED, or DISCONNECTED.
getStatus in interface IHostSearchResultConfigurationpublic void cancel()
IHostSearchResultConfiguration
cancel in interface IHostSearchResultConfigurationpublic void dispose()
IHostSearchResultConfigurationsuper first.
dispose in interface IHostSearchResultConfiguration
public void addResults(Object container,
IHostSearchResult[] results)
IHostSearchResultConfiguration
addResults in interface IHostSearchResultConfigurationpublic void setSearchHandler(ISearchHandler searchHandler)
IHostSearchResultConfiguration
setSearchHandler in interface IHostSearchResultConfigurationpublic ISearchHandler getSearchHandler()
|
RSE Release 3.4 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||