Examples of org.gedcom4j.parser.GedcomParser

org.gedcom4j.parser.GedcomParser
Class for parsing GEDCOM 5.5 files and creating a {@link Gedcom} structure from them.

General usage is as follows:
1. Instantiate a GedcomParser object
2. Call the GedcomParser.load() method (in one of its various forms) to parse a file/stream
3. Access the parser's gedcom property to access the parsed data
It is highly recommended that after calling the GedcomParser.load() method, the user check the {@link GedcomParser#errors} and {@link GedcomParser#warnings} collections to see if anything problematic wasencountered in the data while parsing. Most commonly, the warnings collection will have information about tags from GEDCOM 5.5.1 that were specified in a file that was designated as a GEDCOM 5.5 file. When this occurs, the data is loaded, but will not be able to be written by {@link org.gedcom4j.writer.GedcomWriter} until theversion number in the gedcomVersion field of {@link Gedcom#header} is updated to{@link SupportedVersion#V5_5_1}, or the 5.5.1-specific data is cleared from the data.

The parser takes a "forgiving" approach where it tries to load as much data as possible, including 5.5.1 data in a file that says it's in 5.5 format, and vice-versa. However, when it finds inconsistencies, it will add messages to the warnings and errors collections. Most of these messages indicate that the data was loaded, even though it was incorrect, and the data will need to be corrected before it can be written.

The parser makes the assumption that if the version of GEDCOM used is explicitly specified in the file header, that the rest of the data in the file should conform to that spec. For example, if the file header says the file is in 5.5 format (i.e., has a VERS 5.5 tag), then it will generate warnings if the new 5.5.1 tags (e.g., EMAIL) are encountered elsewhere, but will load the data anyway. If no version is specified, the 5.5.1 format is assumed as a default.

This approach was selected based on the presumption that most of the uses of GEDCOM4J will be to read GEDCOM files rather than to write them, so this provides that use case with the lowest friction.
@author frizbog1

     * @throws GedcomParserException
     * @throws IOException
     */
    @Test
    public void testToStringBigFile() throws IOException, GedcomParserException {
        GedcomParser gp = new GedcomParser();
        gp.load("sample/5.5.1 sample 1.ged");
        Gedcom g = gp.gedcom;


        for (Family f : g.families.values()) {
            assertNotNull(f.customTags.toString());
            assertFalse(0 == f.customTags.hashCode());

View Full Code Here

     * @throws GedcomParserException
     *             if the gedcom can't be parsed
     */
    @Before
    public void setUp() throws IOException, GedcomParserException {
        GedcomParser gp = new GedcomParser();
        gp.load("sample/RelationshipTest.ged");
        assertTrue(gp.errors.isEmpty());
        assertTrue(gp.warnings.isEmpty());


        g = gp.gedcom;
        assertNotNull(g);

View Full Code Here

     *             if there's a problem writing the gedcom
     */
    @Test
    public void testNonStdTagsNotWritten() throws IOException, GedcomParserException, GedcomWriterException {
        // Read original non-standard file, find non-standard birth event, assert some pre-conditions
        GedcomParser gp = new GedcomParser();
        gp.load("sample/Event Tag Test.ged");
        Gedcom gBefore = gp.gedcom;
        assertNotNull(gBefore);


        assertEquals(1, gBefore.individuals.size());
        Individual iBefore = gBefore.individuals.get("@I1@");
        assertNotNull(iBefore);


        assertNotNull(iBefore.events);
        assertEquals(4, iBefore.events.size());
        IndividualEvent eBefore = iBefore.events.get(0); // The birth event
        assertNotNull(eBefore);
        assertEquals(IndividualEventType.BIRTH, eBefore.type);
        assertNull(eBefore.yNull);
        assertNotNull(eBefore.description);


        // Write the file back out in standard format
        String fn = "tmp/" + this.getClass().getName() + ".ged";
        GedcomWriter gw = new GedcomWriter(gBefore);
        gw.validationSuppressed = true;
        gw.write(fn);


        // Read the file we just wrote back in. The non-standard part should be removed.
        gp = new GedcomParser();
        gp.load(fn);
        Gedcom gAfter = gp.gedcom;
        assertNotNull(gBefore);


        assertEquals(1, gAfter.individuals.size());
        Individual iAfter = gAfter.individuals.get("@I1@");

View Full Code Here

     *             if there's a problem writing the gedcom
     */
    @Test
    public void testValidation() throws IOException, GedcomParserException, GedcomWriterException {
        // Read original non-standard file, find non-standard birth event, assert some pre-conditions
        GedcomParser gp = new GedcomParser();
        gp.load("sample/Event Tag Test.ged");
        Gedcom gBefore = gp.gedcom;
        assertNotNull(gBefore);


        assertEquals(1, gBefore.individuals.size());
        Individual iBefore = gBefore.individuals.get("@I1@");

View Full Code Here

     * @throws GedcomParserException
     *             if the file can't be parsed
     */
    public void testValidateStressTestFile() throws IOException, GedcomParserException {
        // Load a file
        GedcomParser p = new GedcomParser();
        p.load(SAMPLE_STRESS_TEST_FILENAME);
        assertTrue(p.errors.isEmpty());
        rootValidator = new GedcomValidator(p.gedcom);
        rootValidator.validate();
        dumpFindings();
        /*

View Full Code Here

     * @throws GedcomWriterException
     *             if a gedcom data structure can't be written (usually due to invalid data, shouldn't happen)
     */
    public GedcomWriterTest() throws IOException, GedcomParserException, GedcomWriterException {
        // Load a file
        GedcomParser p = new GedcomParser();
        p.load(SAMPLE_STRESS_TEST_FILENAME);
        assertTrue(p.errors.isEmpty());
        gedcomOrig = p.gedcom;


        GedcomWriter gw = new GedcomWriter(gedcomOrig);
        gw.validationSuppressed = true;
        File tmpDir = new File("tmp");
        tmpDir.mkdirs();
        File tempFile = new File("tmp/gedcom4j.writertest.ged");
        gw.write(tempFile);


        FileInputStream byteStream = null;
        try {
            byteStream = new FileInputStream(tempFile);
            GedcomFileReader gfr = new GedcomFileReader(new BufferedInputStream(byteStream));
            readbackLines = gfr.getLines();
        } finally {
            if (byteStream != null) {
                byteStream.close();
            }
        }


        // Reload the file we just wrote
        p = new GedcomParser();
        p.load(tempFile.getAbsolutePath());
        for (String s : p.errors) {
            System.err.println(s);
        }
        assertTrue(p.errors.isEmpty());
        assertTrue(p.warnings.isEmpty());

View Full Code Here

     * @throws GedcomParserException
     *             if the gedcom can't be parsed
     */
    @Before
    public void setup() throws IOException, GedcomParserException {
        GedcomParser gp = new GedcomParser();


        gp.load("sample/RelationshipTest.ged");
        assertTrue(gp.errors.isEmpty());
        assertTrue(gp.warnings.isEmpty());
        g = gp.gedcom;
        assertNotNull(g);
        assertEquals("There are supposed to be 43 people in the gedcom - are you using the right file/file version?",

View Full Code Here


        // Write the test data
        gw.write("tmp/writertest551.ged");


        // Read it back
        GedcomParser gp = new GedcomParser();
        gp.load("tmp/writertest551.ged");
        assertTrue(gp.errors.isEmpty());
        assertTrue(gp.warnings.isEmpty());


        // Look for expected data
        g = gp.gedcom;

View Full Code Here

        // Write it
        GedcomWriter gw = new GedcomWriter(g1);
        gw.write("tmp/writertest551.ged");


        // Read it back
        GedcomParser gp = new GedcomParser();
        gp.load("tmp/writertest551.ged");
        assertNotNull(gp.gedcom);


        // See if we read back what we originally built
        Gedcom g2 = gp.gedcom;
        assertEquals(1, g2.multimedia.size());

View Full Code Here

     * @throws IOException
     *             if there's a problem reading the sample file
     */
    @Test
    public void testGetAncestors() throws IOException, GedcomParserException {
        GedcomParser gp = new GedcomParser();
        gp.load("sample/RelationshipTest.ged");
        assertTrue(gp.errors.isEmpty());
        assertTrue(gp.warnings.isEmpty());
        Gedcom g = gp.gedcom;
        assertNotNull(g);
        assertEquals("There are supposed to be 43 people in the gedcom - are you using the right file/file version?",

View Full Code Here

0 1

TOP

Related Classes of org.gedcom4j.parser.GedcomParser

org.gedcom4j.model.IndividualTest

org.gedcom4j.model.StringTreeTest

org.gedcom4j.relationship.AncestryCalculatorTest

org.gedcom4j.relationship.RelationshipCalculatorTest

org.gedcom4j.validate.GedcomValidatorTest

org.gedcom4j.writer.EventsWithDescriptionsTest

org.gedcom4j.writer.GedcomWriter551Test

org.gedcom4j.writer.GedcomWriterTest

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.