gov.nasa.pds.tools.validate

Class ListenerExceptionPropagator

java.lang.Object

gov.nasa.pds.tools.validate.ListenerExceptionPropagator

All Implemented Interfaces:

ProblemListener

public class ListenerExceptionPropagator
extends Object
implements ProblemListener

Listener class intended to propagate the problems to a handler for further processing.

Author:

mrose, mcayanan

Constructor Summary

Constructors

Constructor and Description
ListenerExceptionPropagator(ValidateExceptionHandler handler)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLocation(String location) Adds a location to the listener.
void	addProblem(LabelException exception) Indicates another problem during the validation.
void	addProblem(ValidationProblem problem) Indicates another problem during the validation.
int	getErrorCount() Gets the number of error problems encountered.
int	getInfoCount() Gets the number of informational problems encountered.
Collection<ValidationProblem>	getProblemsForLocation(String location, boolean includeChildren) Gets a collection of problems for a given location.
ExceptionType	getSeverity(String location, boolean includeChildren) Gets the maximum severity of problems related to a location.
int	getWarningCount() Gets the number of warning problems encountered.
boolean	hasProblems(String location, boolean includeChildren) Tests whether a target has had problems reported.
void	printHeader(String title)
void	record(String location)

Methods inherited from class java.lang.Object

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

Constructor Detail

ListenerExceptionPropagator

public ListenerExceptionPropagator(ValidateExceptionHandler handler)

Method Detail

addProblem

public void addProblem(ValidationProblem problem)

Description copied from interface: ProblemListener

Indicates another problem during the validation.

Specified by:

addProblem in interface ProblemListener

Parameters:

problem - the validation problem encountered

addProblem

public void addProblem(LabelException exception)

Description copied from interface: ProblemListener

Indicates another problem during the validation.

Specified by:

addProblem in interface ProblemListener

Parameters:

exception - the label exception encountered.

getErrorCount

public int getErrorCount()

Description copied from interface: ProblemListener

Gets the number of error problems encountered.

Specified by:

getErrorCount in interface ProblemListener

Returns:

the error count

getWarningCount

public int getWarningCount()

Description copied from interface: ProblemListener

Gets the number of warning problems encountered.

Specified by:

getWarningCount in interface ProblemListener

Returns:

the warning count

getInfoCount

public int getInfoCount()

Description copied from interface: ProblemListener

Gets the number of informational problems encountered.

Specified by:

getInfoCount in interface ProblemListener

Returns:

the info count

hasProblems

public boolean hasProblems(String location,
                  boolean includeChildren)

Description copied from interface: ProblemListener

Tests whether a target has had problems reported.

Specified by:

hasProblems in interface ProblemListener

Parameters:

location - the target location

includeChildren - true, if problems for child locations should be included

Returns:

true, if problems have been reported

getSeverity

public ExceptionType getSeverity(String location,
                        boolean includeChildren)

Description copied from interface: ProblemListener

Gets the maximum severity of problems related to a location.

Specified by:

getSeverity in interface ProblemListener

Parameters:

location - the target location

includeChildren - true, if problems in children of the target should be included

Returns:

the maximum problem severity

getProblemsForLocation

public Collection<ValidationProblem> getProblemsForLocation(String location,
                                                   boolean includeChildren)

Description copied from interface: ProblemListener

Gets a collection of problems for a given location.

Specified by:

getProblemsForLocation in interface ProblemListener

Parameters:

location - the target location

includeChildren - true, if problems for child locations should be included

Returns:

a collection of problems

addLocation

public void addLocation(String location)

Description copied from interface: ProblemListener

Adds a location to the listener.

Specified by:

addLocation in interface ProblemListener

Parameters:

location - the location of the label being validated.

record

public void record(String location)

printHeader

public void printHeader(String title)