A B C D E F G I M N P R S T W

A

addEqualExpression(DBTableColumnInfo, Object) - Method in class net.toften.jlips.persist.db.DBAbstractStatement

addEqualExpression(DBTableColumnInfo, Object) - Method in interface net.toften.jlips.persist.db.DBStatement

Adds an equal expresion to the statement This applies to: Select statement (the values to be searched for) Update statement (the values to be changed) Delete statement (the values to be searched for)

addReturnColumn(DBTableColumnInfo) - Method in class net.toften.jlips.persist.db.DBAbstractStatement

addReturnColumn(DBTableColumnInfo) - Method in interface net.toften.jlips.persist.db.DBStatement

Adds a column from which data must be returned This applies to: Select statement If the table of the column has not been added as a source table, this method must add the table.

addSourceTable(DBTableInfo) - Method in class net.toften.jlips.persist.db.DBAbstractStatement

addSourceTable(DBTableInfo) - Method in interface net.toften.jlips.persist.db.DBStatement

Add a table to the statement This applies to: Select statement (data is returned from the table) Update statement (data is updated in the table) Insert statement (a record is inserted in the table) Delete statement (data is removed from the table)

adjustQuotes(Object) - Method in class net.toften.jlips.persist.db.DBTableColumnInfo

This method will adjust the quotes around a value.

appendColumnNames(StringBuffer, Iterator) - Method in class net.toften.jlips.persist.db.DBAbstractStatement

Appends column names to a StringBuffer using ", " as delimeter The column names are taken from an Iterator that must iterate over a Collection containing DBTableColumnInfo objects

appendPrimaryKeyEquals(StringBuffer) - Method in class net.toften.jlips.persist.db.DBAbstractStatement

Will append a equal expression for the primary key for the first added source table This method will append an equal expression to the provided StringBuffer using the specified primary key value and the name of the primary key in the first source table added.

appendStrings(StringBuffer, Iterator, String, String) - Method in class net.toften.jlips.persist.db.DBAbstractStatement

Appends a list of strings to a StringBuffer using a defined delimiter.

appendTableNames(StringBuffer, Iterator) - Method in class net.toften.jlips.persist.db.DBAbstractStatement

Appends table names to a StringBuffer using ", " as delimeter The table names are taken from an Iterator that must iterate over a Collection containing DBTableInfo objects

B

BadDatabaseFormatException - Exception in net.toften.jlips.persist

BadDatabaseFormatException(String) - Constructor for exception net.toften.jlips.persist.BadDatabaseFormatException

Constructor for BadDatabaseFormat DOCUMENT ME!

BadPrimaryKeyException - Exception in net.toften.jlips.persist

BadPrimaryKeyException(String) - Constructor for exception net.toften.jlips.persist.BadPrimaryKeyException

buildDeleteStatement() - Method in class net.toften.jlips.persist.db.DBDefaultStatement

buildInsertStatement() - Method in class net.toften.jlips.persist.db.DBDefaultStatement

buildSelectStatement() - Method in class net.toften.jlips.persist.db.DBDefaultStatement

Will build a standard SQL select statement

buildUpdateStatement() - Method in class net.toften.jlips.persist.db.DBDefaultStatement

C

commit() - Method in interface net.toften.jlips.persist.PersistEntity

Commits all changes made to the object to the database.

connectionProperties - Variable in class net.toften.jlips.persist.db.DBAbstractConnection

Holds the Properties provided by the connection factory

create(Class) - Static method in class net.toften.jlips.persist.EntityFactory

Creates a new row in the database.

createStatement() - Static method in class net.toften.jlips.persist.db.DBConnectionFactory

Returns a new SQL statement from the statement manager

D

DB_DRIVER - Static variable in class net.toften.jlips.persist.db.DBAbstractProperties

String used to identify the driver class

DB_JNDI_URI - Static variable in class net.toften.jlips.persist.db.DBJNDIProperties

String used to specify the JNDI URI in the database properties passed by the application to jLips

DB_PASSWORD - Static variable in class net.toften.jlips.persist.db.DBAbstractProperties

String used to identify the password

DB_SCHEMA - Static variable in class net.toften.jlips.persist.db.DBAbstractProperties

String used to identify the schema

DB_URL - Static variable in class net.toften.jlips.persist.db.DBAbstractProperties

String used to identify the url

DB_USERNAME - Static variable in class net.toften.jlips.persist.db.DBAbstractProperties

String used to identify the username

DBAbstractConnection - Class in net.toften.jlips.persist.db

Provide an abstract base class for connection handlers The class will implement the DataSource interface

DBAbstractConnection() - Constructor for class net.toften.jlips.persist.db.DBAbstractConnection

DBAbstractProperties - Class in net.toften.jlips.persist.db

Abstract helper class implementing the methods defined in the DBProperties class.

DBAbstractProperties() - Constructor for class net.toften.jlips.persist.db.DBAbstractProperties

Default constructor for DBAbstractProperties Is provided because of the other constructors for this class.

DBAbstractProperties(String, String, String, String, String) - Constructor for class net.toften.jlips.persist.db.DBAbstractProperties

Constructor for DBAbstractProperties This constructor will take all the database connection parameters as arguments and initialise the internal properties class

DBAbstractStatement - Class in net.toften.jlips.persist.db

SQL statement which direct implementation of the DBStatement interface can extend.

DBAbstractStatement() - Constructor for class net.toften.jlips.persist.db.DBAbstractStatement

DBBadPropertiesException - Exception in net.toften.jlips.persist.db

This exception is thrown if the databse properties provided by the application are either missing or wrong

DBConnectionFactory - Class in net.toften.jlips.persist.db

This class act as a factory for database connections.

DBConnectionFactory() - Constructor for class net.toften.jlips.persist.db.DBConnectionFactory

DBConnectionHandler - Interface in net.toften.jlips.persist.db

This interface must be implemented by the class handling the connection to the database.

DBDefaultStatement - Class in net.toften.jlips.persist.db

SQL statement implementation using SQL standard notation This class extends the DBAbstractStatement class and overrides the specific SQL statements for the: Select statement Update statement Insert statement Delete statement This is the default implementation of the DBStatement used by jLips if none is specified by the application.

DBDefaultStatement() - Constructor for class net.toften.jlips.persist.db.DBDefaultStatement

dbInitProb - Variable in class net.toften.jlips.persist.db.DBAbstractProperties

This is initialised to the database properties provided by the application when jLips were initialised

DBJNDIConnection - Class in net.toften.jlips.persist.db

Connection handler for a JNDI connection When using this connection handler, the URI of the JNDI database must be passed in by the application.

DBJNDIConnection() - Constructor for class net.toften.jlips.persist.db.DBJNDIConnection

DBJNDIProperties - Class in net.toften.jlips.persist.db

This is the database connection properties for using a JNDI connection The application must provide the JNDI URI to jLips.

DBJNDIProperties() - Constructor for class net.toften.jlips.persist.db.DBJNDIProperties

DBPooledConnection - Class in net.toften.jlips.persist.db

This connection handler implements a pool of connections that can be shared by all parts of jLips

DBPooledConnection() - Constructor for class net.toften.jlips.persist.db.DBPooledConnection

dbProp - Variable in class net.toften.jlips.persist.db.DBAbstractProperties

These properties are used by this class to hold the database properties.

DBProperties - Interface in net.toften.jlips.persist.db

Interface for the class that jLips uses to get information about how to connect to the database.

DBS_DELETE_STM - Static variable in interface net.toften.jlips.persist.db.DBStatement

DBS_INSERT_STM - Static variable in interface net.toften.jlips.persist.db.DBStatement

DBS_SELECT_STM - Static variable in interface net.toften.jlips.persist.db.DBStatement

DBS_UPDATE_STM - Static variable in interface net.toften.jlips.persist.db.DBStatement

DBSimpleConnection - Class in net.toften.jlips.persist.db

This connection handler that will provide a simple wrapper to the standard driver provided by the database driver

DBSimpleConnection() - Constructor for class net.toften.jlips.persist.db.DBSimpleConnection

DBSimpleProperties - Class in net.toften.jlips.persist.db

DOCUMENT ME!

DBSimpleProperties(String, String, String, String, String) - Constructor for class net.toften.jlips.persist.db.DBSimpleProperties

Constructor for DBSimpleProperties DOCUMENT ME!

DBStatement - Interface in net.toften.jlips.persist.db

This interface defines the methods for building a SQL statement.

DBTableColumnInfo - Class in net.toften.jlips.persist.db

DOCUMENT ME!

DBTableColumnInfo(String) - Constructor for class net.toften.jlips.persist.db.DBTableColumnInfo

DOCUMENT ME!

DBTableInfo - Class in net.toften.jlips.persist.db

This class is used to return descriptions of a table in the database

DBTableInfo(String) - Constructor for class net.toften.jlips.persist.db.DBTableInfo

Creates a new DBTableInfo object.

DBWrappedConnection - Class in net.toften.jlips.persist.db

This class wraps an instance of a DataSource The class is abstract, so the extending class must set up the wrapped DataSource

DBWrappedConnection() - Constructor for class net.toften.jlips.persist.db.DBWrappedConnection

doDelete() - Method in class net.toften.jlips.persist.db.DBDefaultStatement

doDelete() - Method in interface net.toften.jlips.persist.db.DBStatement

doInsert() - Method in class net.toften.jlips.persist.db.DBDefaultStatement

doInsert() - Method in interface net.toften.jlips.persist.db.DBStatement

doSelect() - Method in class net.toften.jlips.persist.db.DBDefaultStatement

doSelect() - Method in interface net.toften.jlips.persist.db.DBStatement

Must execute a select statement on the database.

doUpdate() - Method in class net.toften.jlips.persist.db.DBDefaultStatement

doUpdate() - Method in interface net.toften.jlips.persist.db.DBStatement

E

EF_DB_CON_HAND - Static variable in class net.toften.jlips.persist.EntityFactory

String used to specify the name of the database connection handler in the properties passed to jlips when it is initialised

EF_DB_PROP_HAND - Static variable in class net.toften.jlips.persist.EntityFactory

String used to specify the name of the database connection properties in the properties passed to jlips when it is initialised

EF_DB_STM_HAND - Static variable in class net.toften.jlips.persist.EntityFactory

String used to specify the name of the SQL statement creater class.

EntityFactory - Class in net.toften.jlips.persist

Java Lightweight Interface Persistence System (jlips) Factory.

EntityNotFoundException - Exception in net.toften.jlips.persist

DOCUMENT ME!

EntityNotFoundException(String) - Constructor for exception net.toften.jlips.persist.EntityNotFoundException

Constructor for EntityNotFoundException DOCUMENT ME!

expressions - Variable in class net.toften.jlips.persist.db.DBAbstractStatement

Holds the expressions passed in by jLips

F

find(Class, Object) - Static method in class net.toften.jlips.persist.EntityFactory

Finds a row in the database given a primary key.

findAll(Class) - Static method in class net.toften.jlips.persist.EntityFactory

This method will return all the records in the table mapped to the persist entity provided

G

get(String) - Method in interface net.toften.jlips.persist.PersistEntity

Generic get method This method will return the value any named field in the record.

getColumnHandlerList() - Method in class net.toften.jlips.persist.db.DBTableInfo

getColumnInfo() - Method in class net.toften.jlips.persist.db.pk.IntegerPrimaryKeyHandler

getColumnInfo() - Method in interface net.toften.jlips.persist.db.pk.PrimaryKeyHandler

Return the column info for the column that holds the primary key

getColumnName() - Method in class net.toften.jlips.persist.db.DBTableColumnInfo

DOCUMENT ME!

getColumnSize() - Method in class net.toften.jlips.persist.db.DBTableColumnInfo

DOCUMENT ME!

getConnection(String, String) - Method in class net.toften.jlips.persist.db.DBAbstractConnection

This is not supported by this handler

getConnection() - Static method in class net.toften.jlips.persist.db.DBConnectionFactory

Request a connection from the associated connection handler

getConnection() - Method in class net.toften.jlips.persist.db.DBPooledConnection

Will return a connection from the pool of connections

getConnection() - Method in class net.toften.jlips.persist.db.DBSimpleConnection

getConnection() - Method in class net.toften.jlips.persist.db.DBWrappedConnection

getConnection(String, String) - Method in class net.toften.jlips.persist.db.DBWrappedConnection

getConnectionProperties() - Method in class net.toften.jlips.persist.db.DBAbstractConnection

getConnectionProperties() - Method in interface net.toften.jlips.persist.db.DBConnectionHandler

This method must return a reference to the properties passed in by the application.

getDBProperties() - Static method in class net.toften.jlips.persist.db.DBConnectionFactory

Get the DBProperties object

getDriver() - Method in class net.toften.jlips.persist.db.DBAbstractProperties

getDriver() - Method in interface net.toften.jlips.persist.db.DBProperties

The driver the Factory must load to connect to the database

getEntityName(Class) - Static method in class net.toften.jlips.persist.EntityFactory

Returns the name of the interface class given.

getEqualString(Object) - Method in class net.toften.jlips.persist.db.DBTableColumnInfo

DOCUMENT ME!

getLastPrimaryKey() - Method in class net.toften.jlips.persist.db.pk.IntegerPrimaryKeyHandler

getLastPrimaryKey() - Method in interface net.toften.jlips.persist.db.pk.PrimaryKeyHandler

Returns the last used primary key This might not have any meaning for certain types of primary key types

getLoginTimeout() - Method in class net.toften.jlips.persist.db.DBAbstractConnection

getLoginTimeout() - Method in class net.toften.jlips.persist.db.DBWrappedConnection

getLogWriter() - Method in class net.toften.jlips.persist.db.DBAbstractConnection

getLogWriter() - Method in class net.toften.jlips.persist.db.DBWrappedConnection

getNextPrimaryKey() - Method in class net.toften.jlips.persist.db.pk.IntegerPrimaryKeyHandler

The way this primary key handler generates a new primary key is by using the highest number currently in the database and then incrementing it

getNextPrimaryKey() - Method in interface net.toften.jlips.persist.db.pk.PrimaryKeyHandler

Returns the next available primary key for creation of a new record The method of generating a new unique primary key is up to the individual primary key handler

getPassword() - Method in class net.toften.jlips.persist.db.DBAbstractProperties

getPassword() - Method in interface net.toften.jlips.persist.db.DBProperties

The password used to connect to the database

getPrimaryKey() - Method in interface net.toften.jlips.persist.PersistEntity

Returns the primary key Note: This method is package scoped, as it should only be used internally in jLips.

getPrimaryKeyColumnHandler() - Method in class net.toften.jlips.persist.db.DBTableInfo

getPrimaryKeyField(DBTableInfo) - Static method in class net.toften.jlips.persist.db.DBConnectionFactory

Get the last primary key field name for the specified table

getPrimaryKeyHandler(DBTableInfo) - Static method in class net.toften.jlips.persist.db.pk.PrimaryKeyHandlerFactory

Return a PrimaryKeyHandler for the specified table Given a table, the factory will create a primary key handler and return it.

getSchema() - Method in class net.toften.jlips.persist.db.DBAbstractProperties

getSchema() - Method in interface net.toften.jlips.persist.db.DBProperties

This method must return the schema that is used by the application A schema is a text string that indicates which 'part' of the database is used by the application using jLips

getSqlType() - Method in class net.toften.jlips.persist.db.DBTableColumnInfo

DOCUMENT ME!

getTableFields(DBTableInfo) - Static method in class net.toften.jlips.persist.db.DBConnectionFactory

Returns a List containing DBTableColumnInfo objects for all the fields in the specified table

getTableInfo() - Method in class net.toften.jlips.persist.db.pk.IntegerPrimaryKeyHandler

getTableInfo() - Method in interface net.toften.jlips.persist.db.pk.PrimaryKeyHandler

Return the table info for the table the primary key handler is used by

getTableName() - Method in class net.toften.jlips.persist.db.DBTableInfo

DOCUMENT ME!

getTableName() - Method in interface net.toften.jlips.persist.PersistEntity

Returns the name of the table this entity is related to

getTableNames() - Static method in class net.toften.jlips.persist.db.DBConnectionFactory

Returns a List containing DBTableInfo objects for all the tables in the database

getURL() - Method in class net.toften.jlips.persist.db.DBAbstractProperties

getURL() - Method in class net.toften.jlips.persist.db.DBJNDIProperties

This is overridden to return the JNDI URI instead of the database URL

getURL() - Method in interface net.toften.jlips.persist.db.DBProperties

This method must return the URL that jLips uses to connect to the database The URL to a database takes the general form jdbc:subprotocol:subname

getUserName() - Method in class net.toften.jlips.persist.db.DBAbstractProperties

getUserName() - Method in interface net.toften.jlips.persist.db.DBProperties

Must return the username used to connect to the database with

I

init(Map) - Static method in class net.toften.jlips.persist.db.DBConnectionFactory

This method initialises the Database Connection Factory The method will validate, that all parameters has been supplied are correct.

init(DBProperties) - Static method in class net.toften.jlips.persist.db.DBConnectionFactory

Initialises the database connectivity with provided DBProperties object.

init(Properties, Map) - Static method in class net.toften.jlips.persist.EntityFactory

Initializes the persistence system.

init(DBProperties, Map) - Static method in class net.toften.jlips.persist.EntityFactory

IntegerPrimaryKeyHandler - Class in net.toften.jlips.persist.db.pk

This is a primary key handler for a primary key of the type Integer For info about how the key is generated, see IntegerPrimaryKeyHandler.getNextPrimaryKey()

IntegerPrimaryKeyHandler(DBTableInfo, DBTableColumnInfo) - Constructor for class net.toften.jlips.persist.db.pk.IntegerPrimaryKeyHandler

Constructor for IntegerPrimaryKeyHandler

M

myCon - Variable in class net.toften.jlips.persist.db.DBAbstractStatement

Holds the database connection

N

net.toften.jlips.persist - package net.toften.jlips.persist

This package provides the functionality to persist interfaces in the database.

net.toften.jlips.persist.db - package net.toften.jlips.persist.db

net.toften.jlips.persist.db.pk - package net.toften.jlips.persist.db.pk

P

PersistEntity - Interface in net.toften.jlips.persist

The base interface that all the interfaces specifying the accessor methods should extend This interface provides common methods for all the persist interfaces as well as a number of database related methods.

prepareConnection() - Method in class net.toften.jlips.persist.db.DBAbstractStatement

Will request a database connection from the database connection factory and create a statement

PrimaryKeyHandler - Interface in net.toften.jlips.persist.db.pk

Interface used for providing handlers for primary keys.

PrimaryKeyHandlerFactory - Class in net.toften.jlips.persist.db.pk

This factory is used to manage the primary keys for the records in the database Each record must have a primary key field.

primaryKeyValue - Variable in class net.toften.jlips.persist.db.DBAbstractStatement

Holder for valued to be changed by the statement

printStatement(String) - Method in class net.toften.jlips.persist.db.DBDefaultStatement

printStatement(String) - Method in interface net.toften.jlips.persist.db.DBStatement

R

release() - Method in class net.toften.jlips.persist.db.DBAbstractStatement

release() - Method in interface net.toften.jlips.persist.db.DBStatement

When jLips is done with the statement, this method is called.

releaseConnection(Connection) - Method in class net.toften.jlips.persist.db.DBAbstractConnection

releaseConnection(Connection) - Static method in class net.toften.jlips.persist.db.DBConnectionFactory

Release a requested connection After the application is done using the connection, it should invoke this method to inform the connection handler that it doesn't need the connection anymore

releaseConnection(Connection) - Method in interface net.toften.jlips.persist.db.DBConnectionHandler

When jLips is done with a connection it will call this method to allow the connection handler to properly dispose of the connection

releaseConnection(Connection) - Method in class net.toften.jlips.persist.db.DBPooledConnection

remove() - Method in interface net.toften.jlips.persist.PersistEntity

Removes the record from the database Note, that after this method has been called, the reference to the entity should be discarted.

returnColumns - Variable in class net.toften.jlips.persist.db.DBAbstractStatement

Holds the return columns requested by jLips

rollback() - Method in interface net.toften.jlips.persist.PersistEntity

The changes made to the data since the last commit will be discarted

S

search(Class, String, Object[]) - Static method in class net.toften.jlips.persist.EntityFactory

Runs a predefined query.

set(String, Object) - Method in interface net.toften.jlips.persist.PersistEntity

Generic set method This method will set the value of any named field in the record to the specified value

setConnectionProperties(DBProperties) - Method in class net.toften.jlips.persist.db.DBAbstractConnection

This method loads the driver for the database

setConnectionProperties(DBProperties) - Method in interface net.toften.jlips.persist.db.DBConnectionHandler

Method used to pass in the database connection properties provided by the application The connection handler will need these properties to connect to the database

setConnectionProperties(DBProperties) - Method in class net.toften.jlips.persist.db.DBJNDIConnection

setDBInitProperties(Map) - Method in class net.toften.jlips.persist.db.DBAbstractProperties

This method stores a reference to the initialisation properties given to jLips when it was initialised by the application.

setDBInitProperties(Map) - Method in class net.toften.jlips.persist.db.DBJNDIProperties

setDBInitProperties(Map) - Method in interface net.toften.jlips.persist.db.DBProperties

When the Factory is initialised this method is invoked passing in the database properties supplied by the application When the application initialises jLips it must provide a set of properties specifying how jLips connects to the database.

setLoginTimeout(int) - Method in class net.toften.jlips.persist.db.DBAbstractConnection

setLoginTimeout(int) - Method in class net.toften.jlips.persist.db.DBWrappedConnection

setLogWriter(PrintWriter) - Method in class net.toften.jlips.persist.db.DBAbstractConnection

setLogWriter(PrintWriter) - Method in class net.toften.jlips.persist.db.DBWrappedConnection

setPrimaryKeyValue(Object) - Method in class net.toften.jlips.persist.db.DBAbstractStatement

setPrimaryKeyValue(Object) - Method in interface net.toften.jlips.persist.db.DBStatement

Adds a primary key value to be used to locate a specific record This applies to: Update statement (record to be updated) Insert statement (primary key value of new record) Delete statement (record to be removed)

sourceTables - Variable in class net.toften.jlips.persist.db.DBAbstractStatement

Holds the source tables requested by jLips

T

toString() - Method in class net.toften.jlips.persist.db.DBAbstractStatement

Returns the provided data for the statement

toString() - Method in interface net.toften.jlips.persist.db.DBStatement

toString() - Method in class net.toften.jlips.persist.db.DBTableColumnInfo

toString() - Method in class net.toften.jlips.persist.db.DBTableInfo

DOCUMENT ME!

W

wrappedDS - Variable in class net.toften.jlips.persist.db.DBWrappedConnection

A B C D E F G I M N P R S T W