Class AbstractSimpleLimitHandler

java.lang.Object

org.hibernate.dialect.pagination.spi.AbstractLimitHandler

org.hibernate.dialect.pagination.spi.AbstractSimpleLimitHandler

All Implemented Interfaces:

LimitHandler

Direct Known Subclasses:

LimitLimitHandler, LimitOffsetLimitHandler

@SPI({USE,IMPLEMENT})
public abstract class AbstractSimpleLimitHandler
extends AbstractLimitHandler

Superclass for simple LimitHandlers that don't support specifying an offset without a limit.

Since:

8.0

Field Summary

Fields inherited from class AbstractLimitHandler

NO_LIMIT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSimpleLimitHandler()

Method Summary

Modifier and Type	Method	Description
protected String	insert(String limitClause, String sql)
protected abstract String	limitClause(boolean hasFirstRow, PaginationRequest request)
protected String	offsetOnlyClause(PaginationRequest request)
PaginationResult	processSql(PaginationRequest request)	Apply pagination to a complete SQL string.
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

Constructor Details

AbstractSimpleLimitHandler

@SPI(IMPLEMENT)
protected AbstractSimpleLimitHandler()

Method Details

limitClause

@SPI(IMPLEMENT)
protected abstract String limitClause(boolean hasFirstRow,
 PaginationRequest request)

offsetOnlyClause

@SPI(IMPLEMENT)
protected String offsetOnlyClause(PaginationRequest request)

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

insert

@SPI(IMPLEMENT)
protected String insert(String limitClause,
 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.

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

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.