org.hibernate.dialect.pagination

Class AbstractLimitHandler

java.lang.Object

org.hibernate.dialect.pagination.AbstractLimitHandler

All Implemented Interfaces:

LimitHandler

Direct Known Subclasses:

CUBRIDLimitHandler, FirstLimitHandler, LegacyLimitHandler, NoopLimitHandler, SQL2008StandardLimitHandler, SQLServer2005LimitHandler, TopLimitHandler

public abstract class AbstractLimitHandler
extends Object
implements LimitHandler

Default implementation of LimitHandler interface.

Author:

Lukasz Antoniak (lukasz dot antoniak at gmail dot com)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLimitHandler()

Method Summary

Modifier and Type	Method and Description
protected int	bindLimitParameters(RowSelection selection, PreparedStatement statement, int index) Default implementation of binding parameter values needed by the LIMIT clause.
int	bindLimitParametersAtEndOfQuery(RowSelection selection, PreparedStatement statement, int index) Bind parameter values needed by the LIMIT clause after original SELECT statement.
int	bindLimitParametersAtStartOfQuery(RowSelection selection, PreparedStatement statement, int index) Bind parameter values needed by the LIMIT clause before original SELECT statement.
boolean	bindLimitParametersFirst() Does the LIMIT clause come at the start of the SELECT statement, rather than at the end?
boolean	bindLimitParametersInReverseOrder() ANSI SQL defines the LIMIT clause to be in the form LIMIT offset, limit.
int	convertToFirstRowValue(int zeroBasedFirstResult) Hibernate APIs explicitly state that setFirstResult() should be a zero-based offset.
boolean	forceLimitUsage() Generally, if there is no limit applied to a Hibernate query we do not apply any limits to the SQL query.
protected int	getMaxOrLimit(RowSelection selection) Some dialect-specific LIMIT clauses require the maximum last row number (aka, first_row_number + total_row_count), while others require the maximum returned row count (the total maximum number of rows to return).
String	processSql(String sql, RowSelection selection) Return processed SQL query.
void	setMaxRows(RowSelection selection, PreparedStatement statement) Use JDBC API to limit the number of rows returned by the SQL query.
boolean	supportsLimit() Does this handler support some form of limiting query results via a SQL clause?
boolean	supportsLimitOffset() Does this handler's LIMIT support (if any) additionally support specifying an offset?
boolean	supportsVariableLimit() Does this handler support bind variables (i.e., prepared statement parameters) for its limit/offset?
boolean	useMaxForLimit() Does the LIMIT clause take a "maximum" row number instead of a total number of returned rows? This is easiest understood via an example.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLimitHandler

protected AbstractLimitHandler()

Method Detail

supportsLimit

public boolean supportsLimit()

Description copied from interface: LimitHandler

Does this handler support some form of limiting query results via a SQL clause?

Specified by:

supportsLimit in interface LimitHandler

Returns:

True if this handler supports some form of LIMIT.

supportsLimitOffset

public boolean supportsLimitOffset()

Description copied from interface: LimitHandler

Does this handler's LIMIT support (if any) additionally support specifying an offset?

Specified by:

supportsLimitOffset in interface LimitHandler

Returns:

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

supportsVariableLimit

public boolean supportsVariableLimit()

Does this handler support bind variables (i.e., prepared statement parameters) for its limit/offset?

Returns:

True if bind variables can be used; false otherwise.

bindLimitParametersInReverseOrder

public boolean bindLimitParametersInReverseOrder()

ANSI SQL defines the LIMIT clause to be in the form LIMIT offset, limit. Does this dialect require us to bind the parameters in reverse order?

Returns:

true if the correct order is limit, offset

bindLimitParametersFirst

public boolean bindLimitParametersFirst()

Does the LIMIT clause come at the start of the SELECT statement, rather than at the end?

Returns:

true if limit parameters should come before other parameters

useMaxForLimit

public boolean useMaxForLimit()

Does the LIMIT clause take a "maximum" row number instead of a total number of returned rows?

This is easiest understood via an example. Consider you have a table with 20 rows, but you only want to retrieve rows number 11 through 20. Generally, a limit with offset would say that the offset = 11 and the limit = 10 (we only want 10 rows at a time); this is specifying the total number of returned rows. Some dialects require that we instead specify offset = 11 and limit = 20, where 20 is the "last" row we want relative to offset (i.e. total number of rows = 20 - 11 = 9)

So essentially, is limit relative from offset? Or is limit absolute?

Returns:

True if limit is relative from offset; false otherwise.

forceLimitUsage

public boolean forceLimitUsage()

Generally, if there is no limit applied to a Hibernate query we do not apply any limits to the SQL query. This option forces that the limit be written to the SQL query.

Returns:

True to force limit into SQL query even if none specified in Hibernate query; false otherwise.

convertToFirstRowValue

public int convertToFirstRowValue(int zeroBasedFirstResult)

Hibernate APIs explicitly state that setFirstResult() should be a zero-based offset. Here we allow the Dialect a chance to convert that value based on what the underlying db or driver will expect.

NOTE: what gets passed into processSql(String, org.hibernate.engine.spi.RowSelection) is the zero-based offset. Dialects which do not supportsVariableLimit() should take care to perform any needed first-row-conversion calls prior to injecting the limit values into the SQL string.

Parameters:

zeroBasedFirstResult - The user-supplied, zero-based first row offset.

Returns:

The corresponding db/dialect specific offset.

See Also:

Query.setFirstResult(int), Criteria.setFirstResult(int)

processSql

public String processSql(String sql,
                         RowSelection selection)

Description copied from interface: LimitHandler

Return processed SQL query.

Specified by:

processSql in interface LimitHandler

Parameters:

sql - the SQL query to process.

selection - the selection criteria for rows.

Returns:

Query statement with LIMIT clause applied.

bindLimitParametersAtStartOfQuery

public int bindLimitParametersAtStartOfQuery(RowSelection selection,
                                             PreparedStatement statement,
                                             int index)
                                      throws SQLException

Description copied from interface: LimitHandler

Bind parameter values needed by the LIMIT clause before original SELECT statement.

Specified by:

bindLimitParametersAtStartOfQuery in interface LimitHandler

Parameters:

selection - the selection criteria for rows.

statement - Statement to which to bind limit parameter values.

index - Index from which to start binding.

Returns:

The number of parameter values bound.

Throws:

SQLException - Indicates problems binding parameter values.

bindLimitParametersAtEndOfQuery

public int bindLimitParametersAtEndOfQuery(RowSelection selection,
                                           PreparedStatement statement,
                                           int index)
                                    throws SQLException

Description copied from interface: LimitHandler

Bind parameter values needed by the LIMIT clause after original SELECT statement.

Specified by:

bindLimitParametersAtEndOfQuery in interface LimitHandler

Parameters:

selection - the selection criteria for rows.

statement - Statement to which to bind limit parameter values.

index - Index from which to start binding.

Returns:

The number of parameter values bound.

Throws:

SQLException - Indicates problems binding parameter values.

setMaxRows

public void setMaxRows(RowSelection selection,
                       PreparedStatement statement)
                throws SQLException

Description copied from interface: LimitHandler

Use JDBC API to limit the number of rows returned by the SQL query. Typically handlers that do not support LIMIT clause should implement this method.

Specified by:

setMaxRows in interface LimitHandler

Parameters:

selection - the selection criteria for rows.

statement - Statement which number of returned rows shall be limited.

Throws:

SQLException - Indicates problems while limiting maximum rows returned.

bindLimitParameters

protected final int bindLimitParameters(RowSelection selection,
                                        PreparedStatement statement,
                                        int index)
                                 throws SQLException

Default implementation of binding parameter values needed by the LIMIT clause.

Parameters:

selection - the selection criteria for rows.

statement - Statement to which to bind limit parameter values.

index - Index from which to start binding.

Returns:

The number of parameter values bound.

Throws:

SQLException - Indicates problems binding parameter values.

getMaxOrLimit

protected final int getMaxOrLimit(RowSelection selection)

Some dialect-specific LIMIT clauses require the maximum last row number (aka, first_row_number + total_row_count), while others require the maximum returned row count (the total maximum number of rows to return).

Parameters:

selection - the selection criteria for rows.

Returns:

The appropriate value to bind into the limit clause.