FileDataProvider.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.provider.file;

import java.io.File;
import java.io.FileFilter;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.fluttercode.datavalve.provider.InMemoryDataProvider;


//TODO Need to create more tests for this class (i.e. setting the path and so on)
/**
 * Dataset the represents a directory listing as a collection of {@link File}
 * objects.
 * 
 * @author Andy Gibson
 * 
 */
public class FileDataProvider extends InMemoryDataProvider<File> {

	private static final long serialVersionUID = 1L;

	private File sourceDirectory;
	private boolean includeDirectories = false;
	
	private final transient FileFilter fileFilter = new FileFilter() {

		public boolean accept(File file) {
			return file.isFile() || (includeDirectories && file.isDirectory());
		}
	};

	public FileDataProvider(String path) {
		this(createDirectoryFileFromPath(path));
	}

	public FileDataProvider(File targetPath) {

		if (targetPath == null) {
			return;
		}

		// defensively copy the path over
		File temp = targetPath;
		if (temp.isFile()) {
			temp = temp.getParentFile();
		}

		if (!temp.isDirectory()) {
			throw new IllegalArgumentException(
					"File passed to constructor is not a directory : "
							+ temp.getAbsolutePath());
		}

		sourceDirectory = new File(temp.getAbsolutePath());
	}

	public String getPath() {
		return sourceDirectory.getAbsolutePath();
	}

	public void setPath(String path) {
		sourceDirectory = null;
		createDirectoryFileFromPath(path);
	}

	private static File createDirectoryFileFromPath(String path) {
		if (path == null) {
			return null;
		}
		File temp = new File(path);
		if (!temp.exists()) {
			throw new IllegalArgumentException("Invalid path : " + path);
		}

		if (temp.isFile()) {
			temp = temp.getParentFile();
		}
		return temp;
	}

	public void setIncludeDirectories(boolean includeDirectories) {
		this.includeDirectories = includeDirectories;
	}

	public boolean getIncludeDirectories() {
		return includeDirectories;
	}

	@Override
	protected List<File> fetchBackingData() {
		if (sourceDirectory != null) {
			return Arrays.asList(sourceDirectory.listFiles(fileFilter));
		}
		return Collections.emptyList();
	}
}