Examples of GedcomValidator

• org.gedcom4j.validate.GedcomValidator

  A class to validate the contents of a {@link Gedcom} structure. It is used primarily for those users who wish tocreate and write GEDCOM files, and is of little importance or use to those who wish only to read/parse GEDCOM files and use their data. Validation is performed automatically prior to writing a GEDCOM file by default (although this can be disabled), and there is support for automatically repairing ("autorepair") issues found.

  Note that the validation framework is a work in progress and as such, is incompletely implemented at this time.

  General usage is as follows:

  1. Instantiate a {@link GedcomValidator}, passing the {@link Gedcom} structure to be validated as the argument tothe constructor
  2. If desired, turn off automatic repairs during validation by setting {@link GedcomValidator#autorepair} tofalse.
  3. Call the {@link GedcomValidator#validate()} method.
  4. Inspect the {@link GedcomValidator#findings} list, which contains {@link GedcomValidationFinding} objectsdescribing the problems that were found. These will include errors that were fixed by autorepair (with severity of INFO), and those that could not be autorepaired (with severity of ERROR or WARNING).

  Note again that by default, validation is performed automatically by the {@link org.gedcom4j.writer.GedcomWriter}class when writing a GEDCOM file out.

  Autorepair

  The validation framework, by default and unless disabled, will attempt to automatically repair ("autorepair") problems it finds in the object graph, so that if written as a GEDCOM file, the file written will conform to the GEDCOM spec, as well as to help the developer avoid NullPointerExceptions due to certain items not being instantiated.

  This section lists a number of the actions taken automatically when autorepair is enabled.

  • Collection fields (e.g., the language preferences collection on a submitter, or custom tags on those fields/object that support them) are initialized to empty collections if they are null.
  • Certain mandatory fields are given default values. N.B. The values chosen as defaults may not be suitable, so the user is urged to

  @author frizbog1

Examples of org.gedcom4j.validate.GedcomValidator