org.hibernate.engine.query.spi

Class ParamLocationRecognizer

java.lang.Object

org.hibernate.engine.query.spi.ParamLocationRecognizer

All Implemented Interfaces:

ParameterParser.Recognizer

public class ParamLocationRecognizer
extends Object
implements ParameterParser.Recognizer

Implements a parameter parser recognizer specifically for the purpose of journaling parameter locations.

Author:

Steve Ebersole

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParamLocationRecognizer.NamedParameterDescription Internal representation of a recognized named parameter

Constructor Summary

Constructors

Constructor and Description
ParamLocationRecognizer()

Method Summary

Modifier and Type	Method and Description
Map<String,ParamLocationRecognizer.NamedParameterDescription>	getNamedParameterDescriptionMap() Returns the map of named parameter locations.
List<Integer>	getOrdinalParameterLocationList() Returns the list of ordinal parameter locations.
void	jpaPositionalParameter(String name, int position) Called when a JPA-style named parameter is recognized
void	namedParameter(String name, int position) Called when a named parameter is recognized
void	ordinalParameter(int position) Called when an ordinal parameter is recognized
void	other(char character) Called when a character that is not a parameter (or part of a parameter dfinition) is recognized.
void	outParameter(int position) Called when an output parameter is recognized
static ParamLocationRecognizer	parseLocations(String query) Convenience method for creating a param location recognizer and initiating the parse.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamLocationRecognizer

public ParamLocationRecognizer()

Method Detail

parseLocations

public static ParamLocationRecognizer parseLocations(String query)

Convenience method for creating a param location recognizer and initiating the parse.

Parameters:

query - The query to be parsed for parameter locations.

Returns:

The generated recognizer, with journaled location info.

getNamedParameterDescriptionMap

public Map<String,ParamLocationRecognizer.NamedParameterDescription> getNamedParameterDescriptionMap()

Returns the map of named parameter locations. The map is keyed by parameter name; the corresponding value is a (@link NamedParameterDescription}.

Returns:

The map of named parameter locations.

getOrdinalParameterLocationList

public List<Integer> getOrdinalParameterLocationList()

Returns the list of ordinal parameter locations. The list elements are Integers, representing the location for that given ordinal. Thus calling getOrdinalParameterLocationList().elementAt(n) represents the location for the nth parameter.

Returns:

The list of ordinal parameter locations.

ordinalParameter

public void ordinalParameter(int position)

Description copied from interface: ParameterParser.Recognizer

Called when an ordinal parameter is recognized

Specified by:

ordinalParameter in interface ParameterParser.Recognizer

Parameters:

position - The position within the query

namedParameter

public void namedParameter(String name,
                           int position)

Description copied from interface: ParameterParser.Recognizer

Called when a named parameter is recognized

Specified by:

namedParameter in interface ParameterParser.Recognizer

Parameters:

name - The recognized parameter name

position - The position within the query

jpaPositionalParameter

public void jpaPositionalParameter(String name,
                                   int position)

Description copied from interface: ParameterParser.Recognizer

Called when a JPA-style named parameter is recognized

Specified by:

jpaPositionalParameter in interface ParameterParser.Recognizer

Parameters:

name - The name of the JPA-style parameter

position - The position within the query

other

public void other(char character)

Description copied from interface: ParameterParser.Recognizer

Called when a character that is not a parameter (or part of a parameter dfinition) is recognized.

Specified by:

other in interface ParameterParser.Recognizer

Parameters:

character - The recognized character

outParameter

public void outParameter(int position)

Description copied from interface: ParameterParser.Recognizer

Called when an output parameter is recognized

Specified by:

outParameter in interface ParameterParser.Recognizer

Parameters:

position - The position within the query