org.wandora.topicmap.database2

Class AbstractDatabaseTopicMap

java.lang.Object

org.wandora.topicmap.TopicMap

org.wandora.topicmap.database2.AbstractDatabaseTopicMap

All Implemented Interfaces:

TopicMapLogger

Direct Known Subclasses:

DatabaseTopicMap

public abstract class AbstractDatabaseTopicMap
extends TopicMap

Author:

akivela

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	AbstractDatabaseTopicMap.QueryQueue

Field Summary

Fields

Modifier and Type	Field and Description
protected java.sql.Connection	connection The default stored connection
private java.lang.Object	connectionParams
protected java.lang.String	databaseFlavour The database flavor.
private java.lang.String	dbConnectionString
private java.lang.String	dbDriver
private java.lang.String	dbPassword
private java.lang.String	dbUser
protected boolean	isDBReadOnly Note that this is different than topic map read only property.
private int	queryCounter
private java.lang.Object	queryLock
protected boolean	unconnected
private AbstractDatabaseTopicMap.QueryQueue	updateQueue

Fields inherited from class org.wandora.topicmap.TopicMap

consistencyCheck, consistencyCheckWhenXTMImport, EDITTIME_SI, isReadOnly, logger, parentTopicMap

Constructor Summary

Constructors

Constructor and Description
AbstractDatabaseTopicMap(java.lang.String dbDriver, java.lang.String dbConnectionString, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String initScript, java.lang.Object connectionParams)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the topic map.
protected java.lang.String	collectionToSQL(java.util.Collection<java.lang.String> col) Turns a collection of strings into sql syntax representing a collection of strings that can be used with 'in' clauses.
void	commit()
protected java.sql.Connection	createConnection(boolean autocommit) Creates a new database connection using the connection parameters given to the constructor.
protected java.lang.String	escapeSQL(java.lang.String s) Escapes a string so that it can be used in an sql query.
protected int	executeCountQuery(java.lang.String query)
java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>>	executeQuery(java.lang.String query) Executes a database query and returns the results as a collection.
private java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>>	executeQuery(java.lang.String query, java.sql.Connection con)
boolean	executeUpdate(java.lang.String query)
protected java.sql.Connection	getConnection() Gets the connection used with database queries.
java.lang.Object	getConnectionParams() A connection parameters object may be stored in the database topic map.
java.lang.String	getDatabaseFlavour()
java.lang.String	getDBConnectionString() Gets the used jdbc database connection string.
java.lang.String	getDBDriver() Gets the used jdbc database driver class.
java.lang.String	getDBPassword() Gets the used database password.
java.lang.String	getDBUser() Gets the used database user name.
java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>	getRowIterator(java.lang.String query, java.lang.String orderby)
boolean	isConnected() Checks if the database connection is active.
boolean	isReadOnly() Does the topic map only allow reading or both reading and writing.
private void	logQuery(java.lang.String query)
protected boolean	testReadOnly() Tests if the connection allows modifying the topic map.

Methods inherited from class org.wandora.topicmap.TopicMap

addTopicMapListener, addTopicMapListeners, checkAssociationConsistency, checkAssociationConsistency, clearTopicMap, clearTopicMapIndexes, copyAssociationIn, copyTopicAssociationsIn, copyTopicCollectionIn, copyTopicIn, createAssociation, createLocator, createLocator, createTopic, createTopic, disableAllListeners, enableAllListeners, escapeXML, exportJTM, exportJTM, exportJTM, exportJTM, exportLTM, exportLTM, exportLTM, exportLTM, exportTopicMap, exportTopicMap, exportXTM, exportXTM, exportXTM, exportXTM, exportXTM10, exportXTM10, exportXTM10, exportXTM20, exportXTM20, forceStop, getAssociations, getAssociationsOfType, getConsistencyCheck, getLogger, getMergingTopics, getNumAssociations, getNumTopics, getParentTopicMap, getRootTopicMap, getStatistics, getTopic, getTopic, getTopicBySubjectLocator, getTopicBySubjectLocator, getTopicMapListeners, getTopics, getTopics, getTopics, getTopicsOfType, getTopicsOfType, getTopicWithBaseName, hlog, importJTM, importJTM, importJTM, importJTM, importJTM, importJTM, importLTM, importLTM, importLTM, importLTM, importLTM, importLTM, importTopicMap, importTopicMap, importTopicMap, importXTM, importXTM, importXTM, importXTM, importXTM, isTopicMapChanged, log, log, log, makeJTMString, makeJTMTopicId, makeLTMString, makeLTMTopicId, makeSubjectIndicator, makeSubjectIndicatorAsLocator, mergeIn, mergeIn, removeTopicMapListener, resetTopicMapChanged, search, setConsistencyCheck, setLogger, setLogTitle, setParentTopicMap, setProgress, setProgressMax, setReadOnly, setTrackDependent, trackingDependent

Methods inherited from class java.lang.Object

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

Field Detail

queryCounter

private int queryCounter

dbDriver

private java.lang.String dbDriver

dbConnectionString

private java.lang.String dbConnectionString

dbUser

private java.lang.String dbUser

dbPassword

private java.lang.String dbPassword

connectionParams

private java.lang.Object connectionParams

unconnected

protected boolean unconnected

databaseFlavour

protected java.lang.String databaseFlavour

The database flavor. Some operations need to be handled differently with different database vendors. This field is used to store what kind of database is being used. Currently it may have following values

  "mysql" - MySQL database
  "generic" - Any other database presumed to be sufficiently standard compliant
 

It is set automatically based on the connection string used.

isDBReadOnly

protected boolean isDBReadOnly

Note that this is different than topic map read only property. This property tells the state of the connection: is the connection a read only connection and does the user have privileges to modify the database. These can only be changed by connecting to the database using different settings.

connection

protected java.sql.Connection connection

The default stored connection

queryLock

private final java.lang.Object queryLock

updateQueue

private AbstractDatabaseTopicMap.QueryQueue updateQueue

Constructor Detail

AbstractDatabaseTopicMap

public AbstractDatabaseTopicMap(java.lang.String dbDriver,
                                java.lang.String dbConnectionString,
                                java.lang.String dbUser,
                                java.lang.String dbPassword,
                                java.lang.String initScript,
                                java.lang.Object connectionParams)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

Method Detail

getDBDriver

public java.lang.String getDBDriver()

Gets the used jdbc database driver class.

getDBConnectionString

public java.lang.String getDBConnectionString()

Gets the used jdbc database connection string.

getDBUser

public java.lang.String getDBUser()

Gets the used database user name.

getDBPassword

public java.lang.String getDBPassword()

Gets the used database password.

getConnectionParams

public java.lang.Object getConnectionParams()

A connection parameters object may be stored in the database topic map. It is not used by the database topic map, only stored by it. Currently this is used to store higher level connection information than the basic driver, connection string, user name, password. This makes it possible to modify the stored connection in Wandora. The connection parameters object is set at the constructor.

getDatabaseFlavour

public java.lang.String getDatabaseFlavour()

isReadOnly

public boolean isReadOnly()

Does the topic map only allow reading or both reading and writing. Note that this is different than topic map read only property. This property tells the state of the connection: is the connection a read only connection and does the user have privileges to modify the database. These can only be changed by connecting to the database using different settings.

Overrides:

isReadOnly in class TopicMap

testReadOnly

protected boolean testReadOnly()

Tests if the connection allows modifying the topic map. The test is done using an update sql statement that does not change anything in the database but should raise an exception if modifying is not allowed. Note that this only tests modifying the topic table and most database implementations allow specifying different privileges for each tables.

isConnected

public boolean isConnected()

Checks if the database connection is active.

Overrides:

isConnected in class TopicMap

getConnection

protected java.sql.Connection getConnection()

Gets the connection used with database queries. If the old stored connection has been closed for any reason, tries to create a new connection.

createConnection

protected java.sql.Connection createConnection(boolean autocommit)

Creates a new database connection using the connection parameters given to the constructor.

close

public void close()

Closes the topic map. This closes the database connection. Topic map cannot be used or reopened after it has been closed.

Specified by:

close in class TopicMap

executeUpdate

public boolean executeUpdate(java.lang.String query)
                      throws TopicMapException

Throws:

TopicMapException

executeQuery

public java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> executeQuery(java.lang.String query)
                                                                                    throws TopicMapException

Executes a database query and returns the results as a collection. Each element in the collection is a Map and represents a row of the result. The Map maps column names to the objects returned by query.

Throws:

TopicMapException

executeQuery

private java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> executeQuery(java.lang.String query,
                                                                                            java.sql.Connection con)
                                                                                     throws TopicMapException

Throws:

TopicMapException

executeCountQuery

protected int executeCountQuery(java.lang.String query)

logQuery

private void logQuery(java.lang.String query)

getRowIterator

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getRowIterator(java.lang.String query,
                                                                                           java.lang.String orderby)

commit

public void commit()
            throws java.sql.SQLException,
                   TopicMapException

Throws:

java.sql.SQLException

TopicMapException

collectionToSQL

protected java.lang.String collectionToSQL(java.util.Collection<java.lang.String> col)

Turns a collection of strings into sql syntax representing a collection of strings that can be used with 'in' clauses. The returned string contains each string in the collection escaped inside single quotes, each separated by commas and all contain inside parenthesis. For example: ('string1','string2','string3').

escapeSQL

protected java.lang.String escapeSQL(java.lang.String s)

Escapes a string so that it can be used in an sql query.