Interface Fetchable

All Superinterfaces:

Bindable, JdbcMappingContainer, MappingModelExpressible, ModelPart

All Known Subinterfaces:

AggregatedIdentifierMapping, Association, AttributeMapping, BasicEntityIdentifierMapping, BasicValuedModelPart, CollectionIdentifierDescriptor, CollectionPart, CompositeIdentifierMapping, DatabaseSnapshotContributor, DiscriminatedAssociationModelPart, DiscriminatorMapping, EmbeddableDiscriminatorMapping, EmbeddableValuedFetchable, EmbeddableValuedModelPart, EntityAssociationMapping, EntityDiscriminatorMapping, EntityIdentifierMapping, EntityRowIdMapping, EntityValuedFetchable, EntityVersionMapping, NonAggregatedIdentifierMapping, PluralAttributeMapping, SingleAttributeIdentifierMapping, SingularAttributeMapping

@Incubating(since="6.0",
            group="result-processing")
@SPI({USE,IMPLEMENT})
public interface Fetchable
extends ModelPart

Parts of the domain model that can be fetched. In other words, a ModelPart which can produce Fetch references.

Nested Class Summary

Nested classes/interfaces inherited from interface Bindable

Bindable.JdbcValuesBiConsumer<X,Y>, Bindable.JdbcValuesConsumer

Nested classes/interfaces inherited from interface ModelPart

ModelPart.JdbcValueBiConsumer<X,Y>, ModelPart.JdbcValueConsumer

Method Summary

Modifier and Type	Method	Description
Fetch	generateFetch(FetchParent fetchParent, NavigablePath fetchablePath, FetchTiming fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState)	Generates a Fetch of this fetchable
int	getFetchableKey()	The key that identifies this Fetchable within a FetchableContainer.
String	getFetchableName()	The name of the fetchable.
FetchOptions	getMappedFetchOptions()	The configured fetch timing and style
default boolean	incrementFetchDepth()	Should this Fetchable affect the fetch depth? E.g., composites would generally not increment the fetch depth.
default boolean	isSelectable()
default Fetch	resolveCircularFetch(NavigablePath fetchablePath, FetchParent fetchParent, FetchTiming fetchTiming, DomainResultCreationState creationState)	Check whether this Fetchable is considered a circular fetch.

Methods inherited from interface Bindable

addToCacheKey, disassemble, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue, getJdbcTypeCount

Methods inherited from interface JdbcMappingContainer

forEachJdbcType, getJdbcMapping, getSingleJdbcMapping

Methods inherited from interface ModelPart

applySqlSelections, applySqlSelections, areEqual, asAttributeMapping, asBasicValuedModelPart, asEntityMappingType, breakDownJdbcValues, breakDownJdbcValues, createDomainResult, decompose, decompose, findContainingEntityMapping, forEachColumn, forEachSelectable, forEachSelectable, getJavaType, getNavigableRole, getPartMappingType, getPartName, hasPartitionedSelectionMapping, isEntityIdentifierMapping, isVirtual

Method Details

getFetchableName

String getFetchableName()

The name of the fetchable. This is the part's "local name".

See Also:

• ModelPart.getNavigableRole()
• NavigableRole.getLocalName()

getFetchableKey

int getFetchableKey()

The key that identifies this Fetchable within a FetchableContainer. If this Fetchable is part of FetchableContainer.visitFetchables(IndexedConsumer, EntityMappingType), the values is guaranteed to be between 0 (inclusive) and FetchableContainer.getNumberOfFetchableKeys() (exclusive). Other Fetchable objects may have a special negative value.

The main intent of this key is to index e.g. Fetch objects in an array.

getMappedFetchOptions

FetchOptions getMappedFetchOptions()

The configured fetch timing and style

resolveCircularFetch

@SPI(SUPPLY)
default Fetch resolveCircularFetch(NavigablePath fetchablePath,
 FetchParent fetchParent,
 FetchTiming fetchTiming,
 DomainResultCreationState creationState)

Check whether this Fetchable is considered a circular fetch.

Parameters:

fetchablePath - The overall path within the graph

Returns:

The Fetch representing the circularity; null indicates the fetch is not circular

generateFetch

@SPI(SUPPLY)
Fetch generateFetch(FetchParent fetchParent,
 NavigablePath fetchablePath,
 FetchTiming fetchTiming,
 boolean selected,
 String resultVariable,
 DomainResultCreationState creationState)

Generates a Fetch of this fetchable

Parameters:

fetchParent - The parent of the Fetch we are generating

fetchablePath - The overall path within the graph

fetchTiming - The requested fetch timing

incrementFetchDepth

default boolean incrementFetchDepth()

Should this Fetchable affect the fetch depth? E.g., composites would generally not increment the fetch depth.

See Also:

• FetchSettings.MAX_FETCH_DEPTH

isSelectable

default boolean isSelectable()