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

public Class ParamLocationRecognizer

extends Object
implements Recognizer
Class Inheritance
All Implemented Interfaces
org.hibernate.engine.query.spi.ParameterParser.Recognizer
Imports
java.util.ArrayList, .Collections, .HashMap, .List, .Map, org.hibernate.engine.query.ParameterRecognitionException, org.hibernate.engine.spi.SessionFactoryImplementor, org.hibernate.internal.util.collections.ArrayHelper

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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ParamLocationRecognizer.InFlightJpaOrdinalParameterState

Internal in-flight representation of a recognized named parameter

public static class
ParamLocationRecognizer.InFlightNamedParameterState

Internal in-flight representation of a recognized named parameter

public static class
ParamLocationRecognizer.InFlightOrdinalParameterState

Internal in-flight representation of a recognized named parameter

Field Summary

Modifier and TypeField and Description
private Map<Integer, ParamLocationRecognizer.InFlightJpaOrdinalParameterState>
private Map<String, ParamLocationRecognizer.InFlightNamedParameterState>
private Map<Integer, ParamLocationRecognizer.InFlightOrdinalParameterState>
private int
private final int
private Map<String, NamedParameterDescriptor>
private Map<Integer, OrdinalParameterDescriptor>

Constructor Summary

AccessConstructor and Description
public
ParamLocationRecognizer(int jdbcStyleOrdinalCountBase)

Method Summary

Modifier and TypeMethod and Description
public void
public Map<String, NamedParameterDescriptor>
private ParamLocationRecognizer.InFlightJpaOrdinalParameterState
private ParamLocationRecognizer.InFlightNamedParameterState
public Map<Integer, OrdinalParameterDescriptor>
public void
jpaPositionalParameter(int
The identifier (name) of the JPA-style parameter
name
,
int
The position within the query
position
)

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.jpaPositionalParameter.

Called when a JPA-style named parameter is recognized
private ParameterRecognitionException
public void
namedParameter(String
The recognized parameter name
name
,
int
The position within the query
position
)

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.namedParameter.

Called when a named parameter is recognized
public void
ordinalParameter(int
The position within the query
position
)

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.ordinalParameter.

Called when an ordinal parameter is recognized
public void
other(char
The recognized character
character
)

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.other.

Called when a character that is not a parameter (or part of a parameter definition) is recognized.
public void
outParameter(int
The position within the query
position
)

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.outParameter.

Called when an output parameter is recognized
public static ParamLocationRecognizer

Returns:

The generated recognizer, with journaled location info.
parseLocations
(String
The query to be parsed for parameter locations.
query
,
SessionFactoryImplementor sessionFactory)

Deprecated as a consequence of SessionFactoryImplementor being deprecated.
Convenience method for creating a param location recognizer and initiating the parse.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

inFlightJpaOrdinalStateMapback to summary
private Map<Integer, ParamLocationRecognizer.InFlightJpaOrdinalParameterState> inFlightJpaOrdinalStateMap
inFlightNamedStateMapback to summary
private Map<String, ParamLocationRecognizer.InFlightNamedParameterState> inFlightNamedStateMap
inFlightOrdinalStateMapback to summary
private Map<Integer, ParamLocationRecognizer.InFlightOrdinalParameterState> inFlightOrdinalStateMap
jdbcStyleOrdinalCountback to summary
private int jdbcStyleOrdinalCount
jdbcStyleOrdinalCountBaseback to summary
private final int jdbcStyleOrdinalCountBase
namedParameterDescriptorsback to summary
private Map<String, NamedParameterDescriptor> namedParameterDescriptors
ordinalParameterDescriptorsback to summary
private Map<Integer, OrdinalParameterDescriptor> ordinalParameterDescriptors

Constructor Detail

ParamLocationRecognizerback to summary
public ParamLocationRecognizer(int jdbcStyleOrdinalCountBase)

Method Detail

completeback to summary
public void complete()

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.complete.

Annotations
@Override
getNamedParameterDescriptionMapback to summary
public Map<String, NamedParameterDescriptor> getNamedParameterDescriptionMap()
getOrBuildJpaOrdinalParameterDescriptionback to summary
private ParamLocationRecognizer.InFlightJpaOrdinalParameterState getOrBuildJpaOrdinalParameterDescription(int name)
getOrBuildNamedParameterDescriptionback to summary
private ParamLocationRecognizer.InFlightNamedParameterState getOrBuildNamedParameterDescription(String name)
getOrdinalParameterDescriptionMapback to summary
public Map<Integer, OrdinalParameterDescriptor> getOrdinalParameterDescriptionMap()
jpaPositionalParameterback to summary
public void jpaPositionalParameter(int name, int position)

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.jpaPositionalParameter.

Doc from org.hibernate.engine.query.spi.ParameterParser.Recognizer.jpaPositionalParameter.

Called when a JPA-style named parameter is recognized

Parameters
name:int

The identifier (name) of the JPA-style parameter

position:int

The position within the query

Annotations
@Override
mixedParamStrategyback to summary
private ParameterRecognitionException mixedParamStrategy()
namedParameterback to summary
public void namedParameter(String name, int position)

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.namedParameter.

Doc from org.hibernate.engine.query.spi.ParameterParser.Recognizer.namedParameter.

Called when a named parameter is recognized

Parameters
name:String

The recognized parameter name

position:int

The position within the query

Annotations
@Override
ordinalParameterback to summary
public void ordinalParameter(int position)

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.ordinalParameter.

Doc from org.hibernate.engine.query.spi.ParameterParser.Recognizer.ordinalParameter.

Called when an ordinal parameter is recognized

Parameters
position:int

The position within the query

Annotations
@Override
otherback to summary
public void other(char character)

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.other.

Doc from org.hibernate.engine.query.spi.ParameterParser.Recognizer.other.

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

Parameters
character:char

The recognized character

Annotations
@Override
outParameterback to summary
public void outParameter(int position)

Implements org.hibernate.engine.query.spi.ParameterParser.Recognizer.outParameter.

Doc from org.hibernate.engine.query.spi.ParameterParser.Recognizer.outParameter.

Called when an output parameter is recognized

Parameters
position:int

The position within the query

Annotations
@Override
parseLocationsback to summary
public static ParamLocationRecognizer parseLocations(String query, SessionFactoryImplementor sessionFactory)

Deprecated

as a consequence of SessionFactoryImplementor being deprecated. See corresponding docs for further information.

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

Parameters
query:String

The query to be parsed for parameter locations.

Returns:ParamLocationRecognizer

The generated recognizer, with journaled location info.

org.hibernate.engine.query.spi back to summary

public Class ParamLocationRecognizer.InFlightJpaOrdinalParameterState

extends Object
Class Inheritance
  • java.lang.Object
  • org.hibernate.engine.query.spi.ParamLocationRecognizer.InFlightJpaOrdinalParameterState

Internal in-flight representation of a recognized named parameter

Field Summary

Modifier and TypeField and Description
private final int
private final List<Integer>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
private void
add(int position)

private OrdinalParameterDescriptor
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

identifierback to summary
private final int identifier
sourcePositionsback to summary
private final List<Integer> sourcePositions

Constructor Detail

InFlightJpaOrdinalParameterStateback to summary
pack-priv InFlightJpaOrdinalParameterState(int identifier)

Method Detail

addback to summary
private void add(int position)
completeback to summary
private OrdinalParameterDescriptor complete()
org.hibernate.engine.query.spi back to summary

public Class ParamLocationRecognizer.InFlightNamedParameterState

extends Object
Class Inheritance
  • java.lang.Object
  • org.hibernate.engine.query.spi.ParamLocationRecognizer.InFlightNamedParameterState

Internal in-flight representation of a recognized named parameter

Field Summary

Modifier and TypeField and Description
private final String
private final List<Integer>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
private void
add(int position)

private NamedParameterDescriptor
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

nameback to summary
private final String name
sourcePositionsback to summary
private final List<Integer> sourcePositions

Constructor Detail

InFlightNamedParameterStateback to summary
pack-priv InFlightNamedParameterState(String name)

Method Detail

addback to summary
private void add(int position)
completeback to summary
private NamedParameterDescriptor complete()
org.hibernate.engine.query.spi back to summary

public Class ParamLocationRecognizer.InFlightOrdinalParameterState

extends Object
Class Inheritance
  • java.lang.Object
  • org.hibernate.engine.query.spi.ParamLocationRecognizer.InFlightOrdinalParameterState

Internal in-flight representation of a recognized named parameter

Field Summary

Modifier and TypeField and Description
private final int
private final int
private final int

Constructor Summary

AccessConstructor and Description
pack-priv
InFlightOrdinalParameterState(int label, int valuePosition, int sourcePosition)

Method Summary

Modifier and TypeMethod and Description
private OrdinalParameterDescriptor
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

identifierback to summary
private final int identifier
sourcePositionback to summary
private final int sourcePosition
valuePositionback to summary
private final int valuePosition

Constructor Detail

InFlightOrdinalParameterStateback to summary
pack-priv InFlightOrdinalParameterState(int label, int valuePosition, int sourcePosition)

Method Detail

completeback to summary
private OrdinalParameterDescriptor complete()