Top Description Fields Constructors Methods
org.hibernate.query.sqm.tree.expression

public Class SqmNamedParameter<T>

extends AbstractSqmParameter<T>
Class Inheritance
Imports
org.hibernate.query.sqm.NodeBuilder, .SemanticQueryWalker, .SqmExpressible, org.hibernate.query.sqm.tree.SqmCopyContext
Represents a named query parameter in the SQM tree.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final String
name

Constructor Summary

AccessConstructor and Description
public
SqmNamedParameter(String name, boolean canBeMultiValued, NodeBuilder nodeBuilder)

public
SqmNamedParameter(String name, boolean canBeMultiValued, SqmExpressible<T> inherentType, NodeBuilder nodeBuilder)

Method Summary

Modifier and TypeMethod and Description
public <X> X
accept(SemanticQueryWalker<X> walker)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Accept the walker per visitation
public void
appendHqlString(StringBuilder sb)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.appendHqlString.

public String
asLoggableText()

Overrides default org.hibernate.query.sqm.tree.SqmNode.asLoggableText.

public int
compareTo(SqmParameter<T>
the object to be compared.
anotherParameter)

Overrides default org.hibernate.query.sqm.tree.expression.SqmParameter.compareTo.

Compares this object with the specified object for order.
public SqmNamedParameter<T>
copy(SqmCopyContext context)

Implements org.hibernate.query.sqm.tree.expression.SqmParameter.copy, org.hibernate.query.sqm.tree.expression.SqmExpression.copy, org.hibernate.query.sqm.tree.select.SqmSelectableNode.copy, org.hibernate.query.sqm.tree.SqmNode.copy.

public SqmParameter<T>
copy()

Implements org.hibernate.query.sqm.tree.expression.SqmParameter.copy.

Make a copy
public String
getName()

Overrides org.hibernate.query.sqm.tree.expression.AbstractSqmParameter.getName.

Implements org.hibernate.query.sqm.tree.expression.SqmParameter.getName.

If this represents a named parameter, return that parameter name; otherwise return null.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from org.hibernate.query.sqm.tree.expression.AbstractSqmParameter:
allowMultiValuedBindingapplyInferableTypedisallowMultiValuedBindinggetAnticipatedTypegetParameterTypegetPositiongetTupleLength

Field Detail

nameback to summary
private final String name

Constructor Detail

SqmNamedParameterback to summary
public SqmNamedParameter(String name, boolean canBeMultiValued, NodeBuilder nodeBuilder)
SqmNamedParameterback to summary
public SqmNamedParameter(String name, boolean canBeMultiValued, SqmExpressible<T> inherentType, NodeBuilder nodeBuilder)

Method Detail

acceptback to summary
public <X> X accept(SemanticQueryWalker<X> walker)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Doc from org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Accept the walker per visitation

Annotations
@Override
appendHqlStringback to summary
public void appendHqlString(StringBuilder sb)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.appendHqlString.

Annotations
@Override
asLoggableTextback to summary
public String asLoggableText()

Overrides default org.hibernate.query.sqm.tree.SqmNode.asLoggableText.

Annotations
@Override
compareToback to summary
public int compareTo(SqmParameter<T> anotherParameter)

Overrides default org.hibernate.query.sqm.tree.expression.SqmParameter.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
anotherParameter:SqmParameter<T>

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
copyback to summary
public SqmNamedParameter<T> copy(SqmCopyContext context)

Implements org.hibernate.query.sqm.tree.expression.SqmParameter.copy, org.hibernate.query.sqm.tree.expression.SqmExpression.copy, org.hibernate.query.sqm.tree.select.SqmSelectableNode.copy, org.hibernate.query.sqm.tree.SqmNode.copy.

Annotations
@Override
copyback to summary
public SqmParameter<T> copy()

Implements org.hibernate.query.sqm.tree.expression.SqmParameter.copy.

Doc from org.hibernate.query.sqm.tree.expression.SqmParameter.copy.

Make a copy

Annotations
@Override
getNameback to summary
public String getName()

Overrides org.hibernate.query.sqm.tree.expression.AbstractSqmParameter.getName.

Implements org.hibernate.query.sqm.tree.expression.SqmParameter.getName.

Doc from org.hibernate.query.sqm.tree.expression.SqmParameter.getName.

If this represents a named parameter, return that parameter name; otherwise return null.

Returns:String

The parameter name, or null if not a named parameter

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override