GenericPreparedStatement.java

Index Score
org.apache.derby.impl.sql
Apache Derby

View: Reasons, Metrics, Source Code

These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.

MetricDescription
LINE_COMMENTNumber of line comments
DECL_COMMENTSComments in declarations
COMMENTSComment lines
EXEC_COMMENTSComments in executable code
LINESNumber of lines in the source file
DOC_COMMENTNumber of javadoc comment lines
SIZESize of the file in bytes
RETURNSNumber of return points from functions
FUNCTIONSNumber of function declarations
INTERFACE_COMPLEXITYInterface complexity
LOCLines of code
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
CYCLOMATICCyclomatic complexity
ELOCEffective lines of code
BLOCKSNumber of blocks
LOGICAL_LINESNumber of statements
JAVA0034JAVA0034 Missing braces in if statement
UNIQUE_OPERANDSNumber of unique operands
PROGRAM_VOCABHalstead program vocabulary
EXITSProcedure exits
WHITESPACENumber of whitespace lines
JAVA0145JAVA0145 Tab character used in source file
OPERANDSNumber of operands
PROGRAM_LENGTHHalstead program length
OPERATORSNumber of operators
JAVA0259JAVA0259 Return of collection/array field
PARAMSNumber of formal parameter declarations
JAVA0032JAVA0032 Switch statement missing default
JAVA0125JAVA0125 Continue statement with label
UNIQUE_OPERATORSNumber of unique operators
JAVA0177JAVA0177 Variable declaration missing initializer
JAVA0143JAVA0143 Synchronized method
PROGRAM_VOLUMEHalstead program volume
JAVA0136JAVA0136 N methods defined in class (maximum: M)
JAVA0174JAVA0174 Assigned local variable never used
JAVA0126JAVA0126 Method declares unchecked exception in throws
BLOCK_COMMENTNumber of block comment lines
JAVA0100JAVA0100 Class contains N non-final fields (maximum: M)
LOOPSNumber of loops
JAVA0130JAVA0130 Non-static method does not use instance fields
JAVA0256JAVA0256 Assignment of external collection/array to field
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
/* Derby - Class org.apache.derby.impl.sql.GenericPreparedStatement Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package org.apache.derby.impl.sql; import org.apache.derby.catalog.Dependable; import org.apache.derby.catalog.DependableFinder; import org.apache.derby.iapi.services.context.ContextService; import org.apache.derby.iapi.services.context.ContextManager; import org.apache.derby.iapi.services.monitor.Monitor; import org.apache.derby.iapi.services.sanity.SanityManager; import org.apache.derby.iapi.services.stream.HeaderPrintWriter; import org.apache.derby.iapi.services.cache.Cacheable; import org.apache.derby.catalog.UUID; import org.apache.derby.iapi.services.uuid.UUIDFactory; import org.apache.derby.iapi.util.ByteArray; import org.apache.derby.iapi.sql.dictionary.DataDictionary; import org.apache.derby.iapi.sql.dictionary.SchemaDescriptor; import org.apache.derby.iapi.sql.dictionary.SPSDescriptor; import org.apache.derby.iapi.sql.ParameterValueSet; import org.apache.derby.iapi.sql.PreparedStatement; import org.apache.derby.iapi.sql.Statement; import org.apache.derby.iapi.types.DataTypeDescriptor; import org.apache.derby.iapi.sql.ResultColumnDescriptor; import org.apache.derby.iapi.sql.ResultDescription; import org.apache.derby.iapi.sql.ResultSet; import org.apache.derby.iapi.sql.Activation; import org.apache.derby.iapi.sql.execute.ConstantAction; import org.apache.derby.iapi.sql.execute.ExecCursorTableReference; import org.apache.derby.iapi.sql.execute.ExecPreparedStatement; import org.apache.derby.iapi.sql.depend.DependencyManager; import org.apache.derby.iapi.sql.depend.Provider; import org.apache.derby.iapi.sql.conn.LanguageConnectionContext; import org.apache.derby.iapi.sql.conn.StatementContext; import org.apache.derby.impl.sql.compile.CursorNode; import org.apache.derby.impl.sql.compile.StatementNode; import org.apache.derby.iapi.error.StandardException; import org.apache.derby.iapi.reference.SQLState; import org.apache.derby.iapi.services.loader.GeneratedClass; import java.sql.Timestamp; import java.sql.SQLWarning; import java.util.List; /** * Basic implementation of prepared statement. * relies on implementation of ResultDescription and Statement that * are also in this package. * <p> * These are both dependents (of the schema objects and prepared statements * they depend on) and providers. Prepared statements that are providers * are cursors that end up being used in positioned delete and update * statements (at present). * <p> * This is impl with the regular prepared statements; they will never * have the cursor info fields set. * <p> * Stored prepared statements extend this implementation * */ public class GenericPreparedStatement implements ExecPreparedStatement { /////////////////////////////////////////////// // // WARNING: when adding members to this class, be // sure to do the right thing in getClone(): if // it is PreparedStatement specific like finished, // then it shouldn't be copied, but stuff like parameters // must be copied. // //////////////////////////////////////////////// //////////////////////////////////////////////// // STATE that is copied by getClone() //////////////////////////////////////////////// public Statement statement; protected GeneratedClass activationClass; // satisfies Activation protected ResultDescription resultDesc; protected DataTypeDescriptor[] paramTypeDescriptors; private String spsName; private SQLWarning warnings; //If the query node for this statement references SESSION schema tables, mark it so in the boolean below //This information will be used by EXECUTE STATEMENT if it is executing a statement that was created with NOCOMPILE. Because //of NOCOMPILE, we could not catch SESSION schema table reference by the statement at CREATE STATEMENT time. Need to catch //such statements at EXECUTE STATEMENT time when the query is getting compiled. //This information will also be used to decide if the statement should be cached or not. Any statement referencing SESSION //schema tables will not be cached. private boolean referencesSessionSchema; // fields used for cursors protected ExecCursorTableReference targetTable; protected ResultColumnDescriptor[] targetColumns; protected String[] updateColumns; protected int updateMode; protected ConstantAction executionConstants; protected Object[] savedObjects; protected List requiredPermissionsList; // fields for dependency tracking protected String UUIDString; protected UUID UUIDValue; private boolean needsSavepoint; private String execStmtName; private String execSchemaName; protected boolean isAtomic; protected String sourceTxt; private int inUseCount; // true if the statement is being compiled. boolean compilingStatement; //////////////////////////////////////////////// // STATE that is not copied by getClone() //////////////////////////////////////////////// // fields for run time stats protected long parseTime; protected long bindTime; protected long optimizeTime; protected long generateTime; protected long compileTime; protected Timestamp beginCompileTimestamp; protected Timestamp endCompileTimestamp; //private boolean finished; protected boolean isValid; protected boolean spsAction; // state for caching. /** If non-null then this object is the cacheable that holds us in the cache. */ private Cacheable cacheHolder; // // constructors // GenericPreparedStatement() { /* Get the UUID for this prepared statement */ UUIDFactory uuidFactory = Monitor.getMonitor().getUUIDFactory(); UUIDValue = uuidFactory.createUUID(); UUIDString = UUIDValue.toString(); spsAction = false; } /** */ public GenericPreparedStatement(Statement st) { this(); statement = st; } // // PreparedStatement interface // public synchronized boolean upToDate() throws StandardException { return isValid && (activationClass != null) && !compilingStatement; } public void rePrepare(LanguageConnectionContext lcc) throws StandardException { if (!upToDate()) { PreparedStatement ps = statement.prepare(lcc); if (SanityManager.DEBUG) SanityManager.ASSERT(ps == this, "ps != this"); } } /** * Get a new activation instance. * * @exception StandardException thrown if finished. */ public Activation getActivation(LanguageConnectionContext lcc, boolean scrollable) throws StandardException { Activation ac; synchronized (this) { GeneratedClass gc = getActivationClass(); if (gc == null) { rePrepare(lcc); gc = getActivationClass(); } ac = new GenericActivationHolder(lcc, gc, this, scrollable); inUseCount++; } // DERBY-2689. Close unused activations-- this method should be called // when I'm not holding a lock on a prepared statement to avoid // deadlock. lcc.closeUnusedActivations(); Activation callingAct = null; StatementContext stmctx = lcc.getStatementContext(); if (stmctx != null) { // if not null, callingAct represents the activation of // a calling statement and this activation corresponds to // a statement inside a stored procedure or function callingAct = stmctx.getActivation(); } ac.setCallActivation(callingAct); return ac; } public ResultSet execute(LanguageConnectionContext lcc, boolean rollbackParentContext, long timeoutMillis) throws StandardException { Activation a = getActivation(lcc, false); a.setSingleExecution(); return execute(a, rollbackParentContext, timeoutMillis); } /** * The guts of execution. * * @param activation the activation to run. * @param rollbackParentContext True if 1) the statement context is * NOT a top-level context, AND 2) in the event of a statement-level * exception, the parent context needs to be rolled back, too. * @param timeoutMillis timeout value in milliseconds. * @return the result set to be pawed through * * @exception StandardException thrown on error */ public ResultSet execute(Activation activation, boolean rollbackParentContext, long timeoutMillis) throws StandardException { boolean needToClearSavePoint = false; if (activation == null || activation.getPreparedStatement() != this) { throw StandardException.newException(SQLState.LANG_WRONG_ACTIVATION, "execute"); } recompileOutOfDatePlan: while (true) { // verify the activation is for me--somehow. NOTE: This is // different from the above check for whether the activation is // associated with the right PreparedStatement - it's conceivable // that someone could construct an activation of the wrong type // that points to the right PreparedStatement. // //SanityManager.ASSERT(activation instanceof activationClass, "executing wrong activation"); /* This is where we set and clear savepoints around each individual * statement which needs one. We don't set savepoints for cursors because * they're not needed and they wouldn't work in a read only database. * We can't set savepoints for commit/rollback because they'll get * blown away before we try to clear them. */ LanguageConnectionContext lccToUse = activation.getLanguageConnectionContext(); if (lccToUse.getLogStatementText()) { HeaderPrintWriter istream = Monitor.getStream(); String xactId = lccToUse.getTransactionExecute().getActiveStateTxIdString(); String pvsString = ""; ParameterValueSet pvs = activation.getParameterValueSet(); if (pvs != null && pvs.getParameterCount() > 0) { pvsString = " with " + pvs.getParameterCount() + " parameters " + pvs.toString(); } istream.printlnWithHeader(LanguageConnectionContext.xidStr + xactId + "), " + LanguageConnectionContext.lccStr + lccToUse.getInstanceNumber() + "), " + LanguageConnectionContext.dbnameStr + lccToUse.getDbname() + "), " + LanguageConnectionContext.drdaStr + lccToUse.getDrdaID() + "), Executing prepared statement: " + getSource() + " :End prepared statement" + pvsString); } ParameterValueSet pvs = activation.getParameterValueSet(); /* put it in try block to unlock the PS in any case */ if (!spsAction) { // only re-prepare if this isn't an SPS for a trigger-action; // if it _is_ an SPS for a trigger action, then we can't just // do a regular prepare because the statement might contain // internal SQL that isn't allowed in other statements (such as a // static method call to get the trigger context for retrieval // of "new row" or "old row" values). So in that case we // skip the call to 'rePrepare' and if the statement is out // of date, we'll get a NEEDS_COMPILE exception when we try // to execute. That exception will be caught by the executeSPS() // method of the GenericTriggerExecutor class, and at that time // the SPS action will be recompiled correctly. rePrepare(lccToUse); } StatementContext statementContext = lccToUse.pushStatementContext( isAtomic, updateMode==CursorNode.READ_ONLY, getSource(), pvs, rollbackParentContext, timeoutMillis); statementContext.setActivation(activation); if (needsSavepoint()) { /* Mark this position in the log so that a statement * rollback will undo any changes. */ statementContext.setSavePoint(); needToClearSavePoint = true; } if (executionConstants != null) { lccToUse.validateStmtExecution(executionConstants); } ResultSet resultSet = null; try { resultSet = activation.execute(); resultSet.open(); } catch (StandardException se) { /* Cann't handle recompiling SPS action recompile here */ if (!se.getMessageId().equals(SQLState.LANG_STATEMENT_NEEDS_RECOMPILE) || spsAction) throw se; statementContext.cleanupOnError(se); continue recompileOutOfDatePlan; } if (needToClearSavePoint) { /* We're done with our updates */ statementContext.clearSavePoint(); } lccToUse.popStatementContext(statementContext, null); if (activation.isSingleExecution() && resultSet.isClosed()) { // if the result set is 'done', i.e. not openable, // then we can also release the activation. // Note that a result set with output parameters // or rows to return is explicitly finished // by the user. activation.close(); } return resultSet; } } public ResultDescription getResultDescription() { return resultDesc; } public DataTypeDescriptor[] getParameterTypes() { return paramTypeDescriptors; } public String getSource() { return (sourceTxt != null) ? sourceTxt : (statement == null) ? "null" : statement.getSource(); } public void setSource(String text) { sourceTxt = text; } public final void setSPSName(String name) { spsName = name; } public String getSPSName() { return spsName; } /** * Get the total compile time for the associated query in milliseconds. * Compile time can be divided into parse, bind, optimize and generate times. * * @return long The total compile time for the associated query in milliseconds. */ public long getCompileTimeInMillis() { return compileTime; } /** * Get the parse time for the associated query in milliseconds. * * @return long The parse time for the associated query in milliseconds. */ public long getParseTimeInMillis() { return parseTime; } /** * Get the bind time for the associated query in milliseconds. * * @return long The bind time for the associated query in milliseconds. */ public long getBindTimeInMillis() { return bindTime; } /** * Get the optimize time for the associated query in milliseconds. * * @return long The optimize time for the associated query in milliseconds. */ public long getOptimizeTimeInMillis() { return optimizeTime; } /** * Get the generate time for the associated query in milliseconds. * * @return long The generate time for the associated query in milliseconds. */ public long getGenerateTimeInMillis() { return generateTime; } /** * Get the timestamp for the beginning of compilation * * @return Timestamp The timestamp for the beginning of compilation. */ public Timestamp getBeginCompileTimestamp() { return beginCompileTimestamp; } /** * Get the timestamp for the end of compilation * * @return Timestamp The timestamp for the end of compilation. */ public Timestamp getEndCompileTimestamp() { return endCompileTimestamp; } void setCompileTimeWarnings(SQLWarning warnings) { this.warnings = warnings; } public final SQLWarning getCompileTimeWarnings() { return warnings; } /** * Set the compile time for this prepared statement. * * @param compileTime The compile time */ protected void setCompileTimeMillis(long parseTime, long bindTime, long optimizeTime, long generateTime, long compileTime, Timestamp beginCompileTimestamp, Timestamp endCompileTimestamp) { this.parseTime = parseTime; this.bindTime = bindTime; this.optimizeTime = optimizeTime; this.generateTime = generateTime; this.compileTime = compileTime; this.beginCompileTimestamp = beginCompileTimestamp; this.endCompileTimestamp = endCompileTimestamp; } /** Finish marks a statement as totally unusable. */ public void finish(LanguageConnectionContext lcc) { synchronized (this) { inUseCount--; if (cacheHolder != null) return; if (inUseCount != 0) { //if (SanityManager.DEBUG) { // if (inUseCount < 0) // SanityManager.THROWASSERT("inUseCount is negative " + inUseCount + " for " + this); //} return; } } // invalidate any prepared statements that // depended on this statement (including this one) // prepareToInvalidate(this, DependencyManager.PREPARED_STATEMENT_INVALID); try { /* NOTE: Since we are non-persistent, we "know" that no exception * will be thrown under us. */ makeInvalid(DependencyManager.PREPARED_STATEMENT_RELEASE, lcc); } catch (StandardException se) { if (SanityManager.DEBUG) { SanityManager.THROWASSERT("Unexpected exception", se); } } } /** * Set the Execution constants. This routine is called as we Prepare the * statement. * * @param constantAction The big structure enclosing the Execution constants. */ final void setConstantAction( ConstantAction constantAction ) { executionConstants = constantAction; } /** * Get the Execution constants. This routine is called at Execution time. * * @return ConstantAction The big structure enclosing the Execution constants. */ public final ConstantAction getConstantAction() { return executionConstants; } /** * Set the saved objects. Called when compilation completes. * * @param objects The objects to save from compilation */ final void setSavedObjects( Object[] objects ) { savedObjects = objects; } /** * Get the specified saved object. * * @param objectNum The object to get. * @return the requested saved object. */ public final Object getSavedObject(int objectNum) { if (SanityManager.DEBUG) { if (!(objectNum>=0 && objectNum<savedObjects.length)) SanityManager.THROWASSERT( "request for savedObject entry "+objectNum+" invalid; "+ "savedObjects has "+savedObjects.length+" entries"); } return savedObjects[objectNum]; } /** * Get the saved objects. * * @return all the saved objects */ public final Object[] getSavedObjects() { return savedObjects; } // // Dependent interface // /** Check that all of the dependent's dependencies are valid. @return true if the dependent is currently valid */ public boolean isValid() { return isValid; } /** * set this prepared statement to be valid, currently used by * GenericTriggerExecutor. */ public void setValid() { isValid = true; } /** * Indicate this prepared statement is an SPS action, currently used * by GenericTriggerExecutor. */ public void setSPSAction() { spsAction = true; } /** Prepare to mark the dependent as invalid (due to at least one of its dependencies being invalid). @param action The action causing the invalidation @param p the provider @exception StandardException thrown if unable to make it invalid */ public void prepareToInvalidate(Provider p, int action, LanguageConnectionContext lcc) throws StandardException { /* this statement can have other open result sets if another one is closing without any problems. It is not a problem to create an index when there is an open result set, since it doesn't invalidate the access path that was chosen for the result set. */ switch (action) { case DependencyManager.CHANGED_CURSOR: case DependencyManager.CREATE_INDEX: return; } /* Verify that there are no activations with open result sets * on this prepared statement. */ lcc.verifyNoOpenResultSets(this, p, action); } /** Mark the dependent as invalid (due to at least one of its dependencies being invalid). @param action The action causing the invalidation @exception StandardException Standard Derby error policy. */ public void makeInvalid(int action, LanguageConnectionContext lcc) throws StandardException { boolean alreadyInvalid; synchronized (this) { if (compilingStatement) return; alreadyInvalid = !isValid; // make ourseleves invalid isValid = false; // block compiles while we are invalidating compilingStatement = true; } try { DependencyManager dm = lcc.getDataDictionary().getDependencyManager(); /* Clear out the old dependencies on this statement as we * will build the new set during the reprepare in makeValid(). */ dm.clearDependencies(lcc, this); /* ** If we are invalidating an EXECUTE STATEMENT because of a stale ** plan, we also need to invalidate the stored prepared statement. */ if (execStmtName != null) { switch (action) { case DependencyManager.INTERNAL_RECOMPILE_REQUEST: case DependencyManager.CHANGED_CURSOR: { /* ** Get the DataDictionary, so we can get the descriptor for ** the SPP to invalidate it. */ DataDictionary dd = lcc.getDataDictionary(); SchemaDescriptor sd = dd.getSchemaDescriptor(execSchemaName, lcc.getTransactionCompile(), true); SPSDescriptor spsd = dd.getSPSDescriptor(execStmtName, sd); spsd.makeInvalid(action, lcc); break; } } } } finally { synchronized (this) { compilingStatement = false; notifyAll(); } } } /** * Is this dependent persistent? A stored dependency will be required * if both the dependent and provider are persistent. * * @return boolean Whether or not this dependent is persistent. */ public boolean isPersistent() { /* Non-stored prepared statements are not persistent */ return false; } // // Dependable interface // /** @return the stored form of this Dependable @see Dependable#getDependableFinder */ public DependableFinder getDependableFinder() { return null; } /** * Return the name of this Dependable. (Useful for errors.) * * @return String The name of this Dependable.. */ public String getObjectName() { return UUIDString; } /** * Get the Dependable's UUID String. * * @return String The Dependable's UUID String. */ public UUID getObjectID() { return UUIDValue; } /** * Get the Dependable's class type. * * @return String Classname that this Dependable belongs to. */ public String getClassType() { return Dependable.PREPARED_STATEMENT; } /** * Return true if the query node for this statement references SESSION schema * tables/views. * This method gets called at the very beginning of the compile phase of any statement. * If the statement which needs to be compiled is already found in cache, then there is * no need to compile it again except the case when the statement is referencing SESSION * schema objects. There is a small window where such a statement might get cached * temporarily (a statement referencing SESSION schema object will be removed from the * cache after the bind phase is over because that is when we know for sure that the * statement is referencing SESSION schema objects.) * * @return true if references SESSION schema tables, else false */ public boolean referencesSessionSchema() { return referencesSessionSchema; } /** * Return true if the QueryTreeNode references SESSION schema tables/views. * The return value is also saved in the local field because it will be * used by referencesSessionSchema() method. * This method gets called when the statement is not found in cache and * hence it is getting compiled. * At the beginning of compilation for any statement, first we check if * the statement's plan already exist in the cache. If not, then we add * the statement to the cache and continue with the parsing and binding. * At the end of the binding, this method gets called to see if the * QueryTreeNode references a SESSION schema object. If it does, then * we want to remove it from the cache, since any statements referencing * SESSION schema objects should never get cached. * * @return true if references SESSION schema tables/views, else false */ public boolean referencesSessionSchema(StatementNode qt) throws StandardException { //If the query references a SESSION schema table (temporary or permanent), then // mark so in this statement referencesSessionSchema = qt.referencesSessionSchema(); return(referencesSessionSchema); } // // class interface // /** Makes the prepared statement valid, assigning values for its query tree, generated class, and associated information. @param qt the query tree for this statement @exception StandardException thrown on failure. */ void completeCompile(StatementNode qt) throws StandardException { //if (finished) // throw StandardException.newException(SQLState.LANG_STATEMENT_CLOSED, "completeCompile()"); paramTypeDescriptors = qt.getParameterTypes(); // erase cursor info in case statement text changed if (targetTable!=null) { targetTable = null; updateMode = 0; updateColumns = null; targetColumns = null; } // get the result description (null for non-cursor statements) // would we want to reuse an old resultDesc? // or do we need to always replace in case this was select *? resultDesc = qt.makeResultDescription(); // would look at resultDesc.getStatementType() but it // doesn't call out cursors as such, so we check // the root node type instead. if (resultDesc != null) { /* For cursors, we carry around some extra information. */ CursorInfo cursorInfo = (CursorInfo)qt.getCursorInfo(); if (cursorInfo != null) { targetTable = cursorInfo.targetTable; targetColumns = cursorInfo.targetColumns; updateColumns = cursorInfo.updateColumns; updateMode = cursorInfo.updateMode; } } isValid = true; return; } public GeneratedClass getActivationClass() throws StandardException { return activationClass; } void setActivationClass(GeneratedClass ac) { activationClass = ac; } // // ExecPreparedStatement // /** * the update mode of the cursor * * @return The update mode of the cursor */ public int getUpdateMode() { return updateMode; } /** * the target table of the cursor * * @return target table of the cursor */ public ExecCursorTableReference getTargetTable() { if (SanityManager.DEBUG) { SanityManager.ASSERT(targetTable!=null, "Not a cursor, no target table"); } return targetTable; } /** * the target columns of the cursor as a result column list * * @return target columns of the cursor as a result column list */ public ResultColumnDescriptor[] getTargetColumns() { return targetColumns; } /** * the update columns of the cursor as a update column list * * @return update columns of the cursor as a array of strings */ public String[] getUpdateColumns() { return updateColumns; } /** * Return the cursor info in a single chunk. Used * by StrorablePreparedStatement */ public Object getCursorInfo() { return new CursorInfo( updateMode, targetTable, targetColumns, updateColumns); } void setCursorInfo(CursorInfo cursorInfo) { if (cursorInfo != null) { updateMode = cursorInfo.updateMode; targetTable = cursorInfo.targetTable; targetColumns = cursorInfo.targetColumns; updateColumns = cursorInfo.updateColumns; } } // // class implementation // /** * Get the byte code saver for this statement. * Overridden for StorablePreparedStatement. We * don't want to save anything * * @return a byte code saver (null for us) */ ByteArray getByteCodeSaver() { return null; } /** * Does this statement need a savepoint? * * @return true if this statement needs a savepoint. */ public boolean needsSavepoint() { return needsSavepoint; } /** * Set the stmts 'needsSavepoint' state. Used * by an SPS to convey whether the underlying stmt * needs a savepoint or not. * * @param needsSavepoint true if this statement needs a savepoint. */ void setNeedsSavepoint(boolean needsSavepoint) { this.needsSavepoint = needsSavepoint; } /** * Set the stmts 'isAtomic' state. * * @param isAtomic true if this statement must be atomic * (i.e. it is not ok to do a commit/rollback in the middle) */ void setIsAtomic(boolean isAtomic) { this.isAtomic = isAtomic; } /** * Returns whether or not this Statement requires should * behave atomically -- i.e. whether a user is permitted * to do a commit/rollback during the execution of this * statement. * * @return boolean Whether or not this Statement is atomic */ public boolean isAtomic() { return isAtomic; } /** * Set the name of the statement and schema for an "execute statement" * command. */ void setExecuteStatementNameAndSchema(String execStmtName, String execSchemaName) { this.execStmtName = execStmtName; this.execSchemaName = execSchemaName; } /** * Get a new prepared statement that is a shallow copy * of the current one. * * @return a new prepared statement * * @exception StandardException on error */ public ExecPreparedStatement getClone() throws StandardException { GenericPreparedStatement clone = new GenericPreparedStatement(statement); clone.activationClass = getActivationClass(); clone.resultDesc = resultDesc; clone.paramTypeDescriptors = paramTypeDescriptors; clone.executionConstants = executionConstants; clone.UUIDString = UUIDString; clone.UUIDValue = UUIDValue; clone.savedObjects = savedObjects; clone.execStmtName = execStmtName; clone.execSchemaName = execSchemaName; clone.isAtomic = isAtomic; clone.sourceTxt = sourceTxt; clone.targetTable = targetTable; clone.targetColumns = targetColumns; clone.updateColumns = updateColumns; clone.updateMode = updateMode; clone.needsSavepoint = needsSavepoint; return clone; } // cache holder stuff. public void setCacheHolder(Cacheable cacheHolder) { this.cacheHolder = cacheHolder; if (cacheHolder == null) { // need to invalidate the statement if (!isValid || (inUseCount != 0)) return; ContextManager cm = ContextService.getFactory().getCurrentContextManager(); LanguageConnectionContext lcc = (LanguageConnectionContext) (cm.getContext(LanguageConnectionContext.CONTEXT_ID)); // invalidate any prepared statements that // depended on this statement (including this one) // prepareToInvalidate(this, DependencyManager.PREPARED_STATEMENT_INVALID); try { /* NOTE: Since we are non-persistent, we "know" that no exception * will be thrown under us. */ makeInvalid(DependencyManager.PREPARED_STATEMENT_RELEASE, lcc); } catch (StandardException se) { if (SanityManager.DEBUG) { SanityManager.THROWASSERT("Unexpected exception", se); } } } } public String toString() { return getObjectName(); } public boolean isStorable() { return false; } public void setRequiredPermissionsList( List requiredPermissionsList) { this.requiredPermissionsList = requiredPermissionsList; } public List getRequiredPermissionsList() { return requiredPermissionsList; } }

The table below shows all metrics for GenericPreparedStatement.java.

MetricValueDescription
BLOCKS98.00Number of blocks
BLOCK_COMMENT66.00Number of block comment lines
COMMENTS441.00Comment lines
COMMENT_DENSITY 1.09Comment density
COMPARISONS37.00Number of comparison operators
CYCLOMATIC107.00Cyclomatic complexity
DECL_COMMENTS62.00Comments in declarations
DOC_COMMENT273.00Number of javadoc comment lines
ELOC406.00Effective lines of code
EXEC_COMMENTS31.00Comments in executable code
EXITS66.00Procedure exits
FUNCTIONS62.00Number of function declarations
HALSTEAD_DIFFICULTY77.79Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY129.00Interface complexity
JAVA0001 0.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 0.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 1.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 1.00JAVA0007 Should not declare public field
JAVA0008 0.00JAVA0008 Empty catch block
JAVA0009 0.00JAVA0009 Protected member in final class
JAVA0010 0.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 2.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA0034 6.00JAVA0034 Missing braces in if statement
JAVA0035 0.00JAVA0035 Missing braces in for statement
JAVA0036 0.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 0.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 0.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 0.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 0.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 0.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 0.00JAVA0067 Array descriptor on identifier name
JAVA0068 0.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 0.00JAVA0074 Use of Object.notify()
JAVA0075 0.00JAVA0075 Method parameter hides field
JAVA0076 0.00JAVA0076 Use of magic number
JAVA0077 0.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 0.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 0.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 0.00JAVA0096 Field in nested class hides outer field
JAVA0098 1.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 1.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA010810.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110 2.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 0.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 0.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 1.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 1.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 1.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 1.00JAVA0116 Missing javadoc: field 'field'
JAVA0117 4.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 0.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 0.00JAVA0119 Control variable changed within body of for loop
JAVA0123 0.00JAVA0123 Use all three components of for loop
JAVA0125 1.00JAVA0125 Continue statement with label
JAVA0126 0.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 0.00JAVA0128 Public constructor in non-public class
JAVA0130 1.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 0.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 0.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 1.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 0.00JAVA0137 Non-abstract class missing constructor
JAVA0138 1.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 0.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 1.00JAVA0143 Synchronized method
JAVA0144 0.00JAVA0144 Line exceeds maximum M characters
JAVA01451988.00JAVA0145 Tab character used in source file
JAVA0150 0.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 0.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA0166 0.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 0.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 1.00JAVA0174 Assigned local variable never used
JAVA0175 0.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA0177 2.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 0.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 0.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 0.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 0.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 2.00JAVA0256 Assignment of external collection/array to field
JAVA0257 0.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 0.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 5.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 0.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 0.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 0.00JAVA0266 Use of System.out
JAVA0267 0.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 0.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 0.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 0.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 0.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES1174.00Number of lines in the source file
LINE_COMMENT102.00Number of line comments
LOC567.00Lines of code
LOGICAL_LINES241.00Number of statements
LOOPS 1.00Number of loops
NEST_DEPTH 4.00Maximum nesting depth
OPERANDS954.00Number of operands
OPERATORS1737.00Number of operators
PARAMS39.00Number of formal parameter declarations
PROGRAM_LENGTH2691.00Halstead program length
PROGRAM_VOCAB378.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS90.00Number of return points from functions
SIZE31688.00Size of the file in bytes
UNIQUE_OPERANDS325.00Number of unique operands
UNIQUE_OPERATORS53.00Number of unique operators
WHITESPACE166.00Number of whitespace lines