org.modeshape.jcr.api.query.qom
Interface Limit

All Known Implementing Classes:

JcrLimit

public interface Limit

Representation of a limit on the number of tuple results.

Method Summary

int	getOffset() Get the number of rows skipped before the results begin.
int	getRowLimit() Get the maximum number of rows that are to be returned.
boolean	isOffset() Determine whether this limit clause defines an offset.
boolean	isUnlimited() Determine whether this limit clause is necessary.

Method Detail

getOffset

int getOffset()

Get the number of rows skipped before the results begin.

Returns:

the offset; always 0 or a positive number

getRowLimit

int getRowLimit()

Get the maximum number of rows that are to be returned.

Returns:

the maximum number of rows; always positive, or equal to Integer.MAX_VALUE if there is no limit

isUnlimited

boolean isUnlimited()

Determine whether this limit clause is necessary.

Returns:

true if the number of rows is not limited and there is no offset, or false otherwise

isOffset

boolean isOffset()

Determine whether this limit clause defines an offset.

Returns:

true if there is an offset, or false if there is no offset