|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.PlatformObject
org.eclipse.rse.services.search.HostSearchResultSet
public class HostSearchResultSet
A remote search result set represents a page in the Remote Search view. A search result set contains multiple search configurations and their results. This allows it to contain results from multiple connections, filters, and folders (from different systems).
Field Summary | |
---|---|
protected Vector |
configurations
|
protected String |
name
|
Constructor Summary | |
---|---|
HostSearchResultSet()
Constructor to create a result set. |
Method Summary | |
---|---|
void |
addResult(IHostSearchResultConfiguration config,
Object result)
Add a result for a search configuration. |
void |
addSearchConfiguration(IHostSearchResultConfiguration config)
Add a search configuration. |
void |
cancel()
Cancels the search. |
void |
dispose()
Removes all configurations. |
Object[] |
getAllResults()
Returns all results of the search. |
String |
getName()
Gets the name of the search that is being run. |
int |
getNumOfResults()
Gets the number of results. |
Object[] |
getResultsForConfiguration(IHostSearchResultConfiguration config)
Returns the results of a particular search configuration. |
Iterator |
getSearchConfigurations()
Returns an iterator over search configurations. |
boolean |
isCancelled()
Returns whether the search is cancelled. |
boolean |
isDisconnected()
Returns whether the search is disconnected. |
boolean |
isFinished()
Returns whether the search is finished. |
boolean |
isRunning()
Returns whether search is running. |
void |
removeAllResults()
Removes all results of the search. |
void |
removeAndAddResult(Object oldResult,
Object newResult)
Removes the old result from configurations where it is found, and add the new result to those configurations. |
void |
removeResult(IHostSearchResultConfiguration config,
Object result)
Removes a result from a search configuration. |
void |
removeResult(Object result)
Removes a result from all search configurations where it exists. |
void |
removeSearchConfiguration(IHostSearchResultConfiguration config)
Removes a search configuration. |
void |
setName(String name)
Sets the name of the search. |
Methods inherited from class org.eclipse.core.runtime.PlatformObject |
---|
getAdapter |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Field Detail |
---|
protected Vector configurations
protected String name
Constructor Detail |
---|
public HostSearchResultSet()
Method Detail |
---|
public void setName(String name)
IHostSearchResultSet
setName
in interface IHostSearchResultSet
name
- the name of the search.public String getName()
IHostSearchResultSet
getName
in interface IHostSearchResultSet
public void addSearchConfiguration(IHostSearchResultConfiguration config)
IHostSearchResultSet
addSearchConfiguration
in interface IHostSearchResultSet
config
- a search configuration.public void removeSearchConfiguration(IHostSearchResultConfiguration config)
IHostSearchResultSet
removeSearchConfiguration
in interface IHostSearchResultSet
config
- a search configuration.public Iterator getSearchConfigurations()
IHostSearchResultSet
getSearchConfigurations
in interface IHostSearchResultSet
public void addResult(IHostSearchResultConfiguration config, Object result)
IHostSearchResultSet
addResult
in interface IHostSearchResultSet
config
- a search configuration that was previously added.result
- a search result.public void removeResult(IHostSearchResultConfiguration config, Object result)
IHostSearchResultSet
removeResult
in interface IHostSearchResultSet
config
- a search configuration that was previously added.result
- a search result.public Object[] getResultsForConfiguration(IHostSearchResultConfiguration config)
IHostSearchResultSet
getResultsForConfiguration
in interface IHostSearchResultSet
config
- a search configuration.
public Object[] getAllResults()
IHostSearchResultSet
getAllResults
in interface IHostSearchResultSet
public void removeAllResults()
IHostSearchResultSet
removeAllResults
in interface IHostSearchResultSet
public int getNumOfResults()
IHostSearchResultSet
getNumOfResults
in interface IHostSearchResultSet
public void cancel()
IHostSearchResultSet
cancel
in interface IHostSearchResultSet
public void removeResult(Object result)
IHostSearchResultSet
removeResult
in interface IHostSearchResultSet
result
- a search result.public void removeAndAddResult(Object oldResult, Object newResult)
IHostSearchResultSet
removeAndAddResult
in interface IHostSearchResultSet
oldResult
- the old result.newResult
- the new result.public void dispose()
IHostSearchResultSet
dispose
method of
the configurations before removing them.
dispose
in interface IHostSearchResultSet
public boolean isCancelled()
IHostSearchResultSet
isCancelled
in interface IHostSearchResultSet
true
if the search is cancelled, false
otherwise.public boolean isFinished()
IHostSearchResultSet
isFinished
in interface IHostSearchResultSet
true
if the search is finished, false
otherwise.public boolean isRunning()
IHostSearchResultSet
isRunning
in interface IHostSearchResultSet
true
if the search is running, false
otherwise.public boolean isDisconnected()
IHostSearchResultSet
isDisconnected
in interface IHostSearchResultSet
true
if the search is disconnected, false
otherwise.
|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |