站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > Hibernate 3.2.3 正式版 API 英文文档

JoinWalker (Hibernate API Documentation) - Hibernate 3.2.3 正式版 API 英文文档

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hibernate.loader
Class JoinWalker

java.lang.Object
  extended byorg.hibernate.loader.JoinWalker
Direct Known Subclasses:
AbstractEntityJoinWalker, CollectionJoinWalker
public class JoinWalker
extends Object

Walks the metamodel, searching for joins, and collecting together information needed by OuterJoinLoader.

Author:
Gavin King, Jon Lipsky
See Also:
OuterJoinLoader

Field Summary
protected  String[] aliases
           
protected  List associations
           
protected  int[] collectionOwners
           
protected  CollectionPersister[] collectionPersisters
           
protected  String[] collectionSuffixes
           
protected  LockMode[] lockModeArray
           
protected  EntityType[] ownerAssociationTypes
           
protected  int[] owners
           
protected  Loadable[] persisters
           
protected  String sql
           
protected  String[] suffixes
           
 
Constructor Summary
protected JoinWalker(SessionFactoryImplementor factory, Map enabledFilters)
           
 
Method Summary
protected static int countCollectionPersisters(List associations)
          Count the number of instances of Joinable which are actually also instances of PersistentCollection which are being fetched by outer join
protected static int countEntityPersisters(List associations)
          Count the number of instances of Joinable which are actually also instances of Loadable, or are one-to-many associations
protected  String generateRootAlias(String description)
           
protected  String generateTableAlias(int n, String path, Joinable joinable)
           
 String[] getAliases()
           
 int[] getCollectionOwners()
           
 CollectionPersister[] getCollectionPersisters()
           
 String[] getCollectionSuffixes()
           
protected  Dialect getDialect()
           
protected  Map getEnabledFilters()
           
protected  SessionFactoryImplementor getFactory()
           
protected  int getJoinType(AssociationType type, FetchMode config, String path, String lhsTable, String[] lhsColumns, boolean nullable, int currentDepth, CascadeStyle cascadeStyle)
          Get the join type (inner, outer, etc) or -1 if the association should not be joined.
protected  int getJoinType(boolean nullable, int currentDepth)
          Use an inner join if it is a non-null association and this is the "first" join in a series
 LockMode[] getLockModeArray()
           
 EntityType[] getOwnerAssociationTypes()
           
 int[] getOwners()
           
 Loadable[] getPersisters()
           
 String getSQLString()
           
 String[] getSuffixes()
           
protected  void initPersisters(List associations, LockMode lockMode)
           
protected  boolean isDuplicateAssociation(String foreignKeyTable, String[] foreignKeyColumns)
          Used to detect circularities in the joined graph, note that this method is side-effecty
protected  boolean isDuplicateAssociation(String lhsTable, String[] lhsColumnNames, AssociationType type)
          Used to detect circularities in the joined graph, note that this method is side-effecty
protected  boolean isJoinable(int joinType, Set visitedAssociationKeys, String lhsTable, String[] lhsColumnNames, AssociationType type, int depth)
          Should we join this association?
protected  boolean isJoinedFetchEnabled(AssociationType type, FetchMode config, CascadeStyle cascadeStyle)
          Override on subclasses to enable or suppress joining of certain association types
protected  boolean isJoinedFetchEnabledInMapping(FetchMode config, AssociationType type)
          Does the mapping, and Hibernate default semantics, specify that this association should be fetched by outer joining
protected  boolean isTooDeep(int currentDepth)
           
protected  boolean isTooManyCollections()
           
protected static String mergeOrderings(String ordering1, String ordering2)
           
protected  JoinFragment mergeOuterJoins(List associations)
          Generate a sequence of LEFT OUTER JOIN clauses for the given associations.
protected static String orderBy(List associations)
          Get the order by string required for collection fetching
protected  String orderBy(List associations, String orderBy)
           
protected  String selectString(List associations)
          Generate a select list of columns containing all properties of the entity classes
 void setAliases(String[] aliases)
           
 void setCollectionOwners(int[] collectionOwners)
           
 void setCollectionPersisters(CollectionPersister[] collectionPersisters)
           
 void setCollectionSuffixes(String[] collectionSuffixes)
           
 void setLockModeArray(LockMode[] lockModeArray)
           
 void setOwnerAssociationTypes(EntityType[] ownerAssociationType)
           
 void setOwners(int[] owners)
           
 void setPersisters(Loadable[] persisters)
           
 void setSql(String sql)
           
 void setSuffixes(String[] suffixes)
           
protected  void walkCollectionTree(QueryableCollection persister, String alias)
          For a collection role, return a list of associations to be fetched by outerjoin
protected  void walkEntityTree(OuterJoinLoadable persister, String alias)
          For an entity class, return a list of associations to be fetched by outerjoin
protected  StringBuffer whereString(String alias, String[] columnNames, int batchSize)
          Render the where condition for a (batch) load by identifier / collection key
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

associations

protected final List associations

suffixes

protected String[] suffixes

collectionSuffixes

protected String[] collectionSuffixes

persisters

protected Loadable[] persisters

owners

protected int[] owners

ownerAssociationTypes

protected EntityType[] ownerAssociationTypes

collectionPersisters

protected CollectionPersister[] collectionPersisters

collectionOwners

protected int[] collectionOwners

aliases

protected String[] aliases

lockModeArray

protected LockMode[] lockModeArray

sql

protected String sql
Constructor Detail

JoinWalker

protected JoinWalker(SessionFactoryImplementor factory,
                     Map enabledFilters)
Method Detail

getCollectionSuffixes

public String[] getCollectionSuffixes()

setCollectionSuffixes

public void setCollectionSuffixes(String[] collectionSuffixes)

getLockModeArray

public LockMode[] getLockModeArray()

setLockModeArray

public void setLockModeArray(LockMode[] lockModeArray)

getSuffixes

public String[] getSuffixes()

setSuffixes

public void setSuffixes(String[] suffixes)

getAliases

public String[] getAliases()

setAliases

public void setAliases(String[] aliases)

getCollectionOwners

public int[] getCollectionOwners()

setCollectionOwners

public void setCollectionOwners(int[] collectionOwners)

getCollectionPersisters

public CollectionPersister[] getCollectionPersisters()

setCollectionPersisters

public void setCollectionPersisters(CollectionPersister[] collectionPersisters)

getOwnerAssociationTypes

public EntityType[] getOwnerAssociationTypes()

setOwnerAssociationTypes

public void setOwnerAssociationTypes(EntityType[] ownerAssociationType)

getOwners

public int[] getOwners()

setOwners

public void setOwners(int[] owners)

getPersisters

public Loadable[] getPersisters()

setPersisters

public void setPersisters(Loadable[] persisters)

getSQLString

public String getSQLString()

setSql

public void setSql(String sql)

getFactory

protected SessionFactoryImplementor getFactory()

getDialect

protected Dialect getDialect()

getEnabledFilters

protected Map getEnabledFilters()

walkEntityTree

protected final void walkEntityTree(OuterJoinLoadable persister,
                                    String alias)
                             throws MappingException
For an entity class, return a list of associations to be fetched by outerjoin

Throws:
MappingException

walkCollectionTree

protected final void walkCollectionTree(QueryableCollection persister,
                                        String alias)
                                 throws MappingException
For a collection role, return a list of associations to be fetched by outerjoin

Throws:
MappingException

getJoinType

protected int getJoinType(AssociationType type,
                          FetchMode config,
                          String path,
                          String lhsTable,
                          String[] lhsColumns,
                          boolean nullable,
                          int currentDepth,
                          CascadeStyle cascadeStyle)
                   throws MappingException
Get the join type (inner, outer, etc) or -1 if the association should not be joined. Override on subclasses.

Throws:
MappingException

getJoinType

protected int getJoinType(boolean nullable,
                          int currentDepth)
Use an inner join if it is a non-null association and this is the "first" join in a series

isTooDeep

protected boolean isTooDeep(int currentDepth)

isTooManyCollections

protected boolean isTooManyCollections()

isJoinedFetchEnabledInMapping

protected boolean isJoinedFetchEnabledInMapping(FetchMode config,
                                                AssociationType type)
                                         throws MappingException
Does the mapping, and Hibernate default semantics, specify that this association should be fetched by outer joining

Throws:
MappingException

isJoinedFetchEnabled

protected boolean isJoinedFetchEnabled(AssociationType type,
                                       FetchMode config,
                                       CascadeStyle cascadeStyle)
Override on subclasses to enable or suppress joining of certain association types

generateTableAlias

protected String generateTableAlias(int n,
                                    String path,
                                    Joinable joinable)

generateRootAlias

protected String generateRootAlias(String description)

isDuplicateAssociation

protected boolean isDuplicateAssociation(String foreignKeyTable,
                                         String[] foreignKeyColumns)
Used to detect circularities in the joined graph, note that this method is side-effecty

isDuplicateAssociation

protected boolean isDuplicateAssociation(String lhsTable,
                                         String[] lhsColumnNames,
                                         AssociationType type)
Used to detect circularities in the joined graph, note that this method is side-effecty

isJoinable

protected boolean isJoinable(int joinType,
                             Set visitedAssociationKeys,
                             String lhsTable,
                             String[] lhsColumnNames,
                             AssociationType type,
                             int depth)
Should we join this association?

orderBy

protected String orderBy(List associations,
                         String orderBy)

mergeOrderings

protected static String mergeOrderings(String ordering1,
                                       String ordering2)

mergeOuterJoins

protected final JoinFragment mergeOuterJoins(List associations)
                                      throws MappingException
Generate a sequence of LEFT OUTER JOIN clauses for the given associations.

Throws:
MappingException

countEntityPersisters

protected static final int countEntityPersisters(List associations)
                                          throws MappingException
Count the number of instances of Joinable which are actually also instances of Loadable, or are one-to-many associations

Throws:
MappingException

countCollectionPersisters

protected static final int countCollectionPersisters(List associations)
                                              throws MappingException
Count the number of instances of Joinable which are actually also instances of PersistentCollection which are being fetched by outer join

Throws:
MappingException

orderBy

protected static final String orderBy(List associations)
                               throws MappingException
Get the order by string required for collection fetching

Throws:
MappingException

whereString

protected StringBuffer whereString(String alias,
                                   String[] columnNames,
                                   int batchSize)
Render the where condition for a (batch) load by identifier / collection key

initPersisters

protected void initPersisters(List associations,
                              LockMode lockMode)
                       throws MappingException
Throws:
MappingException

selectString

protected final String selectString(List associations)
                             throws MappingException
Generate a select list of columns containing all properties of the entity classes

Throws:
MappingException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD