A B C D E F G H I L M O P R S T U V W X

A

AbstractFileSubtreeWalker<T> - Class in gov.nasa.pds.tools.validate.rule

Implements a class that walks a file system subtree and performs an operation on each file or directory found.

AbstractFileSubtreeWalker() - Constructor for class gov.nasa.pds.tools.validate.rule.AbstractFileSubtreeWalker

AbstractFindTargets - Class in gov.nasa.pds.tools.validate.rule

AbstractFindTargets() - Constructor for class gov.nasa.pds.tools.validate.rule.AbstractFindTargets

AbstractValidationChain - Class in gov.nasa.pds.tools.validate.rule

Implements a command chain that also implements ValidationRule, so we can distinguish command chains that can be used for data validation.

AbstractValidationChain() - Constructor for class gov.nasa.pds.tools.validate.rule.AbstractValidationChain

AbstractValidationRule - Class in gov.nasa.pds.tools.validate.rule

The base class for validation rules.

AbstractValidationRule() - Constructor for class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

addCachedEntities(Map<String, byte[]>) - Method in class gov.nasa.pds.tools.label.CachedEntityResolver

addCachedEntities(Map<String, byte[]>) - Method in class gov.nasa.pds.tools.label.CachedLSResourceResolver

addException(LabelException) - Method in class gov.nasa.pds.tools.label.ExceptionContainer

addException(LabelException) - Method in interface gov.nasa.pds.tools.label.ExceptionHandler

Reports an exception encountered during label validation.

addException(LabelException) - Method in class gov.nasa.pds.tools.validate.rule.pds4.ExceptionProcessor

addIdentifierReference(String, String) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Adds a reference to a target identifier.

addProblem(ValidationProblem) - Method in class gov.nasa.pds.tools.validate.ProblemContainer

addProblem(ValidationProblem) - Method in interface gov.nasa.pds.tools.validate.ProblemListener

Indicates another problem during the validation.

addTarget(String, TargetType, String) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Indicates that a target was discovered in the subtree being validated.

addTargetReference(String, String) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Adds a reference from a label to a target.

addValidator(ExternalValidator) - Method in class gov.nasa.pds.tools.label.LabelValidator

addValidator(DocumentValidator) - Method in class gov.nasa.pds.tools.label.LabelValidator

B

BootstrapResolver - Class in gov.nasa.pds.tools.label

BootstrapResolver() - Constructor for class gov.nasa.pds.tools.label.BootstrapResolver

BundleContentsNamingRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a validation rule ensuring that only valid files and directories appear in the root directory of a bundle.

BundleContentsNamingRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.BundleContentsNamingRule

BundleValidationRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a validation chain that validates PDS4 bundles.

BundleValidationRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.BundleValidationRule

C

CachedEntityResolver - Class in gov.nasa.pds.tools.label

Class that caches entities into memory.

CachedEntityResolver() - Constructor for class gov.nasa.pds.tools.label.CachedEntityResolver

Constructor.

CachedLSResourceResolver - Class in gov.nasa.pds.tools.label

Class to resolve resources.

CachedLSResourceResolver() - Constructor for class gov.nasa.pds.tools.label.CachedLSResourceResolver

Constructor.

CachedLSResourceResolver(ExceptionHandler) - Constructor for class gov.nasa.pds.tools.label.CachedLSResourceResolver

Constructor.

cancel(Task) - Method in interface gov.nasa.pds.tools.validate.task.TaskManager

Requests to cancel the task.

cancelRequested() - Method in interface gov.nasa.pds.tools.validate.task.TaskAdvisor

Tests whether the task is being asked to cancel early.

checkFileAndDirectoryNaming() - Method in class gov.nasa.pds.tools.validate.rule.pds4.BundleContentsNamingRule

Checks that files and directories at the root of the bundle are valid.

checkFileAndDirectoryNaming() - Method in class gov.nasa.pds.tools.validate.rule.pds4.FileAndDirectoryNamingRule

Checks that the files and directories in the target conform to the naming rules in sections 6C.1 and 6C.2.

checkIllegalDirectoryNames() - Method in class gov.nasa.pds.tools.validate.rule.pds4.SubdirectoryNamingRule

Checks for illegal subdirectory names.

checkLabelExtension() - Method in class gov.nasa.pds.tools.validate.rule.pds4.LabelValidationRule

Implements a rule that checks the label file extension.

clear() - Method in class gov.nasa.pds.tools.label.ExceptionContainer

clear() - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Forces the cache of catalog mappings to be cleared.

clear() - Method in class gov.nasa.pds.tools.validate.ProblemContainer

Clears all problems.

CollectionInBundleRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a rule that iterates over subdirectories, treating each as a collection within a bundle, and applying the PDS4 collection rules for each.

CollectionInBundleRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.CollectionInBundleRule

CollectionValidationRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a validation chain that validates PDS4 collections.

CollectionValidationRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.CollectionValidationRule

compareTo(IdentifierReference) - Method in class gov.nasa.pds.tools.validate.IdentifierReference

compareTo(ValidationTarget) - Method in class gov.nasa.pds.tools.validate.ValidationTarget

COPYRIGHT - Static variable in class gov.nasa.pds.tools.util.VersionInfo

D

DEFAULT_NAMESPACE - Static variable in class gov.nasa.pds.tools.util.XMLExtractor

DefaultDocumentValidator - Class in gov.nasa.pds.tools.label.validate

The intent of this class is to perform some default semantic validation on the parsed PDS4 label.

DefaultDocumentValidator() - Constructor for class gov.nasa.pds.tools.label.validate.DefaultDocumentValidator

DIRECTORY_NAME_CONFLICTS_IN_CASE - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a directory name that conflicts with the name of another file or folder in the same parent folder.

DIRECTORY_NAME_TOO_LONG - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a directory name that exceeds the maximum length.

DIRECTORY_NAME_USES_INVALID_CHARACTER - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a directory name that includes a disallowed character.

DirectoryValidationRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a rule chain for validating PDS4 directories, but not necessarily bundles or collections.

DirectoryValidationRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.DirectoryValidationRule

DocumentValidator - Interface in gov.nasa.pds.tools.label.validate

DummyValidationChain - Class in gov.nasa.pds.tools.validate.rule

Implements an empty validation chain that is never applicable.

DummyValidationChain() - Constructor for class gov.nasa.pds.tools.validate.rule.DummyValidationChain

DUPLICATE_LOGICAL_IDENTIFIER - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a logical identifier that was used more than once.

E

equals(Object) - Method in class gov.nasa.pds.tools.label.SourceLocation

equals(Object) - Method in class gov.nasa.pds.tools.validate.IdentifierReference

equals(Object) - Method in class gov.nasa.pds.tools.validate.ProblemDefinition

equals(Object) - Method in class gov.nasa.pds.tools.validate.ValidationTarget

error(SAXParseException) - Method in class gov.nasa.pds.tools.label.LabelErrorHandler

error(TransformerException) - Method in class gov.nasa.pds.tools.label.TransformerErrorListener

error(TransformerException) - Method in class gov.nasa.pds.tools.util.XMLErrorListener

Method is called when an error is encountered.

ExceptionContainer - Class in gov.nasa.pds.tools.label

Implements an exception handler that retains the exceptions in memory.

ExceptionContainer() - Constructor for class gov.nasa.pds.tools.label.ExceptionContainer

ExceptionHandler - Interface in gov.nasa.pds.tools.label

Defines an interface for handling exceptions during label validation.

ExceptionProcessor - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements an exception handler for XML parsing and Schematron errors.

ExceptionProcessor(ProblemListener, File) - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.ExceptionProcessor

ExceptionType - Enum in gov.nasa.pds.tools.label

execute(Context) - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

Invokes the validation tests in the rule in their declared order.

execute(TaskAdvisor) - Method in interface gov.nasa.pds.tools.validate.task.Task

Executes the task with a given advisor to detect cancel requests.

execute(TaskAdvisor) - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

ExternalValidator - Interface in gov.nasa.pds.tools.label.validate

F

fatalError(SAXParseException) - Method in class gov.nasa.pds.tools.label.LabelErrorHandler

fatalError(TransformerException) - Method in class gov.nasa.pds.tools.label.TransformerErrorListener

fatalError(TransformerException) - Method in class gov.nasa.pds.tools.util.XMLErrorListener

Method is called when a fatal error is encountered.

FIELDS_NOT_IN_ORDER - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a table definition where the fields are not defined in physical order.

FIELDS_OVERLAP - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a table definition where the fields are not defined in physical order.

FILE_NAME_CONFLICTS_IN_CASE - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a file name that conflicts with the name of another file or folder in the same parent folder.

FILE_NAME_TOO_LONG - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a file name that exceeds the maximum length.

FILE_NAME_USES_INVALID_CHARACTER - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a file name that includes illegal characters.

FileAndDirectoryNamingRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a validation rule enforcing file and directory naming standards.

FileAndDirectoryNamingRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.FileAndDirectoryNamingRule

FileReferenceValidator - Class in gov.nasa.pds.tools.label.validate

Validator class that looks for file references in the PDS4 product label and performs the following checks: - Verify that the generated checksum matches the supplied checksum, if provided - Verify that the casing of the file reference matches the file name casing on the file system

FileReferenceValidator() - Constructor for class gov.nasa.pds.tools.label.validate.FileReferenceValidator

findApplicableRule(String) - Method in class gov.nasa.pds.tools.validate.rule.ValidationRuleManager

Finds an applicable rule for the given location.

findByID(int) - Static method in class gov.nasa.pds.tools.validate.ProblemDefinition

findRuleByCaption(String) - Method in class gov.nasa.pds.tools.validate.rule.ValidationRuleManager

Finds a rule given its caption.

findRuleByName(String) - Method in class gov.nasa.pds.tools.validate.rule.ValidationRuleManager

Finds a validation rule by name.

findTargets() - Method in class gov.nasa.pds.tools.validate.rule.AbstractFindTargets

FindUnreferencedFiles - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a validation rule that checks that all files are referenced by some label.

FindUnreferencedFiles() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.FindUnreferencedFiles

findUnreferencedTargets() - Method in class gov.nasa.pds.tools.validate.rule.pds4.FindUnreferencedFiles

Iterate over unreferenced targets, reporting an error for each.

G

GenericProblems - Class in gov.nasa.pds.tools.validate.rule

Defines problems which are not specific to a data standard.

getAllTargets() - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

getAncestorTargets() - Method in class gov.nasa.pds.tools.validate.ValidationProblem

getCachedEntities() - Method in class gov.nasa.pds.tools.label.CachedLSResourceResolver

getCaption() - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationChain

getCaption() - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

getCaption() - Method in interface gov.nasa.pds.tools.validate.rule.ValidationRule

Gets a caption describing the rule.

getCatalogList() - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Returns the initial list of catalog entry files.

getChildContext(File) - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

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

getChildTargets(ValidationTarget) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Gets the locations of children of a given target.

getColumnNumber() - Method in exception gov.nasa.pds.tools.label.LabelException

getColumnNumber() - Method in class gov.nasa.pds.tools.label.SourceLocation

Gets the source column number.

getColumnNumber() - Method in class gov.nasa.pds.tools.validate.ValidationProblem

getConfiguration(String) - Method in class gov.nasa.pds.tools.label.LabelValidator

getContext() - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

Gets the rule context.

getContextValue(String, Class<T>) - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

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

getCopyright() - Static method in class gov.nasa.pds.tools.util.VersionInfo

getDanglingReferences() - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Gets a collection of identifiers that are referenced but not defined.

getDefaultModelVersion() - Static method in class gov.nasa.pds.tools.util.VersionInfo

getDefaultNamespace() - Method in class gov.nasa.pds.tools.util.XMLExtractor

getDirectoryFileNames(File) - Static method in class gov.nasa.pds.tools.util.VersionInfo

getDirectoryListing(File) - Static method in class gov.nasa.pds.tools.util.VersionInfo

getDocNode() - Method in class gov.nasa.pds.tools.util.XMLExtractor

Gets the document node of the XML document.

getErrorCount() - Method in class gov.nasa.pds.tools.validate.ProblemContainer

getErrorCount() - Method in interface gov.nasa.pds.tools.validate.ProblemListener

Gets the number of error problems encountered.

getErrorCount() - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Gets the count of errors encountered.

getErrorLimit() - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Gets the limit on the number of errors found.

getExceptions() - Method in class gov.nasa.pds.tools.label.ExceptionContainer

getExceptionType() - Method in exception gov.nasa.pds.tools.label.LabelException

getExceptionType() - Method in exception gov.nasa.pds.tools.label.ValidatorException

getExternalSubset(String, String) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Locates an external subset for documents which do not explicitly provide one.

getID() - Method in class gov.nasa.pds.tools.validate.ProblemDefinition

getIdentifier() - Method in class gov.nasa.pds.tools.validate.IdentifierReference

Gets the identifier referenced.

getIdentifier() - Method in class gov.nasa.pds.tools.validate.ValidationTarget

Gets the identification string for this target.

getInfoCount() - Method in class gov.nasa.pds.tools.validate.ProblemContainer

getInfoCount() - Method in interface gov.nasa.pds.tools.validate.ProblemListener

Gets the number of informational problems encountered.

getInfoCount() - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Gets the count of informational events encountered.

getKey() - Method in enum gov.nasa.pds.tools.validate.ProblemType

Gets the key for mapping the problem type to a UI string.

getLabelCount() - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Gets the number of labels encountered so far.

getLibraryVersion() - Static method in class gov.nasa.pds.tools.util.VersionInfo

getLineNumber() - Method in exception gov.nasa.pds.tools.label.LabelException

getLineNumber() - Method in class gov.nasa.pds.tools.label.SourceLocation

Gets the source line number.

getLineNumber() - Method in class gov.nasa.pds.tools.validate.ValidationProblem

getListener() - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

Gets the problem listener for this validation rule.

getLocation() - Method in class gov.nasa.pds.tools.validate.TargetWithErrors

getLocation() - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Gets the location of the target to validate.

getLocation() - Method in class gov.nasa.pds.tools.validate.ValidationTarget

Gets the target location.

getMD5Checksum(URL) - Static method in class gov.nasa.pds.tools.util.MD5Checksum

Gets the MD5 checksum value.

getMessage() - Method in exception gov.nasa.pds.tools.label.LabelException

getMessage() - Method in exception gov.nasa.pds.tools.label.ValidatorException

getMessage() - Method in class gov.nasa.pds.tools.validate.ProblemDefinition

getMessage() - Method in class gov.nasa.pds.tools.validate.ValidationProblem

getModelVersion() - Method in class gov.nasa.pds.tools.label.LabelValidator

getName() - Method in enum gov.nasa.pds.tools.label.ExceptionType

getName() - Method in class gov.nasa.pds.tools.validate.ValidationTarget

Gets the name of the target.

getNodeFromDoc(String) - Method in class gov.nasa.pds.tools.util.XMLExtractor

Gets a Node object from the given expression.

getNodeFromItem(String, Object) - Method in class gov.nasa.pds.tools.util.XMLExtractor

Gets a Node object from the given expression.

getNodesFromDoc(String) - Method in class gov.nasa.pds.tools.util.XMLExtractor

Gets Node objects from the given expression.

getNodesFromItem(String, Object) - Method in class gov.nasa.pds.tools.util.XMLExtractor

Gets Node objects from the given expression.

getParentTarget() - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

Gets the parent target location for this rule.

getParentTarget() - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

Gets the parent target location.

getPDSDefaultNamespace(String) - Static method in class gov.nasa.pds.tools.util.VersionInfo

getPDSVersion() - Static method in class gov.nasa.pds.tools.util.VersionInfo

getPreferPublic() - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Returns the preference for whether system or public matches are preferred.

getProblem() - Method in class gov.nasa.pds.tools.validate.ValidationProblem

getProblemCount() - Method in class gov.nasa.pds.tools.validate.ProblemContainer

Gets the number of problems reported.

getProblemDefinitionId() - Method in class gov.nasa.pds.tools.validate.ValidationProblem

getProblemListener() - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

getProblemListener() - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Gets the problem listener for getting problems found.

getProblems() - Method in class gov.nasa.pds.tools.validate.ProblemContainer

Gets the problems encountered.

getProblems() - Method in class gov.nasa.pds.tools.validate.TargetWithErrors

getProblemsForLocation(String, boolean) - Method in class gov.nasa.pds.tools.validate.ProblemContainer

getProblemsForLocation(String, boolean) - Method in interface gov.nasa.pds.tools.validate.ProblemListener

Gets a collection of problems for a given location.

getPublicId() - Method in exception gov.nasa.pds.tools.label.LabelException

getReferenceLocation() - Method in class gov.nasa.pds.tools.validate.IdentifierReference

Gets the location of the target containing the reference.

getRegistrar() - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

Gets the target registrar for this validation rule.

getRegistrar() - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Gets the registrar for getting target information.

getResource(Class<T>) - Method in enum gov.nasa.pds.tools.validate.ValidationResourceManager

getResourceListing(String) - Static method in class gov.nasa.pds.tools.util.VersionInfo

getRoot() - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Gets the root location.

getRuleManager() - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

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

getSchemaLocation() - Method in class gov.nasa.pds.tools.util.XMLExtractor

getSchemaRefFromJar(String, String) - Static method in class gov.nasa.pds.tools.util.VersionInfo

getSchemas() - Static method in class gov.nasa.pds.tools.util.VersionInfo

getSchemasFromDirectory() - Static method in class gov.nasa.pds.tools.util.VersionInfo

getSchemasFromJar(String) - Static method in class gov.nasa.pds.tools.util.VersionInfo

getSchematronNamespace() - Static method in class gov.nasa.pds.tools.util.VersionInfo

getSchematronRefFromJar(String, String) - Static method in class gov.nasa.pds.tools.util.VersionInfo

getSchematrons(NodeList, URL, ExceptionHandler) - Method in class gov.nasa.pds.tools.label.LabelValidator

getSchematronsFromJar(String) - Static method in class gov.nasa.pds.tools.util.VersionInfo

getSeverity(String, boolean) - Method in class gov.nasa.pds.tools.validate.ProblemContainer

getSeverity() - Method in class gov.nasa.pds.tools.validate.ProblemDefinition

getSeverity(String, boolean) - Method in interface gov.nasa.pds.tools.validate.ProblemListener

Gets the maximum severity of problems related to a location.

getSource() - Method in exception gov.nasa.pds.tools.label.LabelException

getStandardsDocument() - Method in class gov.nasa.pds.tools.validate.ProblemDefinition

getStandardsSection() - Method in class gov.nasa.pds.tools.validate.ProblemDefinition

getStandardsVersion() - Static method in class gov.nasa.pds.tools.util.VersionInfo

getStatus(Task) - Method in interface gov.nasa.pds.tools.validate.task.TaskManager

Gets the task status.

getSupportedModels() - Static method in class gov.nasa.pds.tools.util.VersionInfo

getSystemId() - Method in exception gov.nasa.pds.tools.label.LabelException

getTarget() - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

Gets the target of this rule.

getTarget() - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

getTarget() - Method in class gov.nasa.pds.tools.validate.ValidationProblem

getTargetCount(TargetType) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Gets the number of targets encountered so far for a target type.

getTargetForIdentifier(String) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Gets the location where an identifier was defined.

getTargetNamespace() - Method in class gov.nasa.pds.tools.util.XMLExtractor

getTargetRegistrar() - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

getType() - Method in class gov.nasa.pds.tools.validate.ProblemDefinition

getType() - Method in class gov.nasa.pds.tools.validate.ValidationTarget

Gets the target type.

getUnreferencedIdentifiers() - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Gets a collection of identifiers that are defined but never referenced.

getUnreferencedTargets() - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Gets a collection of target locations that are never referenced.

getUrl() - Method in class gov.nasa.pds.tools.label.SourceLocation

Gets the url of the source location.

getUseLiteralSystemId() - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Returns the preference for whether the literal system identifier should be used when resolving system identifiers when both it and the expanded system identifier are available.

getValidationType() - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Gets the type of validation.

getValidators() - Method in class gov.nasa.pds.tools.validate.rule.ValidationRuleManager

Gets the list of available validators.

getValue() - Method in enum gov.nasa.pds.tools.label.ExceptionType

getValueFromDoc(String) - Method in class gov.nasa.pds.tools.util.XMLExtractor

Gets the value of the given expression.

getValueFromItem(String, Object) - Method in class gov.nasa.pds.tools.util.XMLExtractor

Gets the value of the given expression.

getValuesFromDoc(String) - Method in class gov.nasa.pds.tools.util.XMLExtractor

Gets the values of the given expression.

getValuesFromItem(String, Object) - Method in class gov.nasa.pds.tools.util.XMLExtractor

Gets the values of the given expression.

getWarningCount() - Method in class gov.nasa.pds.tools.validate.ProblemContainer

getWarningCount() - Method in interface gov.nasa.pds.tools.validate.ProblemListener

Gets the number of warning problems encountered.

getWarningCount() - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Gets the count of warnings encountered.

getXmlModels() - Method in class gov.nasa.pds.tools.util.XMLExtractor

getXMLParserVersion() - Static method in class gov.nasa.pds.tools.util.VersionInfo

getXMLVersion() - Static method in class gov.nasa.pds.tools.util.VersionInfo

gov.nasa.pds.tools.label - package gov.nasa.pds.tools.label

gov.nasa.pds.tools.label.validate - package gov.nasa.pds.tools.label.validate

gov.nasa.pds.tools.util - package gov.nasa.pds.tools.util

gov.nasa.pds.tools.validate - package gov.nasa.pds.tools.validate

Implementations of general-purpose classes for the validation application.

gov.nasa.pds.tools.validate.rule - package gov.nasa.pds.tools.validate.rule

Implementations of rules for checking compliance to data standards.

gov.nasa.pds.tools.validate.rule.pds4 - package gov.nasa.pds.tools.validate.rule.pds4

Implementations of standards rules for the PDS4 data standard.

gov.nasa.pds.tools.validate.task - package gov.nasa.pds.tools.validate.task

Defines client-independent processing interfaces and classes for background tasks.

H

handleDirectory(File, T) - Method in class gov.nasa.pds.tools.validate.rule.AbstractFileSubtreeWalker

Handles encountering a directory.

handleDirectory(File, TargetRegistrar) - Method in class gov.nasa.pds.tools.validate.rule.AbstractFindTargets

handleFile(File, T) - Method in class gov.nasa.pds.tools.validate.rule.AbstractFileSubtreeWalker

Handles encountering a file.

handleFile(File, TargetRegistrar) - Method in class gov.nasa.pds.tools.validate.rule.AbstractFindTargets

hasError() - Method in class gov.nasa.pds.tools.label.ExceptionContainer

hasFatal() - Method in class gov.nasa.pds.tools.label.ExceptionContainer

hashCode() - Method in class gov.nasa.pds.tools.label.SourceLocation

hashCode() - Method in class gov.nasa.pds.tools.validate.IdentifierReference

hashCode() - Method in class gov.nasa.pds.tools.validate.ProblemDefinition

hashCode() - Method in class gov.nasa.pds.tools.validate.ValidationTarget

hasProblems(String, boolean) - Method in class gov.nasa.pds.tools.validate.ProblemContainer

hasProblems(String, boolean) - Method in interface gov.nasa.pds.tools.validate.ProblemListener

Tests whether a target has had problems reported.

hasTarget(String) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Tests whether a target exists for a location.

hasWarning() - Method in class gov.nasa.pds.tools.label.ExceptionContainer

I

IdentifierReference - Class in gov.nasa.pds.tools.validate

Defines a reference from a location to an identifier.

IdentifierReference(String, String) - Constructor for class gov.nasa.pds.tools.validate.IdentifierReference

Creates a new instance with a given location for the target referring to an identifier.

INVALID_COLLECTION_NAME - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a collection directory that has an invalid name.

INVALID_LABEL - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a label that has invalid structure.

INVALID_LABEL_EXTENSION - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a label that does not have the required extension.

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.AbstractFindTargets

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationChain

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

Tests whether a rule is applicable to a target location.

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.DummyValidationChain

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.MarkSubdirectoriesReferenced

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.BundleContentsNamingRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.BundleValidationRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.CollectionInBundleRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.CollectionValidationRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.DirectoryValidationRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.FileAndDirectoryNamingRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.FindUnreferencedFiles

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.LabelInFolderRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.LabelValidationRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.RegisterLabelIdentifiers

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.RegisterTargetReferences

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.SubdirectoryNamingRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.SubDirectoryRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.pds4.TableFieldDefinitionRule

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.RegisterTargets

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.StandardValidationChain

isApplicable(String) - Method in class gov.nasa.pds.tools.validate.rule.UTF8ByteStreamRule

isApplicable(String) - Method in interface gov.nasa.pds.tools.validate.rule.ValidationRule

Tests whether a rule is applicable to a target location.

isIdentifierReferenced(String) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Tests whether an identifier was referenced.

isInternalMode() - Static method in class gov.nasa.pds.tools.util.VersionInfo

isLabel() - Method in class gov.nasa.pds.tools.validate.ValidationTarget

Tests whether the target is a label.

isRootTarget() - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

Tests whether this is the root target for the validation.

isTargetReferenced(String) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Tests whether a target was referenced.

L

LABEL_DOCUMENT - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Context

The key for storing a parsed label as a W3C document.

LabelErrorHandler - Class in gov.nasa.pds.tools.label

LabelErrorHandler(ExceptionHandler) - Constructor for class gov.nasa.pds.tools.label.LabelErrorHandler

LabelException - Exception in gov.nasa.pds.tools.label

LabelException(ExceptionType, String, String, String, Integer, Integer) - Constructor for exception gov.nasa.pds.tools.label.LabelException

LabelException(ExceptionType, String, String) - Constructor for exception gov.nasa.pds.tools.label.LabelException

LabelInFolderRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements the rule that all files that look like labels in a folder must be valid labels.

LabelInFolderRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.LabelInFolderRule

LabelValidationRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a validation chain that validates PDS4 bundles.

LabelValidationRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.LabelValidationRule

LabelValidator - Class in gov.nasa.pds.tools.label

This class is responsible for providing utility functions for validating PDS XML Labels.

LabelValidator() - Constructor for class gov.nasa.pds.tools.label.LabelValidator

Default constructor.

LIBRARY_VERSION - Static variable in class gov.nasa.pds.tools.util.VersionInfo

LISTENER_KEY - Static variable in class gov.nasa.pds.tools.validate.rule.RuleContext

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

LocationValidator - Class in gov.nasa.pds.tools.label

Implements a validator that validates a location (file or directory) against a validation rule set.

LocationValidator() - Constructor for class gov.nasa.pds.tools.label.LocationValidator

M

main(String[]) - Static method in class gov.nasa.pds.tools.label.LabelValidator

makeURL(String) - Static method in class gov.nasa.pds.tools.label.BootstrapResolver

MALFORMED_UTF8_CHARACTER - Static variable in class gov.nasa.pds.tools.validate.rule.GenericProblems

Indicates a problem in a UTF-8 byte stream, where one or more bytes do not indicate a legal encoding of a character.

MarkSubdirectoriesReferenced - Class in gov.nasa.pds.tools.validate.rule

Implements a validation rule that marks all subdirectories as referenced.

MarkSubdirectoriesReferenced() - Constructor for class gov.nasa.pds.tools.validate.rule.MarkSubdirectoriesReferenced

markSubdirectoriesReferenced() - Method in class gov.nasa.pds.tools.validate.rule.MarkSubdirectoriesReferenced

MD5Checksum - Class in gov.nasa.pds.tools.util

A class that calculates the MD5 checksum of a file.

MD5Checksum() - Constructor for class gov.nasa.pds.tools.util.MD5Checksum

MissingLabelSchemaException - Exception in gov.nasa.pds.tools.label

Exception class to indicate that a given PDS4 label is missing the xsi:schemaLocation attribute.

MissingLabelSchemaException(String) - Constructor for exception gov.nasa.pds.tools.label.MissingLabelSchemaException

MODEL_VERSION - Static variable in class gov.nasa.pds.tools.util.VersionInfo

O

openConnection(URLConnection) - Static method in class gov.nasa.pds.tools.util.Utility

Method that opens a connection.

P

PARENT_TARGET_KEY - Static variable in class gov.nasa.pds.tools.validate.rule.RuleContext

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

parseAndValidate(ExceptionHandler, URL) - Method in class gov.nasa.pds.tools.label.LabelValidator

Parses and validates a label against the schema and Schematron files, and returns the parsed XML.

PDS4_STANDARDS_REFERENCE - Static variable in class gov.nasa.pds.tools.validate.Standard

The standard for PDS4.

PDS4Context - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements constants for storing and retrieving items from the rule context.

PDS4Context() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.PDS4Context

PDS4Problems - Class in gov.nasa.pds.tools.validate.rule.pds4

Defines the problems that can be reported by PDS4 validation rules.

PDS_DEFAULT_NAMESPACE - Static variable in class gov.nasa.pds.tools.util.VersionInfo

PDS_VERSION - Static variable in class gov.nasa.pds.tools.util.VersionInfo

performsSchematronValidation() - Method in class gov.nasa.pds.tools.label.LabelValidator

performsSchemaValidation() - Method in class gov.nasa.pds.tools.label.LabelValidator

ProblemContainer - Class in gov.nasa.pds.tools.validate

Implements a problem listener that accumulates problems in a list.

ProblemContainer() - Constructor for class gov.nasa.pds.tools.validate.ProblemContainer

ProblemDefinition - Class in gov.nasa.pds.tools.validate

Defines a specific problem uncovered by a validation rule.

ProblemDefinition(ProblemDefinition.Severity, ProblemType, String, String, String) - Constructor for class gov.nasa.pds.tools.validate.ProblemDefinition

ProblemDefinition.Severity - Enum in gov.nasa.pds.tools.validate

Defines the severities of validation rule violations.

ProblemListener - Interface in gov.nasa.pds.tools.validate

Defines an interface for receiving problems during the validation.

ProblemType - Enum in gov.nasa.pds.tools.validate

Defines the types of problems that can be reported by validation rules.

putContextValue(String, T) - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

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

R

registerDocumentFileReferences() - Method in class gov.nasa.pds.tools.validate.rule.pds4.RegisterTargetReferences

registerFileReferences() - Method in class gov.nasa.pds.tools.validate.rule.pds4.RegisterTargetReferences

registerIdentifiers() - Method in class gov.nasa.pds.tools.validate.rule.pds4.RegisterLabelIdentifiers

Tests that label identifiers are uniquely defined.

RegisterLabelIdentifiers - Class in gov.nasa.pds.tools.validate.rule.pds4

Registers identifiers defined within a label, and verifies that the same identifier is not registered twice.

RegisterLabelIdentifiers() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.RegisterLabelIdentifiers

Creates a new instance.

RegisterTargetReferences - Class in gov.nasa.pds.tools.validate.rule.pds4

Registers file references from the label, as well as an implied reference to the label itself.

RegisterTargetReferences() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.RegisterTargetReferences

Creates a new instance.

RegisterTargets - Class in gov.nasa.pds.tools.validate.rule

Implements a rule that inserts this target into the target registry, if not already present, and also adds all of its child targets.

RegisterTargets() - Constructor for class gov.nasa.pds.tools.validate.rule.RegisterTargets

registerTargets() - Method in class gov.nasa.pds.tools.validate.rule.RegisterTargets

REGISTRAR_KEY - Static variable in class gov.nasa.pds.tools.validate.rule.RuleContext

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

remove(Task) - Method in interface gov.nasa.pds.tools.validate.task.TaskManager

Removes a task from the task manager.

reportError(ProblemDefinition, File, int, int) - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

Reports an error to the validation listener.

reportError(ProblemDefinition, File, int, int, String) - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

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

resolve(String, String) - Method in class gov.nasa.pds.tools.label.BootstrapResolver

Transformer resolve API.

resolve(String, String) - Method in class gov.nasa.pds.tools.util.XslURIResolver

resolveEntity(String, String) - Method in class gov.nasa.pds.tools.label.BootstrapResolver

SAX resolveEntity API.

resolveEntity(String, String) - Method in class gov.nasa.pds.tools.label.CachedEntityResolver

resolveEntity(String, String) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Resolves an external entity.

resolveEntity(String, String, String, String) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Resolves an external entity.

resolveEntity(XMLResourceIdentifier) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Resolves an external entity.

resolveIdentifier(XMLResourceIdentifier) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Resolves an identifier using the catalog.

resolvePublic(String, String) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Returns the URI mapping in the catalog for the given external identifier or null if no mapping exists.

resolveResource(String, String, String, String, String) - Method in class gov.nasa.pds.tools.label.CachedLSResourceResolver

resolveResource(String, String, String, String, String) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Resolves a resource using the catalog.

resolveSystem(String) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Returns the URI mapping in the catalog for the given external identifier or null if no mapping exists.

resolveURI(String) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Returns the URI mapping in the catalog for the given URI reference or null if no mapping exists.

RFC_3629 - Static variable in class gov.nasa.pds.tools.validate.Standard

The standard for UTF-8.

RULE_MANAGER_KEY - Static variable in class gov.nasa.pds.tools.validate.rule.RuleContext

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

RuleContext - Class in gov.nasa.pds.tools.validate.rule

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

RuleContext() - Constructor for class gov.nasa.pds.tools.validate.rule.RuleContext

S

SCHEMA_CHECK - Static variable in class gov.nasa.pds.tools.label.LabelValidator

SCHEMA_DIR - Static variable in class gov.nasa.pds.tools.util.VersionInfo

SCHEMA_DIR_PROP - Static variable in class gov.nasa.pds.tools.util.VersionInfo

SCHEMA_LOCATION_XPATH - Static variable in class gov.nasa.pds.tools.util.XMLExtractor

SCHEMATRON_CHECK - Static variable in class gov.nasa.pds.tools.label.LabelValidator

SCHEMATRON_NAMESPACE - Static variable in class gov.nasa.pds.tools.util.VersionInfo

SchematronTransformer - Class in gov.nasa.pds.tools.label

A class that transforms Schematron files based on the isoSchematron stylesheet.

SchematronTransformer() - Constructor for class gov.nasa.pds.tools.label.SchematronTransformer

Constructor.

setAncestorTargets(Collection<ValidationTarget>) - Method in class gov.nasa.pds.tools.validate.ValidationProblem

setCachedEntityResolver(CachedEntityResolver) - Method in class gov.nasa.pds.tools.label.LabelValidator

setCachedLSResourceResolver(CachedLSResourceResolver) - Method in class gov.nasa.pds.tools.label.LabelValidator

setCaption(String) - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationChain

Sets the caption for this chain.

setCaption(String) - Method in class gov.nasa.pds.tools.validate.rule.AbstractValidationRule

Sets the caption for this chain.

setCatalogList(String[]) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Sets the initial list of catalog entry files.

setCatalogs(String[]) - Method in class gov.nasa.pds.tools.label.LabelValidator

Pass in a list of Catalog files to use during the validation step.

setChecksumManifest(Map<URL, String>) - Method in class gov.nasa.pds.tools.label.validate.FileReferenceValidator

setColumnNumber(int) - Method in class gov.nasa.pds.tools.validate.ValidationProblem

setConfiguration(String, Boolean) - Method in class gov.nasa.pds.tools.label.LabelValidator

setErrorLimit(int) - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Sets the limit on the number of errors encountered before the validation will terminate.

setExceptionHandler(ExceptionHandler) - Method in class gov.nasa.pds.tools.label.CachedLSResourceResolver

setIdentifier(String) - Method in class gov.nasa.pds.tools.validate.ValidationTarget

Sets the identification string for this target.

setLabel(boolean) - Method in class gov.nasa.pds.tools.validate.ValidationTarget

Sets whether the target is a label.

setLabelSchematrons(Map<String, Transformer>) - Method in class gov.nasa.pds.tools.label.LabelValidator

Pass in a hash map of schematron URLs to its transformed schematron object.

setLineNumber(int) - Method in class gov.nasa.pds.tools.validate.ValidationProblem

setLocation(String) - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Sets the location to validate.

setLocation(String) - Method in class gov.nasa.pds.tools.validate.ValidationTarget

Sets the target location.

setMessage(String) - Method in class gov.nasa.pds.tools.validate.ValidationProblem

setModelVersion(String) - Method in class gov.nasa.pds.tools.label.LabelValidator

setName(String) - Method in class gov.nasa.pds.tools.validate.ValidationTarget

Sets the target name.

setParentTarget(String) - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

Sets the parent target location.

setPreferPublic(boolean) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Sets the preference for whether system or public matches are preferred.

setProblemDefinitionId(int) - Method in class gov.nasa.pds.tools.validate.ValidationProblem

setProblemListener(ProblemListener) - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

setProblemListener(ProblemListener) - Method in enum gov.nasa.pds.tools.validate.ValidationResourceManager

setRootTarget(boolean) - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

Sets whether this is the root target for the validation.

setRule(ValidationRule) - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Sets the validation rule to use.

setRuleManager(ValidationRuleManager) - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

Sets the rule manager to use for finding new rules.

setRuleManager(ValidationRuleManager) - Method in class gov.nasa.pds.tools.validate.task.ValidationTask

Sets the validation rule manager to use for finding validation rules.

setSchema(List<URL>) - Method in class gov.nasa.pds.tools.label.LabelValidator

Pass in a list of schemas to validate against.

setSchemaCheck(Boolean) - Method in class gov.nasa.pds.tools.label.LabelValidator

setSchemaCheck(Boolean, Boolean) - Method in class gov.nasa.pds.tools.label.LabelValidator

setSchematronCheck(Boolean) - Method in class gov.nasa.pds.tools.label.LabelValidator

setSchematronCheck(Boolean, Boolean) - Method in class gov.nasa.pds.tools.label.LabelValidator

setSchematronFiles(List<URL>) - Method in class gov.nasa.pds.tools.label.LabelValidator

Pass in a list of schematron files to validate against.

setSchematrons(List<Transformer>) - Method in class gov.nasa.pds.tools.label.LabelValidator

Pass in a list of transformed schematrons to validate against.

setStatus(Task.Status) - Method in interface gov.nasa.pds.tools.validate.task.TaskAdvisor

Sets the status of the task.

setTarget(File) - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

setTarget(ValidationTarget) - Method in class gov.nasa.pds.tools.validate.ValidationProblem

setTargetIdentifier(String, String) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Sets an identifier for uniquely identifying the target.

setTargetIsLabel(String, boolean) - Method in interface gov.nasa.pds.tools.validate.TargetRegistrar

Indicates whether a target is a label.

setTargetRegistrar(TargetRegistrar) - Method in class gov.nasa.pds.tools.validate.rule.RuleContext

setTargetRegistrar(TargetRegistrar) - Method in enum gov.nasa.pds.tools.validate.ValidationResourceManager

setType(TargetType) - Method in class gov.nasa.pds.tools.validate.ValidationTarget

Sets the target type.

setUseLiteralSystemId(boolean) - Method in class gov.nasa.pds.tools.label.XMLCatalogResolver

Sets the preference for whether the literal system identifier should be used when resolving system identifiers when both it and the expanded system identifier are available.

SourceLocation - Class in gov.nasa.pds.tools.label

Implements an object that stores a line, column, and location in a source document.

SourceLocation(int, int, String) - Constructor for class gov.nasa.pds.tools.label.SourceLocation

Creates a new instance with a given line, column number and url of the source.

Standard - Class in gov.nasa.pds.tools.validate

Defines the standards documents against which we are testing.

STANDARDS_VERSION - Static variable in class gov.nasa.pds.tools.util.VersionInfo

StandardValidationChain - Class in gov.nasa.pds.tools.validate.rule

Implements a validation chain that is applicable if any of its contained validation commands are applicable, and performs validation by invoking all of its contained commands in turn.

StandardValidationChain() - Constructor for class gov.nasa.pds.tools.validate.rule.StandardValidationChain

SubdirectoryNamingRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a rule that checks for children of a directory using illegal names.

SubdirectoryNamingRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.SubdirectoryNamingRule

SubDirectoryRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a rule that iterates over subdirectories, validating each as a PDS4 folder.

SubDirectoryRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.SubDirectoryRule

submit(Task) - Method in interface gov.nasa.pds.tools.validate.task.TaskManager

Submits a task to run in the background.

T

TableFieldDefinitionRule - Class in gov.nasa.pds.tools.validate.rule.pds4

Implements a validation rule that checks that fields of tables are defined in order, that they do not overlap, and that the fields do not extend outside the record.

TableFieldDefinitionRule() - Constructor for class gov.nasa.pds.tools.validate.rule.pds4.TableFieldDefinitionRule

Creates a new instance.

TARGET_KEY - Static variable in class gov.nasa.pds.tools.validate.rule.RuleContext

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

TARGET_NAMESPACE - Static variable in class gov.nasa.pds.tools.util.XMLExtractor

TargetRegistrar - Interface in gov.nasa.pds.tools.validate

Defines an interface for keeping track of validation targets and their attributes.

TargetType - Enum in gov.nasa.pds.tools.validate

Defines the types of targets that can be involved in a validation.

TargetWithErrors - Class in gov.nasa.pds.tools.validate

TargetWithErrors(ValidationTarget, ProblemListener) - Constructor for class gov.nasa.pds.tools.validate.TargetWithErrors

Task - Interface in gov.nasa.pds.tools.validate.task

Defines an interface all tasks must implement.

Task.Status - Enum in gov.nasa.pds.tools.validate.task

Defines the states a task can be in.

TaskAdvisor - Interface in gov.nasa.pds.tools.validate.task

Defines an interface that a task may use to find out whether it should exit early.

TaskManager - Interface in gov.nasa.pds.tools.validate.task

Defines the operations of a service that can run tasks in the background.

testCollectionDirectories() - Method in class gov.nasa.pds.tools.validate.rule.pds4.CollectionInBundleRule

testCollectionDirectories() - Method in class gov.nasa.pds.tools.validate.rule.pds4.SubDirectoryRule

testTableDefinitions() - Method in class gov.nasa.pds.tools.validate.rule.pds4.TableFieldDefinitionRule

testUTF8ByteStream() - Method in class gov.nasa.pds.tools.validate.rule.UTF8ByteStreamRule

toString() - Method in class gov.nasa.pds.tools.validate.ValidationTarget

toURL(List<String>) - Static method in class gov.nasa.pds.tools.util.Utility

toURL(String) - Static method in class gov.nasa.pds.tools.util.Utility

transform(Source) - Method in class gov.nasa.pds.tools.label.SchematronTransformer

Transform the given schematron source.

transform(Source, ExceptionHandler) - Method in class gov.nasa.pds.tools.label.SchematronTransformer

Transform the given schematron source.

transform(URL) - Method in class gov.nasa.pds.tools.label.SchematronTransformer

Transform the given schematron.

transform(URL, ExceptionHandler) - Method in class gov.nasa.pds.tools.label.SchematronTransformer

Transform the given schematron.

TransformerErrorListener - Class in gov.nasa.pds.tools.label

Listener class to simply throw exceptions when an error occurs when transforming a schematron.

TransformerErrorListener(ExceptionHandler) - Constructor for class gov.nasa.pds.tools.label.TransformerErrorListener

Constructor.

U

UNALLOWED_BASE_NAME - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a file name that includes a disallowed base name.

UNALLOWED_BUNDLE_SUBDIRECTORY_NAME - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a directory name that is explicitly disallowed by the standard.

UNALLOWED_DIRECTORY_NAME - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a directory name that is explicitly disallowed by the standard.

UNALLOWED_FILE_NAME - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a file name that is explicitly disallowed by the standard.

UNCAUGHT_EXCEPTION - Static variable in class gov.nasa.pds.tools.validate.rule.GenericProblems

UNEXPECTED_FILE_IN_BUNDLE_ROOT - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates an unexpected file in the root directory of a bundle.

UNLABELED_FILE - Static variable in class gov.nasa.pds.tools.validate.rule.pds4.PDS4Problems

Indicates a file that is not associated with any label.

UTF8ByteStreamRule - Class in gov.nasa.pds.tools.validate.rule

Tests that a file has only legal UTF-8 byte sequences.

UTF8ByteStreamRule() - Constructor for class gov.nasa.pds.tools.validate.rule.UTF8ByteStreamRule

Utility - Class in gov.nasa.pds.tools.util

Utility class.

Utility() - Constructor for class gov.nasa.pds.tools.util.Utility

V

validate(ExceptionHandler, File) - Method in class gov.nasa.pds.tools.label.LabelValidator

validate(ExceptionHandler, URL) - Method in class gov.nasa.pds.tools.label.LabelValidator

Validates the label against schema and schematron constraints.

validate(File) - Method in class gov.nasa.pds.tools.label.LabelValidator

validate(File) - Method in class gov.nasa.pds.tools.label.LocationValidator

Validates a location specified by a file or directory.

validate(ExceptionHandler, DocumentInfo) - Method in class gov.nasa.pds.tools.label.validate.DefaultDocumentValidator

validate(ExceptionHandler, DocumentInfo) - Method in interface gov.nasa.pds.tools.label.validate.DocumentValidator

Method signature for checking to see if a label is valid.

validate(ExceptionHandler, File) - Method in interface gov.nasa.pds.tools.label.validate.ExternalValidator

Method signature for checking to see if a label is valid.

validate(ExceptionHandler, URL) - Method in interface gov.nasa.pds.tools.label.validate.ExternalValidator

Method signature for checking to see if a label is valid.

validate(ExceptionHandler, DocumentInfo) - Method in class gov.nasa.pds.tools.label.validate.FileReferenceValidator

validateLabel() - Method in class gov.nasa.pds.tools.validate.rule.pds4.LabelValidationRule

Parses the label and records any errors resulting from the parse, including schema and schematron errors.

validateLabelsInFolder() - Method in class gov.nasa.pds.tools.validate.rule.pds4.LabelInFolderRule

Validates each file with a label suffix as a PDS4 label.

ValidationProblem - Class in gov.nasa.pds.tools.validate

ValidationProblem(ProblemDefinition, ValidationTarget, int, int, String) - Constructor for class gov.nasa.pds.tools.validate.ValidationProblem

ValidationResourceManager - Enum in gov.nasa.pds.tools.validate

Implements an object that allows validation rules to get resource objects of the proper class.

ValidationRule - Interface in gov.nasa.pds.tools.validate.rule

Defines an interface that validation rule classes must implement.

ValidationRuleManager - Class in gov.nasa.pds.tools.validate.rule

Implements an object that allows callers to find out what validators exist.

ValidationRuleManager(Catalog) - Constructor for class gov.nasa.pds.tools.validate.rule.ValidationRuleManager

Creates a new instance with a given catalog.

ValidationTarget - Class in gov.nasa.pds.tools.validate

Represents a location within a validation subtree that can have errors reported against it.

ValidationTarget(File) - Constructor for class gov.nasa.pds.tools.validate.ValidationTarget

Creates a new instance.

ValidationTarget(String, TargetType) - Constructor for class gov.nasa.pds.tools.validate.ValidationTarget

Creates an instance with a given location.

ValidationTask - Class in gov.nasa.pds.tools.validate.task

Implements a background task for performing a validation.

ValidationTask(ProblemListener, RuleContext, TargetRegistrar) - Constructor for class gov.nasa.pds.tools.validate.task.ValidationTask

Creates a new instance of the validation task.

ValidationTest - Annotation Type in gov.nasa.pds.tools.validate.rule

Defines an annotation used to mark validation tests within a validation rule.

ValidatorException - Exception in gov.nasa.pds.tools.label

ValidatorException(ExceptionType, String) - Constructor for exception gov.nasa.pds.tools.label.ValidatorException

valueOf(String) - Static method in enum gov.nasa.pds.tools.label.ExceptionType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum gov.nasa.pds.tools.validate.ProblemDefinition.Severity

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum gov.nasa.pds.tools.validate.ProblemType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum gov.nasa.pds.tools.validate.TargetType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum gov.nasa.pds.tools.validate.task.Task.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum gov.nasa.pds.tools.validate.ValidationResourceManager

Returns the enum constant of this type with the specified name.

values() - Static method in enum gov.nasa.pds.tools.label.ExceptionType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum gov.nasa.pds.tools.validate.ProblemDefinition.Severity

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum gov.nasa.pds.tools.validate.ProblemType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum gov.nasa.pds.tools.validate.TargetType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum gov.nasa.pds.tools.validate.task.Task.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum gov.nasa.pds.tools.validate.ValidationResourceManager

Returns an array containing the constants of this enum type, in the order they are declared.

VersionInfo - Class in gov.nasa.pds.tools.util

This class provides the means to retrieve underlying supported versions of standards.

VersionInfo() - Constructor for class gov.nasa.pds.tools.util.VersionInfo

W

walkSubtree(File, T) - Method in class gov.nasa.pds.tools.validate.rule.AbstractFileSubtreeWalker

Walks a subtree starting from a specified file or directory.

warning(SAXParseException) - Method in class gov.nasa.pds.tools.label.LabelErrorHandler

warning(TransformerException) - Method in class gov.nasa.pds.tools.label.TransformerErrorListener

warning(TransformerException) - Method in class gov.nasa.pds.tools.util.XMLErrorListener

Method is called when a warning is encountered.

X

xCatalogPubId - Static variable in class gov.nasa.pds.tools.label.BootstrapResolver

Public identifier for legacy Apache XCatalog files.

XML_MODEL_XPATH - Static variable in class gov.nasa.pds.tools.util.XMLExtractor

XML_VERSION - Static variable in class gov.nasa.pds.tools.util.VersionInfo

xmlCatalog11PubId - Static variable in class gov.nasa.pds.tools.label.BootstrapResolver

Public identifier for OASIS XML Catalog 1.1 files.

xmlCatalog11SysId - Static variable in class gov.nasa.pds.tools.label.BootstrapResolver

System identifier for OASIS XML Catalog 1.1 files.

xmlCatalogPubId - Static variable in class gov.nasa.pds.tools.label.BootstrapResolver

Public identifier for OASIS XML Catalog files.

XMLCatalogResolver - Class in gov.nasa.pds.tools.label

Adaption of Xerces XMLCatalogResolver to bootstrap in catalog 1.1 support.

XMLCatalogResolver() - Constructor for class gov.nasa.pds.tools.label.XMLCatalogResolver

Constructs a catalog resolver with a default configuration.

XMLCatalogResolver(String[]) - Constructor for class gov.nasa.pds.tools.label.XMLCatalogResolver

Constructs a catalog resolver with the given list of entry files.

XMLCatalogResolver(String[], boolean) - Constructor for class gov.nasa.pds.tools.label.XMLCatalogResolver

Constructs a catalog resolver with the given list of entry files and the preference for whether system or public matches are preferred.

xmlCatalogRNG - Static variable in class gov.nasa.pds.tools.label.BootstrapResolver

URI of the RELAX NG Grammar for OASIS XML Catalog files.

xmlCatalogSysId - Static variable in class gov.nasa.pds.tools.label.BootstrapResolver

System identifier for OASIS XML Catalog files.

xmlCatalogXSD - Static variable in class gov.nasa.pds.tools.label.BootstrapResolver

URI of the W3C XML Schema for OASIS XML Catalog files.

XMLErrorListener - Class in gov.nasa.pds.tools.util

Class that handles errors while parsing an XML file.

XMLErrorListener() - Constructor for class gov.nasa.pds.tools.util.XMLErrorListener

XMLExtractor - Class in gov.nasa.pds.tools.util

Class to extract data from an XML file.

XMLExtractor(DocumentInfo) - Constructor for class gov.nasa.pds.tools.util.XMLExtractor

Constructor.

XMLExtractor(URL) - Constructor for class gov.nasa.pds.tools.util.XMLExtractor

Constructor.

XMLExtractor(InputSource) - Constructor for class gov.nasa.pds.tools.util.XMLExtractor

XMLExtractor(File) - Constructor for class gov.nasa.pds.tools.util.XMLExtractor

XMLExtractor(String) - Constructor for class gov.nasa.pds.tools.util.XMLExtractor

Constructor.

XslURIResolver - Class in gov.nasa.pds.tools.util

This class will load stylesheets used for processing schematron from within the jar file.

XslURIResolver() - Constructor for class gov.nasa.pds.tools.util.XslURIResolver

A B C D E F G H I L M O P R S T U V W X