com.googlecode.icegem.query.pagination
Class PageKey

java.lang.Object
  com.googlecode.icegem.query.pagination.PageKey

All Implemented Interfaces:

java.io.Serializable

public class PageKey
extends java.lang.Object
implements java.io.Serializable

Key for storing paginated query pages.

Author:

Andrey Stepanov aka standy

See Also:

Serialized Form

Constructor Summary

PageKey(java.lang.String queryString, java.lang.Object[] queryParameters, int queryLimit, int pageSize, int pageNumber)
Constructor PageKey creates a new PageKey instance.

Method Summary

boolean	equals(java.lang.Object obj)
void	fromData(java.io.DataInput in)
int	getPageNumber() Method getPageNumber returns the pageNumber of this PageKey object.
int	getPageSize()
int	getQueryLimit()
java.lang.Object[]	getQueryParameters() Method getQueryParameters returns the queryParameters of this PageKey object.
java.lang.String	getQueryString() Method getQueryString returns the queryString of this PageKey object.
int	hashCode()
void	setPageNumber(int pageNumber) Method setPageNumber sets the pageNumber of this PageKey object.
void	setPageSize(int pageSize)
void	setQueryLimit(int queryLimit)
void	setQueryParameters(java.lang.Object[] queryParameters) Method setQueryParameters sets the queryParameters of this PageKey object.
void	setQueryString(java.lang.String queryString) Method setQueryString sets the queryString of this PageKey object.
void	toData(java.io.DataOutput out)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PageKey

public PageKey(java.lang.String queryString,
               java.lang.Object[] queryParameters,
               int queryLimit,
               int pageSize,
               int pageNumber)

Constructor PageKey creates a new PageKey instance.

Parameters:

queryString - the ODL query.

queryParameters - the parameters.

pageSize - the page size.

pageNumber - the number of page.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

fromData

public void fromData(java.io.DataInput in)
              throws java.io.IOException,
                     java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getPageNumber

public int getPageNumber()

Method getPageNumber returns the pageNumber of this PageKey object.

Returns:

the pageNumber (type int) of this PageKey object.

getPageSize

public int getPageSize()

getQueryLimit

public int getQueryLimit()

getQueryParameters

public java.lang.Object[] getQueryParameters()

Method getQueryParameters returns the queryParameters of this PageKey object.

Returns:

the queryParameters (type Object[]) of this PageKey object.

getQueryString

public java.lang.String getQueryString()

Method getQueryString returns the queryString of this PageKey object.

Returns:

the queryString (type String) of this PageKey object.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setPageNumber

public void setPageNumber(int pageNumber)

Method setPageNumber sets the pageNumber of this PageKey object.

Parameters:

pageNumber - the pageNumber of this PageKey object.

setPageSize

public void setPageSize(int pageSize)

setQueryLimit

public void setQueryLimit(int queryLimit)

setQueryParameters

public void setQueryParameters(java.lang.Object[] queryParameters)

Method setQueryParameters sets the queryParameters of this PageKey object.

Parameters:

queryParameters - the queryParameters of this PageKey object.

setQueryString

public void setQueryString(java.lang.String queryString)

Method setQueryString sets the queryString of this PageKey object.

Parameters:

queryString - the queryString of this PageKey object.

toData

public void toData(java.io.DataOutput out)
            throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object