org.hibernate.query.internal

Class ParameterMetadataImpl

java.lang.Object

org.hibernate.query.internal.ParameterMetadataImpl

All Implemented Interfaces:

ParameterMetadata

public class ParameterMetadataImpl
extends Object
implements ParameterMetadata

Encapsulates metadata about parameters encountered within a query.

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor and Description
ParameterMetadataImpl(Map<Integer,OrdinalParameterDescriptor> ordinalDescriptorMap, Map<String,NamedParameterDescriptor> namedDescriptorMap)

Method Summary

Modifier and Type	Method and Description
Set<QueryParameter<?>>	collectAllParameters()
Set<Parameter<?>>	collectAllParametersJpa()
boolean	containsReference(QueryParameter parameter)
NamedParameterDescriptor	getNamedParameterDescriptor(String name) Get the descriptor for a named parameter given the name
Type	getNamedParameterExpectedType(String name) Deprecated. Use AbstractParameterDescriptor.getExpectedType() from the getNamedParameterDescriptor(java.lang.String) return instead
Set<String>	getNamedParameterNames() Return the names of all named parameters of the query.
Collection<QueryParameter>	getNamedParameters()
int[]	getNamedParameterSourceLocations(String name) Deprecated. Use AbstractParameterDescriptor.getPosition() from the getNamedParameterDescriptor(java.lang.String) return instead
int	getOrdinalParameterCount()
OrdinalParameterDescriptor	getOrdinalParameterDescriptor(int position) Get the descriptor for an ordinal parameter given its position
Type	getOrdinalParameterExpectedType(int position) Deprecated. Use AbstractParameterDescriptor.getExpectedType() from the getOrdinalParameterDescriptor(int) return instead
Set<Integer>	getOrdinalParameterLabels()
int	getOrdinalParameterSourceLocation(int position) Deprecated. Use OrdinalParameterDescriptor.getPosition() from the getOrdinalParameterDescriptor(int) return instead
int	getParameterCount()
int	getPositionalParameterCount() Returns the number of positional parameters.
Collection<QueryParameter>	getPositionalParameters()
<T> QueryParameter<T>	getQueryParameter(Integer position)
<T> QueryParameter<T>	getQueryParameter(String name)
boolean	hasNamedParameters() Does this parameter set contain any named parameters?
boolean	hasPositionalParameters() Does this parameter set contain any positional parameters?
<T> QueryParameter<T>	resolve(Parameter<T> param)
void	visitRegistrations(Consumer<QueryParameter> action)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterMetadataImpl

public ParameterMetadataImpl(Map<Integer,OrdinalParameterDescriptor> ordinalDescriptorMap,
                             Map<String,NamedParameterDescriptor> namedDescriptorMap)

Method Detail

getPositionalParameters

public Collection<QueryParameter> getPositionalParameters()

Specified by:

getPositionalParameters in interface ParameterMetadata

getNamedParameters

public Collection<QueryParameter> getNamedParameters()

Specified by:

getNamedParameters in interface ParameterMetadata

getParameterCount

public int getParameterCount()

Specified by:

getParameterCount in interface ParameterMetadata

containsReference

public boolean containsReference(QueryParameter parameter)

Specified by:

containsReference in interface ParameterMetadata

hasNamedParameters

public boolean hasNamedParameters()

Description copied from interface: ParameterMetadata

Does this parameter set contain any named parameters?

Specified by:

hasNamedParameters in interface ParameterMetadata

Returns:

true if there are named parameters; false otherwise.

hasPositionalParameters

public boolean hasPositionalParameters()

Description copied from interface: ParameterMetadata

Does this parameter set contain any positional parameters?

Specified by:

hasPositionalParameters in interface ParameterMetadata

Returns:

true if there are positional parameters; false otherwise.

getPositionalParameterCount

public int getPositionalParameterCount()

Description copied from interface: ParameterMetadata

Returns the number of positional parameters.

Specified by:

getPositionalParameterCount in interface ParameterMetadata

Returns:

The number of positional parameters.

getOrdinalParameterCount

public int getOrdinalParameterCount()

getNamedParameterNames

public Set<String> getNamedParameterNames()

Description copied from interface: ParameterMetadata

Return the names of all named parameters of the query.

Specified by:

getNamedParameterNames in interface ParameterMetadata

Returns:

the parameter names, in no particular order

getOrdinalParameterLabels

public Set<Integer> getOrdinalParameterLabels()

getOrdinalParameterDescriptor

public OrdinalParameterDescriptor getOrdinalParameterDescriptor(int position)

Get the descriptor for an ordinal parameter given its position

Parameters:

position - The position (0 based)

Returns:

The ordinal parameter descriptor

Throws:

QueryParameterException - If the position is out of range

getOrdinalParameterExpectedType

@Deprecated
public Type getOrdinalParameterExpectedType(int position)

Deprecated. Use AbstractParameterDescriptor.getExpectedType() from the getOrdinalParameterDescriptor(int) return instead

Deprecated.

Parameters:

position - The position

Returns:

The type

getOrdinalParameterSourceLocation

@Deprecated
public int getOrdinalParameterSourceLocation(int position)

Deprecated. Use OrdinalParameterDescriptor.getPosition() from the getOrdinalParameterDescriptor(int) return instead

Deprecated.

Parameters:

position - The position

Returns:

The source location

getQueryParameter

public <T> QueryParameter<T> getQueryParameter(String name)

Specified by:

getQueryParameter in interface ParameterMetadata

getQueryParameter

public <T> QueryParameter<T> getQueryParameter(Integer position)

Specified by:

getQueryParameter in interface ParameterMetadata

resolve

public <T> QueryParameter<T> resolve(Parameter<T> param)

Specified by:

resolve in interface ParameterMetadata

getNamedParameterDescriptor

public NamedParameterDescriptor getNamedParameterDescriptor(String name)

Get the descriptor for a named parameter given the name

Parameters:

name - The name of the parameter to locate

Returns:

The named parameter descriptor

Throws:

QueryParameterException - If the name could not be resolved to a named parameter

visitRegistrations

public void visitRegistrations(Consumer<QueryParameter> action)

Specified by:

visitRegistrations in interface ParameterMetadata

getNamedParameterExpectedType

@Deprecated
public Type getNamedParameterExpectedType(String name)

Deprecated. Use AbstractParameterDescriptor.getExpectedType() from the getNamedParameterDescriptor(java.lang.String) return instead

Deprecated.

Parameters:

name - The name of the parameter

Returns:

The type

getNamedParameterSourceLocations

@Deprecated
public int[] getNamedParameterSourceLocations(String name)

Deprecated. Use AbstractParameterDescriptor.getPosition() from the getNamedParameterDescriptor(java.lang.String) return instead

Deprecated.

Parameters:

name - The name of the parameter

Returns:

The type

collectAllParameters

public Set<QueryParameter<?>> collectAllParameters()

Specified by:

collectAllParameters in interface ParameterMetadata

collectAllParametersJpa

public Set<Parameter<?>> collectAllParametersJpa()

Specified by:

collectAllParametersJpa in interface ParameterMetadata