Package org.hibernate.engine.spi

Class EffectiveEntityGraph

java.lang.Object

org.hibernate.engine.spi.EffectiveEntityGraph

All Implemented Interfaces:

Serializable, AppliedGraph

public class EffectiveEntityGraph
extends Object
implements AppliedGraph, Serializable

Think of this as the composite modeling of a graph and the semantic. Its graph and semantic can be obtained by getGraph() and getSemantic() They can be managed by calls to applyGraph(org.hibernate.graph.spi.RootGraphImplementor<?>, org.hibernate.graph.GraphSemantic), applyConfiguredGraph(java.util.Map<java.lang.String, ?>) and clear()

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
EffectiveEntityGraph()
EffectiveEntityGraph(boolean allowOverwrite)

Method Summary

Modifier and Type	Method	Description
void	applyConfiguredGraph(@Nullable Map<String,?> properties)	Apply a graph and semantic based on configuration properties or hints based on GraphSemantic.getJpaHintName() for GraphSemantic.LOAD or GraphSemantic.FETCH.
void	applyGraph(RootGraphImplementor<?> graph, @Nullable GraphSemantic semantic)	Apply the graph and semantic.
void	clear()
@Nullable RootGraphImplementor<?>	getGraph()	The applied graph
@Nullable GraphSemantic	getSemantic()	The semantic (fetch/load) under which the graph should be applied

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EffectiveEntityGraph

@Incubating
public EffectiveEntityGraph()

Implementation Specification:

I explicitly made this constructor package protected because we may need to pass in the SessionFactory or JpaCompliance etc to be able to know what to do in applyConfiguredGraph(Map) when the incoming properties contain both a GraphSemantic.FETCH and a GraphSemantic.LOAD. In other words, we may need to add some constructor argument here so we want to control what can call it

EffectiveEntityGraph

@Incubating
public EffectiveEntityGraph(boolean allowOverwrite)

Implementation Specification:

See EffectiveEntityGraph(boolean)

Method Detail

getSemantic

public @Nullable GraphSemantic getSemantic()

Description copied from interface: AppliedGraph

The semantic (fetch/load) under which the graph should be applied

Specified by:

getSemantic in interface AppliedGraph

getGraph

public @Nullable RootGraphImplementor<?> getGraph()

Description copied from interface: AppliedGraph

The applied graph

Specified by:

getGraph in interface AppliedGraph

applyGraph

public void applyGraph(RootGraphImplementor<?> graph,
                       @Nullable GraphSemantic semantic)

Apply the graph and semantic. The semantic is required. The graph may be null, but that should generally be considered mis-use.

Throws:

IllegalArgumentException - Thrown if the semantic is null

IllegalStateException - If previous state is still available (hasn't been cleared).

applyConfiguredGraph

public void applyConfiguredGraph(@Nullable Map<String,?> properties)

Apply a graph and semantic based on configuration properties or hints based on GraphSemantic.getJpaHintName() for GraphSemantic.LOAD or GraphSemantic.FETCH. The semantic is required. The graph may be null, but that should generally be considered mis-use.

Throws:

IllegalArgumentException - If both kinds of graphs were present in the properties/hints

IllegalStateException - If previous state is still available (hasn't been cleared).

clear

public void clear()