Package org.hibernate.persister.entity

Interface Joinable

All Known Subinterfaces:

OuterJoinLoadable, Queryable, QueryableCollection, SQLLoadableCollection

All Known Implementing Classes:

AbstractCollectionPersister, AbstractEntityPersister, BasicCollectionPersister, JoinedSubclassEntityPersister, OneToManyPersister, SingleTableEntityPersister, UnionSubclassEntityPersister

public interface Joinable

Anything that can be loaded by outer join - namely persisters for classes or collections.

Method Summary

Modifier and Type	Method	Description
boolean	consumesCollectionAlias()	Very, very, very ugly...
boolean	consumesEntityAlias()	Very, very, very ugly...
java.lang.String	filterFragment(java.lang.String alias, java.util.Map enabledFilters)	Get the where clause filter, given a query alias and considering enabled session filters
java.lang.String	filterFragment(java.lang.String alias, java.util.Map enabledFilters, java.util.Set<java.lang.String> treatAsDeclarations)	Get the where clause filter, given a query alias and considering enabled session filters
java.lang.String	fromJoinFragment(java.lang.String alias, boolean innerJoin, boolean includeSubclasses)	Get the from clause part of any joins (optional operation)
java.lang.String	fromJoinFragment(java.lang.String alias, boolean innerJoin, boolean includeSubclasses, java.util.Set<java.lang.String> treatAsDeclarations)	Get the from clause part of any joins (optional operation)
default java.lang.String	fromJoinFragment(java.lang.String alias, boolean innerJoin, boolean includeSubclasses, java.util.Set<java.lang.String> treatAsDeclarations, java.util.Set<java.lang.String> referencedTables)	Get the from clause part of any joins (optional operation)
java.lang.String[]	getKeyColumnNames()	The columns to join on
java.lang.String	getName()	An identifying name; a class name or collection role name.
java.lang.String	getTableName()	The table to join to.
boolean	isCollection()	Is this instance actually a CollectionPersister?
java.lang.String	oneToManyFilterFragment(java.lang.String alias)
java.lang.String	oneToManyFilterFragment(java.lang.String alias, java.util.Set<java.lang.String> treatAsDeclarations)
java.lang.String	selectFragment(Joinable rhs, java.lang.String rhsAlias, java.lang.String lhsAlias, java.lang.String currentEntitySuffix, java.lang.String currentCollectionSuffix, boolean includeCollectionColumns)	All columns to select, when loading.
java.lang.String	whereJoinFragment(java.lang.String alias, boolean innerJoin, boolean includeSubclasses)	Get the where clause part of any joins (optional operation)
java.lang.String	whereJoinFragment(java.lang.String alias, boolean innerJoin, boolean includeSubclasses, java.util.Set<java.lang.String> treatAsDeclarations)	Get the where clause part of any joins (optional operation)

Method Detail

getName

java.lang.String getName()

An identifying name; a class name or collection role name.

getTableName

java.lang.String getTableName()

The table to join to.

selectFragment

java.lang.String selectFragment(Joinable rhs,
                                java.lang.String rhsAlias,
                                java.lang.String lhsAlias,
                                java.lang.String currentEntitySuffix,
                                java.lang.String currentCollectionSuffix,
                                boolean includeCollectionColumns)

All columns to select, when loading.

whereJoinFragment

java.lang.String whereJoinFragment(java.lang.String alias,
                                   boolean innerJoin,
                                   boolean includeSubclasses)

Get the where clause part of any joins (optional operation)

whereJoinFragment

java.lang.String whereJoinFragment(java.lang.String alias,
                                   boolean innerJoin,
                                   boolean includeSubclasses,
                                   java.util.Set<java.lang.String> treatAsDeclarations)

Get the where clause part of any joins (optional operation)

fromJoinFragment

java.lang.String fromJoinFragment(java.lang.String alias,
                                  boolean innerJoin,
                                  boolean includeSubclasses)

Get the from clause part of any joins (optional operation)

fromJoinFragment

java.lang.String fromJoinFragment(java.lang.String alias,
                                  boolean innerJoin,
                                  boolean includeSubclasses,
                                  java.util.Set<java.lang.String> treatAsDeclarations)

Get the from clause part of any joins (optional operation)

fromJoinFragment

default java.lang.String fromJoinFragment(java.lang.String alias,
                                          boolean innerJoin,
                                          boolean includeSubclasses,
                                          java.util.Set<java.lang.String> treatAsDeclarations,
                                          java.util.Set<java.lang.String> referencedTables)

Get the from clause part of any joins (optional operation)

getKeyColumnNames

java.lang.String[] getKeyColumnNames()

The columns to join on

filterFragment

java.lang.String filterFragment(java.lang.String alias,
                                java.util.Map enabledFilters)
                         throws MappingException

Get the where clause filter, given a query alias and considering enabled session filters

Throws:

MappingException

filterFragment

java.lang.String filterFragment(java.lang.String alias,
                                java.util.Map enabledFilters,
                                java.util.Set<java.lang.String> treatAsDeclarations)
                         throws MappingException

Get the where clause filter, given a query alias and considering enabled session filters

Throws:

MappingException

oneToManyFilterFragment

java.lang.String oneToManyFilterFragment(java.lang.String alias)
                                  throws MappingException

Throws:

MappingException

oneToManyFilterFragment

java.lang.String oneToManyFilterFragment(java.lang.String alias,
                                         java.util.Set<java.lang.String> treatAsDeclarations)

isCollection

boolean isCollection()

Is this instance actually a CollectionPersister?

consumesEntityAlias

boolean consumesEntityAlias()

Very, very, very ugly...

Returns:

Does this persister "consume" entity column aliases in the result set?

consumesCollectionAlias

boolean consumesCollectionAlias()

Very, very, very ugly...

Returns:

Does this persister "consume" collection column aliases in the result set?