org.safs.tools.counters

Class SAFSCOUNTERS

java.lang.Object

org.safs.tools.counters.SAFSCOUNTERS

All Implemented Interfaces:

ConfigurableToolsInterface, CountersInterface, GenericToolsInterface

public class SAFSCOUNTERS
extends java.lang.Object
implements ConfigurableToolsInterface, CountersInterface

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable	counters
protected DriverInterface	driver
protected boolean	suspended TRUE if ALL counting is currently suspended.

Fields inherited from interface org.safs.tools.counters.CountersInterface

ALL_STATUS_INFO_MODE, STATUS_GENERAL_FAILURE, STATUS_GENERAL_PASS, STATUS_GENERAL_WARNING, STATUS_IO_FAILURE, STATUS_SKIPPED_RECORD, STATUS_TEST_FAILURE, STATUS_TEST_IO_FAILURE, STATUS_TEST_PASS, STATUS_TEST_WARNING, STEP_TESTS_ONLY_MODE

Constructor Summary

Constructors

Constructor and Description
SAFSCOUNTERS() Constructor for SAFSCOUNTERS

Method Summary

Modifier and Type	Method and Description
void	clearCounter(UniqueIDInterface counter) Clear all counts on the specified counter.
void	copyCounter(UniqueIDInterface from_counter, UniqueIDInterface to_counter) Copy the from_counter counts to the specified to_counter.
void	copyStatus(StatusInterface from_status, UniqueIDInterface to_counter) Copy the from_status counts to the specified to_counter.
void	deleteCounter(UniqueIDInterface counter) Delete a counter out of storage.
void	diffCounters(UniqueIDInterface sub_counter, UniqueIDInterface from_counter) Substract the sub_counter counts from the specified from_counter.
void	diffStatus(StatusInterface sub_status, UniqueIDInterface from_counter) Substract the sub_status counts from the specified from_counter.
CoreInterface	getCoreInterface() Retrieve the instance of the CoreInterface used to communicate with the framework.
long	getCounterMode(UniqueIDInterface counter) Get a counter's mode.
CountStatusInterface	getStatus(UniqueIDInterface counter) Get the status counts from the specified counter.
protected java.lang.String	getUpperCaseKey(UniqueIDInterface counter) internal convenience routine
void	incrementAllCounters(UniqueCounterInterface testlevel, long status) Increment the Total Records and the appropriate status count for ALL counters.
long	incrementGeneralFailures(UniqueCounterInterface counter) Increment the Total Records and General Failures count for the counter.
long	incrementGeneralPasses(UniqueCounterInterface counter) Increment the Total Records and General Passes count for the counter.
long	incrementGeneralWarnings(UniqueCounterInterface counter) Increment the Total Records and General Warnings count for the counter.
long	incrementIOFailures(UniqueCounterInterface counter) Increment the Total Records and IO Failure Records count for the counter.
long	incrementSkippedRecords(UniqueCounterInterface counter) Increment the Total Records and Skipped Records count for the counter.
long	incrementTestFailures(UniqueCounterInterface counter) Increment the Total Records and Test Failures count for the counter.
long	incrementTestIOFailures(UniqueCounterInterface counter) Increment the Total Records, Test Failures, and IO Failure Records count for the counter.
long	incrementTestPasses(UniqueCounterInterface counter) Increment the Total Records and Test Passes count for the counter.
long	incrementTestWarnings(UniqueCounterInterface counter) Increment the Total Records and Test Warnings count for the counter.
void	initCounter(UniqueIDInterface counter) Initialize/Start a new counter.
boolean	isToolRunning() TRUE if the underlying tool is running.
void	launchInterface(java.lang.Object driver) Expects a DriverInterface object for initialization.
void	reset() Reset or clear any cached information in the underlying tool or service.
void	resumeAllCounting() Resumes counting suspended by suspendAllCounting.
void	resumeCounter(UniqueIDInterface counter) Resume counting on a single counter suspended by suspendCounter.
void	setCounterMode(UniqueIDInterface counter, long mode) Set a counter's mode.
void	shutdown() Shutdown the underlying tool or service.
void	sumCounters(UniqueIDInterface add_counter, UniqueIDInterface to_counter) Add the add_counter counts to the specified to_counter.
void	sumStatus(StatusInterface add_status, UniqueIDInterface to_counter) Add the add_status counts to the specified to_counter.
void	suspendAllCounting() Suspends counting on ALL counters until counting is resumed with resumeAllCounting.
void	suspendCounter(UniqueIDInterface counter) Suspend counting on a specific counter.

Methods inherited from class java.lang.Object

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

Field Detail

suspended

protected boolean suspended

TRUE if ALL counting is currently suspended.

driver

protected DriverInterface driver

counters

protected java.util.Hashtable counters

Constructor Detail

SAFSCOUNTERS

public SAFSCOUNTERS()

Constructor for SAFSCOUNTERS

Method Detail

launchInterface

public void launchInterface(java.lang.Object driver)

Expects a DriverInterface object for initialization.

Specified by:

launchInterface in interface ConfigurableToolsInterface

Parameters:

driver - can be whatever the final implementation needs it to be. This might be a String with configuration information, the name of a class, or an instance of some object used to provide configuration assets.

See Also:

SimpleToolsInterface#launchInterface()

getUpperCaseKey

protected java.lang.String getUpperCaseKey(UniqueIDInterface counter)
                                    throws java.lang.IllegalArgumentException

internal convenience routine

Throws:

java.lang.IllegalArgumentException

initCounter

public void initCounter(UniqueIDInterface counter)
                 throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Initialize/Start a new counter.

Specified by:

initCounter in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.initCounter(UniqueIDInterface)

getStatus

public CountStatusInterface getStatus(UniqueIDInterface counter)

Description copied from interface: CountersInterface

Get the status counts from the specified counter.

Specified by:

getStatus in interface CountersInterface

See Also:

CountersInterface.getStatus(UniqueIDInterface)

copyCounter

public void copyCounter(UniqueIDInterface from_counter,
                        UniqueIDInterface to_counter)
                 throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Copy the from_counter counts to the specified to_counter.

Specified by:

copyCounter in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.copyCounter(UniqueIDInterface, UniqueIDInterface)

copyStatus

public void copyStatus(StatusInterface from_status,
                       UniqueIDInterface to_counter)
                throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Copy the from_status counts to the specified to_counter.

Specified by:

copyStatus in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.copyStatus(StatusInterface, UniqueIDInterface)

sumCounters

public void sumCounters(UniqueIDInterface add_counter,
                        UniqueIDInterface to_counter)
                 throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Add the add_counter counts to the specified to_counter. The results are stored in the to_counter.

Specified by:

sumCounters in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.sumCounters(UniqueIDInterface, UniqueIDInterface)

sumStatus

public void sumStatus(StatusInterface add_status,
                      UniqueIDInterface to_counter)
               throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Add the add_status counts to the specified to_counter. The results are stored in the to_counter.

Specified by:

sumStatus in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.sumStatus(StatusInterface, UniqueIDInterface)

diffCounters

public void diffCounters(UniqueIDInterface sub_counter,
                         UniqueIDInterface from_counter)
                  throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Substract the sub_counter counts from the specified from_counter. The results are stored in the from_counter.

Specified by:

diffCounters in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.diffCounters(UniqueIDInterface, UniqueIDInterface)

diffStatus

public void diffStatus(StatusInterface sub_status,
                       UniqueIDInterface from_counter)
                throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Substract the sub_status counts from the specified from_counter. The results are stored in the from_counter.

Specified by:

diffStatus in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.diffStatus(StatusInterface, UniqueIDInterface)

clearCounter

public void clearCounter(UniqueIDInterface counter)
                  throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Clear all counts on the specified counter.

Specified by:

clearCounter in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.clearCounter(UniqueIDInterface)

suspendCounter

public void suspendCounter(UniqueIDInterface counter)
                    throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Suspend counting on a specific counter.

Specified by:

suspendCounter in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.suspendCounter(UniqueIDInterface)

suspendAllCounting

public void suspendAllCounting()

Description copied from interface: CountersInterface

Suspends counting on ALL counters until counting is resumed with resumeAllCounting. Counters already suspended prior to this call will not resume counting due to a call to resumeAllCounting. You must use resumeCounter to resume counting for these.

Specified by:

suspendAllCounting in interface CountersInterface

See Also:

CountersInterface.suspendAllCounting()

resumeCounter

public void resumeCounter(UniqueIDInterface counter)
                   throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Resume counting on a single counter suspended by suspendCounter. Counting will not resume if suspendAllCounters is still "active". In this case, counting will resume once resumeAllCounting has been called.

Specified by:

resumeCounter in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.resumeCounter(UniqueIDInterface)

resumeAllCounting

public void resumeAllCounting()

Description copied from interface: CountersInterface

Resumes counting suspended by suspendAllCounting. Counters specifically suspended by suspendCounter are NOT resumed. You must use resumeCounter to resume counting for these.

Specified by:

resumeAllCounting in interface CountersInterface

See Also:

CountersInterface.resumeAllCounting()

incrementAllCounters

public void incrementAllCounters(UniqueCounterInterface testlevel,
                                 long status)

Description copied from interface: CountersInterface

Increment the Total Records and the appropriate status count for ALL counters.

Specified by:

incrementAllCounters in interface CountersInterface

See Also:

CountersInterface#incrementAllCounters(long)

incrementTestFailures

public long incrementTestFailures(UniqueCounterInterface counter)
                           throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Increment the Total Records and Test Failures count for the counter.

Specified by:

incrementTestFailures in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface#incrementTestFailures(UniqueIDInterface)

incrementTestWarnings

public long incrementTestWarnings(UniqueCounterInterface counter)
                           throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Increment the Total Records and Test Warnings count for the counter.

Specified by:

incrementTestWarnings in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface#incrementTestWarnings(UniqueIDInterface)

incrementTestPasses

public long incrementTestPasses(UniqueCounterInterface counter)
                         throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Increment the Total Records and Test Passes count for the counter.

Specified by:

incrementTestPasses in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface#incrementTestPasses(UniqueIDInterface)

incrementGeneralFailures

public long incrementGeneralFailures(UniqueCounterInterface counter)
                              throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Increment the Total Records and General Failures count for the counter.

Specified by:

incrementGeneralFailures in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface#incrementGeneralFailures(UniqueIDInterface)

incrementGeneralWarnings

public long incrementGeneralWarnings(UniqueCounterInterface counter)
                              throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Increment the Total Records and General Warnings count for the counter.

Specified by:

incrementGeneralWarnings in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface#incrementGeneralWarnings(UniqueIDInterface)

incrementGeneralPasses

public long incrementGeneralPasses(UniqueCounterInterface counter)
                            throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Increment the Total Records and General Passes count for the counter.

Specified by:

incrementGeneralPasses in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface#incrementGeneralPasses(UniqueIDInterface)

incrementIOFailures

public long incrementIOFailures(UniqueCounterInterface counter)
                         throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Increment the Total Records and IO Failure Records count for the counter.

Specified by:

incrementIOFailures in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface#incrementIOFailures(UniqueIDInterface)

incrementTestIOFailures

public long incrementTestIOFailures(UniqueCounterInterface counter)
                             throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Increment the Total Records, Test Failures, and IO Failure Records count for the counter.

Specified by:

incrementTestIOFailures in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface#incrementTestIOFailures(UniqueIDInterface)

incrementSkippedRecords

public long incrementSkippedRecords(UniqueCounterInterface counter)
                             throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Increment the Total Records and Skipped Records count for the counter.

Specified by:

incrementSkippedRecords in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface#incrementSkippedRecords(UniqueIDInterface)

deleteCounter

public void deleteCounter(UniqueIDInterface counter)
                   throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Delete a counter out of storage.

Specified by:

deleteCounter in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.deleteCounter(UniqueIDInterface)

isToolRunning

public boolean isToolRunning()

Description copied from interface: GenericToolsInterface

TRUE if the underlying tool is running. Typically called AFTER initialization attempts have been made.

Specified by:

isToolRunning in interface GenericToolsInterface

See Also:

GenericToolsInterface#isToolRunning()

reset

public void reset()

Description copied from interface: GenericToolsInterface

Reset or clear any cached information in the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is not actually running. If the tool is not running, then this should exit gracefully without adversely affecting anything.

Specified by:

reset in interface GenericToolsInterface

See Also:

GenericToolsInterface#reset()

shutdown

public void shutdown()

Description copied from interface: GenericToolsInterface

Shutdown the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is not actually running. If the tool is not running, then this should exit gracefully without adversely affecting anything.

Specified by:

shutdown in interface GenericToolsInterface

See Also:

GenericToolsInterface#shutdown()

setCounterMode

public void setCounterMode(UniqueIDInterface counter,
                           long mode)
                    throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Set a counter's mode. mode==1: count everything (default). mode==2: count only STEP level results.

Specified by:

setCounterMode in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.setCounterMode(UniqueIDInterface,long)

getCounterMode

public long getCounterMode(UniqueIDInterface counter)
                    throws java.lang.IllegalArgumentException

Description copied from interface: CountersInterface

Get a counter's mode. mode==1: count everything (default). mode==2: count only STEP level results.

Specified by:

getCounterMode in interface CountersInterface

Throws:

java.lang.IllegalArgumentException

See Also:

CountersInterface.getCounterMode(UniqueIDInterface)

getCoreInterface

public CoreInterface getCoreInterface()
                               throws java.lang.IllegalStateException

Description copied from interface: GenericToolsInterface

Retrieve the instance of the CoreInterface used to communicate with the framework.

Specified by:

getCoreInterface in interface GenericToolsInterface

Returns:

CoreInterface instance.

Throws:

java.lang.IllegalStateException - ALWAYS since there is no CoreInterface in this class.

See Also:

GenericToolsInterface#getCoreInterface()