|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectpl.slawas.paging.PagingParams
public class PagingParams
PagingParams - klasa służy do definiowania ile, i których z kolei dokumentów zwrócić ma zwrócić wplucene. Jeśli wplucen znajdzie więcej dokumentów to zwróci tyle o ile została zapytana. Jeśli znajdzie mniej to zwróci tyle ile znalazła. Dla ułatwienia można posłużyć się pl.wp.lucene.api.search.Page i użyć konstruktora z parametrem tej klasy. Ustawienia count i offset zmieniają się w momencie ustawiania paramteru klasy Page. Przy ustawianiu parametrów sprawdzane są ograniczenia. Jeśli podawana wartość prowadzi do przekroczenia ograniczeń to wyszukiwanie nie zostanie przeprowadzone.
Field Summary | |
---|---|
static int |
DEFAULT_PAGING_OFFSET
Domyślna liczba pierwszych wyników/dokumentów jaka ma być pominięta w odpowiedzi wyszukiwarki. |
protected boolean |
isReadOnly
|
static int |
MAX_DOC_COUNT
Domyślna maksymalna liczba dokumentów w wyniku zapytania (w jednym requeście). |
static int |
MAX_PAGE_SIZE
Domyslna maksymalna liczba dokumentów offsetu (maksymalna liczba na stronie) |
Constructor Summary | |
---|---|
protected |
PagingParams()
|
|
PagingParams(int pageSize,
int offset)
Konstruktor za pomocą którego można wygenerować definicję strony podczas wywołania metody getPage() . |
|
PagingParams(int pageSize,
int offset,
int maxPageSize)
Konstruktor za pomocą którego można wygenerować definicję strony podczas wywołania metody getPage() z możliwośćią zmiany ograniczenia na
rozmiar strony. |
|
PagingParams(int pageSize,
int offset,
int maxPageSize,
int maxCount)
Konstruktor za pomocą którego można wygenerować definicję strony podczas wywołania metody getPage() z możliwośćią zmiany ograniczenia na
rozmiar strony oraz maksymalną liczbą zwracanych wyników zapytania. |
|
PagingParams(Page page)
Ustawianie parametrów stronicowania na podstawie definicji strony. |
|
PagingParams(Page page,
int maxPageSize)
Ustawianie parametrów stronicowania na podstawie definicji strony z możliwośćią zmiany ograniczenia na rozmiar strony. |
|
PagingParams(Page page,
int maxPageSize,
int maxCount)
Ustawianie parametrów stronicowania na podstawie definicji strony z możliwośćią zmiany ograniczenia na rozmiar strony oraz maksymalną liczbą zwracanych wyników zapytania. |
Method Summary | |
---|---|
PagingParams |
copy()
Metoda tworząca nową kopie aktualnego obiektu. |
PagingParams |
copy(PagingParams source)
Metoda wykonująca kopiowanie wartości poszczgólnych pól, z obiektu tej samej klasy do aktualnie modyfikowanego obiektu. |
void |
copyTo(PagingParams target)
Metoda wykonująca kopiowanie wartości poszczgólnych pól, z aktualnego obiektu do obiektu docelowego. |
boolean |
equals(java.lang.Object obj)
|
int |
getCursorOfPage()
|
Page |
getFirstPage()
Pobieranie definicji pierwszej strony na podstwawie parametrów stronicowania. |
int |
getMaxCount()
Informacja o ograniczeniu związanych z maksymalną liczbą dokumentów w wyniku zapytania. |
int |
getMaxPages()
Informacja o maksymalnej liczbie stron dostępnych przy aktualnych parametrach stronicowania. |
int |
getMaxPageSize()
Informacja o ograniczeniu związanych z maksymalną liczbą dokumentów na stronie |
Page |
getMinimalPage()
Pobieranie definicji strony o minimlnie możliwym numerze na podstwawie parametrów stronicowania. |
int |
getOffset()
|
Page |
getPage()
Pobieranie obiektu strony. |
int |
getPageSize()
Pobieranie rozmiaru strony pageSize |
int |
hashCode()
|
boolean |
isReadOnly()
|
boolean |
isValid()
|
boolean |
setCursorOfPage(int cursorOfPage)
Ustawianie parametru cursorOfPage , ze sprawdzeniem jego
poprawności w stosunku do ograniczeń związanych obiektem stronicowania. |
void |
setMaxCount(int maxCount)
Zmiana ograniczeń związanych z maksymalną liczbą dokumentów w wyniku zapytania maxCount |
void |
setMaxPageSize(int maxPageSize)
Zmiana ograniczeń związanych z maksymalną liczbą dokumentów na stronie maxPageSize |
boolean |
setOffset(int offset)
|
boolean |
setPage(int pageNumber)
Ustawianie definicji aktualnej strony na podstawie numeru strony. |
boolean |
setPage(Page page)
Ustawianie definicji aktualnej strony. |
boolean |
setPageSize(int pageSize)
Ustawianie rozmiaru strony pageSize , ze sprawdzeniem jego
poprawności w stosunku do ograniczeń związanych z maksymalnym rozmiarem
strony (zobacz maxPageSize ). |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected boolean isReadOnly
public static int DEFAULT_PAGING_OFFSET
public static final int MAX_PAGE_SIZE
public static final int MAX_DOC_COUNT
Page.DEFAULT_MAX_PAGES
oraz
MAX_PAGE_SIZE
.
Constructor Detail |
---|
protected PagingParams()
public PagingParams(Page page)
page
- definicja strony.setPage(Page)
public PagingParams(Page page, int maxPageSize)
page
- definicja stronymaxPageSize
- ograniczenie na rozmiar stronysetPage(Page)
,
maxPageSize
public PagingParams(Page page, int maxPageSize, int maxCount)
page
- definicja stronymaxPageSize
- ograniczenie na rozmiar stronymaxCount
- ograniczenie na liczbę zwracanych wynikówsetPage(Page)
,
maxPageSize
,
maxCount
public PagingParams(int pageSize, int offset)
getPage()
.
pageSize
- roziar strony, liczba elementów na stronieoffset
- numer pozycji elementu w wyniku zapytania dla pierwszego
dokumentu na stronie.public PagingParams(int pageSize, int offset, int maxPageSize)
getPage()
z możliwośćią zmiany ograniczenia na
rozmiar strony.
pageSize
- roziar strony, liczba elementów na stronieoffset
- numer pozycji elementu w wyniku zapytania dla pierwszego
dokumentu na stronie.maxPageSize
- ograniczenie na rozmiar stronymaxPageSize
public PagingParams(int pageSize, int offset, int maxPageSize, int maxCount)
getPage()
z możliwośćią zmiany ograniczenia na
rozmiar strony oraz maksymalną liczbą zwracanych wyników zapytania.
pageSize
- roziar strony, liczba elementów na stronieoffset
- numer pozycji elementu w wyniku zapytania dla pierwszego
dokumentu na stronie.maxPageSize
- ograniczenie na rozmiar stronymaxCount
- ograniczenie na liczbę zwracanych wynikówmaxPageSize
,
maxCount
Method Detail |
---|
public int getPageSize()
pageSize
public boolean setPageSize(int pageSize)
pageSize
, ze sprawdzeniem jego
poprawności w stosunku do ograniczeń związanych z maksymalnym rozmiarem
strony (zobacz maxPageSize
).
pageSize
- rozmiar strony, liczba dokumentów na stronie
true
, jeżeli wszystko jest OK.public int getCursorOfPage()
cursorOfPage
public boolean setCursorOfPage(int cursorOfPage)
cursorOfPage
, ze sprawdzeniem jego
poprawności w stosunku do ograniczeń związanych obiektem stronicowania.
cursorOfPage
- wartość parametru
true
, jeżeli wszystko jest OK.public Page getPage()
cursorOfPage
oraz pageSize
.
public boolean setPage(Page page)
maxCount
oraz maxPageSize
.
page
- defnicja strony
true
, jeżeli wszystko jest OK.page
public boolean setPage(int pageNumber)
maxCount
.
pageNumber
- numer strony
true
, jeżeli wszystko jest OK.page
public Page getFirstPage()
Page.MIN_PAGE_NR
, a jej rozmiar wynika z warunków parametrów
stronicowania getPageSize()
.
public Page getMinimalPage()
offset
oraz pageSize
.
public int getMaxPageSize()
maxPageSize
public void setMaxPageSize(int maxPageSize)
maxPageSize
maxPageSize
- nowa wartość ograniczeńpublic int getMaxCount()
maxCount
public int getMaxPages()
public void setMaxCount(int maxCount)
maxCount
maxCount
- nowa wartość ograniczeńpublic boolean isValid()
public java.lang.String toString()
toString
in class java.lang.Object
public PagingParams copy()
_ICopyable
Przykładowa implementacja:
public TEntity copy() { TEntity newCopy = new TEntity(); return newCopy.copy(this); }
Przykład użycia (pseudo-kod):
... // kopiowanie już istniejącego obiektu o nazwie source Class<Obj> target = source.copy(); ...
copy
in interface _ICopyable<PagingParams>
public PagingParams copy(PagingParams source)
_ICopyable
Przykładowa implementacja:
public TEntity copy(TEntity source) { this.id = source.getId(); this.name = source.getName(); this.date = source.getDate(); this.price = source.getPrice(); this.user = source.getUser(); return this; }
Przykład użycia (pseudo-kod):
... Class<Obj> target = Class<Obj>.newInstance(); // wstrzykiwanie już wartości istniejącego obiektu o nazwie source target = target.copy(source); // albo po prostu: target.copy(source); ...
copy
in interface _ICopyable<PagingParams>
source
- źródło, klasa, której informacje zostaną skopiowane do
aktualnego obiektu
public void copyTo(PagingParams target)
_ICopyable
Przykładowa implementacja:
public void copyTo(TEntity target) { target.setDate(this.date); target.setId(this.id); target.setName(this.name); target.setPrice(this.price); target.setUser(this.user); }
Przykład użycia (pseudo-kod):
... Class<Obj> target = Class<Obj>.newInstance(); // wstrzykiwanie wartości istniejącego obiektu o nazwie source do obiektu target source.copyTo(target); ...
copyTo
in interface _ICopyable<PagingParams>
target
- obiekt, do którego mają zostac skopiowane wartości aktualnego
oniektu.public int getOffset()
offset
public boolean setOffset(int offset)
offset
- the offset
to set
true
, jeżeli wszystko jest OK.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public boolean isReadOnly()
isReadOnly
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |