gvsig-tools / org.gvsig.tools / library / trunk / org.gvsig.tools / org.gvsig.tools.lib / src / main / java / org / gvsig / tools / dynobject / DynObjectPagingHelper.java @ 1860
History | View | Annotate | Download (2.18 KB)
1 | 802 | cordinyana | /**
|
---|---|---|---|
2 | * gvSIG. Desktop Geographic Information System.
|
||
3 | 244 | cordinyana | *
|
4 | 802 | cordinyana | * Copyright (C) 2007-2013 gvSIG Association.
|
5 | 244 | cordinyana | *
|
6 | * This program is free software; you can redistribute it and/or
|
||
7 | * modify it under the terms of the GNU General Public License
|
||
8 | * as published by the Free Software Foundation; either version 2
|
||
9 | * of the License, or (at your option) any later version.
|
||
10 | *
|
||
11 | * This program is distributed in the hope that it will be useful,
|
||
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
14 | * GNU General Public License for more details.
|
||
15 | *
|
||
16 | * You should have received a copy of the GNU General Public License
|
||
17 | * along with this program; if not, write to the Free Software
|
||
18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
||
19 | * MA 02110-1301, USA.
|
||
20 | *
|
||
21 | 802 | cordinyana | * For any additional information, do not hesitate to contact us
|
22 | * at info AT gvsig.com, or visit our website www.gvsig.com.
|
||
23 | 244 | cordinyana | */
|
24 | package org.gvsig.tools.dynobject; |
||
25 | |||
26 | import org.gvsig.tools.exception.BaseException; |
||
27 | import org.gvsig.tools.paging.PagingCalculator; |
||
28 | |||
29 | /**
|
||
30 | * Helper interface to access the values of a DynObjectSet by page or position.
|
||
31 | *
|
||
32 | * @author gvSIG team
|
||
33 | */
|
||
34 | public interface DynObjectPagingHelper extends PagingCalculator { |
||
35 | |||
36 | /**
|
||
37 | * Returns the {@link DynObject} located at the index position.
|
||
38 | *
|
||
39 | * @param index
|
||
40 | * to locate the DynObject in the set
|
||
41 | * @return the DynObject located at the index position
|
||
42 | * @throws BaseException
|
||
43 | * if there is an error getting the DynObject
|
||
44 | */
|
||
45 | DynObject getDynObjectAt(long index) throws BaseException; |
||
46 | |||
47 | /**
|
||
48 | * Returns all the values of the current loaded page.
|
||
49 | *
|
||
50 | * @return all the values of the current loaded page
|
||
51 | */
|
||
52 | DynObject[] getCurrentPageDynObjects();
|
||
53 | |||
54 | /**
|
||
55 | * Returns the {@link DynObjectSet} used to fetch the data.
|
||
56 | *
|
||
57 | * @return the DynObjectSet
|
||
58 | */
|
||
59 | DynObjectSet getDynObjectSet(); |
||
60 | |||
61 | /**
|
||
62 | * Reloads the current page of data from the set.
|
||
63 | *
|
||
64 | * @throws BaseException
|
||
65 | * if there is an error reloading the current page
|
||
66 | */
|
||
67 | void reloadCurrentPage() throws BaseException; |
||
68 | |||
69 | /**
|
||
70 | * Reloads everything.
|
||
71 | *
|
||
72 | * @throws BaseException
|
||
73 | */
|
||
74 | void reload() throws BaseException; |
||
75 | } |