gov.nasa.pds.tools.validate.rule

Class RuleContext

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.apache.commons.chain.impl.ContextBase

gov.nasa.pds.tools.validate.rule.RuleContext

All Implemented Interfaces:

Serializable, Cloneable, Map, org.apache.commons.chain.Context

public class RuleContext
extends org.apache.commons.chain.impl.ContextBase

Implements a type-safe context for using validation rules in commands and chains.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECKSUM_MANIFEST_KEY The key used to retrieve a hash map containing the checksum values from a given checksum manifest.
static String	CRAWLER_KEY The key used to retrieve the crawler.
static String	FILE_FILTERS The key used to set file name filters.
static String	FORCE_LABEL_SCHEMA_VALIDATION The key used to indicate that declared schema and Schematron files in a label should be validated before the label is validate.
static String	LISTENER_KEY The key used to retrieve the definition listener from the execution context.
static String	LOCATION_VALIDATOR_KEY The key used to retrieve the top-level validator for getting singleton utilities.
static String	PARENT_TARGET_KEY The key used to retrieve the parent target from the context.
static String	RECURSIVE_VALIDATION The key used to set whether to validate recursively.
static String	REGISTRAR_KEY The key used to retrieve the validation registrar from the execution context.
static String	RULE_KEY
static String	RULE_MANAGER_KEY The key used to retrieve the rule manager from the context.
static String	TARGET_KEY The key used to retrieve the current validation target from the execution context.

Constructor Summary

Constructors

Constructor and Description
RuleContext()

Method Summary

Methods

Modifier and Type	Method and Description
Map<URL,String>	getChecksumManifest()
<T> T	getContextValue(String key, Class<T> clazz) Gets a value from the context in a type-safe manner.
Crawler	getCrawler()
WildcardOSFilter	getFileFilters()
String	getParentTarget() Gets the parent target location.
ProblemListener	getProblemListener()
LocationValidator	getRootValidator() Gets the top-level validator for getting singleton utilities, such as the label validator.
ValidationRule	getRule()
ValidationRuleManager	getRuleManager() Gets the rule manager used to find other rules to apply.
URL	getTarget()
TargetRegistrar	getTargetRegistrar()
boolean	isForceLabelSchemaValidation() Tests whether to force validation of schemas and Schematrons defined in a label file.
boolean	isRecursive()
boolean	isRootTarget() Tests whether this is the root target for the validation.
<T> void	putContextValue(String key, T value) Puts a value into the context in a type-safe manner.
void	setChecksumManifest(Map<URL,String> manifest)
void	setCrawler(Crawler crawler)
void	setFileFilters(List<String> filters)
void	setFileFilters(WildcardOSFilter filter)
void	setForceLabelSchemaValidation(boolean force) Sets whether to force schema and Schematron validation defined in a label.
void	setParentTarget(String parentLocation) Sets the parent target location.
void	setProblemListener(ProblemListener listener)
void	setRecursive(boolean isRecursive)
void	setRootTarget(boolean flag) Sets whether this is the root target for the validation.
void	setRootValidator(LocationValidator validator) Sets the top-level validator.
void	setRule(ValidationRule rule)
void	setRuleManager(ValidationRuleManager ruleManager) Sets the rule manager to use for finding new rules.
void	setTarget(URL target)
void	setTargetRegistrar(TargetRegistrar registrar)

Methods inherited from class org.apache.commons.chain.impl.ContextBase

clear, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, values

Methods inherited from class java.util.HashMap

clone, containsKey, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, equals, hashCode, size

Field Detail

LOCATION_VALIDATOR_KEY

public static final String LOCATION_VALIDATOR_KEY

The key used to retrieve the top-level validator for getting singleton utilities.

See Also:

Constant Field Values

FORCE_LABEL_SCHEMA_VALIDATION

public static final String FORCE_LABEL_SCHEMA_VALIDATION

The key used to indicate that declared schema and Schematron files in a label should be validated before the label is validate.

See Also:

Constant Field Values

RECURSIVE_VALIDATION

public static final String RECURSIVE_VALIDATION

The key used to set whether to validate recursively.

See Also:

Constant Field Values

FILE_FILTERS

public static final String FILE_FILTERS

The key used to set file name filters.

See Also:

Constant Field Values

TARGET_KEY

public static final String TARGET_KEY

The key used to retrieve the current validation target from the execution context.

See Also:

Constant Field Values

LISTENER_KEY

public static final String LISTENER_KEY

The key used to retrieve the definition listener from the execution context.

See Also:

Constant Field Values

REGISTRAR_KEY

public static final String REGISTRAR_KEY

The key used to retrieve the validation registrar from the execution context.

See Also:

Constant Field Values

RULE_MANAGER_KEY

public static final String RULE_MANAGER_KEY

The key used to retrieve the rule manager from the context.

See Also:

Constant Field Values

RULE_KEY

public static final String RULE_KEY

See Also:

Constant Field Values

PARENT_TARGET_KEY

public static final String PARENT_TARGET_KEY

The key used to retrieve the parent target from the context.

See Also:

Constant Field Values

CRAWLER_KEY

public static final String CRAWLER_KEY

The key used to retrieve the crawler.

See Also:

Constant Field Values

CHECKSUM_MANIFEST_KEY

public static final String CHECKSUM_MANIFEST_KEY

The key used to retrieve a hash map containing the checksum values from a given checksum manifest.

See Also:

Constant Field Values

Constructor Detail

RuleContext

public RuleContext()

Method Detail

getContextValue

public <T> T getContextValue(String key,
                    Class<T> clazz)

Gets a value from the context in a type-safe manner.

Parameters:

key - the key

clazz - the expected class

Returns:

the value, or null if there is no value with that key

putContextValue

public <T> void putContextValue(String key,
                       T value)

Puts a value into the context in a type-safe manner.

Parameters:

key - the key

value - the value

getTarget

public URL getTarget()

setTarget

public void setTarget(URL target)
               throws MalformedURLException,
                      URISyntaxException

Throws:

MalformedURLException

URISyntaxException

getProblemListener

public ProblemListener getProblemListener()

setProblemListener

public void setProblemListener(ProblemListener listener)

getTargetRegistrar

public TargetRegistrar getTargetRegistrar()

setTargetRegistrar

public void setTargetRegistrar(TargetRegistrar registrar)

getRuleManager

public ValidationRuleManager getRuleManager()

Gets the rule manager used to find other rules to apply.

Returns:

the rule manager

getRule

public ValidationRule getRule()

setRuleManager

public void setRuleManager(ValidationRuleManager ruleManager)

Sets the rule manager to use for finding new rules.

Parameters:

ruleManager - the rule manager

setRule

public void setRule(ValidationRule rule)

getParentTarget

public String getParentTarget()

Gets the parent target location.

Returns:

the parent target location, or null if there is no parent target

setParentTarget

public void setParentTarget(String parentLocation)

Sets the parent target location.

Parameters:

parent - the parent target location

isRootTarget

public boolean isRootTarget()

Tests whether this is the root target for the validation.

Returns:

true, if this context is for the root target

setRootTarget

public void setRootTarget(boolean flag)

Sets whether this is the root target for the validation.

Parameters:

flag - true, if this context is for the root target

getRootValidator

public LocationValidator getRootValidator()

Gets the top-level validator for getting singleton utilities, such as the label validator.

Returns:

the top-level validator

setRootValidator

public void setRootValidator(LocationValidator validator)

Sets the top-level validator.

Parameters:

validator - the top-level validator

isRecursive

public boolean isRecursive()

setRecursive

public void setRecursive(boolean isRecursive)

getFileFilters

public WildcardOSFilter getFileFilters()

setFileFilters

public void setFileFilters(List<String> filters)

setFileFilters

public void setFileFilters(WildcardOSFilter filter)

isForceLabelSchemaValidation

public boolean isForceLabelSchemaValidation()

Tests whether to force validation of schemas and Schematrons defined in a label file.

Returns:

true, if declared schema and Schematron files should be validated

setForceLabelSchemaValidation

public void setForceLabelSchemaValidation(boolean force)

Sets whether to force schema and Schematron validation defined in a label.

Parameters:

force - true, if declared schema and Schematron files should be validated

getCrawler

public Crawler getCrawler()

setCrawler

public void setCrawler(Crawler crawler)

setChecksumManifest

public void setChecksumManifest(Map<URL,String> manifest)

getChecksumManifest

public Map<URL,String> getChecksumManifest()