edu.indiana.lib.twinpeaks.util

Class StatusUtils

java.lang.Object

edu.indiana.lib.twinpeaks.util.StatusUtils

public class StatusUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
StatusUtils()

Method Summary

Modifier and Type	Method and Description
static void	clearAsyncInit(SessionContext sessionContext) Clear the asynchronous initialization flag
static void	clearAsyncSearch(SessionContext sessionContext) Clear the asynchronous search flag
static boolean	doingAsyncInit(SessionContext sessionContext) Still performing asynchronous init?
static int	getActiveTargetCount(SessionContext sessionContext) Fetch the number of active (searching) targets
static int	getAllRemainingHits(SessionContext sessionContext) Fetch the number of remaining hits (all targets)
static int	getEstimatedHits(SessionContext sessionContext, String target) Fetch the estimated hits for a specified target (database)
static HashMap	getNewStatusMap(SessionContext sessionContext) Create a new status map
static Iterator	getStatusMapEntrySetIterator(SessionContext sessionContext) Get an iterator into the system status map
static HashMap	getStatusMapForTarget(SessionContext sessionContext, String target) Get the status entry for a specified target database
static void	initialize(SessionContext sessionContext, String targets) Set up initial status information
static boolean	isAsyncSearch(SessionContext sessionContext) Is this an asynchronous search?
static void	setAllComplete(SessionContext sessionContext) Set all status value to "search complete" (effects all target databases)
static void	setAsyncInit(SessionContext sessionContext) Indicate asynchronous initialization in progress
static void	setAsyncSearch(SessionContext sessionContext) Indicate an asynchronous search
static void	setGlobalError(SessionContext sessionContext, String message) Set global error status (effects all target databases)
static void	setGlobalError(SessionContext sessionContext, String error, String message) Set global error status (effects all target databases)
static void	setGlobalStatus(SessionContext sessionContext, String status, String message) Set global status (effects all target databases)
static int	updateHits(SessionContext sessionContext, String target) Update the hit count for this target (database)

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusUtils

public StatusUtils()

Method Detail

initialize

public static void initialize(SessionContext sessionContext,
                              String targets)

Set up initial status information

getStatusMapEntrySetIterator

public static Iterator getStatusMapEntrySetIterator(SessionContext sessionContext)

Get an iterator into the system status map

Parameters:

sessionContext - Active SessionContext

Returns:

Status map Iterator

getStatusMapForTarget

public static HashMap getStatusMapForTarget(SessionContext sessionContext,
                                            String target)

Get the status entry for a specified target database

Parameters:

sessionContext - Active SessionContext

target - Database name

Returns:

Status Map for this target (null if none)

getNewStatusMap

public static HashMap getNewStatusMap(SessionContext sessionContext)

Create a new status map

Parameters:

sessionContext - Active SessionContext

Returns:

Status Map for this target

setGlobalStatus

public static void setGlobalStatus(SessionContext sessionContext,
                                   String status,
                                   String message)

Set global status (effects all target databases)

Parameters:

sessionContext - Active SessionContext

status - One of ERROR | DONE

message - Status text

setGlobalError

public static void setGlobalError(SessionContext sessionContext,
                                  String message)

Set global error status (effects all target databases)

Parameters:

sessionContext - Active SessionContext

message - Expanded error text (null if none - produces "unknown")

setGlobalError

public static void setGlobalError(SessionContext sessionContext,
                                  String error,
                                  String message)

Set global error status (effects all target databases)

Parameters:

sessionContext - Active SessionContext

error - Error number

message - Expanded error text (null to omit expanded message)

setAllComplete

public static void setAllComplete(SessionContext sessionContext)

Set all status value to "search complete" (effects all target databases)

Parameters:

sessionContext - Active SessionContext

updateHits

public static int updateHits(SessionContext sessionContext,
                             String target)

Update the hit count for this target (database)

Parameters:

sessionContext - Active SessionContext

target - Database name

Returns:

Updated hit count

getEstimatedHits

public static int getEstimatedHits(SessionContext sessionContext,
                                   String target)

Fetch the estimated hits for a specified target (database)

Parameters:

sessionContext - Active SessionContext

target - Database name

Returns:

Updated hit count

getAllRemainingHits

public static int getAllRemainingHits(SessionContext sessionContext)

Fetch the number of remaining hits (all targets)

Parameters:

sessionContext - Active SessionContext

Returns:

Remaining hits

getActiveTargetCount

public static int getActiveTargetCount(SessionContext sessionContext)

Fetch the number of active (searching) targets

Parameters:

sessionContext - Active SessionContext

Returns:

Count of active targets

isAsyncSearch

public static boolean isAsyncSearch(SessionContext sessionContext)

Is this an asynchronous search?

Parameters:

sessionContext - Active SessionContext

Returns:

true if so

clearAsyncSearch

public static void clearAsyncSearch(SessionContext sessionContext)

Clear the asynchronous search flag

Parameters:

sessionContext - Active SessionContext

setAsyncSearch

public static void setAsyncSearch(SessionContext sessionContext)

Indicate an asynchronous search

Parameters:

sessionContext - Active SessionContext

clearAsyncInit

public static void clearAsyncInit(SessionContext sessionContext)

Clear the asynchronous initialization flag

Parameters:

sessionContext - Active SessionContext

setAsyncInit

public static void setAsyncInit(SessionContext sessionContext)

Indicate asynchronous initialization in progress

Parameters:

sessionContext - Active SessionContext

doingAsyncInit

public static boolean doingAsyncInit(SessionContext sessionContext)

Still performing asynchronous init?

Parameters:

sessionContext - Active SessionContext

Returns:

true if so