Package gov.nasa.pds.tools.label

Class LocationValidator

java.lang.Object

gov.nasa.pds.tools.label.LocationValidator

public class LocationValidator
extends Object

Implements a validator that validates a location (file or directory) against a validation rule set. If no rule set is specified, an appropriate default is chosen.

Constructor Summary

Constructors

Constructor	Description
LocationValidator(ExceptionType logLevel)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addValidator(DocumentValidator validator)
boolean	getCheckInbetweenFields()
LabelValidator	getLabelValidator()	Gets a singleton label validator.
void	setAllowUnlabeledFiles(boolean flag)
void	setCachedEntityResolver(CachedEntityResolver resolver)
void	setCachedLSResourceResolver(CachedLSResourceResolver resolver)
void	setCatalogs(List<String> catalogFiles)
void	setCheckData(boolean flag)
void	setCheckInbetweenFields(boolean flag)
void	setChecksumManifest(Map<URL,String> checksums)
void	setCompleteDescriptions(boolean b)
void	setContextMismatchAsWarn(boolean value)
void	setEveryN(int value)
void	setExtraTargetInContext(ArrayList<URL> alternateReferentialPaths)
void	setFileFilters(List<String> regExps)
void	setForce(boolean force)
void	setLabelExtension(String extension)
void	setLabelSchematrons(Map<String,String> labelSchematrons)
void	setLastDirectoryFlag(boolean flag)
void	setPDFErrorDir(String dir)
void	setRecurse(boolean traverse)
void	setRegisteredProducts(Map<String,List<ContextProductReference>> products)
void	setReport(Report report)
void	setRule(String ruleName)	Forces a validation rule to use for the target location.
void	setSchema(List<URL> schemaFiles)
void	setSchemaCheck(boolean value, boolean useLabelSchema)
void	setSchematronCheck(Boolean value, Boolean useLabelSchematron)
void	setSchematrons(List<String> schematrons)
void	setSkipProductValidation(boolean flag)
void	setSpotCheckData(int value)
void	setTargetRegistrar(TargetRegistrar registrar)	Sets the target registrar for the next validation.
void	setTaskManager(TaskManager manager)	Sets the task manager to use for running the validation tasks.
void	setValidateContext(boolean flag)
void	validate(ValidateProblemHandler problemHandler, URL url)	Validates a URL location with a given problem handler.
void	validate(File f)	Validates a location specified by a file or directory.
void	validate(URL target)

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationValidator

public LocationValidator(ExceptionType logLevel)
                  throws TransformerConfigurationException,
                         ParserConfigurationException

Creates a new instance.

Throws:

ParserConfigurationException - if a label validator cannot configure its parser

TransformerConfigurationException - if a label validator cannot configure its transformer

Method Detail

setReport

public void setReport(Report report)

getCheckInbetweenFields

public boolean getCheckInbetweenFields()

setCheckInbetweenFields

public void setCheckInbetweenFields(boolean flag)

validate

public void validate(File f)

Validates a location specified by a file or directory.

Parameters:

f - the file or directory to validate

validate

public void validate(URL target)

validate

public void validate(ValidateProblemHandler problemHandler,
                     URL url)

Validates a URL location with a given problem handler. This must be a URL that can be resolved to a file location.

Parameters:

problemHandler - the problem handler

url - the URL to validate

Throws:

URISyntaxException

setExtraTargetInContext

public void setExtraTargetInContext(ArrayList<URL> alternateReferentialPaths)

setTargetRegistrar

public void setTargetRegistrar(TargetRegistrar registrar)

Sets the target registrar for the next validation.

Parameters:

registrar - the new target registrar

setTaskManager

public void setTaskManager(TaskManager manager)

Sets the task manager to use for running the validation tasks.

Parameters:

manager - the new task manager

setSchema

public void setSchema(List<URL> schemaFiles)

setSchematrons

public void setSchematrons(List<String> schematrons)

setCachedEntityResolver

public void setCachedEntityResolver(CachedEntityResolver resolver)

setCachedLSResourceResolver

public void setCachedLSResourceResolver(CachedLSResourceResolver resolver)

setCatalogs

public void setCatalogs(List<String> catalogFiles)

setSchemaCheck

public void setSchemaCheck(boolean value,
                           boolean useLabelSchema)

setSchematronCheck

public void setSchematronCheck(Boolean value,
                               Boolean useLabelSchematron)

addValidator

public void addValidator(DocumentValidator validator)

setLabelSchematrons

public void setLabelSchematrons(Map<String,String> labelSchematrons)

setForce

public void setForce(boolean force)

setFileFilters

public void setFileFilters(List<String> regExps)

setRecurse

public void setRecurse(boolean traverse)

setChecksumManifest

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

setCheckData

public void setCheckData(boolean flag)

setRegisteredProducts

public void setRegisteredProducts(Map<String,List<ContextProductReference>> products)

getLabelValidator

public LabelValidator getLabelValidator()

Gets a singleton label validator.

Returns:

the label validator

setRule

public void setRule(String ruleName)

Forces a validation rule to use for the target location.

Parameters:

ruleName - the name of the rule

setEveryN

public void setEveryN(int value)

setContextMismatchAsWarn

public void setContextMismatchAsWarn(boolean value)

setCompleteDescriptions

public void setCompleteDescriptions(boolean b)

setSpotCheckData

public void setSpotCheckData(int value)

setPDFErrorDir

public void setPDFErrorDir(String dir)

setAllowUnlabeledFiles

public void setAllowUnlabeledFiles(boolean flag)

setValidateContext

public void setValidateContext(boolean flag)

setSkipProductValidation

public void setSkipProductValidation(boolean flag)

setLabelExtension

public void setLabelExtension(String extension)

setLastDirectoryFlag

public void setLastDirectoryFlag(boolean flag)