Class ValidateLauncher


  • public class ValidateLauncher
    extends Object
    Wrapper class for the Validate Tool. Class handles command-line parsing and querying, in addition to reporting setup.
    Author:
    mcayanan
    • Method Detail

      • parse

        public org.apache.commons.cli.CommandLine parse​(String[] args)
                                                 throws org.apache.commons.cli.ParseException
        Parse the command-line arguments
        Parameters:
        args - The command-line arguments
        Returns:
        A class representation of the command-line arguments
        Throws:
        org.apache.commons.cli.ParseException - If an error occurred during parsing.
      • query

        public void query​(org.apache.commons.cli.CommandLine line)
                   throws Exception
        Query the command-line and process the command-line option flags set.
        Parameters:
        line - A CommandLine object containing the flags that were set.
        Throws:
        Exception - If an error occurred while processing the command-line options.
      • query

        public void query​(File configuration)
                   throws org.apache.commons.configuration.ConfigurationException
        Query the configuration file.
        Parameters:
        configuration - A configuration file.
        Throws:
        org.apache.commons.configuration.ConfigurationException - If an error occurred while querying the configuration file.
      • setAdditionalPaths

        public void setAdditionalPaths​(List<String> additionalPaths)
                                throws MalformedURLException
        Set additional paths to be specified when attempting referential integrity validation (pds4.bundle or pds4.collection rules)
        Parameters:
        additionalPaths - A list of paths.
        Throws:
        MalformedURLException
      • setManifestBasePath

        public void setManifestBasePath​(String path)
                                 throws MalformedURLException
        Set the base path to look up relative file references in a given checksum manifest file.
        Parameters:
        path - A path.
        Throws:
        MalformedURLException
      • setCatalogs

        public void setCatalogs​(List<String> catalogs)
        Set the catalogs.
        Parameters:
        catalogs - A list of catalogs.
      • setReport

        public void setReport​(File report)
        Sets the report file.
        Parameters:
        report - A report file.
      • getReport

        public Report getReport()
        Gets the object representation of the Validation Report.
        Returns:
        The Report object.
      • setReportStyle

        public void setReportStyle​(String style)
                            throws Exception
        Set the output style for the report.
        Parameters:
        style - 'sum' for a summary report, 'min' for a minimal report, and 'full' for a full report
        Throws:
        Exception
      • setTraverse

        public void setTraverse​(boolean value)
        Sets the flag to enable/disable directory recursion.
        Parameters:
        value - A boolean value.
      • setSeverity

        public void setSeverity​(int level)
        Sets the severity level for the report.
        Parameters:
        level - An interger value.
      • setRegExps

        public void setRegExps​(List<String> patterns)
        Sets the list of file patterns to look for if traversing a directory.
        Parameters:
        patterns - A list of file patterns.
      • setForce

        public void setForce​(boolean value)
      • setValidationRule

        public void setValidationRule​(String value)
        Sets the validation rule name to use.
        Parameters:
        value - the validation rule name
      • setContentValidation

        public void setContentValidation​(boolean flag)
        Sets the flag that enables/disables data content validation.
        Parameters:
        flag - True or False.
      • setContextReferenceCheck

        public void setContextReferenceCheck​(boolean flag)
      • setCheckInbetweenFields

        public void setCheckInbetweenFields​(boolean flag)
      • setSkipProductValidation

        public void setSkipProductValidation​(boolean flag)
      • setMaxErrors

        public void setMaxErrors​(long value)
      • setEveryN

        public void setEveryN​(int value)
      • setSpotCheckData

        public void setSpotCheckData​(int value)
      • setAllowUnlabeledFiles

        public void setAllowUnlabeledFiles​(boolean flag)
      • setUpdateRegisteredProducts

        public void setUpdateRegisteredProducts​(boolean updateRegisteredProducts)
      • setNonRegisteredProducts

        public void setNonRegisteredProducts​(boolean nonRegisteredProducts)
      • getRegisteredProductsFile

        public File getRegisteredProductsFile()
      • setRegisteredProductsFile

        public void setRegisteredProductsFile​(File registeredProductsFile)
      • getNonRegisteredProductsFile

        public File getNonRegisteredProductsFile()
      • setNonRegisteredProductsFile

        public void setNonRegisteredProductsFile​(File nonRegisteredProductsFile)
      • setValidateContext

        public void setValidateContext​(boolean flag)
        Sets the flag that enables/disables context validation.
        Parameters:
        flag - True or False.
      • displayHelp

        public void displayHelp()
        Displays tool usage.
      • displayVersion

        public void displayVersion()
                            throws IOException
        Displays the current version and disclaimer notice.
        Throws:
        IOException - If there was an error that occurred while getting the tool information.
      • setupReport

        public void setupReport()
                         throws IOException
        Setup the report.
        Throws:
        IOException - If an error occurred while setting up the report.
      • doValidation

        public boolean doValidation​(Map<URL,​String> checksumManifest)
                             throws Exception
        Performs validation.
        Parameters:
        checksumManifest -
        Returns:
        boolean true - success false - fail
        Throws:
        Exception
      • printReportFooter

        public void printReportFooter()
        Print the report footer.
      • processMain

        public int processMain​(String[] args)
                        throws Exception
        Wrapper method for the main class that returns valid exitCode for execution.
        Parameters:
        args - list of command-line arguments.
        Throws:
        Exception
      • flushValidators

        public void flushValidators()
        Flush ValidatorFactory cache (set to null). The ValidatorFactory will cache schemas and other validation data between runs, which can cause issues, specifically when using varying dictionaries and catalog files.
      • getLabelExtension

        public String getLabelExtension()
      • setLabelExtension

        public void setLabelExtension​(String labelExtension)
        Set the label extension to crawl for within the target space. NOTE: This should be executed prior to running the doValidation or it will not be appropriately added to validation pipeline execution context.
        Parameters:
        labelExtension -