SPSDescriptor.java

Index Score
org.apache.derby.iapi.sql.dictionary
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
COMMENTSComment lines
JAVA0143JAVA0143 Synchronized method
DOC_COMMENTNumber of javadoc comment lines
DECL_COMMENTSComments in declarations
LINE_COMMENTNumber of line comments
LINESNumber of lines in the source file
EXEC_COMMENTSComments in executable code
SIZESize of the file in bytes
CYCLOMATICCyclomatic complexity
JAVA0177JAVA0177 Variable declaration missing initializer
RETURNSNumber of return points from functions
INTERFACE_COMPLEXITYInterface complexity
LOCLines of code
ELOCEffective lines of code
JAVA0145JAVA0145 Tab character used in source file
PARAMSNumber of formal parameter declarations
FUNCTIONSNumber of function declarations
UNIQUE_OPERANDSNumber of unique operands
PROGRAM_VOCABHalstead program vocabulary
BLOCK_COMMENTNumber of block comment lines
EXITSProcedure exits
PROGRAM_LENGTHHalstead program length
OPERATORSNumber of operators
OPERANDSNumber of operands
JAVA0081JAVA0081 Boolean literal in comparison
BLOCKSNumber of blocks
LOGICAL_LINESNumber of statements
JAVA0171JAVA0171 Unused local variable
JAVA0034JAVA0034 Missing braces in if statement
JAVA0067JAVA0067 Array descriptor on identifier name
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
UNIQUE_OPERATORSNumber of unique operators
JAVA0117JAVA0117 Missing javadoc: method 'method'
NEST_DEPTHMaximum nesting depth
PROGRAM_VOLUMEHalstead program volume
JAVA0259JAVA0259 Return of collection/array field
JAVA0136JAVA0136 N methods defined in class (maximum: M)
JAVA0138JAVA0138 N parameters defined for method (maximum: M)
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0100JAVA0100 Class contains N non-final fields (maximum: M)
LOOPSNumber of loops
JAVA0068JAVA0068 Modifiers not declared in recommended order
JAVA0256JAVA0256 Assignment of external collection/array to field
/* Derby - Class org.apache.derby.iapi.sql.dictionary.SPSDescriptor 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.iapi.sql.dictionary; import java.sql.Timestamp; import java.util.Enumeration; import java.util.Vector; import org.apache.derby.catalog.Dependable; import org.apache.derby.catalog.DependableFinder; import org.apache.derby.catalog.UUID; import org.apache.derby.iapi.error.StandardException; import org.apache.derby.iapi.reference.SQLState; import org.apache.derby.iapi.services.context.ContextManager; import org.apache.derby.iapi.services.context.ContextService; import org.apache.derby.iapi.services.io.StoredFormatIds; import org.apache.derby.iapi.services.monitor.Monitor; import org.apache.derby.iapi.services.sanity.SanityManager; import org.apache.derby.iapi.services.uuid.UUIDFactory; import org.apache.derby.iapi.sql.Statement; import org.apache.derby.iapi.sql.StorablePreparedStatement; import org.apache.derby.iapi.sql.conn.LanguageConnectionContext; import org.apache.derby.iapi.sql.conn.LanguageConnectionFactory; import org.apache.derby.iapi.sql.depend.DependencyManager; import org.apache.derby.iapi.sql.depend.Dependent; import org.apache.derby.iapi.sql.depend.Provider; import org.apache.derby.iapi.sql.depend.ProviderInfo; import org.apache.derby.iapi.sql.execute.ExecPreparedStatement; import org.apache.derby.iapi.store.access.TransactionController; import org.apache.derby.iapi.types.DataTypeDescriptor; /** * A SPSDescriptor describes a Stored Prepared Statement. * It correlates to a row in SYS.SYSSTATEMENTS. * * <B>SYNCHRONIZATION</B>: Stored prepared statements * may be cached. Thus they may be shared by multiple * threads. It is very hard for two threads to try * to muck with an sps simultaeously because all ddl * (including sps recompilation) clears out the sps * cache and invalidates whatever statement held a * cached sps. But it is possible for two statements * to do a prepare execute statment <x> at the exact * same time, so both try to do an sps.prepare() at the * same time during code generation, so we synchronize * most everything except getters on immutable objects * just to be on the safe side. * * */ public class SPSDescriptor extends TupleDescriptor implements UniqueSQLObjectDescriptor, Dependent, Provider { /** * Statement types. * <UL> * <LI> SPS_TYPE_TRIGGER - trigger (<B>NOT IMPLEMENTED</B>) </LI> * <LI> SPS_TYPE_EXPLAIN - explain (<B>NOT IMPLEMENTED</B>) </LI> * <LI> SPS_TYPE_REGULAR - catchall</LI> * </UL> */ public static final char SPS_TYPE_TRIGGER = 'T'; public static final char SPS_TYPE_REGULAR = 'S'; public static final char SPS_TYPE_EXPLAIN = 'X'; /** interface to this class is: <ol> <li>public void prepare() throws StandardException; <li>public void prepareAndRelease(LanguageConnectionContext lcc) throws StandardException; <li>public void prepareAndRelease(...); <li>public String getQualifiedName(); <li>public char getType(); <li>public String getTypeAsString(); <li>public boolean isValid(); <li>public boolean initiallyCompilable(); <li>public java.sql.Timestamp getCompileTime(); <li>public void setCompileTime(); <li>public String getText(); <li>public String getUsingText(); <li>public void setUsingText(String usingText); <li>public void setUUID(UUID uuid); <li>public DataTypeDescriptor[] getParams() throws StandardException; <li>public void setParams(DataTypeDescriptor[] params); <li>Object[] getParameterDefaults() throws StandardException; <li>void setParameterDefaults(Object[] values); <li>public UUID getCompSchemaId(); <li>public ExecPreparedStatement getPreparedStatement() throws StandardException; <li>public ExecPreparedStatement getPreparedStatement(boolean recompIfInvalid) throws StandardException; <li>public void revalidate(LanguageConnectionContext lcc) throws StandardException; </ol> */ private static final int RECOMPILE = 1; private static final int INVALIDATE = 0; // Class contents private SchemaDescriptor sd; private String name; private UUID uuid; private UUID compSchemaId; private char type; private boolean valid; private String text; private String usingText; private ExecPreparedStatement preparedStatement; private DataTypeDescriptor params[]; private Timestamp compileTime; /** * Old code - never used. */ private Object paramDefaults[]; private boolean initiallyCompilable; private boolean lookedUpParams; private UUIDFactory uuidFactory; // constructors /** * Constructor for a SPS Descriptor * * @param dataDictionary The data dictionary that this descriptor lives in * @param name the SPS name * @param uuid the UUID * @param suuid the schema UUID * @param compSchemaUUID the schema UUID at compilation time * @param type type * @param valid is the sps valid * @param text the text for this statement * @param initiallyCompilable is the statement initially compilable? * * @exception StandardException on error */ public SPSDescriptor (DataDictionary dataDictionary, String name, UUID uuid, UUID suuid, UUID compSchemaUUID, char type, boolean valid, String text, boolean initiallyCompilable ) throws StandardException { this( dataDictionary, name, uuid, suuid, compSchemaUUID, type, valid, text, (String) null, null, null, initiallyCompilable ); } /** * Constructor for a SPS Descriptor. Used when * constructing an SPS descriptor from a row * in SYSSTATEMENTS. * * @param dataDictionary The data dictionary that this descriptor lives in * @param name the SPS name * @param uuid the UUID * @param suuid the schema UUID * @param compSchemaUUID the schema UUID at compilation time * @param type type * @param valid is the sps valid * @param text the text for this statement * @param usingText the text for the USING clause supplied to * CREATE or ALTER STATEMENT * @param compileTime the time this was compiled * @param preparedStatement the PreparedStatement * @param initiallyCompilable is the statement initially compilable? * * @exception StandardException on error */ public SPSDescriptor (DataDictionary dataDictionary, String name, UUID uuid, UUID suuid, UUID compSchemaUUID, char type, boolean valid, String text, String usingText, Timestamp compileTime, ExecPreparedStatement preparedStatement, boolean initiallyCompilable ) throws StandardException { super( dataDictionary ); this.name = name; this.uuid = uuid; this.type = type; this.text = text; this.usingText = usingText; this.valid = valid; this.compileTime = compileTime; this.sd = dataDictionary.getSchemaDescriptor(suuid, null); this.preparedStatement = preparedStatement; this.compSchemaId = compSchemaUUID; this.initiallyCompilable = initiallyCompilable; } /** * FOR TRIGGERS ONLY * <p> * Generate the class for this SPS and immediately * release it. This is useful for cases where we * don't want to immediately execute the statement * corresponding to this sps (e.g. CREATE STATEMENT). * <p> * <I>SIDE EFFECTS</I>: will update and SYSDEPENDS * with the prepared statement dependency info. * * @param lcc the language connection context * @param triggerTable the table descriptor to bind against. Had * better be null if this isn't a trigger sps. * @param tc the transaction controller * * @exception StandardException on error */ public final synchronized void prepareAndRelease ( LanguageConnectionContext lcc, TableDescriptor triggerTable, TransactionController tc ) throws StandardException { if (SanityManager.DEBUG) { if (triggerTable != null) { SanityManager.ASSERT(type == SPS_TYPE_TRIGGER, "only expect a table descriptor when we have a trigger"); } } compileStatement(lcc, triggerTable, tc); preparedStatement.makeInvalid(DependencyManager.PREPARED_STATEMENT_RELEASE, lcc); } /** * FOR TRIGGERS ONLY * <p> * Generate the class for this SPS and immediately * release it. This is useful for cases where we * don't want to immediately execute the statement * corresponding to this sps (e.g. CREATE STATEMENT). * <p> * <I>SIDE EFFECTS</I>: will update and SYSDEPENDS * with the prepared statement dependency info. * * @param lcc the language connection context * @param triggerTable the table descriptor to bind against. Had * better be null if this isn't a trigger sps. * * @exception StandardException on error */ public final synchronized void prepareAndRelease ( LanguageConnectionContext lcc, TableDescriptor triggerTable ) throws StandardException { prepareAndRelease(lcc, triggerTable, (TransactionController)null); } /** * Generate the class for this SPS and immediately * release it. This is useful for cases where we * don't want to immediately execute the statement * corresponding to this sps (e.g. CREATE STATEMENT). * <p> * <I>SIDE EFFECTS</I>: will update and SYSDEPENDS * with the prepared statement dependency info. * * @param lcc the language connection context * * @exception StandardException on error */ public final synchronized void prepareAndRelease(LanguageConnectionContext lcc) throws StandardException { prepareAndRelease(lcc, (TableDescriptor)null, (TransactionController)null); } private void compileStatement ( LanguageConnectionContext lcc, TableDescriptor triggerTable, TransactionController tc ) throws StandardException { ContextManager cm = lcc.getContextManager(); DependencyManager dm; ProviderInfo[] providerInfo; LanguageConnectionFactory lcf = lcc.getLanguageConnectionFactory(); DataDictionary dd = getDataDictionary(); /* ** If we are a trigger, then we have to go ahead ** and locate the trigger's table descriptor and ** push it on the lcc. This is expensive, but ** pretty atypical since trigger actions aren't ** likely to be invalidated too often. Also, when ** possible, we already have the triggerTable. */ if (type == SPS_TYPE_TRIGGER && triggerTable == null) { String uuidStr = name.substring(49); triggerTable = dd.getTableDescriptor(recreateUUID(uuidStr)); if (SanityManager.DEBUG) { if (triggerTable == null) { SanityManager.THROWASSERT("couldn't find trigger table for trigger sps "+name); } } } if (triggerTable != null) { lcc.pushTriggerTable(triggerTable); } // stored statements always stored as unicode. Statement stmt = lcf.getStatement(dd.getSchemaDescriptor(compSchemaId, null), text, true); try { preparedStatement = (ExecPreparedStatement) stmt.prepareStorable( lcc, preparedStatement, getParameterDefaults(), getSchemaDescriptor(), type == SPS_TYPE_TRIGGER); } finally { if (triggerTable != null) { lcc.popTriggerTable(triggerTable); } } //If this references a SESSION schema table (temporary or permanent), then throw an exception //This is if EXECUTE STATEMENT 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. And hence need to catch such statements at EXECUTE STATEMENT time //when the query is getting compiled. if (preparedStatement.referencesSessionSchema()) throw StandardException.newException(SQLState.LANG_OPERATION_NOT_ALLOWED_ON_SESSION_SCHEMA_TABLES); setCompileTime(); setParams(preparedStatement.getParameterTypes()); if (!((org.apache.derby.impl.sql.catalog.DataDictionaryImpl) dd).readOnlyUpgrade) { /* ** Indicate that we are going to write the data ** dictionary. We have probably already done this ** but it is ok to call startWriting more than once. */ dd.startWriting(lcc); dm = dd.getDependencyManager(); /* ** Clear out all the dependencies that exist ** before we recreate them so we don't grow ** SYS.SYSDEPENDS forever. */ dm.clearDependencies(lcc, this, tc); /* ** Copy over all the dependencies to me */ dm.copyDependencies(preparedStatement, // from this, // to false, // persistent only cm, tc); } // mark it as valid valid = true; } /** * Gets the name of the sps. * * @return A String containing the name of the statement. */ public final String getName() { return name; } /** * Gets the full, qualified name of the statement. * * @return A String containing the name of the statement. */ public final String getQualifiedName() { return sd.getSchemaName() + "." + name; } /** * Gets the SchemaDescriptor for this SPS Descriptor. * * @return SchemaDescriptor The SchemaDescriptor. */ public final SchemaDescriptor getSchemaDescriptor() { return sd; } /** * Gets an identifier telling what type of table this is. * Types match final ints in this interface. Currently * returns SPS_TYPE_REGULAR or SPS_TYPE_TRIGGER. * * @return An identifier telling what type of statement * we are. */ public final char getType() { return type; } /** * Simple little helper function to convert your type * to a string, which is easier to use. * * @return type as a string */ public final String getTypeAsString() { char[] charArray = new char[1]; charArray[0] = type; return new String(charArray); } /** * Is the statement initially compilable? * * @return false if statement was created with the NOCOMPILE flag * true otherwise */ public boolean initiallyCompilable() { return initiallyCompilable; } /** * Validate the type. <B>NOTE</B>: Only SPS_TYPE_REGULAR * and SPS_TYPE_TRIGGER are currently valid. * * @param type the type * * @return true/false */ public final static boolean validType(char type) { return (type == SPSDescriptor.SPS_TYPE_REGULAR) || (type == SPSDescriptor.SPS_TYPE_TRIGGER); } /** * The time this prepared statement was compiled * * @return the time this class was last compiled */ public final synchronized Timestamp getCompileTime() { return compileTime; } /** * Set the compile time to now * */ public final synchronized void setCompileTime() { compileTime = new Timestamp(System.currentTimeMillis()); } /** * Get the text used to create this statement. * Returns original text in a cleartext string. * * @return The text */ public final String getText() { return text; } /** * Get the text of the USING clause used on CREATE * or ALTER statement. * * @return The text */ public final synchronized String getUsingText() { return usingText; } /** * Sets the UUID of the SPS. * * @param uuid The UUID of the SPS to be set in the descriptor */ public final synchronized void setUUID(UUID uuid) { this.uuid = uuid; } /** * Gets the UUID of the SPS. * * @return the uuid */ public final UUID getUUID() { return uuid; } /** * Get the array of date type descriptors for * this statement. Currently, we do a lookup * if we don't already have the parameters saved. * When SPSes are cached, the parameters should * be set up when the sps is constructed. * * @return the array of data type descriptors * * @exception StandardException on error */ public final synchronized DataTypeDescriptor[] getParams() throws StandardException { if (params == null && !lookedUpParams) { Vector v = new Vector(); params = getDataDictionary().getSPSParams(this, v); paramDefaults = new Object[v.size()]; Enumeration iterator = v.elements(); for (int i = 0; iterator.hasMoreElements(); i++) { paramDefaults[i] = iterator.nextElement(); } lookedUpParams = true; } return params; } /** * Set the list of parameters for this statement * * @param params the parameter list */ public final synchronized void setParams(DataTypeDescriptor params[]) { this.params = params; } /** * Get the default parameter values for this * statement. Default parameter values are * supplied by a USING clause on either a * CREATE or ALTER STATEMENT statement. * * @return the default parameter values * * @exception StandardException on error */ public final synchronized Object[] getParameterDefaults() throws StandardException { if (paramDefaults == null) getParams(); return paramDefaults; } /** * Set the parameter defaults for this statement. * * @param values the parameter defaults */ public final synchronized void setParameterDefaults(Object[] values) { this.paramDefaults = values; } /** * Get the constant action for this statement * * @return the constant action */ //public final synchronized ConstantAction getConstantAction() //{ // return preparedStatement.getConstantAction(); //} /** * Get the preparedStatement for this statement. * If stmt is invalid or hasn't been compiled yet, * it will be recompiled. * * @return the preparedStatement * * @exception StandardException on error */ public final ExecPreparedStatement getPreparedStatement() throws StandardException { return getPreparedStatement(true); } /** * Get the preparedStatement for this statement. * Expects the prepared statement to have already * been added to SYS.SYSSTATEMENTS. * <p> * Side Effects: will update SYS.SYSSTATEMENTS with * the new plan if it needs to be recompiled. * * @param recompIfInvalid if false, never recompile even * if statement is invalid * * @return the preparedStatement * * @exception StandardException on error */ public final synchronized ExecPreparedStatement getPreparedStatement(boolean recompIfInvalid) throws StandardException { //System.out.println("preparedStatement = " + preparedStatement); /* ** Recompile if we are invalid, we don't have ** a prepared statement, or the statements activation ** has been cleared and cannot be reconstituted. */ if (recompIfInvalid && (!valid || (preparedStatement == null))) { ContextManager cm = ContextService.getFactory().getCurrentContextManager(); /* ** Find the language connection context. Get ** it each time in case a connection is dropped. */ LanguageConnectionContext lcc = (LanguageConnectionContext) cm.getContext(LanguageConnectionContext.CONTEXT_ID); if (!((org.apache.derby.impl.sql.catalog.DataDictionaryImpl) (lcc.getDataDictionary())).readOnlyUpgrade) { //bug 4821 - First try compiling on a nested transaction so we can release //the locks after the compilation. But if we get lock time out on the //nested transaction, then go ahead and do the compilation on the user //transaction. When doing the compilation on user transaction, the locks //acquired for recompilation will be released at the end of the user transaction. TransactionController nestedTC; try { nestedTC = lcc.getTransactionCompile().startNestedUserTransaction(false); } catch (StandardException se) { // If I cannot start a Nested User Transaction use the parent // transaction to do all the work. nestedTC = null; } // DERBY-2584: If the first attempt to compile the query fails, // we need to reset initiallyCompilable to make sure the // prepared plan is fully stored to disk. Save the initial // value here. final boolean compilable = initiallyCompilable; try { prepareAndRelease(lcc, null, nestedTC); updateSYSSTATEMENTS(lcc, RECOMPILE, nestedTC); } catch (StandardException se) { if (se.getMessageId().equals(SQLState.LOCK_TIMEOUT)) { if (nestedTC != null) { nestedTC.commit(); nestedTC.destroy(); nestedTC = null; } // if we couldn't do this with a nested xaction, retry with // parent-- we need to wait this time! initiallyCompilable = compilable; prepareAndRelease(lcc, null, null); updateSYSSTATEMENTS(lcc, RECOMPILE, null); } else throw se; } finally { // no matter what, commit the nested transaction; if something // bad happened in the child xaction lets not abort the parent // here. if (nestedTC != null) { nestedTC.commit(); nestedTC.destroy(); } } } } return preparedStatement; } /** * Get the compilation type schema id when this view * was first bound. * * @return the schema UUID */ public final UUID getCompSchemaId() { return compSchemaId; } /** * Prints the contents of the TableDescriptor * * @return The contents as a String */ public final String toString() { if (SanityManager.DEBUG) { return "SPSDescriptor:\n"+ "\tname: "+sd.getSchemaName()+"."+name+"\n"+ "\tuuid: "+uuid+"\n"+ "\ttext: "+text+"\n"+ "\tvalid: "+((valid) ? "TRUE" : "FALSE")+"\n" + "\tpreparedStatement: "+preparedStatement+"\n"; } else { return ""; } } ////////////////////////////////////////////////////// // // PROVIDER INTERFACE // ////////////////////////////////////////////////////// /** * Return the stored form of this provider * * @see Dependable#getDependableFinder */ public final DependableFinder getDependableFinder() { return getDependableFinder(StoredFormatIds.SPS_DESCRIPTOR_FINDER_V01_ID); } /** * Return the name of this Provider. (Useful for errors.) * * @return String The name of this provider. */ public final String getObjectName() { return name; } /** * Get the provider's UUID * * @return String The provider's UUID */ public final UUID getObjectID() { return uuid; } /** * Get the provider's type. * * @return String The provider's type. */ public final String getClassType() { return Dependable.STORED_PREPARED_STATEMENT; } ////////////////////////////////////////////////////// // // DEPENDENT INTERFACE // ////////////////////////////////////////////////////// /** * Check that all of the dependent's dependencies are valid. * * @return true if the dependent is currently valid */ public final synchronized boolean isValid() { return valid; } /** * 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 final synchronized void prepareToInvalidate( Provider p, int action, LanguageConnectionContext lcc) throws StandardException { switch (action) { /* ** Things that don't affect us */ case DependencyManager.CREATE_VIEW: /* ** Things that force a recompile, but are ** allowed. */ case DependencyManager.CREATE_INDEX: case DependencyManager.CREATE_CONSTRAINT: case DependencyManager.DROP_CONSTRAINT: case DependencyManager.DROP_INDEX: case DependencyManager.DROP_TABLE: case DependencyManager.DROP_VIEW: case DependencyManager.DROP_METHOD_ALIAS: case DependencyManager.DROP_SYNONYM: case DependencyManager.ALTER_TABLE: case DependencyManager.RENAME: case DependencyManager.RENAME_INDEX: case DependencyManager.PREPARED_STATEMENT_RELEASE: case DependencyManager.USER_RECOMPILE_REQUEST: case DependencyManager.CHANGED_CURSOR: case DependencyManager.BULK_INSERT: case DependencyManager.COMPRESS_TABLE: case DependencyManager.SET_CONSTRAINTS_ENABLE: case DependencyManager.SET_CONSTRAINTS_DISABLE: case DependencyManager.SET_TRIGGERS_ENABLE: case DependencyManager.SET_TRIGGERS_DISABLE: case DependencyManager.ROLLBACK: case DependencyManager.INTERNAL_RECOMPILE_REQUEST: case DependencyManager.CREATE_TRIGGER: case DependencyManager.DROP_TRIGGER: case DependencyManager.DROP_COLUMN: case DependencyManager.DROP_COLUMN_RESTRICT: case DependencyManager.UPDATE_STATISTICS: case DependencyManager.DROP_STATISTICS: case DependencyManager.TRUNCATE_TABLE: break; /* ** The rest are errors */ default: DependencyManager dm; dm = getDataDictionary().getDependencyManager(); throw StandardException.newException(SQLState.LANG_PROVIDER_HAS_DEPENDENT_S_P_S, dm.getActionString(action), p.getObjectName(), name); } } /** * Mark the dependent as invalid (due to at least one of * its dependencies being invalid). * * @param action The action causing the invalidation * * @exception StandardException thrown if unable to make it invalid */ public final synchronized void makeInvalid(int action, LanguageConnectionContext lcc) throws StandardException { DependencyManager dm; dm = getDataDictionary().getDependencyManager(); switch (action) { /* ** Some things that don't affect stored prepared ** statements. */ case DependencyManager.PREPARED_STATEMENT_RELEASE: case DependencyManager.CREATE_VIEW: break; /* ** Things that can invalidate a stored ** prepared statement. */ case DependencyManager.CREATE_INDEX: case DependencyManager.CREATE_CONSTRAINT: case DependencyManager.DROP_CONSTRAINT: case DependencyManager.DROP_TABLE: case DependencyManager.DROP_INDEX: case DependencyManager.DROP_VIEW: case DependencyManager.DROP_METHOD_ALIAS: case DependencyManager.DROP_SYNONYM: case DependencyManager.ALTER_TABLE: case DependencyManager.RENAME: case DependencyManager.RENAME_INDEX: case DependencyManager.USER_RECOMPILE_REQUEST: case DependencyManager.CHANGED_CURSOR: case DependencyManager.BULK_INSERT: case DependencyManager.COMPRESS_TABLE: case DependencyManager.SET_CONSTRAINTS_ENABLE: case DependencyManager.SET_CONSTRAINTS_DISABLE: case DependencyManager.SET_TRIGGERS_ENABLE: case DependencyManager.SET_TRIGGERS_DISABLE: case DependencyManager.ROLLBACK: case DependencyManager.INTERNAL_RECOMPILE_REQUEST: case DependencyManager.CREATE_TRIGGER: case DependencyManager.DROP_TRIGGER: case DependencyManager.DROP_COLUMN: case DependencyManager.DROP_COLUMN_RESTRICT: case DependencyManager.UPDATE_STATISTICS: case DependencyManager.DROP_STATISTICS: case DependencyManager.TRUNCATE_TABLE: /* ** If we are already invalid, don't write ourselves ** out. Just to be safe, we'll send out an invalidate ** to our dependents either way. */ if (valid == true) { valid = false; updateSYSSTATEMENTS(lcc, INVALIDATE, null); } dm.invalidateFor(this, dm.USER_RECOMPILE_REQUEST, lcc); break; case DependencyManager.DROP_SPS: //System.out.println("SPSD " + preparedStatement); dm.clearDependencies(lcc, this); break; default: /* ** We should never get here, since we can't have dangling references */ if (SanityManager.DEBUG) { SanityManager.THROWASSERT("makeInvalid("+ dm.getActionString(action)+ ") not expected to get called; should have failed in "+ "prepareToInvalidate()"); } break; } } /** * Invalidate and revalidate. The functional equivalent * of calling makeInvalid() and makeValid(), except it * is optimized. * * @exception StandardException on error */ public final synchronized void revalidate(LanguageConnectionContext lcc) throws StandardException { /* ** Mark it as invalid first to ensure that ** we don't write SYSSTATEMENTS 2x. */ valid = false; makeInvalid(DependencyManager.USER_RECOMPILE_REQUEST, lcc); prepareAndRelease(lcc); updateSYSSTATEMENTS(lcc, RECOMPILE, null); } /** * Load the underlying generatd class. This is not expected * to be used outside of the datadictionary package. It * is used for optimizing class loading for sps * cacheing. * * @exception StandardException on error */ public void loadGeneratedClass() throws StandardException { /* ** On upgrade, we null out the statement body, ** so handle that here. */ if (preparedStatement != null) { ((StorablePreparedStatement)preparedStatement).loadGeneratedClass(); } } /* ** Update SYSSTATEMENTS with the changed the descriptor. ** Always done in the user XACT. ** <p> ** Ideally, the changes to SYSSTATEMENTS would be made ** in a separate xact as the current user xact, but this ** is painful (you'ld need to get a new ContextManager ** and then push all of the usual langauge contexts ** onto it and THEN call AccessManager.getTransaction()), ** and it wont work, because the xact is in a different ** compatibility space and will self deadlock (e.g. ** in the process of call DependencyManager.makeInvalid() ** we first did a DDdependableFinder.getDependable() ** which called DataDictionaryImpl.getSPSDescriptor() ** so we hold a lock on SYS.SYSSTATEMENTS by the ** time we get a 2nd xact and try to drop the statement). */ private void updateSYSSTATEMENTS(LanguageConnectionContext lcc, int mode, TransactionController tc) throws StandardException { int[] colsToUpdate; boolean updateSYSCOLUMNS, recompile; //bug 4821 - we want to wait for locks if updating sysstatements on parent transaction boolean wait = false; boolean firstCompilation = false; if (mode == RECOMPILE) { recompile = true; updateSYSCOLUMNS = true; if(!initiallyCompilable) { firstCompilation = true; initiallyCompilable = true; } } else { recompile = false; updateSYSCOLUMNS = false; } DataDictionary dd = getDataDictionary(); if (((org.apache.derby.impl.sql.catalog.DataDictionaryImpl) dd).readOnlyUpgrade) return; /* ** Get busy time */ dd.startWriting(lcc); if (tc == null) { //bug 4821 - tc will passed null if we want to use the user transaction tc = lcc.getTransactionExecute(); wait = true; } dd.updateSPS(this, tc, recompile, updateSYSCOLUMNS, wait, firstCompilation); } /** * Get the UUID for the given string * * @param idString the string * * @return the UUID */ private UUID recreateUUID(String idString) { if (uuidFactory == null) { uuidFactory = Monitor.getMonitor().getUUIDFactory(); } return uuidFactory.recreateUUID(idString); } /** @see TupleDescriptor#getDescriptorType */ public String getDescriptorType() { return "Statement"; } /** @see TupleDescriptor#getDescriptorName */ // RESOLVE: some descriptors have getName. some descriptors have // getTableName, getColumnName whatever! try and unify all of this to one // getDescriptorName! public String getDescriptorName() { return name; } }

The table below shows all metrics for SPSDescriptor.java.

MetricValueDescription
BLOCKS72.00Number of blocks
BLOCK_COMMENT104.00Number of block comment lines
COMMENTS505.00Comment lines
COMMENT_DENSITY 1.30Comment density
COMPARISONS26.00Number of comparison operators
CYCLOMATIC137.00Cyclomatic complexity
DECL_COMMENTS51.00Comments in declarations
DOC_COMMENT356.00Number of javadoc comment lines
ELOC388.00Effective lines of code
EXEC_COMMENTS27.00Comments in executable code
EXITS61.00Procedure exits
FUNCTIONS40.00Number of function declarations
HALSTEAD_DIFFICULTY78.52Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY113.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 0.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 0.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 0.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA0034 4.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 1.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 1.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 2.00JAVA0067 Array descriptor on identifier name
JAVA0068 1.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 1.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 1.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 0.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
JAVA0108 1.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110 3.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 0.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 2.00JAVA0116 Missing javadoc: field 'field'
JAVA0117 0.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 0.00JAVA0125 Continue statement with label
JAVA0126 0.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 0.00JAVA0128 Public constructor in non-public class
JAVA0130 0.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 2.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
JAVA014316.00JAVA0143 Synchronized method
JAVA0144 0.00JAVA0144 Line exceeds maximum M characters
JAVA01452243.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 2.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 0.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 8.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 2.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
LINES1138.00Number of lines in the source file
LINE_COMMENT45.00Number of line comments
LOC533.00Lines of code
LOGICAL_LINES179.00Number of statements
LOOPS 1.00Number of loops
NEST_DEPTH 6.00Maximum nesting depth
OPERANDS912.00Number of operands
OPERATORS1695.00Number of operators
PARAMS45.00Number of formal parameter declarations
PROGRAM_LENGTH2607.00Halstead program length
PROGRAM_VOCAB354.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS68.00Number of return points from functions
SIZE31857.00Size of the file in bytes
UNIQUE_OPERANDS302.00Number of unique operands
UNIQUE_OPERATORS52.00Number of unique operators
WHITESPACE100.00Number of whitespace lines