org.apache.ddlutils.io

Class DatabaseIO

java.lang.Object

org.apache.ddlutils.io.DatabaseIO

public class DatabaseIO
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE64_ATTR_NAME The name of the XML attribute use to denote that teh content of a data XML element uses Base64 encoding.
static String	DDLUTILS_NAMESPACE The namespace used by DdlUtils.
static QName	QNAME_ATTRIBUTE_AUTO_INCREMENT Qualified name of the autoIncrement attribute.
static QName	QNAME_ATTRIBUTE_DEFAULT Qualified name of the default attribute.
static QName	QNAME_ATTRIBUTE_DEFAULT_ID_METHOD Qualified name of the defaultIdMethod attribute.
static QName	QNAME_ATTRIBUTE_DESCRIPTION Qualified name of the description attribute.
static QName	QNAME_ATTRIBUTE_FOREIGN Qualified name of the foreign attribute.
static QName	QNAME_ATTRIBUTE_FOREIGN_TABLE Qualified name of the foreignTable attribute.
static QName	QNAME_ATTRIBUTE_JAVA_NAME Qualified name of the javaName attribute.
static QName	QNAME_ATTRIBUTE_LOCAL Qualified name of the local attribute.
static QName	QNAME_ATTRIBUTE_NAME Qualified name of the name attribute.
static QName	QNAME_ATTRIBUTE_ON_DELETE Qualified name of the onDelete attribute.
static QName	QNAME_ATTRIBUTE_ON_UPDATE Qualified name of the onUpdate attribute.
static QName	QNAME_ATTRIBUTE_PRIMARY_KEY Qualified name of the primaryKey attribute.
static QName	QNAME_ATTRIBUTE_REQUIRED Qualified name of the required attribute.
static QName	QNAME_ATTRIBUTE_SIZE Qualified name of the size attribute.
static QName	QNAME_ATTRIBUTE_TYPE Qualified name of the type attribute.
static QName	QNAME_ATTRIBUTE_VERSION Qualified name of the version attribute.
static QName	QNAME_ELEMENT_COLUMN Qualified name of the column element.
static QName	QNAME_ELEMENT_DATABASE Qualified name of the database element.
static QName	QNAME_ELEMENT_FOREIGN_KEY Qualified name of the foreign-key element.
static QName	QNAME_ELEMENT_INDEX Qualified name of the index element.
static QName	QNAME_ELEMENT_INDEX_COLUMN Qualified name of the index-column element.
static QName	QNAME_ELEMENT_REFERENCE Qualified name of the reference element.
static QName	QNAME_ELEMENT_TABLE Qualified name of the table element.
static QName	QNAME_ELEMENT_UNIQUE Qualified name of the unique element.
static QName	QNAME_ELEMENT_UNIQUE_COLUMN Qualified name of the unique-column element.

Constructor Summary

Constructors

Constructor and Description
DatabaseIO()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isUseInternalDtd() Deprecated. Switched to XML schema, and the internal XML schema should always be used
boolean	isValidateXml() Returns whether XML is validated upon reading it.
Database	read(File file) Reads the database model contained in the specified file.
Database	read(InputSource source) Reads the database model from the given input source.
Database	read(Reader reader) Reads the database model given by the reader.
Database	read(String filename) Reads the database model contained in the specified file.
void	setUseInternalDtd(boolean useInternalDtd) Deprecated. Switched to XML schema, and the internal XML schema should always be used
void	setValidateXml(boolean validateXml) Specifies whether XML shall be validated upon reading it.
void	write(Database model, OutputStream output) Writes the database model to the given output stream.
void	write(Database model, String filename) Writes the database model to the specified file.
void	write(Database model, 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 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

DDLUTILS_NAMESPACE

public static final String DDLUTILS_NAMESPACE

The namespace used by DdlUtils.

See Also:

Constant Field Values

QNAME_ELEMENT_COLUMN

public static final QName QNAME_ELEMENT_COLUMN

Qualified name of the column element.

QNAME_ELEMENT_DATABASE

public static final QName QNAME_ELEMENT_DATABASE

Qualified name of the database element.

QNAME_ELEMENT_FOREIGN_KEY

public static final QName QNAME_ELEMENT_FOREIGN_KEY

Qualified name of the foreign-key element.

QNAME_ELEMENT_INDEX

public static final QName QNAME_ELEMENT_INDEX

Qualified name of the index element.

QNAME_ELEMENT_INDEX_COLUMN

public static final QName QNAME_ELEMENT_INDEX_COLUMN

Qualified name of the index-column element.

QNAME_ELEMENT_REFERENCE

public static final QName QNAME_ELEMENT_REFERENCE

Qualified name of the reference element.

QNAME_ELEMENT_TABLE

public static final QName QNAME_ELEMENT_TABLE

Qualified name of the table element.

QNAME_ELEMENT_UNIQUE

public static final QName QNAME_ELEMENT_UNIQUE

Qualified name of the unique element.

QNAME_ELEMENT_UNIQUE_COLUMN

public static final QName QNAME_ELEMENT_UNIQUE_COLUMN

Qualified name of the unique-column element.

QNAME_ATTRIBUTE_AUTO_INCREMENT

public static final QName QNAME_ATTRIBUTE_AUTO_INCREMENT

Qualified name of the autoIncrement attribute.

QNAME_ATTRIBUTE_DEFAULT

public static final QName QNAME_ATTRIBUTE_DEFAULT

Qualified name of the default attribute.

QNAME_ATTRIBUTE_DEFAULT_ID_METHOD

public static final QName QNAME_ATTRIBUTE_DEFAULT_ID_METHOD

Qualified name of the defaultIdMethod attribute.

QNAME_ATTRIBUTE_DESCRIPTION

public static final QName QNAME_ATTRIBUTE_DESCRIPTION

Qualified name of the description attribute.

QNAME_ATTRIBUTE_FOREIGN

public static final QName QNAME_ATTRIBUTE_FOREIGN

Qualified name of the foreign attribute.

QNAME_ATTRIBUTE_FOREIGN_TABLE

public static final QName QNAME_ATTRIBUTE_FOREIGN_TABLE

Qualified name of the foreignTable attribute.

QNAME_ATTRIBUTE_JAVA_NAME

public static final QName QNAME_ATTRIBUTE_JAVA_NAME

Qualified name of the javaName attribute.

QNAME_ATTRIBUTE_LOCAL

public static final QName QNAME_ATTRIBUTE_LOCAL

Qualified name of the local attribute.

QNAME_ATTRIBUTE_NAME

public static final QName QNAME_ATTRIBUTE_NAME

Qualified name of the name attribute.

QNAME_ATTRIBUTE_ON_DELETE

public static final QName QNAME_ATTRIBUTE_ON_DELETE

Qualified name of the onDelete attribute.

QNAME_ATTRIBUTE_ON_UPDATE

public static final QName QNAME_ATTRIBUTE_ON_UPDATE

Qualified name of the onUpdate attribute.

QNAME_ATTRIBUTE_PRIMARY_KEY

public static final QName QNAME_ATTRIBUTE_PRIMARY_KEY

Qualified name of the primaryKey attribute.

QNAME_ATTRIBUTE_REQUIRED

public static final QName QNAME_ATTRIBUTE_REQUIRED

Qualified name of the required attribute.

QNAME_ATTRIBUTE_SIZE

public static final QName QNAME_ATTRIBUTE_SIZE

Qualified name of the size attribute.

QNAME_ATTRIBUTE_TYPE

public static final QName QNAME_ATTRIBUTE_TYPE

Qualified name of the type attribute.

QNAME_ATTRIBUTE_VERSION

public static final QName QNAME_ATTRIBUTE_VERSION

Qualified name of the version attribute.

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()

Deprecated. Switched to XML schema, and the internal XML schema should always be used

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)

Deprecated. Switched to XML schema, and the internal XML schema should always be used

Specifies whether the internal dtd is to be used.

Parameters:

useInternalDtd - Whether to use the internal dtd

read

public Database read(String filename)
              throws DdlUtilsXMLException

Reads the database model contained in the specified file.

Parameters:

filename - The model file name

Returns:

The database model

Throws:

DdlUtilsXMLException

read

public Database read(File file)
              throws DdlUtilsXMLException

Reads the database model contained in the specified file.

Parameters:

file - The model file

Returns:

The database model

Throws:

DdlUtilsXMLException

read

public Database read(Reader reader)
              throws DdlUtilsXMLException

Reads the database model given by the reader. Note that this method does not close the given reader.

Parameters:

reader - The reader that returns the model XML

Returns:

The database model

Throws:

DdlUtilsXMLException

read

public Database read(InputSource source)
              throws DdlUtilsXMLException

Reads the database model from the given input source.

Parameters:

source - The input source

Returns:

The database model

Throws:

DdlUtilsXMLException

write

public void write(Database model,
         String filename)
           throws DdlUtilsXMLException

Writes the database model to the specified file.

Parameters:

model - The database model

filename - The model file name

Throws:

DdlUtilsXMLException

write

public void write(Database model,
         OutputStream output)
           throws DdlUtilsXMLException

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

Parameters:

model - The database model

output - The output stream

Throws:

DdlUtilsXMLException

write

public void write(Database model,
         Writer output)
           throws DdlUtilsXMLException

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

Parameters:

model - The database model

output - The output writer

Throws:

DdlUtilsXMLException