uk.gov.nationalarchives.csv.validator.api.java

Class CsvValidator

java.lang.Object

uk.gov.nationalarchives.csv.validator.api.java.CsvValidator

public class CsvValidator
extends java.lang.Object

Validate that a csv file matches a format specified a csv schema. This is a Java wrapper calling the main Scala application.

A typical invocation sequence:

  Boolean failFast = false;
  List<Substitution> pathSubstitutions = new ArrayList<Substitution>();

  //add a substitution path
  pathSubstitutions.add(new Substitution("file://something", "/home/xxx"));

  List<FailMessage> messages = CsvValidator.validate(
    "/home/dev/IdeaProjects/csv/csv-validator/csv-validator-core/data.csv",
    "/home/dev/IdeaProjects/csv/csv-validator/csv-validator-core/data-schema.csvs",
    failFast,
    pathSubstitutions,
    true);

  if(messages.isEmpty()) {
    System.out.println("All worked OK");
  } else {
    for(FailMessage message : messages) {
      if(message instanceof WarningMessage) {
        System.out.println("Warning: " + message.getMessage());
      } else {
        System.out.println("Error: " + message.getMessage());
      }
    }
  }
 

Constructor Summary

Constructors

Constructor and Description
CsvValidator()

Method Summary

Modifier and Type	Method and Description
static java.util.List<FailMessage>	validate(java.io.Reader csvData, java.io.Reader csvSchema, boolean failFast, java.util.List<Substitution> pathSubstitutions, java.lang.Boolean enforceCaseSensitivePathChecks, java.lang.Boolean trace) Validate CSV data against a CSV schema
static java.util.List<FailMessage>	validate(java.io.Reader csvData, java.io.Reader csvSchema, boolean failFast, java.util.List<Substitution> pathSubstitutions, java.lang.Boolean enforceCaseSensitivePathChecks, java.lang.Boolean trace, ProgressCallback progress) Validate CSV data against a CSV schema
static java.util.List<FailMessage>	validate(java.lang.String csvFilename, java.nio.charset.Charset csvEncoding, java.lang.String csvSchemaFilename, java.nio.charset.Charset csvSchemaEncoding, boolean failFast, java.util.List<Substitution> pathSubstitutions, java.lang.Boolean enforceCaseSensitivePathChecks, java.lang.Boolean trace) Validate a CSV file against a CSV schema file
static java.util.List<FailMessage>	validate(java.lang.String csvFilename, java.nio.charset.Charset csvEncoding, java.lang.String csvSchemaFilename, java.nio.charset.Charset csvSchemaEncoding, boolean failFast, java.util.List<Substitution> pathSubstitutions, java.lang.Boolean enforceCaseSensitivePathChecks, java.lang.Boolean trace, ProgressCallback progress) Validate a CSV file against a CSV schema file
static java.util.List<FailMessage>	validate(java.lang.String csvFilename, java.lang.String csvSchemaFilename, boolean failFast, java.util.List<Substitution> pathSubstitutions, java.lang.Boolean enforceCaseSensitivePathChecks, java.lang.Boolean trace) Validate a CSV file against a CSV schema file Assumes that the encoding of the CSV file and CSV Schema file are both UTF-8
static java.util.List<FailMessage>	validate(java.lang.String csvFilename, java.lang.String csvSchemaFilename, boolean failFast, java.util.List<Substitution> pathSubstitutions, java.lang.Boolean enforceCaseSensitivePathChecks, java.lang.Boolean trace, ProgressCallback progress) Validate a CSV file against a CSV schema file Assumes that the encoding of the CSV file and CSV Schema file are both UTF-8

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvValidator

public CsvValidator()

Method Detail

validate

public static java.util.List<FailMessage> validate(java.lang.String csvFilename,
                                                   java.lang.String csvSchemaFilename,
                                                   boolean failFast,
                                                   java.util.List<Substitution> pathSubstitutions,
                                                   java.lang.Boolean enforceCaseSensitivePathChecks,
                                                   java.lang.Boolean trace)

Validate a CSV file against a CSV schema file Assumes that the encoding of the CSV file and CSV Schema file are both UTF-8

Parameters:

csvFilename - filename of the CSV file

csvSchemaFilename - Filename of the CSV schema file

failFast - true if you want to stop processing on the first error found, false if you want to fine all errors

pathSubstitutions - list of substitutions for file paths

enforceCaseSensitivePathChecks - Enforces case-sensitive file path checks

trace - When set to true, a trace of the grammar parse will be output

Returns:

empty list of (if there are no errors), or list of error strings.

validate

public static java.util.List<FailMessage> validate(java.lang.String csvFilename,
                                                   java.nio.charset.Charset csvEncoding,
                                                   java.lang.String csvSchemaFilename,
                                                   java.nio.charset.Charset csvSchemaEncoding,
                                                   boolean failFast,
                                                   java.util.List<Substitution> pathSubstitutions,
                                                   java.lang.Boolean enforceCaseSensitivePathChecks,
                                                   java.lang.Boolean trace)

Validate a CSV file against a CSV schema file

Parameters:

csvFilename - filename of the CSV file

csvEncoding - The charset encoding used in the CSV file

csvSchemaFilename - Filename of the CSV schema file

csvSchemaEncoding - The charset encoding used in the CSV Schema file

failFast - true if you want to stop processing on the first error found, false if you want to fine all errors

pathSubstitutions - list of substitutions for file paths

enforceCaseSensitivePathChecks - Enforces case-sensitive file path checks

trace - When set to true, a trace of the grammar parse will be output

Returns:

empty list of (if there are no errors), or list of error strings.

validate

public static java.util.List<FailMessage> validate(java.lang.String csvFilename,
                                                   java.lang.String csvSchemaFilename,
                                                   boolean failFast,
                                                   java.util.List<Substitution> pathSubstitutions,
                                                   java.lang.Boolean enforceCaseSensitivePathChecks,
                                                   java.lang.Boolean trace,
                                                   ProgressCallback progress)

Validate a CSV file against a CSV schema file Assumes that the encoding of the CSV file and CSV Schema file are both UTF-8

Parameters:

csvFilename - filename of the CSV file

csvSchemaFilename - Filename of the CSV schema file

failFast - true if you want to stop processing on the first error found, false if you want to fine all errors

pathSubstitutions - list of substitutions for file paths

enforceCaseSensitivePathChecks - Enforces case-sensitive file path checks

trace - When set to true, a trace of the grammar parse will be output

progress - A callback to receive progress updates on the validation process

Returns:

empty list of (if there are no errors), or list of error strings.

validate

public static java.util.List<FailMessage> validate(java.lang.String csvFilename,
                                                   java.nio.charset.Charset csvEncoding,
                                                   java.lang.String csvSchemaFilename,
                                                   java.nio.charset.Charset csvSchemaEncoding,
                                                   boolean failFast,
                                                   java.util.List<Substitution> pathSubstitutions,
                                                   java.lang.Boolean enforceCaseSensitivePathChecks,
                                                   java.lang.Boolean trace,
                                                   ProgressCallback progress)

Validate a CSV file against a CSV schema file

Parameters:

csvFilename - filename of the CSV file

csvEncoding - The charset encoding used in the CSV file

csvSchemaFilename - Filename of the CSV schema file

csvSchemaEncoding - The charset encoding used in the CSV Schema file

failFast - true if you want to stop processing on the first error found, false if you want to fine all errors

pathSubstitutions - list of substitutions for file paths

enforceCaseSensitivePathChecks - Enforces case-sensitive file path checks

trace - When set to true, a trace of the grammar parse will be output

progress - A callback to receive progress updates on the validation process

Returns:

empty list of (if there are no errors), or list of error strings.

validate

public static java.util.List<FailMessage> validate(java.io.Reader csvData,
                                                   java.io.Reader csvSchema,
                                                   boolean failFast,
                                                   java.util.List<Substitution> pathSubstitutions,
                                                   java.lang.Boolean enforceCaseSensitivePathChecks,
                                                   java.lang.Boolean trace)

Validate CSV data against a CSV schema

Parameters:

csvData - CSV data

csvSchema - CSV schema

failFast - true if you want to stop processing on the first error found, false if you want to fine all errors

pathSubstitutions - list of substitutions for file paths

enforceCaseSensitivePathChecks - Enforces case-sensitive file path checks

trace - When set to true, a trace of the grammar parse will be output

Returns:

empty list of (if there are no errors), or list of error strings.

validate

public static java.util.List<FailMessage> validate(java.io.Reader csvData,
                                                   java.io.Reader csvSchema,
                                                   boolean failFast,
                                                   java.util.List<Substitution> pathSubstitutions,
                                                   java.lang.Boolean enforceCaseSensitivePathChecks,
                                                   java.lang.Boolean trace,
                                                   ProgressCallback progress)

Validate CSV data against a CSV schema

Parameters:

csvData - CSV data

csvSchema - CSV schema

failFast - true if you want to stop processing on the first error found, false if you want to fine all errors

pathSubstitutions - list of substitutions for file paths

enforceCaseSensitivePathChecks - Enforces case-sensitive file path checks

trace - When set to true, a trace of the grammar parse will be output

progress - A callback to receive progress updates on the validation process

Returns:

empty list of (if there are no errors), or list of error strings.