SingleEntityQueryRendererDelegate (Hibernate HQL/JP-QL Parent 1.3.0.Alpha2 API)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class SingleEntityQueryRendererDelegate.Status
States which this object can have during tree walking

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`SingleEntityQueryRendererDelegate.Status` States which this object can have during tree walking

Field Summary

Fields
Modifier and Type	Field and Description
`protected AggregationPropertyPath.Type`	`aggregationType`
`protected String`	`alias`
`protected Map<String,String>`	`aliasToEntityType` Persister space: keep track of aliases and entity names.
`protected Map<String,PropertyPath>`	`aliasToPropertyPath`
`protected SingleEntityQueryBuilder<Q>`	`builder`
`protected List<String>`	`projections`
`protected PropertyPath`	`propertyPath`
`protected static String`	`SORT_ASC_SPEC`
`protected SingleEntityQueryRendererDelegate.Status`	`status` The current status
`protected Class<?>`	`targetType`
`protected String`	`targetTypeName`

Constructor Summary

Constructors
Constructor and Description
`SingleEntityQueryRendererDelegate(PropertyHelper propertyHelper, EntityNamesResolver entityNames, SingleEntityQueryBuilder<Q> builder, Map<String,Object> namedParameters)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activateAggregation(AggregationPropertyPath.Type aggregationType)`
`void`	`activateAND()`
`void`	`activateNOT()`
`void`	`activateOR()`
`protected void`	`addGrouping(PropertyPath propertyPath, String collateName)` Add 'group by' criteria.
`protected void`	`addSortField(PropertyPath propertyPath, String collateName, boolean isAscending)` Add field sort criteria.
`void`	`aliasNotFound(String alias)` What to do when a mentioned alias is not found.
`void`	`deactivateAggregation()`
`void`	`deactivateBoolean()`
`protected SingleEntityHavingQueryBuilder<?>`	`getHavingBuilder()` Return the optional HAVING clause builder.
`abstract R`	`getResult()` Returns the result created by this delegate after the tree processing has been finished.
`void`	`groupingValue(String collateName)`
`boolean`	`isPersisterReferenceAlias()`
`boolean`	`isUnqualifiedPropertyReference()`
`void`	`popStrategy()`
`void`	`predicateBetween(String lower, String upper)`
`void`	`predicateEquals(String comparativePredicate)` This implements the equality predicate; the comparison predicate could be a constant, a subfunction or some random type parameter.
`void`	`predicateGreater(String comparativePredicate)`
`void`	`predicateGreaterOrEqual(String comparativePredicate)`
`void`	`predicateIn(List<String> list)`
`void`	`predicateIsNull()`
`void`	`predicateLess(String comparativePredicate)`
`void`	`predicateLessOrEqual(String comparativePredicate)`
`void`	`predicateLike(String patternValue, Character escapeCharacter)`
`void`	`predicateNotEquals(String comparativePredicate)`
`void`	`pushFromStrategy(JoinType joinType, org.antlr.runtime.tree.Tree assosiationFetchTree, org.antlr.runtime.tree.Tree propertyFetchTree, org.antlr.runtime.tree.Tree alias)`
`void`	`pushGroupByStrategy()`
`void`	`pushHavingStrategy()`
`void`	`pushOrderByStrategy()`
`void`	`pushSelectStrategy()`
`void`	`pushWhereStrategy()`
`void`	`registerEmbeddedAlias(String alias, PropertyPath propertyPath)`
`void`	`registerJoinAlias(org.antlr.runtime.tree.Tree alias, PropertyPath path)`
`void`	`registerPersisterSpace(org.antlr.runtime.tree.Tree entityName, org.antlr.runtime.tree.Tree alias)` See rule entityName
`protected List<String>`	`resolveAlias(PropertyPath path)`
`void`	`setPropertyReferencePath(PropertyPath propertyPath)`
`void`	`sortSpecification(String collateName, String orderSpec)` Sets the sort direction, either "asc" or "desc", for the current property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.hql.ast.spi.QueryRendererDelegate
setPropertyPath

- Field Detail
  - SORT_ASC_SPEC
```
protected static final String SORT_ASC_SPEC
```
    See Also:
    
    Constant Field Values
  - status
```
protected SingleEntityQueryRendererDelegate.Status status
```
    The current status
  - targetTypeName
```
protected String targetTypeName
```
  - targetType
```
protected Class<?> targetType
```
  - propertyPath
```
protected PropertyPath propertyPath
```
  - aggregationType
```
protected AggregationPropertyPath.Type aggregationType
```
  - builder
```
protected final SingleEntityQueryBuilder<Q> builder
```
  - projections
```
protected final List<String> projections
```
  - aliasToEntityType
```
protected final Map<String,String> aliasToEntityType
```
    Persister space: keep track of aliases and entity names.
  - aliasToPropertyPath
```
protected final Map<String,PropertyPath> aliasToPropertyPath
```
  - alias
```
protected String alias
```
- Constructor Detail
  - SingleEntityQueryRendererDelegate
```
public SingleEntityQueryRendererDelegate(PropertyHelper propertyHelper,
                                         EntityNamesResolver entityNames,
                                         SingleEntityQueryBuilder<Q> builder,
                                         Map<String,Object> namedParameters)
```
- Method Detail
  - getHavingBuilder
```
protected SingleEntityHavingQueryBuilder<?> getHavingBuilder()
```
    Return the optional HAVING clause builder. To be overridden by subclasses that wish to support the HAVING clause.
  - registerPersisterSpace
```
public void registerPersisterSpace(org.antlr.runtime.tree.Tree entityName,
                                   org.antlr.runtime.tree.Tree alias)
```
    See rule entityName
    
    Specified by:
    
    registerPersisterSpace in interface QueryRendererDelegate<R>
  - registerEmbeddedAlias
```
public void registerEmbeddedAlias(String alias,
                                  PropertyPath propertyPath)
```
  - isUnqualifiedPropertyReference
```
public boolean isUnqualifiedPropertyReference()
```
    Specified by:
    
    isUnqualifiedPropertyReference in interface QueryRendererDelegate<R>
  - isPersisterReferenceAlias
```
public boolean isPersisterReferenceAlias()
```
    Specified by:
    
    isPersisterReferenceAlias in interface QueryRendererDelegate<R>
  - pushFromStrategy
```
public void pushFromStrategy(JoinType joinType,
                             org.antlr.runtime.tree.Tree assosiationFetchTree,
                             org.antlr.runtime.tree.Tree propertyFetchTree,
                             org.antlr.runtime.tree.Tree alias)
```
    Specified by:
    
    pushFromStrategy in interface QueryRendererDelegate<R>
  - pushSelectStrategy
```
public void pushSelectStrategy()
```
    Specified by:
    
    pushSelectStrategy in interface QueryRendererDelegate<R>
  - pushWhereStrategy
```
public void pushWhereStrategy()
```
    Specified by:
    
    pushWhereStrategy in interface QueryRendererDelegate<R>
  - pushGroupByStrategy
```
public void pushGroupByStrategy()
```
    Specified by:
    
    pushGroupByStrategy in interface QueryRendererDelegate<R>
  - pushHavingStrategy
```
public void pushHavingStrategy()
```
    Specified by:
    
    pushHavingStrategy in interface QueryRendererDelegate<R>
  - pushOrderByStrategy
```
public void pushOrderByStrategy()
```
    Specified by:
    
    pushOrderByStrategy in interface QueryRendererDelegate<R>
  - popStrategy
```
public void popStrategy()
```
    Specified by:
    
    popStrategy in interface QueryRendererDelegate<R>
  - activateOR
```
public void activateOR()
```
    Specified by:
    
    activateOR in interface QueryRendererDelegate<R>
  - activateAND
```
public void activateAND()
```
    Specified by:
    
    activateAND in interface QueryRendererDelegate<R>
  - activateNOT
```
public void activateNOT()
```
    Specified by:
    
    activateNOT in interface QueryRendererDelegate<R>
  - predicateLess
```
public void predicateLess(String comparativePredicate)
```
    Specified by:
    
    predicateLess in interface QueryRendererDelegate<R>
  - predicateLessOrEqual
```
public void predicateLessOrEqual(String comparativePredicate)
```
    Specified by:
    
    predicateLessOrEqual in interface QueryRendererDelegate<R>
  - predicateEquals
```
public void predicateEquals(String comparativePredicate)
```
    This implements the equality predicate; the comparison predicate could be a constant, a subfunction or some random type parameter. The tree node has all details but with current tree rendering it just passes it's text so we have to figure out the options again.
    
    Specified by:
    
    predicateEquals in interface QueryRendererDelegate<R>
  - predicateNotEquals
```
public void predicateNotEquals(String comparativePredicate)
```
    Specified by:
    
    predicateNotEquals in interface QueryRendererDelegate<R>
  - predicateGreaterOrEqual
```
public void predicateGreaterOrEqual(String comparativePredicate)
```
    Specified by:
    
    predicateGreaterOrEqual in interface QueryRendererDelegate<R>
  - predicateGreater
```
public void predicateGreater(String comparativePredicate)
```
    Specified by:
    
    predicateGreater in interface QueryRendererDelegate<R>
  - predicateIn
```
public void predicateIn(List<String> list)
```
    Specified by:
    
    predicateIn in interface QueryRendererDelegate<R>
  - predicateBetween
```
public void predicateBetween(String lower,
                             String upper)
```
    Specified by:
    
    predicateBetween in interface QueryRendererDelegate<R>
  - predicateLike
```
public void predicateLike(String patternValue,
                          Character escapeCharacter)
```
    Specified by:
    
    predicateLike in interface QueryRendererDelegate<R>
  - predicateIsNull
```
public void predicateIsNull()
```
    Specified by:
    
    predicateIsNull in interface QueryRendererDelegate<R>
  - setPropertyReferencePath
```
public void setPropertyReferencePath(PropertyPath propertyPath)
```
    Specified by:
    
    setPropertyReferencePath in interface QueryRendererDelegate<R>
  - activateAggregation
```
public void activateAggregation(AggregationPropertyPath.Type aggregationType)
```
    Specified by:
    
    activateAggregation in interface QueryRendererDelegate<R>
  - deactivateAggregation
```
public void deactivateAggregation()
```
    Specified by:
    
    deactivateAggregation in interface QueryRendererDelegate<R>
  - sortSpecification
```
public void sortSpecification(String collateName,
                              String orderSpec)
```
    Description copied from interface: QueryRendererDelegate
    
    Sets the sort direction, either "asc" or "desc", for the current property. The property was already specified by QueryRendererDelegate.setPropertyPath(PropertyPath)
    
    Specified by:
    
    sortSpecification in interface QueryRendererDelegate<R>
    
    Parameters:
    
    collateName - optional collation name
    
    orderSpec - a string with possible values "asc" or "desc"
  - groupingValue
```
public void groupingValue(String collateName)
```
    Specified by:
    
    groupingValue in interface QueryRendererDelegate<R>
    
    Parameters:
    
    collateName - optional collation name
  - addSortField
```
protected void addSortField(PropertyPath propertyPath,
                            String collateName,
                            boolean isAscending)
```
    Add field sort criteria. To be overridden by subclasses.
    
    Parameters:
    
    propertyPath - the path of the field being sorted
    
    collateName - optional collation name
    
    isAscending - sort direction
  - addGrouping
```
protected void addGrouping(PropertyPath propertyPath,
                           String collateName)
```
    Add 'group by' criteria. To be overridden by subclasses.
    
    Parameters:
    
    propertyPath - the path of the field used for grouping
    
    collateName - optional collation name
  - deactivateBoolean
```
public void deactivateBoolean()
```
    Specified by:
    
    deactivateBoolean in interface QueryRendererDelegate<R>
  - getResult
```
public abstract R getResult()
```
    Description copied from interface: QueryRendererDelegate
    
    Returns the result created by this delegate after the tree processing has been finished.
    
    Specified by:
    
    getResult in interface QueryRendererDelegate<R>
    
    Returns:
    
    the result created by this delegate after the tree processing has been finished
  - resolveAlias
```
protected List<String> resolveAlias(PropertyPath path)
```
  - registerJoinAlias
```
public void registerJoinAlias(org.antlr.runtime.tree.Tree alias,
                              PropertyPath path)
```
    Specified by:
    
    registerJoinAlias in interface QueryRendererDelegate<R>
  - aliasNotFound
```
public void aliasNotFound(String alias)
```
    What to do when a mentioned alias is not found. An example usage is to throw a custom exception.
    
    Parameters:
    
    alias - the name of the alias which wasn't recognised

Class SingleEntityQueryRendererDelegate<Q,R>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hibernate.hql.ast.spi.QueryRendererDelegate

Field Detail

SORT_ASC_SPEC

status

targetTypeName

targetType

propertyPath

aggregationType

builder

projections

aliasToEntityType

aliasToPropertyPath

alias

Constructor Detail

SingleEntityQueryRendererDelegate

Method Detail

getHavingBuilder

registerPersisterSpace

registerEmbeddedAlias

isUnqualifiedPropertyReference

isPersisterReferenceAlias

pushFromStrategy

pushSelectStrategy

pushWhereStrategy

pushGroupByStrategy

pushHavingStrategy

pushOrderByStrategy

popStrategy

activateOR

activateAND

activateNOT

predicateLess

predicateLessOrEqual

predicateEquals

predicateNotEquals

predicateGreaterOrEqual

predicateGreater

predicateIn

predicateBetween

predicateLike

predicateIsNull

setPropertyReferencePath

activateAggregation

deactivateAggregation

sortSpecification

groupingValue

addSortField

addGrouping

deactivateBoolean

getResult

resolveAlias

registerJoinAlias

aliasNotFound