pl.slawas.paging
Interface _IPagingInfo

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
_IPagedResult<Obj>
All Known Implementing Classes:
PagedResultSupport

public interface _IPagingInfo
extends java.io.Serializable

_IPagingInfo - informacje o stronicowaniu

Version:
$Revision: 1.2 $
Author:
Slawomir Cichy <slawas@slawas.pl>

Method Summary
 java.util.Enumeration<Page> getAllPages()
           
 Page getCurrentPageInfo()
          Pobranie informacji o aktulanej stronie
 Page getFirstPageInfo()
          Pobranie informacji o pierwszej stronie
 java.lang.Integer getFirstRowPositionOfPreviousResultRows()
           
 Page getLastPageInfo()
          Pobranie informacji o ostatniej stronie
 java.lang.Integer getLastRowPosition()
           
 ResultMessage getMessage()
          Komunikat wyniku
 Page getNextPageInfo()
          Pobranie informacji o następnej stronie
 int getNumberOfRowsOnThePage()
          Na skróty: Pobieranie liczby wierszy na obecnej strony.
 Page getPageInfo(java.lang.Integer pageNumber)
          Pobranie informacji o stronie o podanym numerze
 int getPageNr()
          Na skróty: Pobieranie numeru obecnej strony Tę samą informacje można otrzymać poprzez pobranie obiektu @Page za pomocą metody getCurrentPageInfo() i wykorzystanie informacji w Page.getNumber().
 int getPageSize()
          Na skróty: Pobieranie rozmiaru obecnej strony.
 PagingParams getPagingParams()
           
 Page getPreviousPageInfo()
          Pobranie informacji o poprzedniej stronie
 int getResultSize()
          Liczba wswzystkich wierszy jakie można otrzymać w wyniku tego zapytania.
 boolean hasMoreResultRows()
          Metode można wykożystać do badania czy został przekroczony zakres liczby wyników.
 boolean hasPreviousResultRows()
          Implementacja biblioteki pozwala na pobranie kolejnej czesci wyników zapytania w przypadku gdy hasMoreResultRows() zwraca true .
 

Method Detail

getCurrentPageInfo

Page getCurrentPageInfo()
Pobranie informacji o aktulanej stronie

Returns:
informacje o aktualnej stronie

getFirstPageInfo

Page getFirstPageInfo()
Pobranie informacji o pierwszej stronie

Returns:
informacje o pierwszej stronie

getPreviousPageInfo

Page getPreviousPageInfo()
                         throws PagedResultException
Pobranie informacji o poprzedniej stronie

Returns:
informacje o poprzedniej stronie
Throws:
PagedResultException - zwraca błąd gdy obecna strona getCurrentPageInfo() jest stroną pierwszą. Poprzednia nie istnieje.

getNextPageInfo

Page getNextPageInfo()
                     throws PagedResultException
Pobranie informacji o następnej stronie

Returns:
informacje o następnej stronie
Throws:
PagedResultException - zwraca błąd gdy obecna strona getCurrentPageInfo() jest stroną ostatnią. Nastepna nie istnieje.

getPageInfo

Page getPageInfo(java.lang.Integer pageNumber)
                 throws PagedResultException
Pobranie informacji o stronie o podanym numerze

Parameters:
pageNumber - numer intetersującej nas strony
Returns:
informacje o stronie
Throws:
PagedResultException - zwraca błąd gdy strona o danym numerze nie istnieje.

getLastPageInfo

Page getLastPageInfo()
Pobranie informacji o ostatniej stronie

Returns:
informacje o ostatniej stronie

getAllPages

java.util.Enumeration<Page> getAllPages()
Returns:
the pages

getMessage

ResultMessage getMessage()
Komunikat wyniku

Returns:
komunikat wyniku ResultMessage

getResultSize

int getResultSize()
Liczba wswzystkich wierszy jakie można otrzymać w wyniku tego zapytania.

Returns:
liczba wierszy

hasMoreResultRows

boolean hasMoreResultRows()
Metode można wykożystać do badania czy został przekroczony zakres liczby wyników. Przy stronicowanym rezultacie moze dojsc do takiej sytuacji, ze nie wszystkie wiersze spełniające warunki zapytania SQL mieszczą się w danym rezultacie (ograniczenie maksymalnej liczby stron wyników). Wtedy jest ustwiana odpowiednia flaga, z informacją że wyniki się nie zmieściły i ta metoda zwraca informacje o wystąpieniu takiego zdarzenia. Mozna później wykorzystać metodę getLastRowPosition() do pobrania kolejenj paczki rezultatu poprzez wywołanie wykonania zapytania JDBC ze odpowiednią wartością argumentu 'startPosition'.

Przykład na podstawie implementacji:

 if (pagedResult.hasMoreResultRows()) {
        T lastQuery = pagedResult.getQuery();
        lastQuery.setExecuted(false);
        lastQuery.execute(
                        em.getConnection(),
                        pagedResult.getLastRowPosition() + 1,
                        null,
                        CacheUsage.NONE);
 }
 

Returns:
true oznacza, że jest więcej wierszy w bazie danych spełniających warunek wyszukiwania zapytania SQL.

hasPreviousResultRows

boolean hasPreviousResultRows()
Implementacja biblioteki pozwala na pobranie kolejnej czesci wyników zapytania w przypadku gdy hasMoreResultRows() zwraca true . Dla takiego stronicowanego wyniku istotna jest infomacja czy posiada ona poprzednia część rezultatu.

Returns:
true oznacza, że dany wynik jest wynikiem rozszerzonym (poza granicą maksymalnej liczby stron) i posiada poprzedzający obecny wynik obiekt wyniku stronicowanego.

getLastRowPosition

java.lang.Integer getLastRowPosition()
Returns:
ostatnia pozycja wiersza w stronicowanym wyniku zapytania.

getFirstRowPositionOfPreviousResultRows

java.lang.Integer getFirstRowPositionOfPreviousResultRows()
Returns:
pierwsza pozycja wiersza poprzedniej paczki wyników. Jezeli poprzenia paczka nie istnieje (zobacz hasPreviousResultRows()), zwraca null.
See Also:
hasPreviousResultRows(), hasMoreResultRows()

getPageSize

int getPageSize()
Na skróty: Pobieranie rozmiaru obecnej strony.

Tę samą informacje można otrzymać poprzez pobranie obiektu @Page za pomocą metody getCurrentPageInfo() i wykorzystanie informacji w Page.getSize().

Returns:
rozmiar aktualnej strony

getNumberOfRowsOnThePage

int getNumberOfRowsOnThePage()
Na skróty: Pobieranie liczby wierszy na obecnej strony.

Tę samą informacje można otrzymać poprzez pobranie obiektu @Page za pomocą metody getCurrentPageInfo() i wykorzystanie informacji w Page.getNumberOfRowsOnThePage().

Returns:
rozmiar aktualnej strony

getPageNr

int getPageNr()
Na skróty: Pobieranie numeru obecnej strony

Tę samą informacje można otrzymać poprzez pobranie obiektu @Page za pomocą metody getCurrentPageInfo() i wykorzystanie informacji w Page.getNumber().

Returns:
numer aktualnej strony

getPagingParams

PagingParams getPagingParams()
Returns:
the pagingParams


Copyright © 2014 Sci Software. All Rights Reserved.