Dataset.java

/*
 * Copyright 2010, Andrew M Gibson
 *
 * www.andygibson.net
 *
 * This file is part of DataValve.
 *
 * DataValve is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * DataValve 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 Lesser General Public License for more details.
 * 
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with DataValve.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package org.fluttercode.datavalve.dataset;

import java.util.List;

import org.fluttercode.datavalve.DataProvider;
import org.fluttercode.datavalve.Paginator;

/**
 * A Generic version of the provider dataset that extends the
 * {@link AbstractDataset} and holds a typed {@link DataProvider} reference
 * which can be accessed from the client.
 * 
 * <pre>
 * MyCustomProvider<Person> provider = new MyCustomProvider<Person>();
 * ds = new GenericDataset<Person, MyCustomProvider>();
 * ds.getProvider().someCustomMethod();
 * </pre>
 * 
 * We have 'helper' types for this with specific implementations for
 * parameterized,statement,and query provider types. These are currently
 * implemented as {@link ParameterizedDataset}, {@link StatementDataset}, and
 * {@link QueryDataset}.
 * <p/>
 * If you want a straight {@link ObjectDataset} implementation without a typed
 * provider, just use the {@link DataProviderDataset} which accepts any
 * {@link DataProvider} implementation.
 * 
 * @author Andy Gibson
 * 
 * @param <T>
 *            The type of object this dataset will end up returning
 * @param <P>
 *            The type of data provider used to fetch the data
 */
public class Dataset<T, P extends DataProvider<T>> extends AbstractDataset<T> {

	private static final long serialVersionUID = 1L;

	private P provider;

	public Dataset() {
		super();
	}

	public Dataset(P provider) {
		super();
		this.provider = provider;
	}

	public Integer loadResultCount() {
		return provider.fetchResultCount();
	}

	@Override
	protected List<T> loadResults(Paginator paginator) {

		return provider.fetchResults(paginator);
	}

	public List<T> fetchResults(Paginator paginator) {
		return provider.fetchResults(paginator);
	}

	public P getProvider() {
		return provider;
	}
}