Package org.hibernate.query.sqm.tree.expression

Class SqmFieldLiteral<T>

java.lang.Object

org.hibernate.query.sqm.tree.expression.SqmFieldLiteral<T>

All Implemented Interfaces:

Expression<T>, Selection<T>, TupleElement<T>, Serializable, BindableType<T>, JpaCriteriaNode, JpaExpression<T>, JpaSelection<T>, JpaTupleElement<T>, SemanticPathPart, SqmExpressible<T>, SqmExpression<T>, SqmSelectableNode<T>, SqmExpressibleAccessor<T>, SqmNode, SqmTypedNode<T>, SqmVisitableNode

public class SqmFieldLiteral<T>
extends Object
implements SqmExpression<T>, SqmExpressible<T>, SqmSelectableNode<T>, SemanticPathPart

Author:

Steve Ebersole

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.hibernate.query.sqm.tree.SqmNode

log

Constructor Summary

Constructors

Constructor	Description
SqmFieldLiteral(Field field, JavaType<T> fieldJavaType, NodeBuilder nodeBuilder)
SqmFieldLiteral(T value, JavaType<T> fieldJavaType, String fieldName, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
JpaSelection<T>	alias(String name)	Assigns an alias to the selection item.
void	appendHqlString(StringBuilder sb)
void	applyInferableType(@Nullable SqmExpressible<?> type)	Used to apply type information based on the expression's usage within the query.
<X> SqmExpression<X>	as(Class<X> type)	Perform a typecast upon the expression, returning a new expression object.
SqmExpression<BigDecimal>	asBigDecimal()
SqmExpression<BigInteger>	asBigInteger()
SqmExpression<Double>	asDouble()
SqmExpression<Float>	asFloat()
SqmExpression<Integer>	asInteger()
SqmExpression<Long>	asLong()
SqmExpression<String>	asString()
SqmFieldLiteral<T>	copy(SqmCopyContext context)
SqmPredicate	equalTo(Expression<T> that)
SqmPredicate	equalTo(T that)
String	getAlias()	Return the alias assigned to the tuple element or null, if no alias has been assigned.
Class<T>	getBindableJavaType()	The expected Java type
JavaType<T>	getExpressibleJavaType()	The Java type descriptor for this expressible
String	getFieldName()
JavaType<T>	getJavaTypeDescriptor()
NodeBuilder	getNodeBuilder()
SqmExpressible<T>	getNodeType()	The expression's type.
List<? extends JpaSelection<?>>	getSelectionItems()
DomainType<T>	getSqmType()
T	getValue()
SqmPredicate	in(Expression<?>... values)	Create a predicate to test whether the expression is a member of the argument list.
SqmPredicate	in(Expression<Collection<?>> values)	Create a predicate to test whether the expression is a member of the collection.
SqmPredicate	in(Object... values)	Create a predicate to test whether the expression is a member of the argument list.
SqmPredicate	in(Collection<?> values)	Create a predicate to test whether the expression is a member of the collection.
boolean	isCompoundSelection()	Whether the selection item is a compound selection.
SqmPredicate	isNotNull()	Create a predicate to test whether the expression is not null.
SqmPredicate	isNull()	Create a predicate to test whether the expression is null.
NodeBuilder	nodeBuilder()
SqmPath<?>	resolveIndexedAccess(SqmExpression<?> selector, boolean isTerminal, SqmCreationState creationState)
SemanticPathPart	resolvePathPart(String name, boolean isTerminal, SqmCreationState creationState)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.query.criteria.JpaSelection

getCompoundSelectionItems

Methods inherited from interface org.hibernate.query.criteria.JpaTupleElement

getJavaType, getJavaTypeName, isEnum

Methods inherited from interface org.hibernate.query.sqm.SqmExpressible

getRelationalJavaType, getTypeName, isInstance, resolveExpressible

Methods inherited from interface org.hibernate.query.sqm.tree.expression.SqmExpression

cast, castAs, visitSubSelectableNodes

Methods inherited from interface org.hibernate.query.sqm.tree.SqmNode

asLoggableText

Methods inherited from interface org.hibernate.query.sqm.tree.select.SqmSelectableNode

getTupleLength

Methods inherited from interface org.hibernate.query.sqm.tree.SqmTypedNode

getExpressible, getNodeJavaType

Methods inherited from interface org.hibernate.query.sqm.tree.SqmVisitableNode

toHqlString

Constructor Details

SqmFieldLiteral

public SqmFieldLiteral(Field field,
 JavaType<T> fieldJavaType,
 NodeBuilder nodeBuilder)

SqmFieldLiteral

public SqmFieldLiteral(T value,
 JavaType<T> fieldJavaType,
 String fieldName,
 NodeBuilder nodeBuilder)

Method Details

copy

public SqmFieldLiteral<T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<T>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmSelectableNode<T>

Specified by:

copy in interface SqmTypedNode<T>

getValue

public T getValue()

getFieldName

public String getFieldName()

getNodeBuilder

public NodeBuilder getNodeBuilder()

getNodeType

public SqmExpressible<T> getNodeType()

Description copied from interface: SqmExpression

The expression's type.

Can change as a result of calls to SqmExpression.applyInferableType(org.hibernate.query.sqm.SqmExpressible<?>)

Specified by:

getNodeType in interface SqmExpression<T>

Specified by:

getNodeType in interface SqmTypedNode<T>

applyInferableType

public void applyInferableType(@Nullable SqmExpressible<?> type)

Description copied from interface: SqmExpression

Used to apply type information based on the expression's usage within the query.

Specified by:

applyInferableType in interface SqmExpression<T>

getExpressibleJavaType

public JavaType<T> getExpressibleJavaType()

Description copied from interface: SqmExpressible

The Java type descriptor for this expressible

Specified by:

getExpressibleJavaType in interface SqmExpressible<T>

getJavaTypeDescriptor

public JavaType<T> getJavaTypeDescriptor()

Specified by:

getJavaTypeDescriptor in interface JpaTupleElement<T>

getBindableJavaType

public Class<T> getBindableJavaType()

Description copied from interface: BindableType

The expected Java type

Specified by:

getBindableJavaType in interface BindableType<T>

accept

public <X> X accept(SemanticQueryWalker<X> walker)

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

appendHqlString

public void appendHqlString(StringBuilder sb)

Specified by:

appendHqlString in interface SqmVisitableNode

nodeBuilder

public NodeBuilder nodeBuilder()

Specified by:

nodeBuilder in interface SqmNode

isNull

public SqmPredicate isNull()

Description copied from interface: Expression

Create a predicate to test whether the expression is null.

Specified by:

isNull in interface Expression<T>

Specified by:

isNull in interface JpaExpression<T>

Specified by:

isNull in interface SqmExpression<T>

Returns:

predicate testing whether the expression is null

equalTo

public SqmPredicate equalTo(Expression<T> that)

Specified by:

equalTo in interface JpaExpression<T>

Specified by:

equalTo in interface SqmExpression<T>

equalTo

public SqmPredicate equalTo(T that)

Specified by:

equalTo in interface JpaExpression<T>

Specified by:

equalTo in interface SqmExpression<T>

isNotNull

public SqmPredicate isNotNull()

Description copied from interface: Expression

Create a predicate to test whether the expression is not null.

Specified by:

isNotNull in interface Expression<T>

Specified by:

isNotNull in interface JpaExpression<T>

Specified by:

isNotNull in interface SqmExpression<T>

Returns:

predicate testing whether the expression is not null

in

public SqmPredicate in(Object... values)

Description copied from interface: Expression

Create a predicate to test whether the expression is a member of the argument list.

Specified by:

in in interface Expression<T>

Specified by:

in in interface JpaExpression<T>

Specified by:

in in interface SqmExpression<T>

Parameters:

values - values to be tested against

Returns:

predicate testing for membership

in

public SqmPredicate in(Expression<?>... values)

Description copied from interface: Expression

Create a predicate to test whether the expression is a member of the argument list.

Specified by:

in in interface Expression<T>

Specified by:

in in interface JpaExpression<T>

Specified by:

in in interface SqmExpression<T>

Parameters:

values - expressions to be tested against

Returns:

predicate testing for membership

in

public SqmPredicate in(Collection<?> values)

Description copied from interface: Expression

Create a predicate to test whether the expression is a member of the collection.

Specified by:

in in interface Expression<T>

Specified by:

in in interface JpaExpression<T>

Specified by:

in in interface SqmExpression<T>

Parameters:

values - collection of values to be tested against

Returns:

predicate testing for membership

in

public SqmPredicate in(Expression<Collection<?>> values)

Description copied from interface: Expression

Create a predicate to test whether the expression is a member of the collection.

Specified by:

in in interface Expression<T>

Specified by:

in in interface JpaExpression<T>

Specified by:

in in interface SqmExpression<T>

Parameters:

values - expression corresponding to collection to be tested against

Returns:

predicate testing for membership

asLong

public SqmExpression<Long> asLong()

Specified by:

asLong in interface JpaExpression<T>

Specified by:

asLong in interface SqmExpression<T>

asInteger

public SqmExpression<Integer> asInteger()

Specified by:

asInteger in interface JpaExpression<T>

Specified by:

asInteger in interface SqmExpression<T>

asFloat

public SqmExpression<Float> asFloat()

Specified by:

asFloat in interface JpaExpression<T>

Specified by:

asFloat in interface SqmExpression<T>

asDouble

public SqmExpression<Double> asDouble()

Specified by:

asDouble in interface JpaExpression<T>

Specified by:

asDouble in interface SqmExpression<T>

asBigDecimal

public SqmExpression<BigDecimal> asBigDecimal()

Specified by:

asBigDecimal in interface JpaExpression<T>

Specified by:

asBigDecimal in interface SqmExpression<T>

asBigInteger

public SqmExpression<BigInteger> asBigInteger()

Specified by:

asBigInteger in interface JpaExpression<T>

Specified by:

asBigInteger in interface SqmExpression<T>

asString

public SqmExpression<String> asString()

Specified by:

asString in interface JpaExpression<T>

Specified by:

asString in interface SqmExpression<T>

as

public <X> SqmExpression<X> as(Class<X> type)

Description copied from interface: Expression

Perform a typecast upon the expression, returning a new expression object. This method does not cause type conversion: the runtime type is not changed. Warning: may result in a runtime failure.

Specified by:

as in interface Expression<T>

Specified by:

as in interface JpaExpression<T>

Specified by:

as in interface SqmExpression<T>

Parameters:

type - intended type of the expression

Returns:

new expression of the given type

resolvePathPart

public SemanticPathPart resolvePathPart(String name,
 boolean isTerminal,
 SqmCreationState creationState)

Specified by:

resolvePathPart in interface SemanticPathPart

resolveIndexedAccess

public SqmPath<?> resolveIndexedAccess(SqmExpression<?> selector,
 boolean isTerminal,
 SqmCreationState creationState)

Specified by:

resolveIndexedAccess in interface SemanticPathPart

isCompoundSelection

public boolean isCompoundSelection()

Description copied from interface: Selection

Whether the selection item is a compound selection.

Specified by:

isCompoundSelection in interface Selection<T>

Returns:

boolean indicating whether the selection is a compound selection

getSelectionItems

public List<? extends JpaSelection<?>> getSelectionItems()

Specified by:

getSelectionItems in interface JpaSelection<T>

alias

public JpaSelection<T> alias(String name)

Description copied from interface: Selection

Assigns an alias to the selection item. Once assigned, an alias cannot be changed or reassigned. Returns the same selection item.

Specified by:

alias in interface JpaSelection<T>

Specified by:

alias in interface Selection<T>

Parameters:

name - alias

Returns:

selection item

getAlias

public String getAlias()

Description copied from interface: TupleElement

Return the alias assigned to the tuple element or null, if no alias has been assigned.

Specified by:

getAlias in interface TupleElement<T>

Returns:

alias

getSqmType

public DomainType<T> getSqmType()

Specified by:

getSqmType in interface SqmExpressible<T>