|
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.subsystems.files.core.subsystems.RemoteSearchResultConfiguration
public class RemoteSearchResultConfiguration
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 IHostSearchResultSet |
parentResultSet
|
protected Vector |
results
|
protected SystemSearchString |
searchString
|
protected Object |
searchTarget
|
protected int |
status
|
Constructor Summary | |
---|---|
RemoteSearchResultConfiguration(IHostSearchResultSet resultSet,
Object searchObject,
SystemSearchString string)
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()
Does nothing. |
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. |
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 handler)
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 int status
protected Map _containedResults
protected ISearchHandler _searchHandler
Constructor Detail |
---|
public RemoteSearchResultConfiguration(IHostSearchResultSet resultSet, Object searchObject, SystemSearchString string)
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 IHostSearchResultConfiguration
resultSet
- the parent result set.IHostSearchResultConfiguration.setParentResultSet(org.eclipse.rse.services.search.IHostSearchResultSet)
public IHostSearchResultSet getParentResultSet()
IHostSearchResultConfiguration
getParentResultSet
in interface IHostSearchResultConfiguration
IHostSearchResultConfiguration.getParentResultSet()
public void setSearchTarget(Object searchObject)
IHostSearchResultConfiguration
setSearchTarget
in interface IHostSearchResultConfiguration
searchObject
- the object to be searched.IHostSearchResultConfiguration.setSearchTarget(java.lang.Object)
public Object getSearchTarget()
IHostSearchResultConfiguration
getSearchTarget
in interface IHostSearchResultConfiguration
IHostSearchResultConfiguration.getSearchTarget()
public void setSearchString(SystemSearchString string)
IHostSearchResultConfiguration
setSearchString
in interface IHostSearchResultConfiguration
string
- the search string.IHostSearchResultConfiguration.setSearchString(org.eclipse.rse.services.clientserver.SystemSearchString)
public SystemSearchString getSearchString()
IHostSearchResultConfiguration
getSearchString
in interface IHostSearchResultConfiguration
IHostSearchResultConfiguration.getSearchString()
public void addResult(Object result)
IHostSearchResultConfiguration
addResult
in interface IHostSearchResultConfiguration
result
- a search result.IHostSearchResultConfiguration.addResult(java.lang.Object)
public void removeResult(Object result)
IHostSearchResultConfiguration
removeResult
in interface IHostSearchResultConfiguration
result
- a search result.IHostSearchResultConfiguration.removeResult(java.lang.Object)
public void removeAndAddResult(Object oldResult, Object newResult)
IHostSearchResultConfiguration
removeAndAddResult
in interface IHostSearchResultConfiguration
oldResult
- the old result.newResult
- the new result.IHostSearchResultConfiguration.removeAndAddResult(java.lang.Object, java.lang.Object)
public Object[] getResults()
IHostSearchResultConfiguration
getResults
in interface IHostSearchResultConfiguration
IHostSearchResultConfiguration.getResults()
public IHostSearchResult[] getContainedResults(Object resultContainer)
IHostSearchResultConfiguration
getContainedResults
in interface IHostSearchResultConfiguration
public int getResultsSize()
IHostSearchResultConfiguration
getResultsSize
in interface IHostSearchResultConfiguration
IHostSearchResultConfiguration.getResultsSize()
public void removeResults()
IHostSearchResultConfiguration
removeResults
in interface IHostSearchResultConfiguration
IHostSearchResultConfiguration.removeResults()
public void setStatus(int status)
IHostSearchResultConfiguration
RUNNING
, FINISHED
,
CANCELLED
, or DISCONNECTED
.
setStatus
in interface IHostSearchResultConfiguration
status
- the status.IHostSearchResultConfiguration.setStatus(int)
public int getStatus()
IHostSearchResultConfiguration
RUNNING
, FINISHED
,
CANCELLED
, or DISCONNECTED
.
getStatus
in interface IHostSearchResultConfiguration
IHostSearchResultConfiguration.getStatus()
public void cancel()
cancel
in interface IHostSearchResultConfiguration
IHostSearchResultConfiguration.cancel()
public void dispose()
IHostSearchResultConfiguration
super
first.
dispose
in interface IHostSearchResultConfiguration
IHostSearchResultConfiguration.dispose()
public void addResults(Object container, IHostSearchResult[] results)
IHostSearchResultConfiguration
addResults
in interface IHostSearchResultConfiguration
public void setSearchHandler(ISearchHandler handler)
IHostSearchResultConfiguration
setSearchHandler
in interface IHostSearchResultConfiguration
public ISearchHandler getSearchHandler()
|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |