org.apache.cayenne.access.jdbc
Class SQLTemplateAction

java.lang.Object
  extended by org.apache.cayenne.access.jdbc.SQLTemplateAction
All Implemented Interfaces:
SQLAction

public class SQLTemplateAction
extends Object
implements SQLAction

Implements a strategy for execution of SQLTemplates.

Since:
1.2 replaces SQLTemplateExecutionPlan

Field Summary
protected  DbAdapter adapter
           
protected  DbEntity dbEntity
           
protected  SQLTemplate query
           
protected  QueryMetadata queryMetadata
           
 
Constructor Summary
SQLTemplateAction(SQLTemplate query, DbAdapter adapter)
          Deprecated. since 3.0 use a SQLTemplateAction(SQLTemplate, DbAdapter, EntityResolver) constructor.
SQLTemplateAction(SQLTemplate query, DbAdapter adapter, EntityResolver entityResolver)
           
 
Method Summary
protected  void bind(PreparedStatement preparedStatement, ParameterBinding[] bindings)
          Binds parameters to the PreparedStatement.
protected  RowDescriptorBuilder configureRowDescriptorBuilder(SQLStatement compiled, ResultSet resultSet)
           
protected  void execute(Connection connection, OperationObserver callback, SQLStatement compiled, Collection<Number> updateCounts)
           
protected  String extractTemplateString()
          Extracts a template string from a SQLTemplate query.
 DbAdapter getAdapter()
          Returns DbAdapter associated with this execution plan object.
protected  int getFetchOffset()
           
 SQLTemplate getQuery()
          Returns a SQLTemplate for this action.
 boolean isRemovingLineBreaks()
          Deprecated. since 3.0
 void performAction(Connection connection, OperationObserver callback)
          Runs a SQLTemplate query, collecting all results.
protected  void processSelectResult(SQLStatement compiled, Connection connection, Statement statement, ResultSet resultSet, OperationObserver callback, long startTime)
           
 void setRemovingLineBreaks(boolean removingLineBreaks)
          Deprecated. since 3.0 - does nothing
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

adapter

protected DbAdapter adapter

query

protected SQLTemplate query

queryMetadata

protected QueryMetadata queryMetadata

dbEntity

protected DbEntity dbEntity
Constructor Detail

SQLTemplateAction

@Deprecated
public SQLTemplateAction(SQLTemplate query,
                                    DbAdapter adapter)
Deprecated. since 3.0 use a SQLTemplateAction(SQLTemplate, DbAdapter, EntityResolver) constructor.


SQLTemplateAction

public SQLTemplateAction(SQLTemplate query,
                         DbAdapter adapter,
                         EntityResolver entityResolver)
Since:
3.0
Method Detail

getAdapter

public DbAdapter getAdapter()
Returns DbAdapter associated with this execution plan object.


performAction

public void performAction(Connection connection,
                          OperationObserver callback)
                   throws SQLException,
                          Exception
Runs a SQLTemplate query, collecting all results. If a callback expects an iterated result, result processing is stopped after the first ResultSet is encountered.

Specified by:
performAction in interface SQLAction
Throws:
SQLException
Exception

execute

protected void execute(Connection connection,
                       OperationObserver callback,
                       SQLStatement compiled,
                       Collection<Number> updateCounts)
                throws SQLException,
                       Exception
Throws:
SQLException
Exception

processSelectResult

protected void processSelectResult(SQLStatement compiled,
                                   Connection connection,
                                   Statement statement,
                                   ResultSet resultSet,
                                   OperationObserver callback,
                                   long startTime)
                            throws Exception
Throws:
Exception

configureRowDescriptorBuilder

protected RowDescriptorBuilder configureRowDescriptorBuilder(SQLStatement compiled,
                                                             ResultSet resultSet)
                                                      throws SQLException
Throws:
SQLException
Since:
3.0

extractTemplateString

protected String extractTemplateString()
Extracts a template string from a SQLTemplate query. Exists mainly for the benefit of subclasses that can customize returned template.

Since:
1.2

bind

protected void bind(PreparedStatement preparedStatement,
                    ParameterBinding[] bindings)
             throws SQLException,
                    Exception
Binds parameters to the PreparedStatement.

Throws:
SQLException
Exception

isRemovingLineBreaks

@Deprecated
public boolean isRemovingLineBreaks()
Deprecated. since 3.0

Always returns true.


setRemovingLineBreaks

@Deprecated
public void setRemovingLineBreaks(boolean removingLineBreaks)
Deprecated. since 3.0 - does nothing


getQuery

public SQLTemplate getQuery()
Returns a SQLTemplate for this action.


getFetchOffset

protected int getFetchOffset()
Since:
3.0


Copyright © 2001-2011 Apache Cayenne. All Rights Reserved.