org.hibernate.query.internal

Class ParameterMetadataImpl

java.lang.Object

org.hibernate.query.internal.ParameterMetadataImpl

All Implemented Interfaces:

ParameterMetadata

public class ParameterMetadataImpl
extends java.lang.Object
implements ParameterMetadata

Encapsulates metadata about parameters encountered within a query.

Constructor Summary

Constructors

Constructor and Description
ParameterMetadataImpl(OrdinalParameterDescriptor[] ordinalDescriptors, java.util.Map<java.lang.String,NamedParameterDescriptor> namedDescriptorMap) Instantiates a ParameterMetadata container.

Method Summary

Modifier and Type	Method and Description
java.util.Set<QueryParameter<?>>	collectAllParameters()
java.util.Set<javax.persistence.Parameter<?>>	collectAllParametersJpa()
NamedParameterDescriptor	getNamedParameterDescriptor(java.lang.String name) Get the descriptor for a named parameter given the name
Type	getNamedParameterExpectedType(java.lang.String name) Deprecated. Use NamedParameterDescriptor.getExpectedType() from the getNamedParameterDescriptor(java.lang.String) return instead
java.util.Set<java.lang.String>	getNamedParameterNames() Access to the names of all named parameters
int[]	getNamedParameterSourceLocations(java.lang.String name) Deprecated. Use NamedParameterDescriptor.getSourceLocations() 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 OrdinalParameterDescriptor.getExpectedType() from the getOrdinalParameterDescriptor(int) return instead
int	getOrdinalParameterSourceLocation(int position) Deprecated. Use OrdinalParameterDescriptor.getSourceLocation() from the getOrdinalParameterDescriptor(int) return instead
ParameterMetadataImpl	getOrdinalParametersZeroBasedCopy()
int	getPositionalParameterCount() Returns the number of positional parameters.
<T> QueryParameter<T>	getQueryParameter(java.lang.Integer position)
<T> QueryParameter<T>	getQueryParameter(java.lang.String name)
boolean	hasNamedParameters() Does this parameter set contain any named parameters?
boolean	hasPositionalParameters() Does this parameter set contain any positional parameters?
boolean	isOrdinalParametersZeroBased()
<T> QueryParameter<T>	resolve(javax.persistence.Parameter<T> param)
void	setOrdinalParametersZeroBased(boolean isZeroBased)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterMetadataImpl

public ParameterMetadataImpl(OrdinalParameterDescriptor[] ordinalDescriptors,
                             java.util.Map<java.lang.String,NamedParameterDescriptor> namedDescriptorMap)

Instantiates a ParameterMetadata container.

Parameters:

ordinalDescriptors - Descriptors of the ordinal parameters

namedDescriptorMap - Descriptors of the named parameters

Method Detail

collectAllParameters

public java.util.Set<QueryParameter<?>> collectAllParameters()

Specified by:

collectAllParameters in interface ParameterMetadata

collectAllParametersJpa

public java.util.Set<javax.persistence.Parameter<?>> collectAllParametersJpa()

Specified by:

collectAllParametersJpa 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()

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 OrdinalParameterDescriptor.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.getSourceLocation() from the getOrdinalParameterDescriptor(int) return instead

Deprecated.

Parameters:

position - The position

Returns:

The source location

getNamedParameterNames

public java.util.Set<java.lang.String> getNamedParameterNames()

Access to the names of all named parameters

Specified by:

getNamedParameterNames in interface ParameterMetadata

Returns:

The named parameter names

getQueryParameter

public <T> QueryParameter<T> getQueryParameter(java.lang.String name)

Specified by:

getQueryParameter in interface ParameterMetadata

getQueryParameter

public <T> QueryParameter<T> getQueryParameter(java.lang.Integer position)

Specified by:

getQueryParameter in interface ParameterMetadata

resolve

public <T> QueryParameter<T> resolve(javax.persistence.Parameter<T> param)

Specified by:

resolve in interface ParameterMetadata

getNamedParameterDescriptor

public NamedParameterDescriptor getNamedParameterDescriptor(java.lang.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

getNamedParameterExpectedType

@Deprecated
public Type getNamedParameterExpectedType(java.lang.String name)

Deprecated. Use NamedParameterDescriptor.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(java.lang.String name)

Deprecated. Use NamedParameterDescriptor.getSourceLocations() from the getNamedParameterDescriptor(java.lang.String) return instead

Deprecated.

Parameters:

name - The name of the parameter

Returns:

The type

isOrdinalParametersZeroBased

public boolean isOrdinalParametersZeroBased()

Specified by:

isOrdinalParametersZeroBased in interface ParameterMetadata

setOrdinalParametersZeroBased

public void setOrdinalParametersZeroBased(boolean isZeroBased)

Specified by:

setOrdinalParametersZeroBased in interface ParameterMetadata

getOrdinalParametersZeroBasedCopy

public ParameterMetadataImpl getOrdinalParametersZeroBasedCopy()