Interface ResultSetMapping

All Superinterfaces:

JdbcValuesMappingProducer

@Incubating(since="8.0")
@SPI({USE,IMPLEMENT,SUPPLY})
public interface ResultSetMapping
extends JdbcValuesMappingProducer

JdbcValuesMappingProducer implementation based on a graph of ResultBuilder and FetchBuilder reference. Used to model result-set mappings from:

• SqlResultSetMapping
• ResultSetMapping
• orm.xml
• mapping.xml
• hbm.xml
• Hibernate-specific APIs:
  • NativeQuery.addScalar(String)
  • NativeQuery.addEntity(String)
  • NativeQuery.addJoin(String, String)
  • NativeQuery.addFetch(String, String, String)
  • NativeQuery.addRoot(String, String)

See Also:

• NativeQuery
• ProcedureCall
• StoredProcedureQuery
• JdbcValuesMappingProducerProvider.buildResultSetMapping(String, boolean, SessionFactoryImplementor)

Method Summary

Modifier and Type	Method	Description
void	addLegacyFetchBuilder(LegacyFetchBuilder fetchBuilder)	Add a legacy fetch builder
void	addResultBuilder(ResultBuilder resultBuilder)	Add a builder
ResultSetMapping	cacheKeyInstance()
String	getMappingIdentifier()	An identifier for the mapping
int	getNumberOfResultBuilders()	The number of result builders currently associated with this mapping
List<ResultBuilder>	getResultBuilders()	The result builders currently associated with this mapping
boolean	isDynamic()	Indicates whether the mapping is dynamic per ResultSetMapping
static ResultSetMapping	resolveResultSetMapping(String name, boolean isDynamic, SessionFactoryImplementor sessionFactory)
static ResultSetMapping	resolveResultSetMapping(String name, SessionFactoryImplementor sessionFactory)
NamedResultSetMappingMemento	toMemento(String name)	Create a memento from this mapping.
void	visitLegacyFetchBuilders(Consumer<LegacyFetchBuilder> resultBuilderConsumer)	Visit the "legacy" fetch builders.
void	visitResultBuilders(BiConsumer<Integer, ResultBuilder> resultBuilderConsumer)	Visit each result builder

Methods inherited from interface JdbcValuesMappingProducer

addAffectedTableNames, resolve

Method Details

getMappingIdentifier

String getMappingIdentifier()

An identifier for the mapping

isDynamic

boolean isDynamic()

Indicates whether the mapping is dynamic per ResultSetMapping

getNumberOfResultBuilders

int getNumberOfResultBuilders()

The number of result builders currently associated with this mapping

getResultBuilders

List<ResultBuilder> getResultBuilders()

The result builders currently associated with this mapping

visitResultBuilders

void visitResultBuilders(BiConsumer<Integer, ResultBuilder> resultBuilderConsumer)

Visit each result builder

visitLegacyFetchBuilders

void visitLegacyFetchBuilders(Consumer<LegacyFetchBuilder> resultBuilderConsumer)

Visit the "legacy" fetch builders.

Historically these mappings in Hibernate were defined such that results and fetches are unaware of each other. So while ResultBuilder encapsulates the fetches (see ResultBuilder.visitFetchBuilders(BiConsumer)), fetches defined in the legacy way are unassociated to their "parent".

addResultBuilder

@SPI(SUPPLY)
void addResultBuilder(ResultBuilder resultBuilder)

Add a builder

See Also:

• ResultBuilder

addLegacyFetchBuilder

@SPI(SUPPLY)
void addLegacyFetchBuilder(LegacyFetchBuilder fetchBuilder)

Add a legacy fetch builder

See Also:

• LegacyFetchBuilder

toMemento

NamedResultSetMappingMemento toMemento(String name)

Create a memento from this mapping.

resolveResultSetMapping

static ResultSetMapping resolveResultSetMapping(String name,
 SessionFactoryImplementor sessionFactory)

resolveResultSetMapping

static ResultSetMapping resolveResultSetMapping(String name,
 boolean isDynamic,
 SessionFactoryImplementor sessionFactory)

cacheKeyInstance

ResultSetMapping cacheKeyInstance()

Specified by:

cacheKeyInstance in interface JdbcValuesMappingProducer