Class AbstractNoOffsetLimitHandler

java.lang.Object

org.hibernate.dialect.pagination.spi.AbstractLimitHandler

org.hibernate.dialect.pagination.spi.AbstractNoOffsetLimitHandler

All Implemented Interfaces:

LimitHandler

Direct Known Subclasses:

FetchLimitHandler, TopLimitHandler

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

Superclass for LimitHandlers that don't support offsets at all.

Since:

8.0

Field Summary

Fields inherited from class AbstractLimitHandler

NO_LIMIT

Constructor Summary

Constructors

Constructor	Description
AbstractNoOffsetLimitHandler(boolean variableLimit)

Method Summary

Modifier and Type	Method	Description
abstract boolean	bindLimitParametersFirst()	Does the offset/limit clause come at the start of the SELECT statement, or at the end of the query?
protected abstract String	insert(String limitClause, String sql)
protected abstract String	limitClause(PaginationRequest request)
PaginationResult	processSql(PaginationRequest request)	Apply pagination to a complete SQL string.
final boolean	supportsLimit()	Does this handler support limiting query results?
final boolean	supportsLimitOffset()	Does this handler support combinations of limit and offset?
final boolean	supportsVariableLimit()	Does this handler support bind variables (JDBC prepared statement parameters) for its limit/offset?

Methods inherited from class AbstractLimitHandler

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

Methods inherited from class Object

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

Constructor Details

AbstractNoOffsetLimitHandler

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

Method Details

limitClause

@SPI(IMPLEMENT)
protected abstract String limitClause(PaginationRequest request)

insert

@SPI(IMPLEMENT)
protected abstract String insert(String limitClause,
 String sql)

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

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.

supportsLimitOffset

public final boolean supportsLimitOffset()

Description copied from interface: LimitHandler

Does this handler support combinations of limit and offset?

Specified by:

supportsLimitOffset in interface LimitHandler

Overrides:

supportsLimitOffset in class AbstractLimitHandler

Returns:

True if the handler supports an offset within the limit support.

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

bindLimitParametersFirst

@SPI(IMPLEMENT)
public abstract boolean bindLimitParametersFirst()

Description copied from class: AbstractLimitHandler

Does the offset/limit clause come at the start of the SELECT statement, or at the end of the query?

Overrides:

bindLimitParametersFirst in class AbstractLimitHandler

Returns:

true if limit parameters come before other parameters