org.gedcomx.fileformat

Class GedcomxOutputStream

java.lang.Object

org.gedcomx.fileformat.GedcomxOutputStream

public class GedcomxOutputStream
extends Object

Class to help in writing a GEDCOM X file.

Constructor Summary

Constructors

Constructor and Description
GedcomxOutputStream(OutputStream gedxOutputStream, Class<?>... classes) Constructs a GEDCOM X output stream.
GedcomxOutputStream(OutputStream gedxOutputStream, GedcomxEntrySerializer serializer)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String name, String value) Add an attribute to the GEDCOM X output stream.
void	addResource(Gedcomx resource) Add a resource to the GEDCOM X output stream.
void	addResource(Gedcomx resource, Date lastModified) Add a resource to the GEDCOM X output stream.
void	addResource(String entryName, Gedcomx resource, Date lastModified) Add a resource to the GEDCOM X output stream.
void	addResource(String contentType, String entryName, InputStream resource, Date lastModified, Map<String,String> attributes) Add a resource to the GEDCOM X output stream.
void	addResource(String contentType, String entryName, Object resource, Date lastModified) Add a resource to the GEDCOM X output stream.
void	addResource(String contentType, String entryName, Object resource, Date lastModified, Map<String,String> attributes) Add a resource to the GEDCOM X output stream.
void	close() Closes the GEDCOM X output stream as well as the stream being filtered.
protected void	putNextEntry(String contentType, String entryName, Date lastModified, Map<String,String> attributes)

Methods inherited from class java.lang.Object

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

Constructor Detail

GedcomxOutputStream

public GedcomxOutputStream(OutputStream gedxOutputStream,
                           GedcomxEntrySerializer serializer)
                    throws IOException

Throws:

IOException

GedcomxOutputStream

public GedcomxOutputStream(OutputStream gedxOutputStream,
                           Class<?>... classes)
                    throws IOException

Constructs a GEDCOM X output stream. NOTE: This class uses the GedcomXFileJAXBContextFactory to create a JAXB context from which to derive the marshaller that is used to marshal resources into the output stream. GedcomXFileJAXBContextFactory creates a context that includes some default resource classes. The classes passed via this constructor will supplement these defaults; they will not overwrite or replace these defaults. Please see the documentation for GedcomXFileJAXBContextFactory to review the list of default classes.

Parameters:

gedxOutputStream - an output stream to which the GEDCOM X resources will appended

classes - classes representing resources that will be marshaled (via JAXB) into the GEDCOM X output stream

Throws:

IOException - if an I/O error has occurred

Method Detail

addAttribute

public void addAttribute(String name,
                         String value)

Add an attribute to the GEDCOM X output stream.

Parameters:

name - The name of the attribute.

value - The value of the attribute.

addResource

public void addResource(Gedcomx resource)
                 throws IOException

Add a resource to the GEDCOM X output stream.

Parameters:

resource - The resource.

Throws:

IOException - if an I/O error has occurred

addResource

public void addResource(Gedcomx resource,
                        Date lastModified)
                 throws IOException

Add a resource to the GEDCOM X output stream.

Parameters:

resource - The resource.

lastModified - timestamp when the resource was last modified (can be null)

Throws:

IOException - if an I/O error has occurred

addResource

public void addResource(String entryName,
                        Gedcomx resource,
                        Date lastModified)
                 throws IOException

Add a resource to the GEDCOM X output stream.

Parameters:

entryName - The name by which this resource shall be known within the GEDCOM X file.

resource - The resource.

lastModified - timestamp when the resource was last modified (can be null)

Throws:

IOException - if an I/O error has occurred

addResource

public void addResource(String contentType,
                        String entryName,
                        Object resource,
                        Date lastModified)
                 throws IOException

Add a resource to the GEDCOM X output stream.

Parameters:

contentType - The content type of the resource.

entryName - The name by which this resource shall be known within the GEDCOM X file.

resource - The resource.

lastModified - timestamp when the resource was last modified (can be null)

Throws:

IOException - if an I/O error has occurred

addResource

public void addResource(String contentType,
                        String entryName,
                        Object resource,
                        Date lastModified,
                        Map<String,String> attributes)
                 throws IOException

Add a resource to the GEDCOM X output stream.

Parameters:

contentType - The content type of the resource.

entryName - The name by which this resource shall be known within the GEDCOM X file.

resource - The resource.

lastModified - timestamp when the resource was last modified (can be null)

attributes - The attributes of the resource.

Throws:

IOException - if an I/O error has occurred

addResource

public void addResource(String contentType,
                        String entryName,
                        InputStream resource,
                        Date lastModified,
                        Map<String,String> attributes)
                 throws IOException

Add a resource to the GEDCOM X output stream.

Parameters:

contentType - The content type of the resource.

entryName - The name by which this resource shall be known within the GEDCOM X file.

resource - The resource.

lastModified - timestamp when the resource was last modified (can be null)

attributes - The attributes of the resource.

Throws:

IOException - if an I/O error has occurred

putNextEntry

protected void putNextEntry(String contentType,
                            String entryName,
                            Date lastModified,
                            Map<String,String> attributes)
                     throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Closes the GEDCOM X output stream as well as the stream being filtered.

Throws:

IOException - if an I/O error has occurred