A C D E F G H I L M N P Q R S T U V W

A

add(ValidationRecord) - Method in class gov.nasa.pds.vtool.validate.ValidationRecord
Record the results of a label validation.
add(String, int, int) - Method in class gov.nasa.pds.vtool.validate.ValidationRecord
Record the results of a label validation.
ALIAS - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
ALIASKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
APPLICATION_ERROR - Static variable in interface gov.nasa.pds.vtool.status.ExitStatusType
 
ApplicationException - Exception in gov.nasa.pds.vtool
 
ApplicationException(String) - Constructor for exception gov.nasa.pds.vtool.ApplicationException
 

C

closehandle() - Method in class gov.nasa.pds.vtool.VTool
Closes the handlers that were set for the logger.

D

DICTKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 

E

ERRORS_FOUND - Static variable in interface gov.nasa.pds.vtool.status.ExitStatusType
 
ExitStatus - Class in gov.nasa.pds.vtool.status
Exit Status values 0 = Success 1 = Application error 2 = System error 32 = One or more files skipped the validation run 64 = One or more validation warnings encountered during the validation run 96 = One or more files skipped and validation warnings encountered during the validation run 128 = One or more validation errors encountered during the validation run 160 = One or more files skipped and validation errors encountered during the validation run 192 = One or more validation warnings and errors encountered during the validation run 224 = One or more files skipped, validation warnings and errors encountered during the validation run
ExitStatus() - Constructor for class gov.nasa.pds.vtool.status.ExitStatus
Constructor
ExitStatusType - Interface in gov.nasa.pds.vtool.status
Values to indicate the success/failure of a VTool run.

F

FOLLOW - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
FOLLOWKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
FORCEKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 

G

getFilesFailed() - Method in class gov.nasa.pds.vtool.validate.ValidationRecord
 
getFilesPassed() - Method in class gov.nasa.pds.vtool.validate.ValidationRecord
 
getFilesSkipped() - Method in class gov.nasa.pds.vtool.validate.ValidationRecord
 
getInstance() - Static method in class gov.nasa.pds.vtool.handler.HandlerFactory
 
getInstance() - Static method in class gov.nasa.pds.vtool.validate.ValidatorFactory
 
getStatus(String) - Method in class gov.nasa.pds.vtool.status.ExitStatus
Get the status
getTotalErrors() - Method in class gov.nasa.pds.vtool.validate.ValidationRecord
 
getTotalWarnings() - Method in class gov.nasa.pds.vtool.validate.ValidationRecord
 
gov.nasa.pds.vtool - package gov.nasa.pds.vtool
This package provides the main class for executing the Validation Tool.
gov.nasa.pds.vtool.config - package gov.nasa.pds.vtool.config
This package provides an interface to the keywords for the Validation Tool configuration file.
gov.nasa.pds.vtool.flags - package gov.nasa.pds.vtool.flags
This package provides an interface for the command-line option flags and flag descriptions.
gov.nasa.pds.vtool.handler - package gov.nasa.pds.vtool.handler
 
gov.nasa.pds.vtool.status - package gov.nasa.pds.vtool.status
This package allows VTool to determine an exit value to give back to the user.
gov.nasa.pds.vtool.validate - package gov.nasa.pds.vtool.validate
This package contains classes that will perform the validation step for the Validation Tool.

H

HandlerFactory - Class in gov.nasa.pds.vtool.handler
 
hasErrors() - Method in class gov.nasa.pds.vtool.validate.ValidationRecord
Determines if any errors are present in the record.
hasWarnings() - Method in class gov.nasa.pds.vtool.validate.ValidationRecord
Determines if any warnings are present in the record.

I

IGNOREDIR - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
IGNOREDIRKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
IGNOREFILE - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
IGNOREFILEKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
INCLUDES - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
INCLUDESKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 

L

LabelValidator - Class in gov.nasa.pds.vtool.validate
Class to parse a label.
LabelValidator(LabelParser) - Constructor for class gov.nasa.pds.vtool.validate.LabelValidator
 
LOCAL - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
LOG - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
LOGKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
logMessage(Level, String) - Method in class gov.nasa.pds.vtool.VTool
Routine to store a message into the logger.
logMessage(Level, String, String) - Method in class gov.nasa.pds.vtool.VTool
Routine to store a message into the logger.
logRptHeader() - Method in class gov.nasa.pds.vtool.VTool
Logs report header information such as version of the tool, execution time, and flag settings.

M

main(String[]) - Static method in class gov.nasa.pds.vtool.VTool
Implementation to perform automated PDS validation.

N

newInstance(File, String, String) - Method in class gov.nasa.pds.vtool.handler.HandlerFactory
Get an instance of a Handler object for the human-readable report.
newInstance(LabelParser, URL, boolean) - Method in class gov.nasa.pds.vtool.validate.ValidatorFactory
 

P

parseLine(String[]) - Method in class gov.nasa.pds.vtool.VTool
Parses the VTool command-line.
PARTIAL - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
PartialLabelValidator - Class in gov.nasa.pds.vtool.validate
Class to parse a partial label.
PartialLabelValidator(LabelParser) - Constructor for class gov.nasa.pds.vtool.validate.PartialLabelValidator
 
processTarget(String, boolean) - Method in class gov.nasa.pds.vtool.VTool
Processes a target.
PROGRESS - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
PROGRESSKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 

Q

queryCmdLine(CommandLine) - Method in class gov.nasa.pds.vtool.VTool
Queries the VTool command-line.

R

readConfigFile(URL) - Method in class gov.nasa.pds.vtool.VTool
Reads a configuration file to set the default behaviors for VTool.
readDictionaries(List) - Method in class gov.nasa.pds.vtool.VTool
Parse the dictionary files.
RECURSEKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
REGEXP - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
REGEXPKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
REPORTKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
RPTSTYLE - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 

S

setAlias(boolean) - Method in class gov.nasa.pds.vtool.VTool
Set aliasing flag.
setDictionaries(List) - Method in class gov.nasa.pds.vtool.VTool
Set the dictionary file names passed into VTool .
setFollowPtrs(boolean) - Method in class gov.nasa.pds.vtool.VTool
Set the flag that determines whether to follow pointers found in a label.
setForcePartial(boolean) - Method in class gov.nasa.pds.vtool.VTool
Set the flag that determines whether to validate standalone label.
setIncludePaths(List) - Method in class gov.nasa.pds.vtool.VTool
Set the paths to search for files referenced by pointers.
setLogFile(File) - Method in class gov.nasa.pds.vtool.VTool
Set the file name for the machine-readable log.
setNoDirs(List) - Method in class gov.nasa.pds.vtool.VTool
Set the flag to ignore specified directories.
setNoFiles(List) - Method in class gov.nasa.pds.vtool.VTool
Set the flag to ignore specified files.
setProgress(boolean) - Method in class gov.nasa.pds.vtool.VTool
Set the progress reporting flag.
setRecursive(boolean) - Method in class gov.nasa.pds.vtool.VTool
Set the recursive flag.
setRegexp(List) - Method in class gov.nasa.pds.vtool.VTool
Set the patterns flag.
setRptFile(File) - Method in class gov.nasa.pds.vtool.VTool
Set the file for the human-readable report.
setRptStyle(String) - Method in class gov.nasa.pds.vtool.VTool
Set the output style for the report.
setShowLog(boolean) - Method in class gov.nasa.pds.vtool.VTool
Set the flag to write the log to standard out.
setStatus(int) - Method in class gov.nasa.pds.vtool.status.ExitStatus
Set the status
setStatus(ValidationRecord) - Method in class gov.nasa.pds.vtool.status.ExitStatus
Set the status
setTargets(List) - Method in class gov.nasa.pds.vtool.VTool
Set the targets flag.
setupLogger() - Method in class gov.nasa.pds.vtool.VTool
Configures the logger appropriately.
setVerbose(short) - Method in class gov.nasa.pds.vtool.VTool
Set the verbosity level and above to include in the reporting.
showHelp() - Method in class gov.nasa.pds.vtool.VTool
Display VTool usage and help information
SHOWLOGKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
showProgress(URL) - Method in class gov.nasa.pds.vtool.VTool
Prints out the current directory being validated and represents each file being validated by an asterisk.
showVersion() - Method in class gov.nasa.pds.vtool.VTool
Show the version and disclaimer notice for VTool.
SKIPPED_FILES - Static variable in interface gov.nasa.pds.vtool.status.ExitStatusType
 
STYLEKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
SUCCESS - Static variable in interface gov.nasa.pds.vtool.status.ExitStatusType
 
SYSTEM_ERROR - Static variable in interface gov.nasa.pds.vtool.status.ExitStatusType
 
SystemException - Exception in gov.nasa.pds.vtool
 
SystemException(String) - Constructor for exception gov.nasa.pds.vtool.SystemException
 

T

TARGET - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
TARGETKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 

U

UnknownHandlerConfigurationException - Exception in gov.nasa.pds.vtool.handler
 
UnknownHandlerConfigurationException(String) - Constructor for exception gov.nasa.pds.vtool.handler.UnknownHandlerConfigurationException
 
UnknownLabelStatusException - Exception in gov.nasa.pds.vtool.validate
 
UnknownLabelStatusException(String) - Constructor for exception gov.nasa.pds.vtool.validate.UnknownLabelStatusException
 

V

validate(URL) - Method in class gov.nasa.pds.vtool.validate.LabelValidator
 
validate(URL, Dictionary) - Method in class gov.nasa.pds.vtool.validate.LabelValidator
 
validate(URL) - Method in class gov.nasa.pds.vtool.validate.PartialLabelValidator
 
validate(URL, Dictionary) - Method in class gov.nasa.pds.vtool.validate.PartialLabelValidator
 
validate(URL) - Method in interface gov.nasa.pds.vtool.validate.Validator
 
validate(URL, Dictionary) - Method in interface gov.nasa.pds.vtool.validate.Validator
 
validateLabel(URL, Dictionary) - Method in class gov.nasa.pds.vtool.VTool
Validate a label file.
validateLabels(List) - Method in class gov.nasa.pds.vtool.VTool
Validate labels, performing only syntactic validation.
validateLabels(List, Dictionary) - Method in class gov.nasa.pds.vtool.VTool
Validate labels, performing both syntactic and semantic validation.
ValidationRecord - Class in gov.nasa.pds.vtool.validate
Class that can be used to save the results of a validation run.
ValidationRecord() - Constructor for class gov.nasa.pds.vtool.validate.ValidationRecord
Constructor
ValidationRecord(String, int, int) - Constructor for class gov.nasa.pds.vtool.validate.ValidationRecord
Constructor
Validator - Interface in gov.nasa.pds.vtool.validate
Interface for parsing a label.
ValidatorException - Exception in gov.nasa.pds.vtool.validate
 
ValidatorException(String) - Constructor for exception gov.nasa.pds.vtool.validate.ValidatorException
 
ValidatorFactory - Class in gov.nasa.pds.vtool.validate
Class to be used to determine what type of label parser to use (either a partial or full label).
VERBOSE - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
VERBOSEKEY - Static variable in interface gov.nasa.pds.vtool.config.VToolConfigKeys
 
VTool - Class in gov.nasa.pds.vtool
Class to perform automated validation to determine if a given data product is PDS compliant.
VTool() - Constructor for class gov.nasa.pds.vtool.VTool
Default constructor.
VToolConfigKeys - Interface in gov.nasa.pds.vtool.config
Contains the valid keys for a VTool configuration file.
VToolFlags - Interface in gov.nasa.pds.vtool.flags
Contains command-line option flags available to VTool.

W

WARNINGS_FOUND - Static variable in interface gov.nasa.pds.vtool.status.ExitStatusType
 
WHATIS_ALIAS - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_DICT - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_FOLLOW - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_IGNOREDIR - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_IGNOREFILE - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_INCLUDES - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_LOCAL - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_LOG - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_PARTIAL - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_PROGRESS - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_REGEXP - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_REPORT - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_RPTSTYLE - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_TARGET - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 
WHATIS_VERBOSE - Static variable in interface gov.nasa.pds.vtool.flags.VToolFlags
 

A C D E F G H I L M N P Q R S T U V W

Copyright © 2005-2009 NASA Jet Propulsion Laboratory, California Institute of Technology. All Rights Reserved.