Top Description Inners Constructors Methods
org.hibernate.engine.query

public Class ParameterParser

extends Object
Class Inheritance
Imports
org.hibernate.QueryException, org.hibernate.hql.classic.ParserHelper, org.hibernate.util.StringHelper

The single available method parse is responsible for parsing a query string and recognizing tokens in relation to parameters (either named, JPA-style, or ordinal) and providing callbacks about such recognitions.
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface

Constructor Summary

AccessConstructor and Description
private
ParameterParser()

Direct instantiation of ParameterParser disallowed.

Method Summary

Modifier and TypeMethod and Description
public static void
parse(String
The string to be parsed/tokenized.
sqlString
,
ParameterParser.Recognizer
The thing which handles recognition events.
recognizer
)

Performs the actual parsing and tokenizing of the query string making appropriate callbacks to the given recognizer upon recognition of the various tokens.

public static boolean
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

ParameterParserback to summary
private ParameterParser()

Direct instantiation of ParameterParser disallowed.

Method Detail

parseback to summary
public static void parse(String sqlString, ParameterParser.Recognizer recognizer) throws QueryException

Performs the actual parsing and tokenizing of the query string making appropriate callbacks to the given recognizer upon recognition of the various tokens.

Note that currently, this only knows how to deal with a single output parameter (for callable statements). If we later add support for multiple output params, this, obviously, needs to change.

Parameters
sqlString:String

The string to be parsed/tokenized.

recognizer:ParameterParser.Recognizer

The thing which handles recognition events.

Exceptions
QueryException:
Indicates unexpected parameter conditions.
startsWithEscapeCallTemplateback to summary
public static boolean startsWithEscapeCallTemplate(String sqlString)
org.hibernate.engine.query back to summary

public Interface ParameterParser.Recognizer

Known Direct Implementers
org.hibernate.engine.query.ParamLocationRecognizer, org.hibernate.loader.custom.sql.SQLQueryParser.ParameterSubstitutionRecognizer

Method Summary

Modifier and TypeMethod and Description
public void
jpaPositionalParameter(String name, int position)

public void
namedParameter(String name, int position)

public void
ordinalParameter(int position)

public void
other(char character)

public void
outParameter(int position)

Method Detail

jpaPositionalParameterback to summary
public void jpaPositionalParameter(String name, int position)
namedParameterback to summary
public void namedParameter(String name, int position)
ordinalParameterback to summary
public void ordinalParameter(int position)
otherback to summary
public void other(char character)
outParameterback to summary
public void outParameter(int position)