Top Description Fields Constructors Methods
org.apache.derby.impl.sql.compile

pack-priv Class VTIDeferModPolicy

extends Object
implements Visitor
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.sql.compile.Visitor
Imports
java.sql.ResultSet, .SQLException, java.util.Arrays, .HashSet, org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.sql.compile.Visitable, .Visitor, org.apache.derby.iapi.sql.dictionary.TableDescriptor, org.apache.derby.vti.DeferModification

This class applies a VTI modification deferral policy to a statement to see whether it should be deferred.

Field Summary

Modifier and TypeField and Description
private final HashSet<String>
private DeferModification
private boolean
private int
private int

Constructor Summary

AccessConstructor and Description
private
VTIDeferModPolicy(FromVTI targetVTI, String[] columnNames, DeferModification deferralControl, int statementType)

Method Summary

Modifier and TypeMethod and Description
public static boolean
deferIt(int
DeferModification.INSERT_STATEMENT, UPDATE_STATEMENT, or DELETE_STATEMENT
statementType
,
FromVTI
The target VTI
targetVTI
,
String[]
The list of columns being updated, null if this is not an update statement
updateColumnNames
,
QueryTreeNode source)

See if a VTI modification statement should be deferred.

public boolean
skipChildren(Visitable
the node to process
node
)

Implements org.apache.derby.iapi.sql.compile.Visitor.skipChildren.

Method that is called to indicate whether we should skip all nodes below this node for traversal.

public boolean
stopTraversal()

Implements org.apache.derby.iapi.sql.compile.Visitor.stopTraversal.

Method that is called to see if query tree traversal should be stopped before visiting all nodes.

public Visitable
visit(Visitable
the node to process
node
)

Implements org.apache.derby.iapi.sql.compile.Visitor.visit.

This is the default visit operation on a QueryTreeNode.

public boolean
visitChildrenFirst(Visitable
the top node of a sub-tree about to be visited
node
)

Implements org.apache.derby.iapi.sql.compile.Visitor.visitChildrenFirst.

Method that is called to see if visit() should be called on the children of node before it is called on node itself.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

columnsback to summary
private final HashSet<String> columns
deferralControlback to summary
private DeferModification deferralControl
deferredback to summary
private boolean deferred
statementTypeback to summary
private int statementType
tableNumberback to summary
private int tableNumber

Constructor Detail

VTIDeferModPolicyback to summary
private VTIDeferModPolicy(FromVTI targetVTI, String[] columnNames, DeferModification deferralControl, int statementType)

Method Detail

deferItback to summary
public static boolean deferIt(int statementType, FromVTI targetVTI, String[] updateColumnNames, QueryTreeNode source) throws StandardException

See if a VTI modification statement should be deferred.

Parameters
statementType:int

DeferModification.INSERT_STATEMENT, UPDATE_STATEMENT, or DELETE_STATEMENT

targetVTI:FromVTI

The target VTI

updateColumnNames:String[]

The list of columns being updated, null if this is not an update statement

skipChildrenback to summary
public boolean skipChildren(Visitable node)

Implements org.apache.derby.iapi.sql.compile.Visitor.skipChildren.

Doc from org.apache.derby.iapi.sql.compile.Visitor.skipChildren.

Method that is called to indicate whether we should skip all nodes below this node for traversal. Useful if we want to effectively ignore/prune all branches under a particular node.

Differs from stopTraversal() in that it only affects subtrees, rather than the entire traversal.

Parameters
node:Visitable

the node to process

Returns:boolean

true/false

stopTraversalback to summary
public boolean stopTraversal()

Implements org.apache.derby.iapi.sql.compile.Visitor.stopTraversal.

Doc from org.apache.derby.iapi.sql.compile.Visitor.stopTraversal.

Method that is called to see if query tree traversal should be stopped before visiting all nodes. Useful for short circuiting traversal if we already know we are done.

Returns:boolean

true/false

visitback to summary
public Visitable visit(Visitable node) throws StandardException

Implements org.apache.derby.iapi.sql.compile.Visitor.visit.

Doc from org.apache.derby.iapi.sql.compile.Visitor.visit.

This is the default visit operation on a QueryTreeNode. It just returns the node. This will typically suffice as the default visit operation for most visitors unless the visitor needs to count the number of nodes visited or something like that.

Visitors will overload this method by implementing a version with a signature that matches a specific type of node. For example, if I want to do something special with aggregate nodes, then that Visitor will implement a visit(AggregateNode node) method which does the aggregate specific processing.

Parameters
node:Visitable

the node to process

Returns:Visitable

a query tree node. Often times this is the same node that was passed in, but Visitors that replace nodes with other nodes will use this to return the new replacement node.

Exceptions
StandardException:
may be throw an error as needed by the visitor (i.e. may be a normal error if a particular node is found, e.g. if checking a group by, we don't expect to find any ColumnReferences that aren't under an AggregateNode -- the easiest thing to do is just throw an error when we find the questionable node).
visitChildrenFirstback to summary
public boolean visitChildrenFirst(Visitable node)

Implements org.apache.derby.iapi.sql.compile.Visitor.visitChildrenFirst.

Doc from org.apache.derby.iapi.sql.compile.Visitor.visitChildrenFirst.

Method that is called to see if visit() should be called on the children of node before it is called on node itself. If this method always returns true, the visitor will walk the tree bottom-up. If it always returns false, the tree is visited top-down.

Parameters
node:Visitable

the top node of a sub-tree about to be visited

Returns:boolean

true if node's children should be visited before node, false otherwise