LockTableNode (Apache Derby V10.14 Internals)

java.lang.Object
- org.apache.derby.impl.sql.compile.QueryTreeNode
- - org.apache.derby.impl.sql.compile.StatementNode
  - - org.apache.derby.impl.sql.compile.MiscellaneousStatementNode
    - - org.apache.derby.impl.sql.compile.LockTableNode

All Implemented Interfaces:

Visitable
```
class LockTableNode
extends MiscellaneousStatementNode
```
A LockTableNode is the root of a QueryTree that represents a LOCK TABLE command: LOCK TABLE IN SHARE/EXCLUSIVE MODE

Field Summary

Fields
Modifier and Type	Field	Description
`private long`	`conglomerateNumber`
`private boolean`	`exclusiveMode`
`private TableDescriptor`	`lockTableDescriptor`
`private TableName`	`tableName`

Fields inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode
AUTOINCREMENT_CREATE_MODIFY, AUTOINCREMENT_CYCLE, AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX

Fields inherited from class org.apache.derby.impl.sql.compile.StatementNode
EMPTY_TD_LIST, NEED_CURSOR_ACTIVATION, NEED_DDL_ACTIVATION, NEED_NOTHING_ACTIVATION, NEED_PARAM_ACTIVATION, NEED_ROW_ACTIVATION

Constructor Summary

Constructors
Constructor Description

LockTableNode(TableName tableName, boolean exclusiveMode, ContextManager cm)

Constructors
Constructor	Description
`LockTableNode(TableName tableName, boolean exclusiveMode, ContextManager cm)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) void`	`acceptChildren(Visitor v)`	Accept a visitor on all child nodes.
`void`	`bindStatement()`	Bind this LockTableNode.
`ConstantAction`	`makeConstantAction()`	Create the Constant information that will drive the guts of Execution.
`boolean`	`referencesSessionSchema()`	Return true if the node references SESSION schema tables (temporary or permanent)
`(package private) java.lang.String`	`statementToString()`
`java.lang.String`	`toString()`	Convert this object to a String.

Methods inherited from class org.apache.derby.impl.sql.compile.MiscellaneousStatementNode
activationKind, generate, needsSavepoint

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode
accept, addTag, addUDTUsagePriv, addUDTUsagePriv, bindOffsetFetch, bindRowMultiSet, bindUserCatalogType, bindUserType, checkReliability, checkReliability, convertDefaultNode, copyTagsFrom, createTypeDependency, debugFlush, debugPrint, disablePrivilegeCollection, formatNodeString, generateAuthorizeCheck, getBeginOffset, getClassFactory, getCompilerContext, getContext, getContextManager, getDataDictionary, getDependencyManager, getEndOffset, getExecutionFactory, getGenericConstantActionFactory, getIntProperty, getLanguageConnectionContext, getLongProperty, getNullNode, getOffsetOrderedNodes, getOptimizerFactory, getOptimizerTracer, getParameterTypes, getSchemaDescriptor, getSchemaDescriptor, getStatementType, getTableDescriptor, getTypeCompiler, getUDTDesc, isPrivilegeCollectionRequired, isSessionSchema, isSessionSchema, makeTableName, makeTableName, nodeHeader, optimizerTracingIsOn, orReliability, parseSearchCondition, parseStatement, printLabel, printSubNodes, resolveTableToSynonym, setBeginOffset, setEndOffset, setRefActionInfo, stackPrint, taggedWith, treePrint, treePrint, verifyClassExist

Methods inherited from class org.apache.derby.impl.sql.compile.StatementNode
executeSchemaName, executeStatementName, generate, getCursorInfo, getSPSName, isAtomic, lockTableForCompilation, makeResultDescription, optimizeStatement, updateIndexStatisticsFor

- Field Detail
  - tableName
```
private TableName tableName
```
  - exclusiveMode
```
private boolean exclusiveMode
```
  - conglomerateNumber
```
private long conglomerateNumber
```
  - lockTableDescriptor
```
private TableDescriptor lockTableDescriptor
```
- Constructor Detail
  - LockTableNode
```
LockTableNode(TableName tableName,
              boolean exclusiveMode,
              ContextManager cm)
```
    Parameters:
    
    tableName - The table to lock
    
    exclusiveMode - Whether or not to get an exclusive lock.
    
    cm - Context manager
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Convert this object to a String. See comments in QueryTreeNode.java for how this should be done for tree printing.
    
    Overrides:
    
    toString in class StatementNode
    
    Returns:
    
    This object as a String
  - statementToString
```
java.lang.String statementToString()
```
    Specified by:
    
    statementToString in class StatementNode
  - bindStatement
```
public void bindStatement()
                   throws StandardException
```
    Bind this LockTableNode. This means looking up the table, verifying it exists and getting the heap conglomerate number.
    
    Overrides:
    
    bindStatement in class StatementNode
    
    Throws:
    
    StandardException - Thrown on error
  - referencesSessionSchema
```
public boolean referencesSessionSchema()
                                throws StandardException
```
    Return true if the node references SESSION schema tables (temporary or permanent)
    
    Overrides:
    
    referencesSessionSchema in class QueryTreeNode
    
    Returns:
    
    true if references SESSION schema tables, else false
    
    Throws:
    
    StandardException - Thrown on error
  - makeConstantAction
```
public ConstantAction makeConstantAction()
                                  throws StandardException
```
    Create the Constant information that will drive the guts of Execution.
    
    Overrides:
    
    makeConstantAction in class QueryTreeNode
    
    Throws:
    
    StandardException - Thrown on failure
  - acceptChildren
```
void acceptChildren(Visitor v)
             throws StandardException
```
    Description copied from class: QueryTreeNode
    
    Accept a visitor on all child nodes. All sub-classes that add fields that should be visited, should override this method and call accept(v) on all visitable fields, as well as super.acceptChildren(v) to make sure all visitable fields defined by the super-class are accepted too.
    
    Overrides:
    
    acceptChildren in class QueryTreeNode
    
    Parameters:
    
    v - the visitor
    
    Throws:
    
    StandardException - on errors raised by the visitor

Class LockTableNode

Field Summary

Fields inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode

Fields inherited from class org.apache.derby.impl.sql.compile.StatementNode

Constructor Summary

Method Summary

Methods inherited from class org.apache.derby.impl.sql.compile.MiscellaneousStatementNode

Methods inherited from class java.lang.Object

Methods inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode

Methods inherited from class org.apache.derby.impl.sql.compile.StatementNode

Field Detail

tableName

exclusiveMode

conglomerateNumber

lockTableDescriptor

Constructor Detail

LockTableNode

Method Detail

toString

statementToString

bindStatement

referencesSessionSchema

makeConstantAction

acceptChildren