Eclipse RSE Development Guide (Galileo) - HostSearchResultSet (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.services.search
Class HostSearchResultSet


java.lang.Object
  

org.eclipse.core.runtime.PlatformObject
      
org.eclipse.rse.services.search.HostSearchResultSet

All Implemented Interfaces:: IAdaptable, IHostSearchResultSet

public class HostSearchResultSet
extends PlatformObject
implements IHostSearchResultSet, IAdaptable
extends PlatformObject
implements IHostSearchResultSet, IAdaptable

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

configurations

protected 
Vector configurations

name

protected 
String name

Constructor Detail

HostSearchResultSet

public HostSearchResultSet()

Constructor to create a result set.

Method Detail