com.k_int.hss
Class HSSSearchTask

java.lang.Object
  |
  +--java.util.Observable
        |
        +--com.k_int.IR.SearchTask
              |
              +--com.k_int.hss.HSSSearchTask

public class HSSSearchTask

extends SearchTask

HSSSearchTask Object used in conunction with HeterogeneousSetOfSearchable object to track the progress of a specific HSS query and provide access to it's results (And component searches)

Version:

$Id: HSSSearchTask.java,v 1.9 2001/06/19 17:19:59 ianibbo Exp $

Author:

Ian Ibbotson

See Also:

HeterogeneousSetOfSearchable, Searchable, IRQuery

Field Summary

java.util.Observer

subtask_observer

Fields inherited from class com.k_int.IR.SearchTask

create_time, max_messages, message_log, query, TASK_COMPLETE, TASK_EXECUTING_ASYNC, TASK_EXECUTING_SYNC, TASK_FAILURE, task_identifier, TASK_IDLE, task_status_code, user_data

Constructor Summary

HSSSearchTask(HeterogeneousSetOfSearchable manager, java.util.Observer[] observers)

Method Summary

void	addSubQuery(SearchTask st)
void	beginSearchGroup() Used to indicate that a client is sending a group of queries to search and that the search should not be considered complete until after the last task has been established.
void	cancelTask() Cancel any active operation, but leave all the searchTask's data intact
void	destroyTask() Shut down the task and release any resources, maybe notify our creating searchable
void	endSearchGroup() Used to indicate that a client has done adding child queries and we can now wait for all sub tasks to complete...
int	evaluate(int timeout) Evaluate the query, waiting at most timeout milliseconds, returning the search status.
protected void	finalize()
int	getPrivateTaskStatusCode()
InformationFragmentSource	getTaskResultSet() getTaskResultSet.
java.lang.String	lookupPrivateStatusCode(int code)

Methods inherited from class com.k_int.IR.SearchTask

addFragmentSourceObserver, getLastStatusMessages, getQuery, getSubtasks, getTaskCreationTime, getTaskIdentifier, getTaskStatusCode, getUserData, hasSubtasks, logStatusMessage, setMaxStatusMessageItems, setQuery, setTaskStatusCode, setUserData, waitForStatus

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

subtask_observer

public java.util.Observer subtask_observer

Constructor Detail

HSSSearchTask

public HSSSearchTask(HeterogeneousSetOfSearchable manager,
                     java.util.Observer[] observers)

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

getPrivateTaskStatusCode

public int getPrivateTaskStatusCode()

Overrides:

getPrivateTaskStatusCode in class SearchTask

lookupPrivateStatusCode

public java.lang.String lookupPrivateStatusCode(int code)

Overrides:

lookupPrivateStatusCode in class SearchTask

addSubQuery

public void addSubQuery(SearchTask st)

evaluate

public int evaluate(int timeout)

Description copied from class: SearchTask

Evaluate the query, waiting at most timeout milliseconds, returning the search status. InformationFragmentSource object should be used to check the final number of result records.

Overrides:

evaluate in class SearchTask

getTaskResultSet

public InformationFragmentSource getTaskResultSet()

Description copied from class: SearchTask

getTaskResultSet. Search tasks delagate the responsibility of managing a result set to an instance of the InformationFragmentSource. Often, the SearchTask will implement InformationFragmentSource itself, and return (this) as the realisation of the getTaskResultSet method. Other SearchTasks may use some cache managing FragmentSource to wrapper the source result set and return that object.

Overrides:

getTaskResultSet in class SearchTask

beginSearchGroup

public void beginSearchGroup()

Used to indicate that a client is sending a group of queries to search and that the search should not be considered complete until after the last task has been established.

endSearchGroup

public void endSearchGroup()

Used to indicate that a client has done adding child queries and we can now wait for all sub tasks to complete...

cancelTask

public void cancelTask()

Description copied from class: SearchTask

Cancel any active operation, but leave all the searchTask's data intact

Overrides:

cancelTask in class SearchTask

destroyTask

public void destroyTask()

Description copied from class: SearchTask

Shut down the task and release any resources, maybe notify our creating searchable

Overrides:

destroyTask in class SearchTask