org.xcmis.search.model
Class Limit

java.lang.Object
  org.xcmis.search.model.Limit

All Implemented Interfaces:

Serializable, QueryElement

public class Limit
extends Object
implements QueryElement

Version:

$Id: Limit.java 34360 2009-07-22 23:58:59Z ksm $

Author:

Sergey Kabashnyuk

See Also:

Serialized Form

Field Summary

static Limit

NONE

Constructor Summary

Limit(int rowLimit)
Create a limit on the number of rows.

Limit(int rowLimit, int offset)
Create a limit on the number of rows and the number of initial rows to skip.

Method Summary

void	accept(QueryObjectModelVisitor visitor) Accepts a visitor and calls the appropriate visit method depending on the type of this QOM node.
boolean	equals(Object obj)
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.
int	hashCode()
boolean	hasRowLimited() Determine whether this limit clause defines a maximum limit
boolean	isOffset() Determine whether this limit clause defines an offset.
boolean	isUnlimited() Determine whether this limit clause is necessary.
String	toString()
Limit	withOffset(int offset)
Limit	withRowLimit(int rowLimit)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NONE

public static final Limit NONE

Constructor Detail

Limit

public Limit(int rowLimit)

Create a limit on the number of rows.

Parameters:

rowLimit - the maximum number of rows

Limit

public Limit(int rowLimit,
             int offset)

Create a limit on the number of rows and the number of initial rows to skip.

Parameters:

rowLimit - the maximum number of rows

offset - the number of rows to skip before beginning the results

Method Detail

accept

public void accept(QueryObjectModelVisitor visitor)
            throws VisitException

Description copied from interface: QueryElement

Accepts a visitor and calls the appropriate visit method depending on the type of this QOM node.

Specified by:

accept in interface QueryElement

Parameters:

visitor - the visitor.

Throws:

VisitException

See Also:

QueryElement.accept(org.xcmis.search.QueryObjectModelVisitor)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getOffset

public final int getOffset()

Get the number of rows skipped before the results begin.

Returns:

the offset; always 0 or a positive number

getRowLimit

public final 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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

hasRowLimited

public final boolean hasRowLimited()

Determine whether this limit clause defines a maximum limit

Returns:

true if the number of rows are limited, or false if there is no limit to the number of rows

isOffset

public final boolean isOffset()

Determine whether this limit clause defines an offset.

Returns:

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

isUnlimited

public final 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

withOffset

public Limit withOffset(int offset)

withRowLimit

public Limit withRowLimit(int rowLimit)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()