org.apache.ddlutils.io
Class DatabaseIO

java.lang.Object
  org.apache.ddlutils.io.DatabaseIO

public class DatabaseIO
extends java.lang.Object

This class provides functions to read and write database models from/to XML.

Version:

$Revision: 481151 $

Field Summary

static java.lang.String

BASE64_ATTR_NAME The name of the XML attribute use to denote that teh content of a data XML element uses Base64 encoding.

Constructor Summary

DatabaseIO()

Method Summary

protected org.xml.sax.InputSource	getBetwixtMapping() Returns the commons-betwixt mapping file as an InputSource object.
protected org.apache.commons.betwixt.io.BeanReader	getReader() Returns a new bean reader configured to read database models.
protected org.apache.commons.betwixt.io.BeanWriter	getWriter(java.io.Writer output) Returns a new bean writer configured to writer database models.
boolean	isUseInternalDtd() Returns whether the internal dtd that comes with DdlUtils is used.
boolean	isValidateXml() Returns whether XML is validated upon reading it.
Database	read(java.io.File file) Reads the database model contained in the specified file.
Database	read(org.xml.sax.InputSource source) Reads the database model from the given input source.
Database	read(java.io.Reader reader) Reads the database model given by the reader.
Database	read(java.lang.String filename) Reads the database model contained in the specified file.
void	setUseInternalDtd(boolean useInternalDtd) Specifies whether the internal dtd is to be used.
void	setValidateXml(boolean validateXml) Specifies whether XML shall be validated upon reading it.
void	write(Database model, java.io.OutputStream output) Writes the database model to the given output stream.
void	write(Database model, java.lang.String filename) Writes the database model to the specified file.
void	write(Database model, java.io.Writer output) Writes the database model to the given output writer.

Methods inherited from class java.lang.Object

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

Field Detail

BASE64_ATTR_NAME

public static final java.lang.String BASE64_ATTR_NAME

The name of the XML attribute use to denote that teh content of a data XML element uses Base64 encoding.

See Also:

Constant Field Values

Constructor Detail

DatabaseIO

public DatabaseIO()

Method Detail

isValidateXml

public boolean isValidateXml()

Returns whether XML is validated upon reading it.

Returns:

true if read XML is validated

setValidateXml

public void setValidateXml(boolean validateXml)

Specifies whether XML shall be validated upon reading it.

Parameters:

validateXml - true if read XML shall be validated

isUseInternalDtd

public boolean isUseInternalDtd()

Returns whether the internal dtd that comes with DdlUtils is used.

Returns:

true if parsing uses the internal dtd

setUseInternalDtd

public void setUseInternalDtd(boolean useInternalDtd)

Specifies whether the internal dtd is to be used.

Parameters:

useInternalDtd - Whether to use the internal dtd

getBetwixtMapping

protected org.xml.sax.InputSource getBetwixtMapping()

Returns the commons-betwixt mapping file as an InputSource object. Per default, this will be classpath resource under the path /mapping.xml.

Returns:

The input source for the mapping

getReader

protected org.apache.commons.betwixt.io.BeanReader getReader()
                                                      throws java.beans.IntrospectionException,
                                                             org.xml.sax.SAXException,
                                                             java.io.IOException

Returns a new bean reader configured to read database models.

Returns:

The reader

Throws:

java.beans.IntrospectionException

org.xml.sax.SAXException

java.io.IOException

getWriter

protected org.apache.commons.betwixt.io.BeanWriter getWriter(java.io.Writer output)
                                                      throws DdlUtilsException

Returns a new bean writer configured to writer database models.

Parameters:

output - The target output writer

Returns:

The writer

Throws:

DdlUtilsException

read

public Database read(java.lang.String filename)
              throws DdlUtilsException

Reads the database model contained in the specified file.

Parameters:

filename - The model file name

Returns:

The database model

Throws:

DdlUtilsException

read

public Database read(java.io.File file)
              throws DdlUtilsException

Reads the database model contained in the specified file.

Parameters:

file - The model file

Returns:

The database model

Throws:

DdlUtilsException

read

public Database read(java.io.Reader reader)
              throws DdlUtilsException

Reads the database model given by the reader.

Parameters:

reader - The reader that returns the model XML

Returns:

The database model

Throws:

DdlUtilsException

read

public Database read(org.xml.sax.InputSource source)
              throws DdlUtilsException

Reads the database model from the given input source.

Parameters:

source - The input source

Returns:

The database model

Throws:

DdlUtilsException

write

public void write(Database model,
                  java.lang.String filename)
           throws DdlUtilsException

Writes the database model to the specified file.

Parameters:

model - The database model

filename - The model file name

Throws:

DdlUtilsException

write

public void write(Database model,
                  java.io.OutputStream output)
           throws DdlUtilsException

Writes the database model to the given output stream. Note that this method does not flush the stream.

Parameters:

model - The database model

output - The output stream

Throws:

DdlUtilsException

write

public void write(Database model,
                  java.io.Writer output)
           throws DdlUtilsException

Writes the database model to the given output writer. Note that this method does not flush the writer.

Parameters:

model - The database model

output - The output writer

Throws:

DdlUtilsException