Modifier and Type	Class and Description
public static class	JoinSequence.Join Represents a join
public static interface	JoinSequence.Selector A subclass join selector

Modifier and Type	Field and Description
private final boolean	collectionJoinSubquery
private final StringBuilder	conditions
private final SessionFactoryImplementor	factory Deprecated as a consequence of `SessionFactoryImplementor` being deprecated.
private boolean	isFromPart
private final List<JoinSequence.Join>	joins
private JoinSequence	next
private Set<String>	queryReferencedTables
private String	rootAlias
private Joinable	rootJoinable
private JoinSequence.Selector	selector
private Set<String>	treatAsDeclarations
private boolean	useThetaStyle

Access	Constructor and Description
public	JoinSequence(SessionFactoryImplementor The SessionFactory factory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. Constructs a JoinSequence

Method Summary

Modifier and Type	Method and Description
public JoinSequence	Returns: `this`, for method chaining addCondition(String The condition condition) Add a condition to this sequence.
public JoinSequence	Returns: `this`, for method chaining addCondition(String The alias to apply to the columns alias, String[] The columns to add checks for columns, String The conditions to check against the columns condition) Add a condition to this sequence.
public JoinSequence	Returns: The Join memento addJoin(AssociationType The type of the association representing the join associationType, String The RHS alias for the join alias, JoinType The type of join (INNER, etc) joinType, String[] The LHS columns for the join condition referencingKey) Add a join to this sequence
public JoinSequence	Returns: The Join memento addJoin(AssociationType The type of the association representing the join associationType, String The RHS alias for the join alias, JoinType The type of join (INNER, etc) joinType, String[][] The LHS columns for the join condition referencingKeys) Add a join to this sequence
public JoinSequence	Returns: The Join memento addJoin(ImpliedFromElement The implied from element to embed fromElement) Deprecated as a consequence of `ImpliedFromElement` being deprecated. Embeds an implied from element into this sequence
private void	addSubclassJoins(JoinFragment joinFragment, String alias, Joinable joinable, boolean innerJoin, boolean includeSubclassJoins, Set<String> treatAsDeclarations)
public void	applyTreatAsDeclarations(Set<String> treatAsDeclarations)
public JoinSequence	Returns: The copy copy() Create a full, although shallow, copy.
public JoinSequence	copyForCollectionProperty()
public JoinSequence.Join	getFirstJoin()
public JoinSequence	Returns: The JoinSequence that represents just the FROM clause parts getFromPart() Retrieve a JoinSequence that represents just the FROM clause parts
protected Set<String>	getTreatAsDeclarations()
private boolean	isAliasDereferenced(String withClauseFragment, String alias)
protected boolean	isIncluded(String alias)
private boolean	isManyToManyRoot(Joinable joinable)
private boolean	isSubclassAliasDereferenced(JoinSequence.Join join, String withClauseFragment)
public boolean	isThetaStyle()
private boolean	needsTableGroupJoin(List<JoinSequence.Join> joins, String withClauseFragment)
public JoinSequence	Returns: `this`, for method chaining setNext(JoinSequence The next JoinSequence in the directed graph next) Sets the next join sequence
public void	setQueryReferencedTables(Set<String> queryReferencedTables) Set all tables the query refers to.
public JoinSequence	Returns: `this`, for method chaining setRoot(Joinable The entity/collection that is the root of this JoinSequence joinable, String The alias associated with that joinable. alias) Set the root of this JoinSequence.
public JoinSequence	Returns: `this`, for method chaining setSelector(JoinSequence.Selector The selector to apply selector) Set the Selector to use to determine how subclass joins should be applied.
public JoinSequence	Returns: `this`, for method chaining setUseThetaStyle(boolean `true` indicates that theta-style joins should be used. useThetaStyle) Should this JoinSequence use theta-style joining (both a FROM and WHERE component) in the rendered SQL?
public JoinFragment	Returns: The JoinFragment toJoinFragment() Generate a JoinFragment
public JoinFragment	Returns: The JoinFragment toJoinFragment(Map<K, V> The filters associated with the originating session to properly define join conditions enabledFilters, boolean Should all subclass joins be added to the rendered JoinFragment? includeAllSubclassJoins) Generate a JoinFragment
public JoinFragment	Returns: The JoinFragment toJoinFragment(Map<K, V> The filters associated with the originating session to properly define join conditions enabledFilters, boolean Should all subclass joins be added to the rendered JoinFragment? includeAllSubclassJoins, String The with clause (which represents additional join restrictions) fragment withClauseFragment) Generate a JoinFragment
public JoinFragment	toJoinFragment(Map<K, V> enabledFilters, boolean includeAllSubclassJoins, boolean renderSubclassJoins, String withClauseFragment)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

collectionJoinSubquery	back to summary
private final boolean collectionJoinSubquery

conditions	back to summary
private final StringBuilder conditions

factory	back to summary
private final SessionFactoryImplementor factory Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information.

isFromPart	back to summary
private boolean isFromPart

joins	back to summary
private final List<JoinSequence.Join> joins

next	back to summary
private JoinSequence next

queryReferencedTables	back to summary
private Set<String> queryReferencedTables

rootAlias	back to summary
private String rootAlias

rootJoinable	back to summary
private Joinable rootJoinable

selector	back to summary
private JoinSequence.Selector selector

treatAsDeclarations	back to summary
private Set<String> treatAsDeclarations

useThetaStyle	back to summary
private boolean useThetaStyle

Constructor Detail

JoinSequence back to summary

JoinSequence	back to summary
public JoinSequence(SessionFactoryImplementor factory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information. Constructs a JoinSequence Parameters factory:SessionFactoryImplementor The SessionFactory

public JoinSequence(SessionFactoryImplementor factory)

Deprecated

as a consequence of SessionFactoryImplementor being deprecated. See corresponding docs for further information.

Constructs a JoinSequence

Parameters

factory:SessionFactoryImplementor: The SessionFactory

Method Detail

addCondition back to summary

addCondition	back to summary
public JoinSequence addCondition(String condition) Add a condition to this sequence. Parameters condition:String The condition Returns:JoinSequence `this`, for method chaining

public JoinSequence addCondition(String condition)

Add a condition to this sequence.

Parameters

condition:String: The condition

Returns:JoinSequence

this, for method chaining

addCondition back to summary

addCondition	back to summary
public JoinSequence addCondition(String alias, String[] columns, String condition) Add a condition to this sequence. Typical usage here might be: addCondition( "a", {"c1", "c2"}, "?" ) to represent: "... a.c1 = ? and a.c2 = ? ..." Parameters alias:String The alias to apply to the columns columns:String[] The columns to add checks for condition:String The conditions to check against the columns Returns:JoinSequence `this`, for method chaining

public JoinSequence addCondition(String alias, String[] columns, String condition)

Add a condition to this sequence. Typical usage here might be:

    addCondition( "a", {"c1", "c2"}, "?" )

to represent:

    "... a.c1 = ? and a.c2 = ? ..."

Parameters

alias:String: The alias to apply to the columns
columns:String[]: The columns to add checks for
condition:String: The conditions to check against the columns

Returns:JoinSequence

this, for method chaining

addJoin back to summary

addJoin	back to summary
public JoinSequence addJoin(AssociationType associationType, String alias, JoinType joinType, String[] referencingKey) throws MappingException Add a join to this sequence Parameters associationType:AssociationType The type of the association representing the join alias:String The RHS alias for the join joinType:JoinType The type of join (INNER, etc) referencingKey:String[] The LHS columns for the join condition Returns:JoinSequence The Join memento Exceptions MappingException: Generally indicates a problem resolving the associationType to a `Joinable`

public JoinSequence addJoin(AssociationType associationType, String alias, JoinType joinType, String[] referencingKey) throws MappingException

Add a join to this sequence

Parameters

associationType:AssociationType: The type of the association representing the join
alias:String: The RHS alias for the join
joinType:JoinType: The type of join (INNER, etc)
referencingKey:String[]: The LHS columns for the join condition

Returns:JoinSequence

The Join memento

Exceptions

MappingException:: Generally indicates a problem resolving the associationType to a Joinable

addJoin back to summary

addJoin	back to summary
public JoinSequence addJoin(AssociationType associationType, String alias, JoinType joinType, String[][] referencingKeys) throws MappingException Add a join to this sequence Parameters associationType:AssociationType The type of the association representing the join alias:String The RHS alias for the join joinType:JoinType The type of join (INNER, etc) referencingKeys:String[][] The LHS columns for the join condition Returns:JoinSequence The Join memento Exceptions MappingException: Generally indicates a problem resolving the associationType to a `Joinable`

public JoinSequence addJoin(AssociationType associationType, String alias, JoinType joinType, String[][] referencingKeys) throws MappingException

Add a join to this sequence

Parameters

associationType:AssociationType: The type of the association representing the join
alias:String: The RHS alias for the join
joinType:JoinType: The type of join (INNER, etc)
referencingKeys:String[][]: The LHS columns for the join condition

Returns:JoinSequence

The Join memento

Exceptions

MappingException:: Generally indicates a problem resolving the associationType to a Joinable

addJoin back to summary

addJoin	back to summary
public JoinSequence addJoin(ImpliedFromElement fromElement) Deprecated as a consequence of `ImpliedFromElement` being deprecated. See corresponding docs for further information. Embeds an implied from element into this sequence Parameters fromElement:ImpliedFromElement The implied from element to embed Returns:JoinSequence The Join memento

public JoinSequence addJoin(ImpliedFromElement fromElement)

Deprecated

as a consequence of ImpliedFromElement being deprecated. See corresponding docs for further information.

Embeds an implied from element into this sequence

Parameters

fromElement:ImpliedFromElement: The implied from element to embed

Returns:JoinSequence

The Join memento

addSubclassJoins	back to summary
private void addSubclassJoins(JoinFragment joinFragment, String alias, Joinable joinable, boolean innerJoin, boolean includeSubclassJoins, Set<String> treatAsDeclarations)

applyTreatAsDeclarations	back to summary
public void applyTreatAsDeclarations(Set<String> treatAsDeclarations)

copy	back to summary
public JoinSequence copy() Create a full, although shallow, copy. Returns:JoinSequence The copy

copy

back to summary

public JoinSequence copy()

Create a full, although shallow, copy.

Returns:JoinSequence: The copy

copyForCollectionProperty	back to summary
public JoinSequence copyForCollectionProperty()

getFirstJoin	back to summary
public JoinSequence.Join getFirstJoin()

getFromPart	back to summary
public JoinSequence getFromPart() Retrieve a JoinSequence that represents just the FROM clause parts Returns:JoinSequence The JoinSequence that represents just the FROM clause parts

getFromPart

back to summary

public JoinSequence getFromPart()

Retrieve a JoinSequence that represents just the FROM clause parts

Returns:JoinSequence: The JoinSequence that represents just the FROM clause parts

getTreatAsDeclarations	back to summary
protected Set<String> getTreatAsDeclarations()

isAliasDereferenced	back to summary
private boolean isAliasDereferenced(String withClauseFragment, String alias)

isIncluded	back to summary
protected boolean isIncluded(String alias)

isManyToManyRoot	back to summary
private boolean isManyToManyRoot(Joinable joinable) Annotations @SuppressWarnings:SimplifiableIfStatement

isSubclassAliasDereferenced	back to summary
private boolean isSubclassAliasDereferenced(JoinSequence.Join join, String withClauseFragment)

isThetaStyle	back to summary
public boolean isThetaStyle()

needsTableGroupJoin	back to summary
private boolean needsTableGroupJoin(List<JoinSequence.Join> joins, String withClauseFragment)

setNext back to summary

setNext	back to summary
public JoinSequence setNext(JoinSequence next) Sets the next join sequence Parameters next:JoinSequence The next JoinSequence in the directed graph Returns:JoinSequence `this`, for method chaining

public JoinSequence setNext(JoinSequence next)

Sets the next join sequence

Parameters

next:JoinSequence: The next JoinSequence in the directed graph

Returns:JoinSequence

this, for method chaining

setQueryReferencedTables	back to summary
public void setQueryReferencedTables(Set<String> queryReferencedTables) Set all tables the query refers to. It allows to optimize the query.

setRoot back to summary

setRoot	back to summary
public JoinSequence setRoot(Joinable joinable, String alias) Set the root of this JoinSequence. In SQL terms, this would be the driving table. Parameters joinable:Joinable The entity/collection that is the root of this JoinSequence alias:String The alias associated with that joinable. Returns:JoinSequence `this`, for method chaining

public JoinSequence setRoot(Joinable joinable, String alias)

Set the root of this JoinSequence. In SQL terms, this would be the driving table.

Parameters

joinable:Joinable: The entity/collection that is the root of this JoinSequence
alias:String: The alias associated with that joinable.

Returns:JoinSequence

this, for method chaining

setSelector back to summary

setSelector	back to summary
public JoinSequence setSelector(JoinSequence.Selector selector) Set the Selector to use to determine how subclass joins should be applied. Parameters selector:JoinSequence.Selector The selector to apply Returns:JoinSequence `this`, for method chaining

public JoinSequence setSelector(JoinSequence.Selector selector)

Set the Selector to use to determine how subclass joins should be applied.

Parameters

selector:JoinSequence.Selector: The selector to apply

Returns:JoinSequence

this, for method chaining

setUseThetaStyle back to summary

setUseThetaStyle	back to summary
public JoinSequence setUseThetaStyle(boolean useThetaStyle) Should this JoinSequence use theta-style joining (both a FROM and WHERE component) in the rendered SQL? Parameters useThetaStyle:boolean `true` indicates that theta-style joins should be used. Returns:JoinSequence `this`, for method chaining

public JoinSequence setUseThetaStyle(boolean useThetaStyle)

Should this JoinSequence use theta-style joining (both a FROM and WHERE component) in the rendered SQL?

Parameters

useThetaStyle:boolean: true indicates that theta-style joins should be used.

Returns:JoinSequence

this, for method chaining

toJoinFragment	back to summary
public JoinFragment toJoinFragment() throws MappingException Generate a JoinFragment Returns:JoinFragment The JoinFragment Exceptions MappingException: Indicates a problem access the provided metadata, or incorrect metadata

toJoinFragment

back to summary

public JoinFragment toJoinFragment() throws MappingException

Generate a JoinFragment

Returns:JoinFragment

The JoinFragment

Exceptions

MappingException:: Indicates a problem access the provided metadata, or incorrect metadata

toJoinFragment	back to summary
public JoinFragment toJoinFragment(Map<K, V> enabledFilters, boolean includeAllSubclassJoins) throws MappingException Generate a JoinFragment Parameters enabledFilters:Map<K, V> The filters associated with the originating session to properly define join conditions includeAllSubclassJoins:boolean Should all subclass joins be added to the rendered JoinFragment? Returns:JoinFragment The JoinFragment Exceptions MappingException: Indicates a problem access the provided metadata, or incorrect metadata

toJoinFragment

back to summary

public JoinFragment toJoinFragment(Map<K, V> enabledFilters, boolean includeAllSubclassJoins) throws MappingException

Generate a JoinFragment

Parameters

enabledFilters:Map<K, V>: The filters associated with the originating session to properly define join conditions
includeAllSubclassJoins:boolean: Should all subclass joins be added to the rendered JoinFragment?

Returns:JoinFragment

The JoinFragment

Exceptions

MappingException:: Indicates a problem access the provided metadata, or incorrect metadata

toJoinFragment	back to summary
public JoinFragment toJoinFragment(Map<K, V> enabledFilters, boolean includeAllSubclassJoins, String withClauseFragment) throws MappingException Generate a JoinFragment Parameters enabledFilters:Map<K, V> The filters associated with the originating session to properly define join conditions includeAllSubclassJoins:boolean Should all subclass joins be added to the rendered JoinFragment? withClauseFragment:String The with clause (which represents additional join restrictions) fragment Returns:JoinFragment The JoinFragment Exceptions MappingException: Indicates a problem access the provided metadata, or incorrect metadata

toJoinFragment

back to summary

public JoinFragment toJoinFragment(Map<K, V> enabledFilters, boolean includeAllSubclassJoins, String withClauseFragment) throws MappingException

Generate a JoinFragment

Parameters

enabledFilters:Map<K, V>: The filters associated with the originating session to properly define join conditions
includeAllSubclassJoins:boolean: Should all subclass joins be added to the rendered JoinFragment?
withClauseFragment:String: The with clause (which represents additional join restrictions) fragment

Returns:JoinFragment

The JoinFragment

Exceptions

MappingException:: Indicates a problem access the provided metadata, or incorrect metadata

toJoinFragment	back to summary
public JoinFragment toJoinFragment(Map<K, V> enabledFilters, boolean includeAllSubclassJoins, boolean renderSubclassJoins, String withClauseFragment) throws MappingException

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.hibernate.engine.internal back to summary

public final Class JoinSequence.Join

Class Inheritance

extends Object

java.lang.Object
org.hibernate.engine.internal.JoinSequence.Join

Represents a join

Field Summary

Modifier and Type	Field and Description
private final String	alias
private final AssociationType	associationType
private final Joinable	joinable
private final JoinType	joinType
private final String[][]	lhsColumns

Constructor Summary

Access	Constructor and Description
pack-priv	Join(SessionFactoryImplementor factory, AssociationType associationType, String alias, JoinType joinType, String[][] lhsColumns) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated.

Method Summary

Modifier and Type	Method and Description
public String	getAlias()
public AssociationType	getAssociationType()
public Joinable	getJoinable()
public JoinType	getJoinType()
public String[][]	getLHSColumns()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

alias	back to summary
private final String alias

associationType	back to summary
private final AssociationType associationType

joinable	back to summary
private final Joinable joinable

joinType	back to summary
private final JoinType joinType

lhsColumns	back to summary
private final String[][] lhsColumns

Constructor Detail

Join	back to summary
pack-priv Join(SessionFactoryImplementor factory, AssociationType associationType, String alias, JoinType joinType, String[][] lhsColumns) throws MappingException Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information.

Method Detail

getAlias	back to summary
public String getAlias()

getAssociationType	back to summary
public AssociationType getAssociationType()

getJoinable	back to summary
public Joinable getJoinable()

getJoinType	back to summary
public JoinType getJoinType()

getLHSColumns	back to summary
public String[][] getLHSColumns()

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Class JoinSequence

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class JoinSequence.Join

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface JoinSequence.Selector

Method Summary

Method Detail