gov.nasa.pds.tools.validate.rule

Class AbstractValidationRule

java.lang.Object

gov.nasa.pds.tools.validate.rule.AbstractValidationRule

All Implemented Interfaces:

ValidationRule, org.apache.commons.chain.Command

Direct Known Subclasses:

AbstractFindTargets, BundleContentsNamingRule, BundleReferentialIntegrityRule, CollectionInBundleRule, CollectionReferentialIntegrityRule, FileAndDirectoryNamingRule, FileReferenceValidationRule, FindUnreferencedFiles, FindUnreferencedIdentifiers, LabelInFolderRule, LabelValidationRule, MarkSubdirectoriesReferenced, RegisterLabelIdentifiers, RegisterTargetReferences, RegisterTargets, SubdirectoryNamingRule, SubDirectoryRule, TableDataContentValidationRule, TableFieldDefinitionRule, UTF8ByteStreamRule, VolumeValidationRule

public abstract class AbstractValidationRule
extends Object
implements ValidationRule

The base class for validation rules. To implement validation rules, write the validation tests as public void methods and annotate them with the ValidationTest annotation. The tests will be invoked in they appear within the class.

Field Summary

Fields inherited from interface org.apache.commons.chain.Command

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

Constructors

Constructor and Description
AbstractValidationRule()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute(org.apache.commons.chain.Context theContext) Invokes the validation tests in the rule in their declared order.
String	getCaption() Gets a caption describing the rule.
protected RuleContext	getChildContext(URL child) Gets a rule context for validating a file or directory inside the current target.
protected RuleContext	getContext() Gets the rule context.
protected ProblemListener	getListener() Gets the problem listener for this validation rule.
protected String	getParentTarget() Gets the parent target location for this rule.
protected TargetRegistrar	getRegistrar() Gets the target registrar for this validation rule.
protected URL	getTarget() Gets the target of this rule.
abstract boolean	isApplicable(String location) Tests whether a rule is applicable to a target location.
protected void	reportError(ProblemDefinition defn, URL targetUrl, int lineNumber, int columnNumber) Reports an error to the validation listener.
protected void	reportError(ProblemDefinition defn, URL target, int lineNumber, int columnNumber, String message) Reports an error to the validation listener with a custom message.
void	setCaption(String caption) Sets the caption for this chain.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractValidationRule

public AbstractValidationRule()

Method Detail

execute

public boolean execute(org.apache.commons.chain.Context theContext)
                throws Exception

Invokes the validation tests in the rule in their declared order. Validation tests are denoted by public methods annotated with the ValidationTest annotation.

Specified by:

execute in interface org.apache.commons.chain.Command

Parameters:

theContext - the context for the rule, which must be a RuleContext

Throws:

{@inheritDoc}

Exception

getContext

protected RuleContext getContext()

Gets the rule context.

Returns:

the context

getChildContext

protected RuleContext getChildContext(URL child)
                               throws MalformedURLException,
                                      URISyntaxException

Gets a rule context for validating a file or directory inside the current target.

Parameters:

child - the child target

Returns:

a new rule context for validating the child

Throws:

URISyntaxException

MalformedURLException

getTarget

protected URL getTarget()

Gets the target of this rule.

Returns:

the validation target

getParentTarget

protected String getParentTarget()

Gets the parent target location for this rule.

Returns:

the parent target location, or null if no parent

getListener

protected ProblemListener getListener()

Gets the problem listener for this validation rule.

Returns:

the problem listener

getRegistrar

protected TargetRegistrar getRegistrar()

Gets the target registrar for this validation rule.

Returns:

the target registrar

reportError

protected void reportError(ProblemDefinition defn,
               URL targetUrl,
               int lineNumber,
               int columnNumber)

Reports an error to the validation listener.

Parameters:

defn - the problem definition

targetFile - the validation target file containing the problem

lineNumber - the line number, or -1 if no line number applies

columnNumber - the column number, or -1 if no column number applies

reportError

protected void reportError(ProblemDefinition defn,
               URL target,
               int lineNumber,
               int columnNumber,
               String message)

Reports an error to the validation listener with a custom message.

Parameters:

defn - the problem definition

target - the validation target containing the problem

lineNumber - the line number, or -1 if no line number applies

columnNumber - the column number, or -1 if no column number applies

message - the error message to report

isApplicable

public abstract boolean isApplicable(String location)

Tests whether a rule is applicable to a target location.

Specified by:

isApplicable in interface ValidationRule

Parameters:

location - the target location

Returns:

true, if the rule is applicable to the target, false otherwise

getCaption

public final String getCaption()

Description copied from interface: ValidationRule

Gets a caption describing the rule.

Specified by:

getCaption in interface ValidationRule

Returns:

a string caption

setCaption

public final void setCaption(String caption)

Sets the caption for this chain.

Parameters:

caption - the new caption string