nce.error

Class ErrorStack

java.lang.Object

nce.error.ErrorStack

public class ErrorStack
extends java.lang.Object

Stack of errors to be associated to a calculation model. Each model defines a prescribed set of errors that may occur during its computation. For each type of error there is track about if it occurred and how many times it happened. The error stack can be pushed to the global NCE error stack that is used to keep track of errors during a computation run.

Version:

20160212

Author:

Carlo Tegano

Constructor Summary

Constructors

Constructor and Description
ErrorStack()

Method Summary

Methods

Modifier and Type	Method and Description
int	countErrors() Counts the total number of errors in the stack
void	createErrorField(java.lang.String key, java.lang.String description) Creates a new error entry in the stack
boolean	hasErrors() Check if some error occurred in the stack
boolean	isOccured(java.lang.String key) Checks if the specified error occured
static boolean	isOccured(java.lang.String key, ErrorStack es) Checks if the specified error occured
void	print() Prints stack state to vout
void	printReport() Print a report on stack state to vout
void	printSummary() Print a summary of stack state to vout
void	resetOccurance() Reset state of all errors to "not occured"
void	setContestDescription(java.lang.String contestDescription)
void	setMainDescription(java.lang.String key, java.lang.String description)
void	setOccured(java.lang.String key) Sets the state of the specified error to "occured"
void	setOptDescription(java.lang.String key, double d)
void	setOptDescription(java.lang.String key, java.lang.String description)

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorStack

public ErrorStack()

Method Detail

createErrorField

public void createErrorField(java.lang.String key,
                    java.lang.String description)

Creates a new error entry in the stack

Parameters:

key - error id (usually equal to description)

description - error description

setOccured

public void setOccured(java.lang.String key)

Sets the state of the specified error to "occured"

Parameters:

key - error id

hasErrors

public boolean hasErrors()

Check if some error occurred in the stack

Returns:

true if at least one error occurred

setMainDescription

public void setMainDescription(java.lang.String key,
                      java.lang.String description)

setOptDescription

public void setOptDescription(java.lang.String key,
                     java.lang.String description)

setOptDescription

public void setOptDescription(java.lang.String key,
                     double d)

resetOccurance

public void resetOccurance()

Reset state of all errors to "not occured"

isOccured

public boolean isOccured(java.lang.String key)

Checks if the specified error occured

Parameters:

key - error id

Returns:

true if the error occured

isOccured

public static boolean isOccured(java.lang.String key,
                ErrorStack es)

Checks if the specified error occured

Parameters:

key - error id

es - error stack

Returns:

true if error occured

countErrors

public int countErrors()

Counts the total number of errors in the stack

Returns:

number of errors

print

public void print()

Prints stack state to vout

printReport

public void printReport()

Print a report on stack state to vout

printSummary

public void printSummary()

Print a summary of stack state to vout

setContestDescription

public void setContestDescription(java.lang.String contestDescription)