Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.engine.spi.EffectiveEntityGraph

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, applyConfiguredGraph and clear

Field Summary

Modifier and Type	Field and Description
private final boolean	allowOverwrite
private RootGraphImplementor<?>	graph
private static final Logger	log
private GraphSemantic	semantic

Constructor Summary

Access	Constructor and Description
public	EffectiveEntityGraph()
public	EffectiveEntityGraph(boolean allowOverwrite)

Method Summary

Modifier and Type	Method and Description
public void	applyConfiguredGraph(Map<String, ?> properties) Apply a graph and semantic based on configuration properties or hints based on `GraphSemantic#getJpaHintName()` for `GraphSemantic#LOAD` or `GraphSemantic#FETCH`.
public void	applyGraph(RootGraphImplementor<?> graph, GraphSemantic semantic) Apply the graph and semantic.
public void	clear()
public RootGraphImplementor<?>	getGraph() Implements org.hibernate.graph.spi.AppliedGraph.getGraph. The applied graph
public GraphSemantic	getSemantic() Implements org.hibernate.graph.spi.AppliedGraph.getSemantic. The semantic (fetch/load) under which the graph should be applied
private void	verifyWriteability()

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

Field Detail

allowOverwrite	back to summary
private final boolean allowOverwrite

graph	back to summary
private RootGraphImplementor<?> graph

log	back to summary
private static final Logger log

semantic	back to summary
private GraphSemantic semantic

Constructor Detail

EffectiveEntityGraph back to summary

EffectiveEntityGraph	back to summary
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 Annotations @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

Annotations

@Incubating

EffectiveEntityGraph	back to summary
public EffectiveEntityGraph(boolean allowOverwrite) Implementation Specification See `EffectiveEntityGraph` Annotations @Incubating @SuppressWarnings:WeakerAccess

Method Detail

applyConfiguredGraph back to summary

applyConfiguredGraph	back to summary
public void applyConfiguredGraph(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. Exceptions IllegalArgumentException: If both kinds of graphs were present in the properties/hints IllegalStateException: If previous state is still available (hasn't been cleared).

public void applyConfiguredGraph(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.

Exceptions

IllegalArgumentException:: If both kinds of graphs were present in the properties/hints
IllegalStateException:: If previous state is still available (hasn't been cleared).

applyGraph	back to summary
public void applyGraph(RootGraphImplementor<?> graph, GraphSemantic semantic) Apply the graph and semantic. The semantic is required. The graph may be null, but that should generally be considered mis-use. Exceptions IllegalArgumentException: Thrown if the semantic is null IllegalStateException: If previous state is still available (hasn't been cleared).

applyGraph

back to summary

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

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

Exceptions

IllegalArgumentException:: Thrown if the semantic is null
IllegalStateException:: If previous state is still available (hasn't been cleared).

clear	back to summary
public void clear()

getGraph	back to summary
public RootGraphImplementor<?> getGraph() Implements org.hibernate.graph.spi.AppliedGraph.getGraph. Doc from org.hibernate.graph.spi.AppliedGraph.getGraph. The applied graph Annotations @Override

getGraph

back to summary

public RootGraphImplementor<?> getGraph()

Implements org.hibernate.graph.spi.AppliedGraph.getGraph.

Doc from org.hibernate.graph.spi.AppliedGraph.getGraph.

The applied graph

Annotations

@Override

getSemantic	back to summary
public GraphSemantic getSemantic() Implements org.hibernate.graph.spi.AppliedGraph.getSemantic. Doc from org.hibernate.graph.spi.AppliedGraph.getSemantic. The semantic (fetch/load) under which the graph should be applied Annotations @Override

getSemantic

back to summary

public GraphSemantic getSemantic()

Implements org.hibernate.graph.spi.AppliedGraph.getSemantic.

Doc from org.hibernate.graph.spi.AppliedGraph.getSemantic.

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

Annotations

@Override

verifyWriteability	back to summary
private void verifyWriteability()

public Class EffectiveEntityGraph

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail