org.hibernate.engine.query.spi

Class ParameterMetadata

java.lang.Object

org.hibernate.engine.query.spi.ParameterMetadata

All Implemented Interfaces:

Serializable

public class ParameterMetadata
extends Object
implements Serializable

Encapsulates metadata about parameters encountered within a query.

Author:

Steve Ebersole

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
NamedParameterDescriptor	getNamedParameterDescriptor(String name) Get the descriptor for a named parameter given the name
Type	getNamedParameterExpectedType(String name) Deprecated. Use NamedParameterDescriptor.getExpectedType() from the getNamedParameterDescriptor(java.lang.String) return instead
Set<String>	getNamedParameterNames() Access to the names of all named parameters
int[]	getNamedParameterSourceLocations(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

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterMetadata

public ParameterMetadata(OrdinalParameterDescriptor[] ordinalDescriptors,
                         Map<String,NamedParameterDescriptor> namedDescriptorMap)

Instantiates a ParameterMetadata container.

Parameters:

ordinalDescriptors - Descriptors of the ordinal parameters

namedDescriptorMap - Descriptors of the named parameters

Method Detail

getOrdinalParameterCount

public int getOrdinalParameterCount()

getOrdinalParameterDescriptor

public OrdinalParameterDescriptor getOrdinalParameterDescriptor(int position)

Get the descriptor for an ordinal parameter given its position

Parameters:

position - The position (1 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 Set<String> getNamedParameterNames()

Access to the names of all named parameters

Returns:

The named parameter names

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

getNamedParameterExpectedType

@Deprecated
public Type getNamedParameterExpectedType(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(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