|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object za.org.coefficient.util.common.HibernatePager
public class HibernatePager
DOCUMENT ME!
Field Summary | |
---|---|
private static java.lang.String |
AND
|
private java.lang.StringBuffer |
andConstraints
|
private java.util.ArrayList |
andVals
|
private boolean |
ascending
|
private int |
currentPageNumber
|
private java.lang.StringBuffer |
fromClause
|
private boolean |
hasNext
|
private static java.lang.String |
OR
|
private java.lang.StringBuffer |
orConstraints
|
private java.lang.String |
orderByField
|
private java.util.ArrayList |
orVals
|
private java.util.ArrayList |
page
|
private java.lang.Class |
pagerClass
|
private int |
pageSize
|
private int |
total
|
private java.lang.String |
userQuery
|
private java.lang.Object[] |
userValues
|
Constructor Summary | |
---|---|
HibernatePager()
|
|
HibernatePager(java.lang.Class pageClass,
java.lang.String orderByField)
|
|
HibernatePager(java.lang.Class pageClass,
java.lang.String orderByField,
boolean orderByAscending)
|
|
HibernatePager(java.lang.Class pageClass,
java.lang.String orderByField,
boolean orderByAscending,
java.util.HashMap andSearchParams)
|
|
HibernatePager(java.lang.Class pageClass,
java.lang.String orderByField,
boolean orderByAscending,
java.util.HashMap andSearchParams,
java.util.HashMap orSearchParams)
|
|
HibernatePager(java.lang.Class pageClass,
java.lang.String orderByField,
int pageSize)
|
|
HibernatePager(java.lang.Class pageClass,
java.lang.String orderByField,
int pageSize,
boolean orderByAscending)
|
|
HibernatePager(java.lang.Class pageClass,
java.lang.String orderByField,
int pageSize,
java.util.HashMap andSearchParams)
|
|
HibernatePager(java.lang.Class pageClass,
java.lang.String orderByField,
int pageSize,
java.util.HashMap andSearchParams,
boolean orderByAscending)
|
|
HibernatePager(java.lang.Class pageClass,
java.lang.String orderByField,
int pageSize,
java.util.HashMap andSearchParams,
java.util.HashMap orSearchParams)
|
|
HibernatePager(java.lang.Class pageClass,
java.lang.String orderByField,
int pageSize,
java.util.HashMap andSearchParams,
java.util.HashMap orSearchParams,
boolean orderByAscending)
|
|
HibernatePager(java.lang.String searchQuery,
java.lang.Object[] values)
|
|
HibernatePager(java.lang.String searchQuery,
java.lang.Object[] values,
int pageSize)
|
Method Summary | |
---|---|
private java.lang.Object[] |
convertValsToArray()
|
java.util.List |
currentPage()
Returns the data in the current page. |
int |
getCurrentPageNumber()
Returns the current page number |
private int |
getLengthForConstraint(boolean and)
|
int |
getMaxPageNumber()
Returns the maximum number of pages |
int |
getPageSize()
|
int |
getTotalNumberOfResults()
Returns the total number of results found by the query |
java.util.List |
goToPage(int pageNumber)
If the submitted page is in range then the pager will jump to that page otherwise it will stay where it is |
boolean |
hasNextPage()
Checks whether there is a "next" page of data |
boolean |
hasPreviousPage()
Checks whether there is a "previous" page of data |
void |
initialize()
This will start the pager at the beginning of the search set |
void |
next()
Moves to the next page of data. |
java.util.List |
nextPage()
Moves to the next page of data, and returns the data in that page. |
private void |
performQuery(int startElement)
|
void |
previous()
Moves to the previous page of data. |
java.util.List |
previousPage()
Moves to the previous page of data, and returns the data in that page. |
void |
setAndSearchParams(java.util.HashMap searchParams)
Use this to constrain the result set by doing a field 'like' value for the key-value pairs in the hashmap all pairs being And'ed together |
void |
setFromClauses(java.util.HashMap fromElements)
Use fromElements to add elments to the from portion of the query |
void |
setFromWhereAndInitialize(java.util.HashMap andSearchParams,
java.util.HashMap orSearchParams,
java.util.HashMap fromElements)
|
private void |
setIntoConstraint(boolean and,
java.lang.String addition)
|
private void |
setIntoVals(boolean and,
java.lang.Object val)
|
void |
setOrSearchParams(java.util.HashMap searchParams)
Use this to constrain the result set by doing a field 'like' value for the key-value pairs in the hashmap all pairs being Or'ed together |
void |
setPageSize(int pageSize)
|
void |
setQuery(java.lang.String queryString,
java.lang.Object[] values)
|
private void |
setSearchParams(java.util.HashMap searchParams,
java.lang.String logicalOperator)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final java.lang.String AND
private static final java.lang.String OR
private java.util.ArrayList andVals
private java.util.ArrayList orVals
private java.util.ArrayList page
private java.lang.Class pagerClass
private java.lang.String orderByField
private java.lang.String userQuery
private java.lang.StringBuffer andConstraints
private java.lang.StringBuffer fromClause
private java.lang.StringBuffer orConstraints
private java.lang.Object[] userValues
private boolean ascending
private boolean hasNext
private int currentPageNumber
private int pageSize
private int total
Constructor Detail |
---|
public HibernatePager()
public HibernatePager(java.lang.String searchQuery, java.lang.Object[] values) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.String searchQuery, java.lang.Object[] values, int pageSize) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.Class pageClass, java.lang.String orderByField) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.Class pageClass, java.lang.String orderByField, boolean orderByAscending) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.Class pageClass, java.lang.String orderByField, int pageSize) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.Class pageClass, java.lang.String orderByField, int pageSize, boolean orderByAscending) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.Class pageClass, java.lang.String orderByField, boolean orderByAscending, java.util.HashMap andSearchParams) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.Class pageClass, java.lang.String orderByField, boolean orderByAscending, java.util.HashMap andSearchParams, java.util.HashMap orSearchParams) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.Class pageClass, java.lang.String orderByField, int pageSize, java.util.HashMap andSearchParams) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.Class pageClass, java.lang.String orderByField, int pageSize, java.util.HashMap andSearchParams, java.util.HashMap orSearchParams) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.Class pageClass, java.lang.String orderByField, int pageSize, java.util.HashMap andSearchParams, boolean orderByAscending) throws java.lang.Exception
java.lang.Exception
public HibernatePager(java.lang.Class pageClass, java.lang.String orderByField, int pageSize, java.util.HashMap andSearchParams, java.util.HashMap orSearchParams, boolean orderByAscending) throws java.lang.Exception
java.lang.Exception
Method Detail |
---|
public void setAndSearchParams(java.util.HashMap searchParams) throws java.lang.Exception
searchParams
- must contain a string key which is the element
name on the class this pager is for and an Object
representing the value of this field to constrain
by. If null it will clear the old params.
exception
- is thrown if a named element does not exist on
the pager class or if a Hibernate Type can not
be determined for it
java.lang.Exception
public int getCurrentPageNumber()
public void setFromClauses(java.util.HashMap fromElements) throws java.lang.Exception
java.lang.Exception
public void setFromWhereAndInitialize(java.util.HashMap andSearchParams, java.util.HashMap orSearchParams, java.util.HashMap fromElements) throws java.lang.Exception
java.lang.Exception
public int getMaxPageNumber()
public void setOrSearchParams(java.util.HashMap searchParams) throws java.lang.Exception
searchParams
- must contain a string key which is the element
name on the class this pager is for and an Object
representing the value of this field to constrain
by. If null it will clear the old params.
exception
- is thrown if a named element does not exist on
the pager class or if a Hibernate Type can not
be determined for it
java.lang.Exception
public void setPageSize(int pageSize)
public int getPageSize()
public void setQuery(java.lang.String queryString, java.lang.Object[] values)
public int getTotalNumberOfResults()
public java.util.List currentPage()
currentPage
in interface Pager
public java.util.List goToPage(int pageNumber)
pageNumber
- is the page to move to
public boolean hasNextPage()
hasNextPage
in interface Pager
public boolean hasPreviousPage()
hasPreviousPage
in interface Pager
public void initialize()
public void next()
next
in interface Pager
public java.util.List nextPage()
nextPage
in interface Pager
public void previous()
previous
in interface Pager
public java.util.List previousPage()
previousPage
in interface Pager
private void setIntoConstraint(boolean and, java.lang.String addition)
private void setIntoVals(boolean and, java.lang.Object val)
private int getLengthForConstraint(boolean and)
private void setSearchParams(java.util.HashMap searchParams, java.lang.String logicalOperator) throws java.lang.Exception
java.lang.Exception
private java.lang.Object[] convertValsToArray()
private void performQuery(int startElement)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |