Top Description Inners Fields Constructors Methods

org.hibernate.hql.ast

public Class SqlGenerator

Generates SQL by overriding callback methods in the base class, which does the actual SQL AST walking.

Authors: Joshua Davis, Steve Ebersole

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	SqlGenerator.DefaultWriter The default SQL writer.
pack-priv class	SqlGenerator.FunctionArguments SQL function processing code redirects generated SQL output to an instance of this class which catches function arguments.
pack-priv static interface	SqlGenerator.SqlWriter Writes SQL fragments.

Field Summary

Modifier and Type	Field and Description
private List<E>	collectedParameters
private static final Logger	log Hides org.hibernate.hql.antlr.SqlGeneratorBase.log.
private LinkedList<SqlGenerator.SqlWriter>	outputStack
private ParseErrorHandler	parseErrorHandler
private final ASTPrinter	printer
public static boolean	REGRESSION_STYLE_CROSS_JOINS
private SessionFactoryImplementor	sessionFactory
private final boolean	trace
private int	traceDepth Hides antlr.TreeParser.traceDepth.
private SqlGenerator.SqlWriter	writer all append invocations on the buf should go through this Output instance variable.

Inherited from org.hibernate.hql.antlr.SqlGeneratorBase:: _tokenNames _tokenSet_0 _tokenSet_1 _tokenSet_2 _tokenSet_3 _tokenSet_4 _tokenSet_5

Constructor Summary

Access	Constructor and Description
public	SqlGenerator(SessionFactoryImplementor sfi)

Method Summary

Modifier and Type	Method and Description
protected void	beginFunctionTemplate(AST node, AST nameNode) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.beginFunctionTemplate.
private String	buildTraceNodeName(AST tree)
protected void	commaBetweenParameters(String comma) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.commaBetweenParameters.
protected void	endFunctionTemplate(AST node) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.endFunctionTemplate.
protected void	fromFragmentSeparator(AST a) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.fromFragmentSeparator.
public List<E>	getCollectedParameters()
public ParseErrorHandler	getParseErrorHandler()
public String	getSQL()
protected void	nestedFromFragment(AST d, AST parent) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.nestedFromFragment.
protected void	optionalSpace() Overrides org.hibernate.hql.antlr.SqlGeneratorBase.optionalSpace. Add a aspace if the previous token was not a space or a parenthesis.
protected void	out(String s) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.out.
protected void	out(AST n) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.out.
public static void	panic() Hides antlr.TreeParser.panic.
public void	reportError(RecognitionException e) Overrides antlr.TreeParser.reportError. Implements org.hibernate.hql.ast.ErrorReporter.reportError. Parser error-reporting function can be overridden in subclass
public void	reportError(String s) Overrides antlr.TreeParser.reportError. Implements org.hibernate.hql.ast.ErrorReporter.reportError. Parser error-reporting function can be overridden in subclass
public void	reportWarning(String s) Overrides antlr.TreeParser.reportWarning. Implements org.hibernate.hql.ast.ErrorReporter.reportWarning. Parser warning-reporting function can be overridden in subclass
public void	traceIn(String ruleName, AST tree) Overrides antlr.TreeParser.traceIn.
public void	traceOut(String ruleName, AST tree) Overrides antlr.TreeParser.traceOut.
private void	writeCrossJoinSeparator()

Field Detail

collectedParameters	back to summary
private List<E> collectedParameters

log	back to summary
private static final Logger log Hides org.hibernate.hql.antlr.SqlGeneratorBase.log.

outputStack	back to summary
private LinkedList<SqlGenerator.SqlWriter> outputStack

parseErrorHandler	back to summary
private ParseErrorHandler parseErrorHandler

printer	back to summary
private final ASTPrinter printer

REGRESSION_STYLE_CROSS_JOINS	back to summary
public static boolean REGRESSION_STYLE_CROSS_JOINS

sessionFactory	back to summary
private SessionFactoryImplementor sessionFactory

trace	back to summary
private final boolean trace

traceDepth	back to summary
private int traceDepth Hides antlr.TreeParser.traceDepth.

writer	back to summary
private SqlGenerator.SqlWriter writer all append invocations on the buf should go through this Output instance variable. The value of this variable may be temporarily substituted by sql function processing code to catch generated arguments. This is because sql function templates need arguments as separate string chunks that will be assembled into the target dialect-specific function call.

Constructor Detail

SqlGenerator	back to summary
public SqlGenerator(SessionFactoryImplementor sfi)

Method Detail

beginFunctionTemplate	back to summary
protected void beginFunctionTemplate(AST node, AST nameNode) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.beginFunctionTemplate.

buildTraceNodeName	back to summary
private String buildTraceNodeName(AST tree)

commaBetweenParameters	back to summary
protected void commaBetweenParameters(String comma) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.commaBetweenParameters.

endFunctionTemplate	back to summary
protected void endFunctionTemplate(AST node) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.endFunctionTemplate.

fromFragmentSeparator	back to summary
protected void fromFragmentSeparator(AST a) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.fromFragmentSeparator.

getCollectedParameters	back to summary
public List<E> getCollectedParameters()

getParseErrorHandler	back to summary
public ParseErrorHandler getParseErrorHandler()

getSQL	back to summary
public String getSQL()

nestedFromFragment	back to summary
protected void nestedFromFragment(AST d, AST parent) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.nestedFromFragment.

optionalSpace	back to summary
protected void optionalSpace() Overrides org.hibernate.hql.antlr.SqlGeneratorBase.optionalSpace. Doc from org.hibernate.hql.antlr.SqlGeneratorBase.optionalSpace. Add a aspace if the previous token was not a space or a parenthesis.

optionalSpace

back to summary

protected void optionalSpace()

Overrides org.hibernate.hql.antlr.SqlGeneratorBase.optionalSpace.

Doc from org.hibernate.hql.antlr.SqlGeneratorBase.optionalSpace.

Add a aspace if the previous token was not a space or a parenthesis.

out	back to summary
protected void out(String s) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.out.

out	back to summary
protected void out(AST n) Overrides org.hibernate.hql.antlr.SqlGeneratorBase.out.

panic	back to summary
public static void panic() Hides antlr.TreeParser.panic.

reportError	back to summary
public void reportError(RecognitionException e) Overrides antlr.TreeParser.reportError. Implements org.hibernate.hql.ast.ErrorReporter.reportError. Doc from antlr.TreeParser.reportError. Parser error-reporting function can be overridden in subclass

reportError

back to summary

public void reportError(RecognitionException e)

Overrides antlr.TreeParser.reportError.

Implements org.hibernate.hql.ast.ErrorReporter.reportError.

Doc from antlr.TreeParser.reportError.

Parser error-reporting function can be overridden in subclass

reportError	back to summary
public void reportError(String s) Overrides antlr.TreeParser.reportError. Implements org.hibernate.hql.ast.ErrorReporter.reportError. Doc from antlr.TreeParser.reportError. Parser error-reporting function can be overridden in subclass

reportError

back to summary

public void reportError(String s)

Overrides antlr.TreeParser.reportError.

Implements org.hibernate.hql.ast.ErrorReporter.reportError.

Doc from antlr.TreeParser.reportError.

Parser error-reporting function can be overridden in subclass

reportWarning	back to summary
public void reportWarning(String s) Overrides antlr.TreeParser.reportWarning. Implements org.hibernate.hql.ast.ErrorReporter.reportWarning. Doc from antlr.TreeParser.reportWarning. Parser warning-reporting function can be overridden in subclass

reportWarning

back to summary

public void reportWarning(String s)

Overrides antlr.TreeParser.reportWarning.

Implements org.hibernate.hql.ast.ErrorReporter.reportWarning.

Doc from antlr.TreeParser.reportWarning.

Parser warning-reporting function can be overridden in subclass

traceIn	back to summary
public void traceIn(String ruleName, AST tree) Overrides antlr.TreeParser.traceIn.

traceOut	back to summary
public void traceOut(String ruleName, AST tree) Overrides antlr.TreeParser.traceOut.

writeCrossJoinSeparator	back to summary
private void writeCrossJoinSeparator()

org.hibernate.hql.ast back to summary

pack-priv Class SqlGenerator.DefaultWriter

Class Inheritance

extends Object
implements SqlWriter

java.lang.Object
org.hibernate.hql.ast.SqlGenerator.DefaultWriter

All Implemented Interfaces

org.hibernate.hql.ast.SqlGenerator.SqlWriter

The default SQL writer.

Constructor Summary

Access	Constructor and Description
pack-priv	DefaultWriter()

Method Summary

Modifier and Type	Method and Description
public void	clause(String clause) Implements org.hibernate.hql.ast.SqlGenerator.SqlWriter.clause.
public void	commaBetweenParameters(String either " , " or ", " comma) Implements org.hibernate.hql.ast.SqlGenerator.SqlWriter.commaBetweenParameters. todo remove this hack The parameter is either ", " or " , ".

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DefaultWriter	back to summary
pack-priv DefaultWriter()

Method Detail

clause	back to summary
public void clause(String clause) Implements org.hibernate.hql.ast.SqlGenerator.SqlWriter.clause.

commaBetweenParameters	back to summary
public void commaBetweenParameters(String comma) Implements org.hibernate.hql.ast.SqlGenerator.SqlWriter.commaBetweenParameters. Doc from org.hibernate.hql.ast.SqlGenerator.SqlWriter.commaBetweenParameters. todo remove this hack The parameter is either ", " or " , ". This is needed to pass sql generating tests as the old sql generator uses " , " in the WHERE and ", " in SELECT. Parameters comma:String either " , " or ", "

commaBetweenParameters

back to summary

public void commaBetweenParameters(String comma)

Implements org.hibernate.hql.ast.SqlGenerator.SqlWriter.commaBetweenParameters.

Doc from org.hibernate.hql.ast.SqlGenerator.SqlWriter.commaBetweenParameters.

todo remove this hack The parameter is either ", " or " , ". This is needed to pass sql generating tests as the old sql generator uses " , " in the WHERE and ", " in SELECT.

Parameters

comma:String: either " , " or ", "

org.hibernate.hql.ast back to summary

pack-priv Class SqlGenerator.FunctionArguments

Class Inheritance

extends Object
implements SqlWriter

java.lang.Object
org.hibernate.hql.ast.SqlGenerator.FunctionArguments

All Implemented Interfaces

org.hibernate.hql.ast.SqlGenerator.SqlWriter

SQL function processing code redirects generated SQL output to an instance of this class which catches function arguments.

Field Summary

Modifier and Type	Field and Description
private int	argInd
private final List<String>	args

Constructor Summary

Access	Constructor and Description
pack-priv	FunctionArguments()

Method Summary

Modifier and Type	Method and Description
public void	clause(String clause) Implements org.hibernate.hql.ast.SqlGenerator.SqlWriter.clause.
public void	commaBetweenParameters(String either " , " or ", " comma) Implements org.hibernate.hql.ast.SqlGenerator.SqlWriter.commaBetweenParameters. todo remove this hack The parameter is either ", " or " , ".
public List<E>	getArgs()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

argInd	back to summary
private int argInd

args	back to summary
private final List<String> args

Constructor Detail

FunctionArguments	back to summary
pack-priv FunctionArguments()

Method Detail

clause	back to summary
public void clause(String clause) Implements org.hibernate.hql.ast.SqlGenerator.SqlWriter.clause.

commaBetweenParameters	back to summary
public void commaBetweenParameters(String comma) Implements org.hibernate.hql.ast.SqlGenerator.SqlWriter.commaBetweenParameters. Doc from org.hibernate.hql.ast.SqlGenerator.SqlWriter.commaBetweenParameters. todo remove this hack The parameter is either ", " or " , ". This is needed to pass sql generating tests as the old sql generator uses " , " in the WHERE and ", " in SELECT. Parameters comma:String either " , " or ", "

commaBetweenParameters

back to summary

public void commaBetweenParameters(String comma)

Implements org.hibernate.hql.ast.SqlGenerator.SqlWriter.commaBetweenParameters.

Doc from org.hibernate.hql.ast.SqlGenerator.SqlWriter.commaBetweenParameters.

todo remove this hack The parameter is either ", " or " , ". This is needed to pass sql generating tests as the old sql generator uses " , " in the WHERE and ", " in SELECT.

Parameters

comma:String: either " , " or ", "

getArgs	back to summary
public List<E> getArgs()

org.hibernate.hql.ast back to summary

pack-priv Interface SqlGenerator.SqlWriter

Known Direct Implementers: org.hibernate.hql.ast.SqlGenerator.FunctionArguments, org.hibernate.hql.ast.SqlGenerator.DefaultWriter

Writes SQL fragments.

Method Summary

Modifier and Type	Method and Description
public void	clause(String clause)
public void	commaBetweenParameters(String either " , " or ", " comma) todo remove this hack The parameter is either ", " or " , ".

Method Detail

clause	back to summary
public void clause(String clause)

commaBetweenParameters

back to summary

public void commaBetweenParameters(String comma)

todo remove this hack The parameter is either ", " or " , ". This is needed to pass sql generating tests as the old sql generator uses " , " in the WHERE and ", " in SELECT.

Parameters

comma:String: either " , " or ", "