Class OffsetFetchLimitHandler

java.lang.Object

org.hibernate.dialect.pagination.spi.AbstractLimitHandler

org.hibernate.dialect.pagination.spi.OffsetFetchLimitHandler

All Implemented Interfaces:

LimitHandler

Direct Known Subclasses:

DB2LimitHandler, SQLServer2012LimitHandler

@SPI({USE,IMPLEMENT})
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.

Since:

8.0

Field Summary

Fields

Modifier and Type	Field	Description
static final OffsetFetchLimitHandler	INSTANCE

Fields inherited from class AbstractLimitHandler

NO_LIMIT

Constructor Summary

Constructors

Constructor	Description
OffsetFetchLimitHandler(boolean variableLimit)

Method Summary

Modifier and Type	Method	Description
protected void	begin(String sql, StringBuilder offsetFetch, boolean hasFirstRow, boolean hasMaxRows)
protected String	insert(String offsetFetch, String sql)
PaginationResult	processSql(PaginationRequest request)	Apply pagination to a complete SQL string.
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 AbstractLimitHandler

bindLimitParametersFirst, bindLimitParametersInReverseOrder, bindLimitParameterValues, convertToFirstRowValue, forceLimitUsage, getFirstRow, getForUpdatePattern, getMaxOrLimit, hasFirstRow, hasMaxRows, insertAfterDistinct, insertAfterSelect, insertAtEnd, insertBeforeForUpdate, jdbcInstructions, jdbcMaxRows, parameterPositionStart, result, rowsToSkip, supportsLimitOffset, useMaxForLimit

Methods inherited from class Object

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

Field Details

INSTANCE

public static final OffsetFetchLimitHandler INSTANCE

Constructor Details

OffsetFetchLimitHandler

@SPI({USE,IMPLEMENT})
public OffsetFetchLimitHandler(boolean variableLimit)

Method Details

processSql

public PaginationResult processSql(PaginationRequest request)

Description copied from interface: LimitHandler

Apply pagination to a complete SQL string.

Return PaginationResult.unchanged(String) when the request needs no SQL or JDBC pagination. The returned JDBC instructions must describe every pagination parameter introduced by the rewritten SQL.

Specified by:

processSql in interface LimitHandler

Overrides:

processSql in class AbstractLimitHandler

Parameters:

request - immutable completed-SQL pagination input

Returns:

rewritten SQL and the JDBC work needed to execute it

begin

@SPI(IMPLEMENT)
protected void begin(String sql,
 StringBuilder offsetFetch,
 boolean hasFirstRow,
 boolean hasMaxRows)

insert

@SPI(IMPLEMENT)
protected String insert(String offsetFetch,
 String sql)

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

@SPI(IMPLEMENT)
protected boolean renderOffsetRowsKeyword()