Package org.hibernate.dialect.pagination

Class OffsetFetchLimitHandler

java.lang.Object

org.hibernate.dialect.pagination.AbstractLimitHandler

org.hibernate.dialect.pagination.OffsetFetchLimitHandler

All Implemented Interfaces:

LimitHandler

Direct Known Subclasses:

DB2LimitHandler, SQLServer2012LimitHandler

public class OffsetFetchLimitHandler
extends AbstractLimitHandler

A LimitHandler for databases which support the ANSI SQL standard syntax FETCH FIRST m ROWS ONLY and OFFSET n ROWS FETCH NEXT m ROWS ONLY.

Field Summary

Fields

Modifier and Type	Field	Description
static final OffsetFetchLimitHandler	INSTANCE

Fields inherited from class org.hibernate.dialect.pagination.AbstractLimitHandler

NO_LIMIT

Constructor Summary

Constructors

Constructor	Description
OffsetFetchLimitHandler(boolean variableLimit)

Method Summary

Modifier and Type	Method	Description
String	processSql(String sql, int jdbcParameterCount, @Nullable ParameterMarkerStrategy parameterMarkerStrategy, QueryOptions queryOptions)	Applies the limit from the QueryOptions to the SQL with the given ParameterMarkerStrategy.
String	processSql(String sql, Limit limit)
boolean	processSqlMutatesState()	Returns whether LimitHandler.processSql(String, int, ParameterMarkerStrategy, QueryOptions) mutates the state of this limit handler and needs to be called for certain other methods to work correctly.
protected boolean	renderOffsetRowsKeyword()
final boolean	supportsLimit()	Does this handler support limiting query results?
boolean	supportsOffset()	Does this handler support offsetting query results without also specifying a limit?
final boolean	supportsVariableLimit()	Does this handler support bind variables (JDBC prepared statement parameters) for its limit/offset?

Methods inherited from class org.hibernate.dialect.pagination.AbstractLimitHandler

bindLimitParameters, bindLimitParametersAtEndOfQuery, bindLimitParametersAtStartOfQuery, bindLimitParametersFirst, bindLimitParametersInReverseOrder, convertToFirstRowValue, forceLimitUsage, getFirstRow, getForUpdatePattern, getMaxOrLimit, hasFirstRow, hasMaxRows, insertAfterDistinct, insertAfterSelect, insertAtEnd, insertBeforeForUpdate, setMaxRows, supportsLimitOffset, useMaxForLimit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.dialect.pagination.LimitHandler

getParameterPositionStart, processSql

Field Details

INSTANCE

public static final OffsetFetchLimitHandler INSTANCE

Constructor Details

OffsetFetchLimitHandler

public OffsetFetchLimitHandler(boolean variableLimit)

Method Details

processSql

public String processSql(String sql,
 int jdbcParameterCount,
 @Nullable ParameterMarkerStrategy parameterMarkerStrategy,
 QueryOptions queryOptions)

Description copied from interface: LimitHandler

Applies the limit from the QueryOptions to the SQL with the given ParameterMarkerStrategy.

processSql

public String processSql(String sql,
 Limit limit)

Specified by:

processSql in interface LimitHandler

Overrides:

processSql in class AbstractLimitHandler

supportsLimit

public final boolean supportsLimit()

Description copied from interface: LimitHandler

Does this handler support limiting query results?

Specified by:

supportsLimit in interface LimitHandler

Overrides:

supportsLimit in class AbstractLimitHandler

Returns:

True if this handler supports limit alone.

supportsOffset

public boolean supportsOffset()

Description copied from interface: LimitHandler

Does this handler support offsetting query results without also specifying a limit?

Specified by:

supportsOffset in interface LimitHandler

Overrides:

supportsOffset in class AbstractLimitHandler

Returns:

True if this handler supports offset alone.

supportsVariableLimit

public final boolean supportsVariableLimit()

Description copied from class: AbstractLimitHandler

Does this handler support bind variables (JDBC prepared statement parameters) for its limit/offset?

Overrides:

supportsVariableLimit in class AbstractLimitHandler

Returns:

true if bind variables can be used

renderOffsetRowsKeyword

protected boolean renderOffsetRowsKeyword()

processSqlMutatesState

public boolean processSqlMutatesState()

Description copied from interface: LimitHandler

Returns whether LimitHandler.processSql(String, int, ParameterMarkerStrategy, QueryOptions) mutates the state of this limit handler and needs to be called for certain other methods to work correctly.