public class ValidationUtil extends Object
Config
property "validation.expectationFile" and give the file
path to the "validation" folder of the run that you want to match. To specify which file attributes
are reported, use Config
property "validation.reportOn". To specify which file attributes are used for
the comparison, use use Config
property "validation.compareOn".Modifier and Type | Field and Description |
---|---|
protected static String |
COMPARE_ON
Config set property giving the file metrics to use in comparing to the expectation. |
static String |
EXPECTATION_FILE
Config String property giving the file path that gives the expected values for file metrics. |
protected static int |
FAIL |
protected static String |
HALT_PIPELINE
Config boolean property "validation.stopPipeline". |
protected static String |
MATCHED_EXPECTATION
The last column in a the output file, "MATCHED_EXPECTATION", indicates if the referenced file met all
expectations (PASS), or not (FAIL), or was not compared to any expectations (REPORT).
|
protected static String |
MD5 |
protected static String |
NAME
The first column in an expectation file must be "name"
|
protected static String |
OUTPUT_FILE_SUFFIX
Append the String "_validation.txt" to the name of the validated module to get the output file name.
|
protected static int |
PASS |
protected static int |
REPORT |
protected static String |
REPORT_ON
Config property "validation.reportOn" giving the set of file metrics to use report. |
protected static String |
SIZE |
protected static String |
SIZE_WITHIN_PERCENT
Config property "validation.sizeWithinPercent" giving the percentage by which size is allow to
deviate and still be considered a valid match for the expectation. |
protected static String[] |
statusStrings |
protected static String |
VALIDATION_FOLDER |
Constructor and Description |
---|
ValidationUtil() |
Modifier and Type | Method and Description |
---|---|
static void |
checkDependencies(BioModule module)
This method calls the methods that are used by executeTask to get the validation input.
|
protected static List<String> |
getValidationAttributes() |
static File |
getValidationDir() |
static boolean |
hasStrictValidation(boolean printStdOut)
Print a message (and return boolean) to indicate that this pipeline has validation enabled.
|
static void |
registerProps() |
static void |
validateModule(BioModule module) |
public static final String EXPECTATION_FILE
Config
String property giving the file path that gives the expected values for file metrics.
Probably generated by a previous run of the same pipeline.protected static final String COMPARE_ON
Config
set property giving the file metrics to use in comparing to the expectation. Default is
to use all metrics in the expectation file.protected static final int FAIL
protected static final String HALT_PIPELINE
Config
boolean property "validation.stopPipeline". If the output files do not meet expectation,
stop the pipeline.protected static final String MATCHED_EXPECTATION
protected static final String MD5
protected static final String NAME
protected static final String OUTPUT_FILE_SUFFIX
protected static final int PASS
protected static final int REPORT
protected static final String REPORT_ON
Config
property "validation.reportOn" giving the set of file metrics to use report. Default is to
use all currently available metrics.protected static final String SIZE
protected static final String SIZE_WITHIN_PERCENT
Config
property "validation.sizeWithinPercent" giving the percentage by which size is allow to
deviate and still be considered a valid match for the expectation.protected static final String[] statusStrings
protected static final String VALIDATION_FOLDER
public static void checkDependencies(BioModule module) throws Exception
module
- BioModule to check validation dependencies forException
- if errors occurpublic static File getValidationDir()
public static void validateModule(BioModule module) throws BioLockJException
BioLockJException
public static boolean hasStrictValidation(boolean printStdOut)
printStdOut
- public static void registerProps() throws API_Exception
API_Exception