Class CompilerContextImpl

java.lang.Object

org.apache.derby.iapi.services.context.ContextImpl

org.apache.derby.impl.sql.compile.CompilerContextImpl

All Implemented Interfaces:

Context, CompilerContext

public class CompilerContextImpl
extends ContextImpl
implements CompilerContext

CompilerContextImpl, implementation of CompilerContext. CompilerContext and hence CompilerContextImpl objects are private to a LanguageConnectionContext.

Field Summary

Fields

Modifier and Type	Field	Description
private String	classPrefix
private SchemaDescriptor	compilationSchema
private ProviderList	currentAPL
private Dependent	currentDependent
private int	currPrivType
private Object	cursorInfo
private ArrayList<SchemaDescriptor>	defaultSchemaStack	Saved execution time default schema, if we need to change it temporarily.
private DependencyManager	dm
private boolean	firstOnStack
private boolean	inUse
private final LanguageConnectionContext	lcc
private final LanguageConnectionFactory	lcf
private HashMap<String,int[]>	namedScopes
private long	nextClassName
private int	nextColumnNumber
private int	nextEquivalenceClass
private int	nextResultSetNumber
private int	nextSubqueryNumber
private int	nextTableNumber
private DataTypeDescriptor[]	parameterDescriptors
private List<ParameterNode>	parameterList
private final Parser	parser
private ArrayList<VisitableFilter>	privilegeCheckFilters
private final ArrayList<Integer>	privTypeStack
private HashMap<UUID, SequenceDescriptor>	referencedSequences
private int	reliability
private HashMap<StatementTablePermission, StatementColumnPermission>	requiredColumnPrivileges
private HashMap<StatementRolePermission, StatementRolePermission>	requiredRolePrivileges
private HashMap<UUID,Integer>	requiredRoutinePrivileges
private HashMap<StatementSchemaPermission, StatementSchemaPermission>	requiredSchemaPrivileges
private HashMap<StatementTablePermission, StatementTablePermission>	requiredTablePrivileges
private HashMap<UUID,String>	requiredUsagePrivileges
private boolean	returnParameterFlag
private List<Object>	savedObjects
private int	scanIsolationLevel
private static final int	SCOPE_CELL
private boolean	skippingTypePrivileges
private SortCostController	sortCostController
private final HashMap<Long, StoreCostController>	storeCostControllers	Map that contains all store cost controllers opened in this compiler context.
private TypeCompilerFactory	typeCompilerFactory
private SQLWarning	warnings

Fields inherited from interface CompilerContext

AGGREGATE_RESTRICTION, CASE_OPERAND_RESTRICTION, CHECK_CONSTRAINT, COLUMN_REFERENCE_ILLEGAL, CONDITIONAL_RESTRICTION, CONTEXT_ID, CURRENT_CONNECTION_ILLEGAL, DATETIME_ILLEGAL, DEFAULT_RESTRICTION, DIAGNOSTICS_ILLEGAL, FUNCTION_CALL_ILLEGAL, GENERATION_CLAUSE_RESTRICTION, GROUP_BY_RESTRICTION, HAVING_CLAUSE_RESTRICTION, IGNORE_MISSING_CLASSES, INTERNAL_SQL_ILLEGAL, INTERNAL_SQL_LEGAL, MODIFIES_SQL_DATA_PROCEDURE_ILLEGAL, NEXT_VALUE_FOR_ILLEGAL, NON_DETERMINISTIC_ILLEGAL, ON_CLAUSE_RESTRICTION, SCHEMA_ILLEGAL, SQL_IN_ROUTINES_ILLEGAL, SQL_LEGAL, SUBQUERY_ILLEGAL, UNNAMED_PARAMETER_ILLEGAL, USER_ILLEGAL, WHERE_CLAUSE_RESTRICTION, WHERE_SCOPE

Constructor Summary

Constructors

Constructor	Description
CompilerContextImpl(ContextManager cm, LanguageConnectionContext lcc, TypeCompilerFactory typeCompilerFactory)	This constructor creates and saves the parser using the language connection factory when the context is created (when the first statement comes in, likely).

Method Summary

Modifier and Type	Method	Description
void	addPrivilegeFilter(VisitableFilter vf)	Add a filter for determining which QueryTreeNodes give rise to privilege checks at run time.
private void	addProviderToAuxiliaryList(Provider p)	Add a Provider to the current AuxiliaryProviderList, if one exists.
void	addReferencedSequence(SequenceDescriptor sd)	Add a sequence descriptor to the list of referenced sequences.
void	addRequiredColumnPriv(ColumnDescriptor column)	Add a column privilege to the list of used column privileges.
void	addRequiredRolePriv(String roleName, int privType)	Add a required role privilege to the list privileges.
void	addRequiredRoutinePriv(AliasDescriptor routine)	Add a routine execute privilege to the list of used routine privileges.
void	addRequiredSchemaPriv(String schemaName, String aid, int privType)	Add a required schema privilege to the list privileges.
void	addRequiredTablePriv(TableDescriptor table)	Add a table or view privilege to the list of used table privileges.
void	addRequiredUsagePriv(PrivilegedSQLObject usableObject)	Add a usage privilege to the list of required privileges.
int	addSavedObject(Object obj)	Add an object to the pool that is created at compile time and used at execution time.
void	addWarning(SQLWarning warning)	Add a compile time warning.
void	beginScope(String scopeName)	Record that the compiler is entering a named scope.
void	cleanupOnError(Throwable error)	Contexts will be passed errors that are caught by the outer system when they are serious enough to require corrective action.
private void	closeSortCostControllers()
private void	closeStoreCostControllers()
void	createDependency(Dependent d, Provider p)	Add a dependency between two objects.
void	createDependency(Provider p)	Add a dependency for the current dependent.
void	endScope(String scopeName)	Record that the compiler is exiting a named scope.
void	firstOnStack()	Mark this CompilerContext as the first on the stack, so we can avoid continually popping and pushing a CompilerContext.
ClassFactory	getClassFactory()	Return the class factory to use in this compilation.
SchemaDescriptor	getCompilationSchema()	Get the compilation schema descriptor for this compilation context.
ProviderList	getCurrentAuxiliaryProviderList()	Get the current auxiliary provider list from this CompilerContext.
Object	getCursorInfo()	Get the cursor info stored in the context.
boolean	getInUse()	Return the in use state for the compiler context.
JavaFactory	getJavaFactory()	Get the JavaFactory from this CompilerContext.
int	getNextColumnNumber()	Get the current next column number (for generated column names) from this CompilerContext.
int	getNextEquivalenceClass()	Get the next equivalence class for equijoin clauses.
int	getNextResultSetNumber()	Get the current next ResultSet number from this CompilerContext.
int	getNextSubqueryNumber()	Get the current next subquery number from this CompilerContext.
int	getNextTableNumber()	Get the current next table number from this CompilerContext.
int	getNumResultSets()	Get the number of Results in the current statement from this CompilerContext.
int	getNumSubquerys()	Get the number of subquerys in the current statement from this CompilerContext.
int	getNumTables()	Get the number of tables in the current statement from this CompilerContext.
OptimizerFactory	getOptimizerFactory()	Get the OptimizerFactory for this context
List<ParameterNode>	getParameterList()	Get the parameter list.
(package private) DataTypeDescriptor[]	getParameterTypes()	Get an array of type descriptors for all the ?
Parser	getParser()	Get the Parser from this CompilerContext
int	getReliability()	Return the reliability requirements of this clause.
List<StatementPermission>	getRequiredPermissionsList()
boolean	getReturnParameterFlag()	Is the callable statement uses ?
Object[]	getSavedObjects()	Get the saved object pool (for putting into the prepared statement).
int	getScanIsolationLevel()	Get the isolation level for the scans in this query.
SortCostController	getSortCostController()	Get a SortCostController.
StoreCostController	getStoreCostController(long conglomerateNumber)	Get a StoreCostController for the given conglomerate.
TypeCompilerFactory	getTypeCompilerFactory()	Get the TypeCompilerFactory from this CompilerContext.
String	getUniqueClassName()	Get a unique Class name from this CompilerContext.
SQLWarning	getWarnings()	Get the chain of compile time warnings.
private void	initRequiredPriv()
boolean	isFirstOnStack()	Is this the first CompilerContext on the stack?
boolean	isReferenced(SequenceDescriptor sd)	Report whether the given sequence has been referenced already.
boolean	passesPrivilegeFilters(Visitable visitable)	Return true if a QueryTreeNode passes all of the filters which determine whether the QueryTreeNode gives rise to run time privilege checks.
void	popCompilationSchema()	Pop the default schema to use when compiling.
void	popCurrentPrivType()
void	pushCompilationSchema(SchemaDescriptor sd)	Push a default schema to use when compiling.
void	pushCurrentPrivType(int privType)	Sets the current privilege type context.
void	removePrivilegeFilter(VisitableFilter vf)	Remove a filter for determining which QueryTreeNodes give rise to privilege checks at run time.
void	resetContext()	Reset compiler context (as for instance, when we recycle a context for use by another compilation.
void	resetNextResultSetNumber()	Reset the next ResultSet number from this CompilerContext.
int	scopeDepth(String scopeName)	Get the current depth for the named scope.
SchemaDescriptor	setCompilationSchema(SchemaDescriptor newDefault)	Set the compilation schema descriptor for this compilation context.
void	setCurrentAuxiliaryProviderList(ProviderList apl)	Set the current auxiliary provider list for this CompilerContext.
void	setCurrentDependent(Dependent d)	Set the current dependent from this CompilerContext.
void	setCursorInfo(Object cursorInfo)	Set params
void	setInUse(boolean inUse)	Set the in use state for the compiler context.
void	setParameterList(List<ParameterNode> parameterList)	Set the parameter list.
void	setReliability(int reliability)	Sets which kind of query fragments are NOT allowed.
void	setReturnParameterFlag()	If callable statement uses ?
void	setSavedObjects(List<Object> objs)	Set the saved object pool (for putting into the prepared statement).
void	setScanIsolationLevel(int isolationLevel)	Set the isolation level for the scans in this query.
boolean	skippingTypePrivileges()	Return whether we are skipping USAGE privileges for user-defined types
boolean	skipTypePrivileges(boolean skip)	Set whether we should skip adding USAGE privileges for user-defined types

Methods inherited from class ContextImpl

appendErrorInfo, getContextManager, getIdName, isLastHandler, popMe, pushMe

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Context

getContextManager, getIdName, isLastHandler, popMe, pushMe

Field Details

SCOPE_CELL

private static final int SCOPE_CELL

See Also:

• Constant Field Values

parser

private final Parser parser

lcc

private final LanguageConnectionContext lcc

lcf

private final LanguageConnectionFactory lcf

typeCompilerFactory

private TypeCompilerFactory typeCompilerFactory

currentDependent

private Dependent currentDependent

dm

private DependencyManager dm

firstOnStack

private boolean firstOnStack

inUse

private boolean inUse

reliability

private int reliability

nextColumnNumber

private int nextColumnNumber

nextTableNumber

private int nextTableNumber

nextSubqueryNumber

private int nextSubqueryNumber

nextResultSetNumber

private int nextResultSetNumber

scanIsolationLevel

private int scanIsolationLevel

nextEquivalenceClass

private int nextEquivalenceClass

nextClassName

private long nextClassName

savedObjects

private List<Object> savedObjects

classPrefix

private String classPrefix

compilationSchema

private SchemaDescriptor compilationSchema

privilegeCheckFilters

private ArrayList<VisitableFilter> privilegeCheckFilters

namedScopes

private HashMap<String,int[]> namedScopes

skippingTypePrivileges

private boolean skippingTypePrivileges

defaultSchemaStack

private ArrayList<SchemaDescriptor> defaultSchemaStack

Saved execution time default schema, if we need to change it temporarily.

currentAPL

private ProviderList currentAPL

returnParameterFlag

private boolean returnParameterFlag

storeCostControllers

private final HashMap<Long, StoreCostController> storeCostControllers

Map that contains all store cost controllers opened in this compiler context. Conglomerate id (long) is the key.

sortCostController

private SortCostController sortCostController

parameterList

private List<ParameterNode> parameterList

parameterDescriptors

private DataTypeDescriptor[] parameterDescriptors

cursorInfo

private Object cursorInfo

warnings

private SQLWarning warnings

privTypeStack

private final ArrayList<Integer> privTypeStack

currPrivType

private int currPrivType

requiredColumnPrivileges

private HashMap<StatementTablePermission, StatementColumnPermission> requiredColumnPrivileges

requiredTablePrivileges

private HashMap<StatementTablePermission, StatementTablePermission> requiredTablePrivileges

requiredSchemaPrivileges

private HashMap<StatementSchemaPermission, StatementSchemaPermission> requiredSchemaPrivileges

requiredRoutinePrivileges

private HashMap<UUID,Integer> requiredRoutinePrivileges

requiredUsagePrivileges

private HashMap<UUID,String> requiredUsagePrivileges

requiredRolePrivileges

private HashMap<StatementRolePermission, StatementRolePermission> requiredRolePrivileges

referencedSequences

private HashMap<UUID, SequenceDescriptor> referencedSequences

Constructor Details

CompilerContextImpl

public CompilerContextImpl(ContextManager cm,
 LanguageConnectionContext lcc,
 TypeCompilerFactory typeCompilerFactory)

This constructor creates and saves the parser using the language connection factory when the context is created (when the first statement comes in, likely).

Method Details

cleanupOnError

public void cleanupOnError(Throwable error)
                    throws StandardException

Description copied from interface: Context

Contexts will be passed errors that are caught by the outer system when they are serious enough to require corrective action. They will be told what the error is, so that they can react appropriately. Most of the time, the contexts will react by either doing nothing or by removing themselves from the context manager. If there are no other references to the context, removing itself from the manager equates to freeing it.
On an exception that is session severity or greater the Context must push itself off the stack. This is to ensure that after a session has been closed there are no Contexts on the stack that potentially hold references to objects, thus delaying their garbage collection.

Contexts must release all their resources before removing themselves from their context manager.

The context manager will "unwind" the contexts during cleanup in the reverse order they were placed on its global stack.

If error is an instance of StandardException then an implementation of this method may throw a new exception if and only if the new exception is an instance of StandardException that is more severe than the original error or the new exception is a not an instance of StandardException (e.g java.lang.NullPointerException).

Specified by:

cleanupOnError in interface Context

Throws:

StandardException - thrown by makeInvalid() call

resetContext

public void resetContext()

Reset compiler context (as for instance, when we recycle a context for use by another compilation.

Specified by:

resetContext in interface CompilerContext

getParser

public Parser getParser()

Description copied from interface: CompilerContext

Get the Parser from this CompilerContext. *

Specified by:

getParser in interface CompilerContext

Returns:

The parser associated with this CompilerContext

getOptimizerFactory

public OptimizerFactory getOptimizerFactory()

Get the OptimizerFactory for this context

Specified by:

getOptimizerFactory in interface CompilerContext

Returns:

The OptimizerFactory for this context.

getNextColumnNumber

public int getNextColumnNumber()

Description copied from interface: CompilerContext

Get the current next column number (for generated column names) from this CompilerContext.

Specified by:

getNextColumnNumber in interface CompilerContext

Returns:

int The next column number for the current statement.

getNextTableNumber

public int getNextTableNumber()

Description copied from interface: CompilerContext

Get the current next table number from this CompilerContext.

Specified by:

getNextTableNumber in interface CompilerContext

Returns:

int The next table number for the current statement.

getNumTables

public int getNumTables()

Description copied from interface: CompilerContext

Get the number of tables in the current statement from this CompilerContext.

Specified by:

getNumTables in interface CompilerContext

Returns:

int The number of tables in the current statement.

getNextSubqueryNumber

public int getNextSubqueryNumber()

Get the current next subquery number from this CompilerContext.

Specified by:

getNextSubqueryNumber in interface CompilerContext

Returns:

int The next subquery number for the current statement.

getNumSubquerys

public int getNumSubquerys()

Get the number of subquerys in the current statement from this CompilerContext.

Specified by:

getNumSubquerys in interface CompilerContext

Returns:

int The number of subquerys in the current statement.

getNextResultSetNumber

public int getNextResultSetNumber()

Description copied from interface: CompilerContext

Get the current next ResultSet number from this CompilerContext.

Specified by:

getNextResultSetNumber in interface CompilerContext

Returns:

int The next ResultSet number for the current statement.

resetNextResultSetNumber

public void resetNextResultSetNumber()

Description copied from interface: CompilerContext

Reset the next ResultSet number from this CompilerContext.

Specified by:

resetNextResultSetNumber in interface CompilerContext

getNumResultSets

public int getNumResultSets()

Description copied from interface: CompilerContext

Get the number of Results in the current statement from this CompilerContext.

Specified by:

getNumResultSets in interface CompilerContext

Returns:

The number of ResultSets in the current statement.

getUniqueClassName

public String getUniqueClassName()

Description copied from interface: CompilerContext

Get a unique Class name from this CompilerContext. Ensures it is globally unique for this JVM.

Specified by:

getUniqueClassName in interface CompilerContext

Returns:

String A unique-enough class name.

getNextEquivalenceClass

public int getNextEquivalenceClass()

Get the next equivalence class for equijoin clauses.

Specified by:

getNextEquivalenceClass in interface CompilerContext

Returns:

The next equivalence class for equijoin clauses.

getClassFactory

public ClassFactory getClassFactory()

Description copied from interface: CompilerContext

Return the class factory to use in this compilation.

Specified by:

getClassFactory in interface CompilerContext

getJavaFactory

public JavaFactory getJavaFactory()

Description copied from interface: CompilerContext

Get the JavaFactory from this CompilerContext.

Specified by:

getJavaFactory in interface CompilerContext

Returns:

The JavaFactory associated with this CompilerContext

setCurrentDependent

public void setCurrentDependent(Dependent d)

Description copied from interface: CompilerContext

Set the current dependent from this CompilerContext. This should be called at the start of a compile to register who has the dependencies needed for the compilation.

Specified by:

setCurrentDependent in interface CompilerContext

Parameters:

d - The Dependent currently being compiled.

getCurrentAuxiliaryProviderList

public ProviderList getCurrentAuxiliaryProviderList()

Get the current auxiliary provider list from this CompilerContext.

Specified by:

getCurrentAuxiliaryProviderList in interface CompilerContext

Returns:

The current AuxiliaryProviderList.

setCurrentAuxiliaryProviderList

public void setCurrentAuxiliaryProviderList(ProviderList apl)

Set the current auxiliary provider list for this CompilerContext.

Specified by:

setCurrentAuxiliaryProviderList in interface CompilerContext

Parameters:

apl - The new current AuxiliaryProviderList.

createDependency

public void createDependency(Provider p)
                      throws StandardException

Description copied from interface: CompilerContext

Add a dependency for the current dependent.

Specified by:

createDependency in interface CompilerContext

Parameters:

p - The Provider of the dependency.

Throws:

StandardException - thrown on failure.

createDependency

public void createDependency(Dependent d,
 Provider p)
                      throws StandardException

Add a dependency between two objects.

Specified by:

createDependency in interface CompilerContext

Parameters:

d - The Dependent object.

p - The Provider of the dependency.

Throws:

StandardException - thrown on failure.

addProviderToAuxiliaryList

private void addProviderToAuxiliaryList(Provider p)

Add a Provider to the current AuxiliaryProviderList, if one exists.

Parameters:

p - The Provider to add.

addSavedObject

public int addSavedObject(Object obj)

Description copied from interface: CompilerContext

Add an object to the pool that is created at compile time and used at execution time. Use the integer to reference it in execution constructs. Execution code will have to generate:

(#objectType) (this.getPreparedStatement().getSavedObject(#int))
 

Specified by:

addSavedObject in interface CompilerContext

Parameters:

obj - object to add to the pool of saved objects

Returns:

the entry # for the object

getSavedObjects

public Object[] getSavedObjects()

Description copied from interface: CompilerContext

Get the saved object pool (for putting into the prepared statement). This turns it into its storable form, an array of objects.

Specified by:

getSavedObjects in interface CompilerContext

Returns:

the saved object pool.

setSavedObjects

public void setSavedObjects(List<Object> objs)

Description copied from interface: CompilerContext

Set the saved object pool (for putting into the prepared statement).

Specified by:

setSavedObjects in interface CompilerContext

Parameters:

objs - The new saved objects

See Also:

• CompilerContext.setSavedObjects(List)

setCursorInfo

public void setCursorInfo(Object cursorInfo)

Description copied from interface: CompilerContext

Set params

Specified by:

setCursorInfo in interface CompilerContext

Parameters:

cursorInfo - the cursor info

See Also:

• CompilerContext.setCursorInfo(Object)

getCursorInfo

public Object getCursorInfo()

Description copied from interface: CompilerContext

Get the cursor info stored in the context.

Specified by:

getCursorInfo in interface CompilerContext

Returns:

the cursor info

See Also:

• CompilerContext.getCursorInfo()

firstOnStack

public void firstOnStack()

Description copied from interface: CompilerContext

Mark this CompilerContext as the first on the stack, so we can avoid continually popping and pushing a CompilerContext.

Specified by:

firstOnStack in interface CompilerContext

See Also:

• CompilerContext.firstOnStack()

isFirstOnStack

public boolean isFirstOnStack()

Description copied from interface: CompilerContext

Is this the first CompilerContext on the stack?

Specified by:

isFirstOnStack in interface CompilerContext

See Also:

• CompilerContext.isFirstOnStack()

setInUse

public void setInUse(boolean inUse)

Set the in use state for the compiler context.

Specified by:

setInUse in interface CompilerContext

Parameters:

inUse - The new inUse state for the compiler context.

getInUse

public boolean getInUse()

Return the in use state for the compiler context.

Specified by:

getInUse in interface CompilerContext

Returns:

boolean The in use state for the compiler context.

setReliability

public void setReliability(int reliability)

Sets which kind of query fragments are NOT allowed. Basically, these are fragments which return unstable results. CHECK CONSTRAINTS and CREATE PUBLICATION want to forbid certain kinds of fragments.

Specified by:

setReliability in interface CompilerContext

Parameters:

reliability - bitmask of types of query fragments to be forbidden see the reliability bitmasks in CompilerContext.java

getReliability

public int getReliability()

Return the reliability requirements of this clause. See setReliability() for a definition of clause reliability.

Specified by:

getReliability in interface CompilerContext

Returns:

a bitmask of which types of query fragments are to be forbidden

getStoreCostController

public StoreCostController getStoreCostController(long conglomerateNumber)
                                           throws StandardException

Description copied from interface: CompilerContext

Get a StoreCostController for the given conglomerate.

Specified by:

getStoreCostController in interface CompilerContext

Parameters:

conglomerateNumber - The conglomerate for which to get a StoreCostController.

Returns:

The appropriate StoreCostController.

Throws:

StandardException - Thrown on error

See Also:

• CompilerContext.getStoreCostController(long)

closeStoreCostControllers

private void closeStoreCostControllers()

getSortCostController

public SortCostController getSortCostController()
                                         throws StandardException

Description copied from interface: CompilerContext

Get a SortCostController.

Specified by:

getSortCostController in interface CompilerContext

Throws:

StandardException - Thrown on error

See Also:

• CompilerContext.getSortCostController()

closeSortCostControllers

private void closeSortCostControllers()

Throws:

StandardException - Thrown on error

getCompilationSchema

public SchemaDescriptor getCompilationSchema()

Get the compilation schema descriptor for this compilation context. Will be null if no default schema lookups have occured. Ie. the statement is independent of the current schema.

Specified by:

getCompilationSchema in interface CompilerContext

Returns:

the compilation schema descirptor

setCompilationSchema

public SchemaDescriptor setCompilationSchema(SchemaDescriptor newDefault)

Set the compilation schema descriptor for this compilation context.

Specified by:

setCompilationSchema in interface CompilerContext

Parameters:

newDefault - the compilation schema

Returns:

the previous compilation schema descirptor

pushCompilationSchema

public void pushCompilationSchema(SchemaDescriptor sd)

Description copied from interface: CompilerContext

Push a default schema to use when compiling.

Sometimes, we need to temporarily change the default schema, for example when recompiling a view, since the execution time default schema may differ from the required default schema when the view was defined. Another case is when compiling generated columns which reference unqualified user functions.

Specified by:

pushCompilationSchema in interface CompilerContext

Parameters:

sd - schema to use

See Also:

• CompilerContext.pushCompilationSchema(SchemaDescriptor)

popCompilationSchema

public void popCompilationSchema()

Description copied from interface: CompilerContext

Pop the default schema to use when compiling.

Specified by:

popCompilationSchema in interface CompilerContext

See Also:

• CompilerContext.popCompilationSchema()

setParameterList

public void setParameterList(List<ParameterNode> parameterList)

Description copied from interface: CompilerContext

Set the parameter list.

Specified by:

setParameterList in interface CompilerContext

Parameters:

parameterList - The parameter list.

See Also:

• CompilerContext.setParameterList(List)

getParameterList

public List<ParameterNode> getParameterList()

Description copied from interface: CompilerContext

Get the parameter list.

Specified by:

getParameterList in interface CompilerContext

Returns:

The parameter list.

See Also:

• CompilerContext.getParameterList()

setReturnParameterFlag

public void setReturnParameterFlag()

Description copied from interface: CompilerContext

If callable statement uses ? = form

Specified by:

setReturnParameterFlag in interface CompilerContext

See Also:

• CompilerContext.setReturnParameterFlag()

getReturnParameterFlag

public boolean getReturnParameterFlag()

Description copied from interface: CompilerContext

Is the callable statement uses ? for return parameter.

Specified by:

getReturnParameterFlag in interface CompilerContext

Returns:

true if ? = call else false

See Also:

• CompilerContext.getReturnParameterFlag()

getParameterTypes

DataTypeDescriptor[] getParameterTypes()

Get an array of type descriptors for all the ? parameters.

setScanIsolationLevel

public void setScanIsolationLevel(int isolationLevel)

Description copied from interface: CompilerContext

Set the isolation level for the scans in this query.

Specified by:

setScanIsolationLevel in interface CompilerContext

Parameters:

isolationLevel - The isolation level to use.

See Also:

• CompilerContext.setScanIsolationLevel(int)

getScanIsolationLevel

public int getScanIsolationLevel()

Description copied from interface: CompilerContext

Get the isolation level for the scans in this query.

Specified by:

getScanIsolationLevel in interface CompilerContext

Returns:

The isolation level for the scans in this query.

See Also:

• CompilerContext.getScanIsolationLevel()

getTypeCompilerFactory

public TypeCompilerFactory getTypeCompilerFactory()

Description copied from interface: CompilerContext

Get the TypeCompilerFactory from this CompilerContext.

Specified by:

getTypeCompilerFactory in interface CompilerContext

Returns:

The TypeCompilerFactory associated with this CompilerContext

See Also:

• CompilerContext.getTypeCompilerFactory()

addWarning

public void addWarning(SQLWarning warning)

Add a compile time warning.

Specified by:

addWarning in interface CompilerContext

getWarnings

public SQLWarning getWarnings()

Get the chain of compile time warnings.

Specified by:

getWarnings in interface CompilerContext

initRequiredPriv

private void initRequiredPriv()

pushCurrentPrivType

public void pushCurrentPrivType(int privType)

Sets the current privilege type context. Column and table nodes do not know how they are being used. Higher level nodes in the query tree do not know what is being referenced. Keeping the context allows the two to come together.

Specified by:

pushCurrentPrivType in interface CompilerContext

Parameters:

privType - One of the privilege types in org.apache.derby.iapi.sql.conn.Authorizer.

popCurrentPrivType

public void popCurrentPrivType()

Specified by:

popCurrentPrivType in interface CompilerContext

addRequiredColumnPriv

public void addRequiredColumnPriv(ColumnDescriptor column)

Add a column privilege to the list of used column privileges.

Specified by:

addRequiredColumnPriv in interface CompilerContext

Parameters:

column - The column whose privileges we're interested in.

addRequiredTablePriv

public void addRequiredTablePriv(TableDescriptor table)

Add a table or view privilege to the list of used table privileges.

Specified by:

addRequiredTablePriv in interface CompilerContext

Parameters:

table -

See Also:

• CompilerContext.addRequiredRoutinePriv(AliasDescriptor)

addRequiredRoutinePriv

public void addRequiredRoutinePriv(AliasDescriptor routine)

Add a routine execute privilege to the list of used routine privileges.

Specified by:

addRequiredRoutinePriv in interface CompilerContext

Parameters:

routine -

See Also:

• CompilerContext.addRequiredRoutinePriv(AliasDescriptor)

addRequiredUsagePriv

public void addRequiredUsagePriv(PrivilegedSQLObject usableObject)

Description copied from interface: CompilerContext

Add a usage privilege to the list of required privileges.

Specified by:

addRequiredUsagePriv in interface CompilerContext

Parameters:

usableObject -

See Also:

• CompilerContext.addRequiredUsagePriv(PrivilegedSQLObject)

addRequiredSchemaPriv

public void addRequiredSchemaPriv(String schemaName,
 String aid,
 int privType)

Add a required schema privilege to the list privileges.

Specified by:

addRequiredSchemaPriv in interface CompilerContext

Parameters:

schemaName - Schema name of the object that is being accessed

aid - Requested authorizationId for new schema

privType - CREATE_SCHEMA_PRIV, MODIFY_SCHEMA_PRIV or DROP_SCHEMA_PRIV

See Also:

• CompilerContext.addRequiredSchemaPriv(String, String, int)

addRequiredRolePriv

public void addRequiredRolePriv(String roleName,
 int privType)

Add a required role privilege to the list privileges.

Specified by:

addRequiredRolePriv in interface CompilerContext

See Also:

• CompilerContext.addRequiredRolePriv(String, int)

getRequiredPermissionsList

public List<StatementPermission> getRequiredPermissionsList()

Specified by:

getRequiredPermissionsList in interface CompilerContext

Returns:

The list of required privileges.

addReferencedSequence

public void addReferencedSequence(SequenceDescriptor sd)

Description copied from interface: CompilerContext

Add a sequence descriptor to the list of referenced sequences.

Specified by:

addReferencedSequence in interface CompilerContext

isReferenced

public boolean isReferenced(SequenceDescriptor sd)

Report whether the given sequence has been referenced already.

Specified by:

isReferenced in interface CompilerContext

addPrivilegeFilter

public void addPrivilegeFilter(VisitableFilter vf)

Description copied from interface: CompilerContext

Add a filter for determining which QueryTreeNodes give rise to privilege checks at run time. The null filter (the default) says that all QueryTreeNodes potentially give rise to privilege checks.

Specified by:

addPrivilegeFilter in interface CompilerContext

removePrivilegeFilter

public void removePrivilegeFilter(VisitableFilter vf)

Description copied from interface: CompilerContext

Remove a filter for determining which QueryTreeNodes give rise to privilege checks at run time.

Specified by:

removePrivilegeFilter in interface CompilerContext

passesPrivilegeFilters

public boolean passesPrivilegeFilters(Visitable visitable)
                               throws StandardException

Description copied from interface: CompilerContext

Return true if a QueryTreeNode passes all of the filters which determine whether the QueryTreeNode gives rise to run time privilege checks.

Specified by:

passesPrivilegeFilters in interface CompilerContext

Throws:

StandardException

beginScope

public void beginScope(String scopeName)

Description copied from interface: CompilerContext

Record that the compiler is entering a named scope. Increment the depth counter for that scope.

Specified by:

beginScope in interface CompilerContext

endScope

public void endScope(String scopeName)

Description copied from interface: CompilerContext

Record that the compiler is exiting a named scope. Decrement the depth counter for that scope.

Specified by:

endScope in interface CompilerContext

scopeDepth

public int scopeDepth(String scopeName)

Description copied from interface: CompilerContext

Get the current depth for the named scope. For instance, if we are processing a WHERE clause inside a subquery which is invoked inside an outer WHERE clause, the depth of the whereScope would be 2. Returns 0 if the compiler isn't inside any such scope.

Specified by:

scopeDepth in interface CompilerContext

skipTypePrivileges

public boolean skipTypePrivileges(boolean skip)

Set whether we should skip adding USAGE privileges for user-defined types

Specified by:

skipTypePrivileges in interface CompilerContext

skippingTypePrivileges

public boolean skippingTypePrivileges()

Return whether we are skipping USAGE privileges for user-defined types

Specified by:

skippingTypePrivileges in interface CompilerContext