Package org.hibernate.query.sqm.tree.domain

Class SqmMapEntryReference<K,V>

java.lang.Object

org.hibernate.query.sqm.tree.domain.SqmMapEntryReference<K,V>

All Implemented Interfaces:

Expression<Map.Entry<K,V>>, Selection<Map.Entry<K,V>>, TupleElement<Map.Entry<K,V>>, Serializable, BindableType<Map.Entry<K,V>>, JpaCriteriaNode, JpaSelection<Map.Entry<K,V>>, JpaTupleElement<Map.Entry<K,V>>, SqmExpressible<Map.Entry<K,V>>, SqmSelectableNode<Map.Entry<K,V>>, SqmExpressibleAccessor<Map.Entry<K,V>>, SqmNode, SqmTypedNode<Map.Entry<K,V>>, SqmVisitableNode

public class SqmMapEntryReference<K,V>
extends Object
implements SqmSelectableNode<Map.Entry<K,V>>, Expression<Map.Entry<K,V>>, SqmExpressible<Map.Entry<K,V>>

Represents the reference to a Map attribute's Map.Entry entries in a select clause

Author:

Gunnar Morling, Steve Ebersole

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
SqmMapEntryReference(SqmPath<?> mapPath, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
JpaSelection<Map.Entry<K,V>>	alias(String name)	Assigns an alias to the selection item.
void	appendHqlString(StringBuilder sb)
<X> Expression<X>	as(Class<X> type)	Perform a typecast upon the expression, returning a new expression object.
SqmMapEntryReference<K,V>	copy(SqmCopyContext context)
String	getAlias()	Return the alias assigned to the tuple element or null, if no alias has been assigned.
Class<Map.Entry<K,V>>	getBindableJavaType()	The expected Java type
JavaType<Map.Entry<K,V>>	getExpressibleJavaType()	The Java type descriptor for this expressible
JavaType<Map.Entry<K,V>>	getJavaTypeDescriptor()
SqmPath<?>	getMapPath()
JavaType<Map.Entry<K,V>>	getNodeJavaType()	The Java type descriptor for this node.
SqmExpressible<Map.Entry<K,V>>	getNodeType()
List<? extends JpaSelection<?>>	getSelectionItems()
DomainType<Map.Entry<K,V>>	getSqmType()
Predicate	in(Expression<?>... values)	Create a predicate to test whether the expression is a member of the argument list.
Predicate	in(Expression<Collection<?>> values)	Create a predicate to test whether the expression is a member of the collection.
Predicate	in(Object... values)	Create a predicate to test whether the expression is a member of the argument list.
Predicate	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.
Predicate	isNotNull()	Create a predicate to test whether the expression is not null.
Predicate	isNull()	Create a predicate to test whether the expression is null.
NodeBuilder	nodeBuilder()
void	visitSubSelectableNodes(Consumer<SqmSelectableNode<?>> jpaSelectionConsumer)	Visit each of this selectable's direct sub-selectables - used to support JPA's Selection model (which is really a "selectable", just poorly named and poorly defined

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.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

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

toHqlString

Constructor Details

SqmMapEntryReference

public SqmMapEntryReference(SqmPath<?> mapPath,
 NodeBuilder nodeBuilder)

Method Details

copy

public SqmMapEntryReference<K,V> copy(SqmCopyContext context)

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmSelectableNode<K>

Specified by:

copy in interface SqmTypedNode<K>

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<K>

Returns:

alias

getMapPath

public SqmPath<?> getMapPath()

alias

public JpaSelection<Map.Entry<K,V>> 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<K>

Specified by:

alias in interface Selection<K>

Parameters:

name - alias

Returns:

selection item

getJavaTypeDescriptor

public JavaType<Map.Entry<K,V>> getJavaTypeDescriptor()

Specified by:

getJavaTypeDescriptor in interface JpaTupleElement<K>

getNodeJavaType

public JavaType<Map.Entry<K,V>> getNodeJavaType()

Description copied from interface: SqmTypedNode

The Java type descriptor for this node.

Specified by:

getNodeJavaType in interface SqmExpressibleAccessor<K>

Specified by:

getNodeJavaType in interface SqmTypedNode<K>

getExpressibleJavaType

public JavaType<Map.Entry<K,V>> getExpressibleJavaType()

Description copied from interface: SqmExpressible

The Java type descriptor for this expressible

Specified by:

getExpressibleJavaType in interface SqmExpressible<K>

accept

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

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

visitSubSelectableNodes

public void visitSubSelectableNodes(Consumer<SqmSelectableNode<?>> jpaSelectionConsumer)

Description copied from interface: SqmSelectableNode

Visit each of this selectable's direct sub-selectables - used to support JPA's Selection model (which is really a "selectable", just poorly named and poorly defined

Specified by:

visitSubSelectableNodes in interface SqmSelectableNode<K>

See Also:

• JpaSelection.getSelectionItems()
• Selection.getCompoundSelectionItems()

isCompoundSelection

public boolean isCompoundSelection()

Description copied from interface: Selection

Whether the selection item is a compound selection.

Specified by:

isCompoundSelection in interface Selection<K>

Returns:

boolean indicating whether the selection is a compound selection

getSelectionItems

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

Specified by:

getSelectionItems in interface JpaSelection<K>

getNodeType

public SqmExpressible<Map.Entry<K,V>> getNodeType()

Specified by:

getNodeType in interface SqmTypedNode<K>

getSqmType

public DomainType<Map.Entry<K,V>> getSqmType()

Specified by:

getSqmType in interface SqmExpressible<K>

getBindableJavaType

public Class<Map.Entry<K,V>> getBindableJavaType()

Description copied from interface: BindableType

The expected Java type

Specified by:

getBindableJavaType in interface BindableType<K>

nodeBuilder

public NodeBuilder nodeBuilder()

Specified by:

nodeBuilder in interface SqmNode

appendHqlString

public void appendHqlString(StringBuilder sb)

Specified by:

appendHqlString in interface SqmVisitableNode

isNull

public Predicate isNull()

Description copied from interface: Expression

Create a predicate to test whether the expression is null.

Specified by:

isNull in interface Expression<K>

Returns:

predicate testing whether the expression is null

isNotNull

public Predicate isNotNull()

Description copied from interface: Expression

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

Specified by:

isNotNull in interface Expression<K>

Returns:

predicate testing whether the expression is not null

in

public Predicate 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<K>

Parameters:

values - values to be tested against

Returns:

predicate testing for membership

in

public Predicate 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<K>

Parameters:

values - expressions to be tested against

Returns:

predicate testing for membership

in

public Predicate 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<K>

Parameters:

values - collection of values to be tested against

Returns:

predicate testing for membership

in

public Predicate 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<K>

Parameters:

values - expression corresponding to collection to be tested against

Returns:

predicate testing for membership

as

public <X> Expression<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<K>

Parameters:

type - intended type of the expression

Returns:

new expression of the given type