## org.hibernate.ejb.criteria.path
Class CollectionAttributeJoin<O,E>

    java.lang.Object
      org.hibernate.ejb.criteria.AbstractNode
          org.hibernate.ejb.criteria.expression.AbstractTupleElement<X>
              org.hibernate.ejb.criteria.expression.SelectionImpl<T>
                  org.hibernate.ejb.criteria.expression.ExpressionImpl<X>
                      org.hibernate.ejb.criteria.path.AbstractPathImpl<X>
                          org.hibernate.ejb.criteria.path.AbstractFromImpl<Z,X>
                              org.hibernate.ejb.criteria.path.AbstractJoinImpl<O,E>
                                  org.hibernate.ejb.criteria.path.PluralAttributeJoinSupport<O,Collection<E>,E>
                                      org.hibernate.ejb.criteria.path.CollectionAttributeJoin<O,E>

All Implemented Interfaces:
  Serializable, javax.persistence.criteria.CollectionJoin<O,E>, javax.persistence.criteria.Expression<E>, javax.persistence.criteria.Fetch<O,E>, javax.persistence.criteria.FetchParent<O,E>, javax.persistence.criteria.From<O,E>, javax.persistence.criteria.Join<O,E>, javax.persistence.criteria.Path<E>, javax.persistence.criteria.PluralJoin<O,Collection<E>,E>, javax.persistence.criteria.Selection<E>, TupleElement<E>, CollectionJoinImplementor<O,E>, ExpressionImplementor<E>, FromImplementor<O,E>, JoinImplementor<O,E>, ParameterContainer, PathImplementor<E>, PathSource<E>, Renderable, SelectionImplementor<E>, TupleElementImplementor<E>

    public class CollectionAttributeJoin<O,E>

extends PluralAttributeJoinSupport<O,Collection<E>,E>
implements CollectionJoinImplementor<O,E>, Serializable

TODO : javadoc

Author:
  Steve Ebersole
See Also:
  Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.ejb.criteria.path.AbstractFromImpl
`AbstractFromImpl.BasicJoinScope, AbstractFromImpl.CorrelationJoinScope, AbstractFromImpl.JoinScope<X>`

Nested classes/interfaces inherited from interface org.hibernate.ejb.criteria.ParameterContainer
`ParameterContainer.Helper`

Field Summary

Fields inherited from class org.hibernate.ejb.criteria.path.AbstractFromImpl
`DEFAULT_JOIN_TYPE`

Constructor Summary
`CollectionAttributeJoin(CriteriaBuilderImpl criteriaBuilder, Class<E> javaType, PathSource<O> pathSource, javax.persistence.metamodel.CollectionAttribute<? super O,E> joinAttribute, javax.persistence.criteria.JoinType joinType)`

Method Summary
`CollectionAttributeJoin<O,E>` `correlateTo(CriteriaSubqueryImpl subquery)`
`protected FromImplementor<O,E>` `createCorrelationDelegate()`
`javax.persistence.metamodel.CollectionAttribute<? super O,E>` `getAttribute()` Retrieve reference to the attribute this path represents.
`javax.persistence.metamodel.CollectionAttribute<? super O,E>` `getModel()`

Methods inherited from class org.hibernate.ejb.criteria.path.PluralAttributeJoinSupport
`canBeDereferenced, canBeJoinSource, isBasicCollection, locateManagedType`

Methods inherited from class org.hibernate.ejb.criteria.path.AbstractJoinImpl
`getJoinType, getParent, renderTableExpression`

Methods inherited from class org.hibernate.ejb.criteria.path.AbstractFromImpl

`canBeFetchSource, fetch, fetch, fetch, fetch, fetch, fetch, getAlias, getCorrelationParent, getFetches, getJoins, getPathIdentifier, getPathSource, isCorrelated, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet, locateAttributeInternal, prepareAlias, prepareCorrelationDelegate, render, renderProjection`

Methods inherited from class org.hibernate.ejb.criteria.path.AbstractPathImpl
`get, get, get, get, getParentPath, illegalDereference, locateAttribute, registerAttributePath, registerParameters, resolveCachedAttributePath, type, unknownAttribute`

Methods inherited from class org.hibernate.ejb.criteria.expression.ExpressionImpl
`as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, in, in, in, in, isNotNull, isNull`

Methods inherited from class org.hibernate.ejb.criteria.expression.SelectionImpl
`alias, getCompoundSelectionItems, getValueHandlers, isCompoundSelection`

Methods inherited from class org.hibernate.ejb.criteria.expression.AbstractTupleElement
`forceConversion, getJavaType, getValueHandler, resetJavaType, setAlias`

Methods inherited from class org.hibernate.ejb.criteria.AbstractNode
`criteriaBuilder`

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

Methods inherited from interface javax.persistence.criteria.Fetch
`getJoinType, getParent`

Methods inherited from interface org.hibernate.ejb.criteria.FromImplementor
`getCorrelationParent, prepareAlias, prepareCorrelationDelegate, renderTableExpression`

Methods inherited from interface org.hibernate.ejb.criteria.ExpressionImplementor
`asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString`

Methods inherited from interface org.hibernate.ejb.criteria.SelectionImplementor
`getValueHandlers`

Methods inherited from interface org.hibernate.ejb.criteria.TupleElementImplementor
`getValueHandler`

Methods inherited from interface org.hibernate.ejb.criteria.Renderable
`render, renderProjection`

Methods inherited from interface org.hibernate.ejb.criteria.PathSource
`getPathIdentifier`

Methods inherited from interface javax.persistence.criteria.Join
`getJoinType, getParent`

Methods inherited from interface javax.persistence.criteria.From
`getJoins, isCorrelated, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet`

Methods inherited from interface javax.persistence.criteria.FetchParent
`fetch, fetch, fetch, fetch, fetch, fetch, getFetches`

Constructor Detail

### CollectionAttributeJoin

    public CollectionAttributeJoin(CriteriaBuilderImpl criteriaBuilder,
                                   Class<E> javaType,
                                   PathSource<O> pathSource,
                                   javax.persistence.metamodel.CollectionAttribute<? super O,E> joinAttribute,
                                   javax.persistence.criteria.JoinType joinType)

Method Detail

### correlateTo

    public final CollectionAttributeJoin<O,E> correlateTo(CriteriaSubqueryImpl subquery)

  Description copied from class: `AbstractFromImpl`

  Specified by:
    `correlateTo` in interface `CollectionJoinImplementor<O,E>`
  Specified by:
    `correlateTo` in interface `FromImplementor<O,E>`
  Specified by:
    `correlateTo` in interface `JoinImplementor<O,E>`
  Overrides:
    `correlateTo` in class `AbstractJoinImpl<O,E>`

### getAttribute

    public javax.persistence.metamodel.CollectionAttribute<? super O,E> getAttribute()

  Description copied from class: `AbstractJoinImpl`
  Retrieve reference to the attribute this path represents.

  Specified by:
    `getAttribute` in interface `javax.persistence.criteria.Fetch<O,E>`
  Specified by:
    `getAttribute` in interface `javax.persistence.criteria.Join<O,E>`
  Specified by:
    `getAttribute` in interface `PathImplementor<E>`
  Overrides:
    `getAttribute` in class `PluralAttributeJoinSupport<O,Collection<E>,E>`
  Returns:
    The metamodel attribute.

### getModel

    public javax.persistence.metamodel.CollectionAttribute<? super O,E> getModel()

  Specified by:
    `getModel` in interface `javax.persistence.criteria.CollectionJoin<O,E>`
  Specified by:
    `getModel` in interface `javax.persistence.criteria.Path<E>`
  Specified by:
    `getModel` in interface `javax.persistence.criteria.PluralJoin<O,Collection<E>,E>`
  Overrides:
    `getModel` in class `PluralAttributeJoinSupport<O,Collection<E>,E>`

### createCorrelationDelegate

    protected FromImplementor<O,E> createCorrelationDelegate()

  Specified by:
    `createCorrelationDelegate` in class `AbstractFromImpl<O,E>`

Copyright © 2001-2010 Red Hat, Inc. All Rights Reserved.