net.sourceforge.toscanaj.model.database
Class DatabaseInfo

java.lang.Object
  net.sourceforge.toscanaj.model.database.DatabaseInfo

All Implemented Interfaces:

XMLizable

public class DatabaseInfo

extends java.lang.Object

implements XMLizable

This class contains information how to connect to a database.

Nested Class Summary

static class

DatabaseInfo.Type

Field Summary

static DatabaseInfo.Type	ACCESS_FILE
static java.net.URL	baseURL
static java.lang.String	DATABASE_CONNECTION_ELEMENT_NAME
static DatabaseInfo.Type	EMBEDDED
static DatabaseInfo.Type	EXCEL_FILE
static DatabaseInfo.Type	JDBC
static DatabaseInfo.Type	ODBC
static DatabaseInfo.Type	UNDEFINED

Constructor Summary

DatabaseInfo()
Creates an empty instance.

DatabaseInfo(DatabaseInfo other)

DatabaseInfo(org.jdom.Element element)

Method Summary

Query	createAggregateQuery(java.lang.String name, java.lang.String header) Creates a new Query that will query a single number as aggregate.
Query	createListQuery(java.lang.String name, java.lang.String header, boolean isDistinct) Creates a new Query that will query a list.
java.lang.String	getAccessFileUrl()
java.lang.String	getDriverClass()
static DatabaseInfo	getEmbeddedDatabaseInfo()
java.net.URL	getEmbeddedSQLLocation()
java.lang.String	getExcelFileUrl()
Column	getKey()
java.lang.String	getOdbcDataSourceName()
java.lang.String	getPassword()
Table	getTable()
DatabaseInfo.Type	getType()
static DatabaseInfo.Type	getType(java.lang.String url, java.lang.String driverClass)
java.lang.String	getURL() Returns the JDBC url for connecting to the database.
java.lang.String	getUserName()
void	readXML(org.jdom.Element elem) Read this element as the content of elem.
void	setAccessFileInfo(java.lang.String fileLocation, java.lang.String userName, java.lang.String password)
void	setDriverClass(java.lang.String driverClass)
void	setEmbeddedSQLLocation(java.lang.String relativePath)
void	setEmbeddedSQLLocation(java.net.URL url)
void	setExcelFileInfo(java.lang.String fileLocation, java.lang.String userName, java.lang.String password)
void	setKey(Column key) Sets the key we use in queries.
void	setOdbcDataSource(java.lang.String dsn, java.lang.String userName, java.lang.String password)
void	setPassword(java.lang.String password)
void	setTable(Table table) Sets the database table we want to query.
void	setUrl(java.lang.String url) Sets the given URL as DB connecion point.
void	setUserName(java.lang.String userName)
java.lang.String	toString() Debugging info.
org.jdom.Element	toXML() Write this element as the content of elem.

Methods inherited from class java.lang.Object

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

Field Detail

baseURL

public static java.net.URL baseURL

UNDEFINED

public static final DatabaseInfo.Type UNDEFINED

EMBEDDED

public static final DatabaseInfo.Type EMBEDDED

JDBC

public static final DatabaseInfo.Type JDBC

ODBC

public static final DatabaseInfo.Type ODBC

ACCESS_FILE

public static final DatabaseInfo.Type ACCESS_FILE

EXCEL_FILE

public static final DatabaseInfo.Type EXCEL_FILE

DATABASE_CONNECTION_ELEMENT_NAME

public static final java.lang.String DATABASE_CONNECTION_ELEMENT_NAME

See Also:

Constant Field Values

Constructor Detail

DatabaseInfo

public DatabaseInfo()

Creates an empty instance.

DatabaseInfo

public DatabaseInfo(DatabaseInfo other)

DatabaseInfo

public DatabaseInfo(org.jdom.Element element)
             throws XMLSyntaxError

Method Detail

getEmbeddedDatabaseInfo

public static DatabaseInfo getEmbeddedDatabaseInfo()

createListQuery

public Query createListQuery(java.lang.String name,
                             java.lang.String header,
                             boolean isDistinct)

Creates a new Query that will query a list.

createAggregateQuery

public Query createAggregateQuery(java.lang.String name,
                                  java.lang.String header)

Creates a new Query that will query a single number as aggregate.

toXML

public org.jdom.Element toXML()

Description copied from interface: XMLizable

Write this element as the content of elem.

Specified by:

toXML in interface XMLizable

readXML

public void readXML(org.jdom.Element elem)
             throws XMLSyntaxError

Description copied from interface: XMLizable

Read this element as the content of elem.

Specified by:

readXML in interface XMLizable

Throws:

XMLSyntaxError

getURL

public java.lang.String getURL()

Returns the JDBC url for connecting to the database.

setUrl

public void setUrl(java.lang.String url)

Sets the given URL as DB connecion point.

setUserName

public void setUserName(java.lang.String userName)

getUserName

public java.lang.String getUserName()

setPassword

public void setPassword(java.lang.String password)

getPassword

public java.lang.String getPassword()

setTable

public void setTable(Table table)

Sets the database table we want to query.

getTable

public Table getTable()

setKey

public void setKey(Column key)

Sets the key we use in queries.

getKey

public Column getKey()

setEmbeddedSQLLocation

public void setEmbeddedSQLLocation(java.lang.String relativePath)

setEmbeddedSQLLocation

public void setEmbeddedSQLLocation(java.net.URL url)

getEmbeddedSQLLocation

public java.net.URL getEmbeddedSQLLocation()

getDriverClass

public java.lang.String getDriverClass()

setDriverClass

public void setDriverClass(java.lang.String driverClass)

toString

public java.lang.String toString()

Debugging info.

getType

public DatabaseInfo.Type getType()

getType

public static DatabaseInfo.Type getType(java.lang.String url,
                                        java.lang.String driverClass)

setAccessFileInfo

public void setAccessFileInfo(java.lang.String fileLocation,
                              java.lang.String userName,
                              java.lang.String password)

getAccessFileUrl

public java.lang.String getAccessFileUrl()

setExcelFileInfo

public void setExcelFileInfo(java.lang.String fileLocation,
                             java.lang.String userName,
                             java.lang.String password)

getExcelFileUrl

public java.lang.String getExcelFileUrl()

setOdbcDataSource

public void setOdbcDataSource(java.lang.String dsn,
                              java.lang.String userName,
                              java.lang.String password)

getOdbcDataSourceName

public java.lang.String getOdbcDataSourceName()