Application: gvSIG desktop » Library: org.gvsig.tools

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.tools.dynobject;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.paging.PagingCalculator;

/**

 * Helper interface to access the values of a DynObjectSet by page or position.

 * 

 * @author gvSIG team

 */

public interface DynObjectPagingHelper extends PagingCalculator {

        /**

         * Returns the {@link DynObject} located at the index position.

         * 

         * @param index

         *            to locate the DynObject in the set

         * @return the DynObject located at the index position

         * @throws BaseException

         *             if there is an error getting the DynObject

         */

        DynObject getDynObjectAt(long index) throws BaseException;

        /**

         * Returns all the values of the current loaded page.

         * 

         * @return all the values of the current loaded page

         */

        DynObject[] getCurrentPageDynObjects();

        /**

         * Returns the {@link DynObjectSet} used to fetch the data.

         * 

         * @return the DynObjectSet

         */

        DynObjectSet getDynObjectSet();

        /**

         * Reloads the current page of data from the set.

         * 

         * @throws BaseException

         *             if there is an error reloading the current page

         */

        void reloadCurrentPage() throws BaseException;

        /**

         * Reloads everything.

         * 

         * @throws BaseException

         */

        void reload() throws BaseException;

}