org.mmbase.util
Class XMLDatabaseReader

java.lang.Object
  |
  +--org.mmbase.util.XMLBasicReader
        |
        +--org.mmbase.util.XMLDatabaseReader

public class XMLDatabaseReader

extends XMLBasicReader

Author:

Case Roole, Rico Jansen, Pierre van Rooden

Fields inherited from class org.mmbase.util.XMLBasicReader

document

Constructor Summary

XMLDatabaseReader(java.lang.String path)
Constructor

Method Summary

java.lang.String	getBlobDataDir() Retrieves the file path where binary objects are to be stored.
java.lang.String	getCreateExtendedScheme() Retrieves the create scheme for extending tables.
java.lang.String	getCreateScheme() Retrieves the create scheme
java.util.Hashtable	getDisallowedFields() Retrieve a map of fieldnames that are disallowed (i.e reserved words) for this database.
java.lang.String	getForeignKeyScheme() Retrieves the foreign key scheme.
java.lang.String	getKeyScheme() Retrieves the key scheme.
int	getMaxDropSize() Get the max drop size for this database.
java.lang.String	getMMBaseDatabaseDriver() Returns the mmbase database driver class for this database.
java.lang.String	getName() Returns the name of the database.
java.lang.String	getNotNullScheme() Retrieves the not null scheme.
java.lang.String	getPrimaryKeyScheme() Retrieves the primary key scheme.
java.util.Hashtable	getTypeMapping() Obtains the type map.

Methods inherited from class org.mmbase.util.XMLBasicReader

getChildElements, getChildElements, getChildElements, getChildElements, getDocumentBuilder, getDocumentBuilder, getDocumentBuilder, getDocumentBuilder, getDocumentBuilder, getDocumentBuilder, getElementAttributeValue, getElementAttributeValue, getElementByPath, getElementByPath, getElementName, getElementValue, getElementValue, getFileName, reinitLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLDatabaseReader

public XMLDatabaseReader(java.lang.String path)

Constructor

Parameters:

path - the filename

Method Detail

getName

public java.lang.String getName()

Returns the name of the database.

Returns:

the name as a string

getMMBaseDatabaseDriver

public java.lang.String getMMBaseDatabaseDriver()

Returns the mmbase database driver class for this database.

Returns:

the name of the class

getBlobDataDir

public java.lang.String getBlobDataDir()

Retrieves the file path where binary objects are to be stored. If this value is set, binary objects are stored as files, not in the databse.

Returns:

the path, or the empty string if not specified

getMaxDropSize

public int getMaxDropSize()

Get the max drop size for this database. The max drop size determines whether a table can be dropped as part of a table alteration command.

Returns:

the max drop size in number of records

getDisallowedFields

public java.util.Hashtable getDisallowedFields()

Retrieve a map of fieldnames that are disallowed (i.e reserved words) for this database. Each entry in the map has as its key the disallowed name, and as its value the name with which it needs to be replaced.

Returns:

the map with the disallowed fields

getCreateScheme

public java.lang.String getCreateScheme()

Retrieves the create scheme

Returns:

the create scheme, or the empty string if not available

getCreateExtendedScheme

public java.lang.String getCreateExtendedScheme()

Retrieves the create scheme for extending tables.

Returns:

the create extended scheme, or the empty string if not available

Since:

MMBase 1.6

getPrimaryKeyScheme

public java.lang.String getPrimaryKeyScheme()

Retrieves the primary key scheme.

Returns:

the primary key scheme, or the empty string if not available

getForeignKeyScheme

public java.lang.String getForeignKeyScheme()

Retrieves the foreign key scheme.

Returns:

the foreign key scheme, or the empty string if not available

Since:

MMBase 1.6

getKeyScheme

public java.lang.String getKeyScheme()

Retrieves the key scheme.

Returns:

the key scheme, or the empty string if not available

getNotNullScheme

public java.lang.String getNotNullScheme()

Retrieves the not null scheme.

Returns:

the not null scheme, or the empty string if not available

getTypeMapping

public java.util.Hashtable getTypeMapping()

Obtains the type map. The type map is used to convert MMBase types to database types (needed for creating tables). The kyes in the map are Integer object whos evalues match the MMBase object types as defined in FieldDefs.The value are dTypeInfos objects.

Returns:

a Map of MMBase types and their database type.