org.jboss.ejb.plugins.jaws.jdbc
Class JDBCDefinedFinderCommand

java.lang.Object
  |
  +--org.jboss.ejb.plugins.jaws.jdbc.JDBCCommand
        |
        +--org.jboss.ejb.plugins.jaws.jdbc.JDBCQueryCommand
              |
              +--org.jboss.ejb.plugins.jaws.jdbc.JDBCFinderCommand
                    |
                    +--org.jboss.ejb.plugins.jaws.jdbc.JDBCDefinedFinderCommand

All Implemented Interfaces:

JPMFindEntitiesCommand

public class JDBCDefinedFinderCommand

extends JDBCFinderCommand

JAWSPersistenceManager JDBCDefinedFinderCommand

Version:

$Revision: 1.14.2.6 $

Author:

Rickard Öberg, Marc Fleury, Joe Shevland, Justin Forder, Michel de Groot, Vinay Menon, danch (Dan Christopherson, Lennart Petersson

See Also:

Fields inherited from class org.jboss.ejb.plugins.jaws.jdbc.JDBCFinderCommand

finderMetaData

Fields inherited from class org.jboss.ejb.plugins.jaws.jdbc.JDBCCommand

debug, factory, jawsEntity, log, name

Constructor Summary

JDBCDefinedFinderCommand(JDBCCommandFactory factory, FinderMetaData f)

Method Summary

protected java.lang.String[]	cleanOrderClause(java.lang.String rawOrder) helper method to clean the order clause into a list of table.field entries.
java.lang.String	getFromClause() This method must be ovverridden to return the full table list for the query, including any join statements.
java.lang.String	getOrderByClause() This method must be ovverridded to return the full order by clause for the query, including the 'ORDER BY' keyword.
java.lang.String	getWhereClause() This method must be overridden to return the where clause used in this query.
protected void	setParameters(java.sql.PreparedStatement stmt, java.lang.Object argOrArgs) Default implementation does nothing.

Methods inherited from class org.jboss.ejb.plugins.jaws.jdbc.JDBCFinderCommand

execute, getFinderMetaData, handleResult

Methods inherited from class org.jboss.ejb.plugins.jaws.jdbc.JDBCQueryCommand

executeStatementAndHandleResult

Methods inherited from class org.jboss.ejb.plugins.jaws.jdbc.JDBCCommand

getCMPFieldValue, getConnection, getJawsCMPFieldJDBCType, getJDBCType, getJDBCTypeName, getPkColumnList, getPkColumnWhereList, getPkFieldValue, getResultObject, getResultObject, getSQL, getState, isBinaryType, jdbcExecute, setCMPFieldValue, setParameter, setPrimaryKeyParameters, setSQL

Methods inherited from class java.lang.Object

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

Constructor Detail

JDBCDefinedFinderCommand

public JDBCDefinedFinderCommand(JDBCCommandFactory factory,
                                FinderMetaData f)

Method Detail

getWhereClause

public java.lang.String getWhereClause()

Description copied from class: JDBCFinderCommand

This method must be overridden to return the where clause used in this query. This must start with the keyword 'WHERE' and include all conditions needed to execute the query properly.

Overrides:

getWhereClause in class JDBCFinderCommand

getFromClause

public java.lang.String getFromClause()

Description copied from class: JDBCFinderCommand

This method must be ovverridden to return the full table list for the query, including any join statements. This must start with the keyword 'FROM' and include all tables needed to execute the query properly.

Overrides:

getFromClause in class JDBCFinderCommand

getOrderByClause

public java.lang.String getOrderByClause()

Description copied from class: JDBCFinderCommand

This method must be ovverridded to return the full order by clause for the query, including the 'ORDER BY' keyword.

Overrides:

getOrderByClause in class JDBCFinderCommand

cleanOrderClause

protected java.lang.String[] cleanOrderClause(java.lang.String rawOrder)

helper method to clean the order clause into a list of table.field entries. This is used only to clean up the algorythm in the ctor.

Returns:

String array containing order fields stripped of 'ASC' or 'DESC' modifiers.

setParameters

protected void setParameters(java.sql.PreparedStatement stmt,
                             java.lang.Object argOrArgs)
                      throws java.lang.Exception

Description copied from class: JDBCCommand

Default implementation does nothing. Override if parameters need to be set.

Overrides:

setParameters in class JDBCCommand

Following copied from class: org.jboss.ejb.plugins.jaws.jdbc.JDBCCommand

Parameters:

stmt - the PreparedStatement which will be executed by this Command.

argOrArgs - argument or array of arguments passed in from subclass execute method.

Throws:

java.lang.Exception - if parameter setting fails.