org.gedcomx.fileformat

Class GedcomxFile

java.lang.Object

org.gedcomx.fileformat.GedcomxFile

public class GedcomxFile
extends Object

The GedcomxFile class is used to read the contents of a GEDCOM X file from any file that can be opened with java.util.jar.JarFile.

Constructor Summary

Constructors

Constructor and Description
GedcomxFile(JarFile jarFile, Class<?>... classes) Creates a new GedcomxFile to read from the specified file JarFile.
GedcomxFile(JarFile gedxFile, GedcomxEntryDeserializer deserializer)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the GEDCOM X file.
String	getAttribute(String name) Get the value of the specified attribute for this GEDCOM X file.
Map<String,String>	getAttributes() Get the attributes that have been associated with this GEDCOM X file.
Iterable<GedcomxFileEntry>	getEntries() Get the entries found in this GEDCOM X file.
Manifest	getManifest() Get the manifest.
InputStream	getResourceStream(GedcomxFileEntry gedxEntry) Get the input stream of the resource in the given entry.
Object	readResource(GedcomxFileEntry gedxEntry) Unmarshal the resource contained in the given entry as an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

GedcomxFile

public GedcomxFile(JarFile gedxFile,
                   GedcomxEntryDeserializer deserializer)

GedcomxFile

public GedcomxFile(JarFile jarFile,
                   Class<?>... classes)
            throws IOException

Creates a new GedcomxFile to read from the specified file JarFile.

Parameters:

jarFile - the jar file to be read

classes - the classes to use for serialization

Throws:

IOException - if an I/O error has occurred

Method Detail

getAttribute

public String getAttribute(String name)
                    throws IOException

Get the value of the specified attribute for this GEDCOM X file.

Parameters:

name - The attribute name.

Returns:

The attribute value.

Throws:

IOException - if an I/O error has occurred

getAttributes

public Map<String,String> getAttributes()
                                 throws IOException

Get the attributes that have been associated with this GEDCOM X file.

Returns:

The attributes.

Throws:

IOException - if an I/O error has occurred

getEntries

public Iterable<GedcomxFileEntry> getEntries()

Get the entries found in this GEDCOM X file.

Returns:

The GEDCOM X file entries.

getManifest

public Manifest getManifest()
                     throws IOException

Get the manifest.

Returns:

The manifest.

Throws:

IOException - if an I/O error has occurred

getResourceStream

public InputStream getResourceStream(GedcomxFileEntry gedxEntry)
                              throws IOException

Get the input stream of the resource in the given entry.

Parameters:

gedxEntry - The entry that contains the desired resource.

Returns:

The input stream that constitutes the nature of the resource.

Throws:

IOException - if an I/O error has occurred

readResource

public Object readResource(GedcomxFileEntry gedxEntry)
                    throws IOException

Unmarshal the resource contained in the given entry as an object.

Parameters:

gedxEntry - The entry that contains the desired resource.

Returns:

The resource.

Throws:

IOException - If there was a problem unmarshalling the resource.

close

public void close()
           throws IOException

Closes the GEDCOM X file.

Throws:

IOException - if an I/O error has occurred