Top Description Inners Methods
org.hibernate.query.sql.spi

public Interface NamedNativeQueryMemento

extends NamedQueryMemento
Known Direct Implementers
org.hibernate.query.sql.internal.NamedNativeQueryMementoImpl
Imports
java.util.Set, jakarta.persistence.SqlResultSetMapping, org.hibernate.boot.query.NamedNativeQueryDefinition, org.hibernate.boot.registry.classloading.spi.ClassLoaderService, org.hibernate.engine.spi.SessionFactoryImplementor, .SharedSessionContractImplementor, org.hibernate.query.named.AbstractNamedQueryMemento, .NamedQueryMemento, org.hibernate.query.sql.internal.NamedNativeQueryMementoImpl
Descriptor for a named native query in the runtime environment
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NamedNativeQueryMemento.Builder

Delegate used in creating named HQL query mementos.

Method Summary

Modifier and TypeMethod and Description
public Integer
getFirstResult()

public Integer
getMaxResults()

public default String
getOriginalSqlString()

public Set<String>
getQuerySpaces()

The affected query spaces.

public Class<?>
getResultMappingClass()

An implicit entity mapping by entity class

public String
getResultMappingName()

An explicit ResultSet mapping by name

public String
getSqlString()

Informational access to the SQL query string

public NamedNativeQueryMemento
makeCopy(String name)

Redeclares org.hibernate.query.named.NamedQueryMemento.makeCopy.

Makes a copy of the memento using the specified registration name
public <T> NativeQueryImplementor<T>
toQuery(SharedSessionContractImplementor session)

Redeclares org.hibernate.query.named.NamedQueryMemento.toQuery.

Convert the memento into an untyped executable query
public <T> NativeQueryImplementor<T>
toQuery(SharedSessionContractImplementor session, Class<T> resultType)

Redeclares org.hibernate.query.named.NamedQueryMemento.toQuery.

Convert the memento into a typed executable query
public <T> NativeQueryImplementor<T>
toQuery(SharedSessionContractImplementor session, String resultSetMapping)

Convert the memento into a typed executable query

Inherited from org.hibernate.query.named.NamedQueryMemento:
getCacheablegetCacheModegetCacheRegiongetCommentgetFetchSizegetFlushModegetHintsgetReadOnlygetRegistrationNamegetTimeoutvalidate

Method Detail

getFirstResultback to summary
public Integer getFirstResult()
getMaxResultsback to summary
public Integer getMaxResults()
getOriginalSqlStringback to summary
public default String getOriginalSqlString()
getQuerySpacesback to summary
public Set<String> getQuerySpaces()

The affected query spaces.

getResultMappingClassback to summary
public Class<?> getResultMappingClass()

An implicit entity mapping by entity class

getResultMappingNameback to summary
public String getResultMappingName()

An explicit ResultSet mapping by name

See Also
SqlResultSetMapping#name
getSqlStringback to summary
public String getSqlString()

Informational access to the SQL query string

makeCopyback to summary
public NamedNativeQueryMemento makeCopy(String name)

Redeclares org.hibernate.query.named.NamedQueryMemento.makeCopy.

Doc from org.hibernate.query.named.NamedQueryMemento.makeCopy.

Makes a copy of the memento using the specified registration name

Annotations
@Override
toQueryback to summary
public <T> NativeQueryImplementor<T> toQuery(SharedSessionContractImplementor session)

Redeclares org.hibernate.query.named.NamedQueryMemento.toQuery.

Convert the memento into an untyped executable query

Annotations
@Override
toQueryback to summary
public <T> NativeQueryImplementor<T> toQuery(SharedSessionContractImplementor session, Class<T> resultType)

Redeclares org.hibernate.query.named.NamedQueryMemento.toQuery.

Convert the memento into a typed executable query

Annotations
@Override
toQueryback to summary
public <T> NativeQueryImplementor<T> toQuery(SharedSessionContractImplementor session, String resultSetMapping)

Convert the memento into a typed executable query

org.hibernate.query.sql.spi back to summary

public Class NamedNativeQueryMemento.Builder

extends AbstractNamedQueryMemento.AbstractBuilder<NamedNativeQueryMemento.Builder>
Class Inheritance
Delegate used in creating named HQL query mementos.
See Also
NamedNativeQueryDefinition

Field Summary

Modifier and TypeField and Description
protected Integer
firstResult

protected Integer
maxResults

protected Set<String>
querySpaces

Hides org.hibernate.query.named.AbstractNamedQueryMemento.AbstractBuilder.querySpaces.

protected String
queryString

protected String
resultSetMappingClassName

protected String
resultSetMappingName

Inherited from org.hibernate.query.named.AbstractNamedQueryMemento.AbstractBuilder:
cacheablecacheModecacheRegioncommentfetchSizeflushModehintsnamereadOnlytimeout

Constructor Summary

AccessConstructor and Description
public
Builder(String name)

Method Summary

Modifier and TypeMethod and Description
public NamedNativeQueryMemento
build(SessionFactoryImplementor sessionFactory)

Deprecated as a consequence of SessionFactoryImplementor being deprecated.
protected NamedNativeQueryMemento.Builder
getThis()

Implements abstract org.hibernate.query.named.AbstractNamedQueryMemento.AbstractBuilder.getThis.

public NamedNativeQueryMemento.Builder
setCacheable(boolean cacheable)

public NamedNativeQueryMemento.Builder
setFirstResult(Integer firstResult)

public NamedNativeQueryMemento.Builder
setMaxResults(Integer maxResults)

public NamedNativeQueryMemento.Builder
setQuery(String queryString)

public void
setQuerySpaces(Set<String> querySpaces)

public void
setResultSetMappingClassName(String resultSetMappingClassName)

public void
setResultSetMappingName(String resultSetMappingName)

Inherited from org.hibernate.query.named.AbstractNamedQueryMemento.AbstractBuilder:
addHintaddQuerySpaceaddQuerySpacesgetCacheablegetCacheModegetCacheRegiongetCommentgetFetchSizegetFlushModegetNamegetQuerySpacesgetReadOnlygetTimeoutsetCacheablesetCacheModesetCacheRegionsetCommentsetFetchSizesetFlushModesetReadOnlysetReadOnlysetTimeout

Field Detail

firstResultback to summary
protected Integer firstResult
maxResultsback to summary
protected Integer maxResults
querySpacesback to summary
protected Set<String> querySpaces

Hides org.hibernate.query.named.AbstractNamedQueryMemento.AbstractBuilder.querySpaces.

queryStringback to summary
protected String queryString
resultSetMappingClassNameback to summary
protected String resultSetMappingClassName
resultSetMappingNameback to summary
protected String resultSetMappingName

Constructor Detail

Builderback to summary
public Builder(String name)

Method Detail

buildback to summary
public NamedNativeQueryMemento build(SessionFactoryImplementor sessionFactory)

Deprecated

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

getThisback to summary
protected NamedNativeQueryMemento.Builder getThis()

Implements abstract org.hibernate.query.named.AbstractNamedQueryMemento.AbstractBuilder.getThis.

Annotations
@Override
setCacheableback to summary
public NamedNativeQueryMemento.Builder setCacheable(boolean cacheable)
setFirstResultback to summary
public NamedNativeQueryMemento.Builder setFirstResult(Integer firstResult)
setMaxResultsback to summary
public NamedNativeQueryMemento.Builder setMaxResults(Integer maxResults)
setQueryback to summary
public NamedNativeQueryMemento.Builder setQuery(String queryString)
setQuerySpacesback to summary
public void setQuerySpaces(Set<String> querySpaces)
setResultSetMappingClassNameback to summary
public void setResultSetMappingClassName(String resultSetMappingClassName)
setResultSetMappingNameback to summary
public void setResultSetMappingName(String resultSetMappingName)