Application: gvSIG desktop

org.gvsig.fmap.dal.DALFileLibrary

/**

 * 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 3

 * 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.fmap.dal;

import java.io.InputStream;

import org.gvsig.metadata.MetadataLocator;

import org.gvsig.metadata.MetadataManager;

import org.gvsig.metadata.exceptions.MetadataException;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.exception.BaseRuntimeException;

import org.gvsig.tools.persistence.PersistenceManager;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public class FileHelper {

	private static final Logger LOG = LoggerFactory.getLogger(FileHelper.class);

	private FileHelper() {

		// Do nothing

	}

	public static DynStruct registerParametersDefinition(String name, Class theClass, String filename) {

		DynStruct definition = null;

		PersistenceManager manager = ToolsLocator.getPersistenceManager();

		definition = manager.getDefinition(name);

		if ( definition == null) {

			InputStream stream = theClass.getResourceAsStream(filename);

			if( stream == null ) {

				throw new DefinitionNotFoundException(theClass,filename);

			}

			definition = manager.addDefinition(

					theClass,

					name, 

					stream,

					theClass.getClassLoader(), 

					null, 

					null

			);

		}

		return definition;

	}

	public static DynStruct registerMetadataDefinition(String name, Class theClass, String filename) throws MetadataException {

		DynStruct definition = null;

		MetadataManager manager = MetadataLocator.getMetadataManager();

		definition = manager.getDefinition(name);

		if ( definition == null) {

			InputStream stream = theClass.getResourceAsStream(filename);

			if( stream == null ) {

				throw new DefinitionNotFoundException(theClass,filename);

			}

			definition = manager.addDefinition(

					name, 

					theClass.getResourceAsStream(filename),

					theClass.getClassLoader()

			);

		}

		return definition;

	}

	public static DynObject newParameters(String name) {

    	return ToolsLocator.getDynObjectManager()

			.createDynObject(

				ToolsLocator.getPersistenceManager().getDefinition(name)

			);

	}

	public static DynObject newMetadataContainer(String name) {

		try {

			MetadataManager manager = MetadataLocator.getMetadataManager();

			DynStruct definition = manager.getDefinition(name);

	    	return ToolsLocator.getDynObjectManager().createDynObject(definition);

		} catch(NullPointerException e) {

			throw new CantCreateMetadataException(name,e);

		}

	}

	private static class DefinitionNotFoundException extends BaseRuntimeException {

		/**

		 * 

		 */

		private static final long serialVersionUID = 7598155353307119897L;

		public DefinitionNotFoundException(Class theClass, String filename ) {

			super(

				"Can't open parameters definition '%(filename)' from class %(classname).",

				"_ResourceForParametersDefinitionNotFoundException",

				serialVersionUID

			);

			this.setValue("filename", filename);

			this.setValue("classname", theClass.getClass().getName());

		}

	}

	private static class CantCreateMetadataException extends RuntimeException {

		/**

		 * 

		 */

		private static final long serialVersionUID = -8373306339537106075L;

		CantCreateMetadataException(String name, Throwable cause) {

			super("Can't retrieve metadata definition for '"+name+"'.", cause);			

		}

	}

}

/**

 * 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 3

 * 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.fmap.dal;

import org.gvsig.fmap.dal.serverexplorer.filesystem.spi.FilesystemServerExplorerManager;

import org.gvsig.tools.locator.AbstractLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

public class DALFileLocator extends AbstractLocator {

	private static final String LOCATOR_NAME = "DALFileLocator";

	/**

	 * DataManager name used by the locator to access the instance

	 */

	public static final String FILESYSTEMSERVEREXPLORERE_MANAGER_NAME = "FilesystemServerExplorereManager";

	private static final String FILESYSTEMSERVEREXPLORERE_MANAGER_DESCRIPTION = "FilesystemServerExplorereManager of gvSIG Data Access Library";

	/**

	 * Unique instance.

	 */

	private static final DALFileLocator instance = new DALFileLocator();

	/**

	 * Return the singleton instance.

	 *

	 * @return the singleton instance

	 */

	public static DALFileLocator getInstance() {

		return instance;

	}

	public String getLocatorName() {

		return LOCATOR_NAME;

	}

	/**

	 * Return a reference to FilesystemServerExplorerManager.

	 *

	 * @return a reference to FilesystemServerExplorerManager

	 * @throws LocatorException

	 *             if there is no access to the class or the class cannot be

	 *             instantiated

	 * @see Locator#get(String)

	 */

	public static FilesystemServerExplorerManager getFilesystemServerExplorerManager()

			throws LocatorException {

		return (FilesystemServerExplorerManager) getInstance().get(

				FILESYSTEMSERVEREXPLORERE_MANAGER_NAME);

	}

	/**

	 * Registers the Class implementing the FilesystemSeverExplorerManager

	 * interface.

	 * 

	 * @param clazz

	 *            implementing the FilesystemSeverExplorerManager interface

	 */

	public static void registerFilesystemSeverExplorerManager(Class clazz) {

		getInstance().register(FILESYSTEMSERVEREXPLORERE_MANAGER_NAME,

				FILESYSTEMSERVEREXPLORERE_MANAGER_DESCRIPTION,

				clazz);

	}

}

/**

 * 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 3

 * 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.fmap.dal;

import org.gvsig.fmap.dal.resource.file.FileResource;

import org.gvsig.fmap.dal.resource.file.FileResourceParameters;

import org.gvsig.fmap.dal.resource.spi.ResourceManagerProviderServices;

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemServerExplorer;

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemServerExplorerParameters;

import org.gvsig.fmap.dal.serverexplorer.filesystem.impl.DefaultFilesystemServerExplorer;

import org.gvsig.fmap.dal.serverexplorer.filesystem.impl.DefaultFilesystemServerExplorerManager;

import org.gvsig.fmap.dal.spi.DataManagerProviderServices;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

public class DALFileLibrary extends AbstractLibrary {

    public void doRegistration() {

        registerAsServiceOf(DALLibrary.class);

    }

	protected void doInitialize() throws LibraryException {

	}

	protected void doPostInitialize() throws LibraryException {

    	DataManagerProviderServices dataman = (DataManagerProviderServices) DALLocator.getDataManager();

    	ResourceManagerProviderServices resman = (ResourceManagerProviderServices) DALLocator.getResourceManager();

    	if (!resman.getResourceProviders().contains(FileResource.NAME)) {

			resman.register(FileResource.NAME, FileResource.DESCRIPTION,

					FileResource.class, FileResourceParameters.class);

		}

    	if (!dataman.getExplorerProviders().contains(FilesystemServerExplorer.NAME)) {

			dataman.registerExplorerProvider(FilesystemServerExplorer.NAME,

					DefaultFilesystemServerExplorer.class,

					FilesystemServerExplorerParameters.class);

			DALFileLocator

					.registerFilesystemSeverExplorerManager(DefaultFilesystemServerExplorerManager.class);

    	}

	}

}

/**

 * 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 3

 * 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.fmap.dal.resource.file;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.text.MessageFormat;

import org.gvsig.fmap.dal.exception.InitializeException;

import org.gvsig.fmap.dal.resource.ResourceParameters;

import org.gvsig.fmap.dal.resource.exception.AccessResourceException;

import org.gvsig.fmap.dal.resource.exception.PrepareResourceException;

import org.gvsig.fmap.dal.resource.exception.ResourceException;

import org.gvsig.fmap.dal.resource.exception.ResourceNotifyOpenException;

import org.gvsig.fmap.dal.resource.spi.AbstractResource;

/**

 * @author jmvivo

 *

 */

public class FileResource extends AbstractResource {

	final public static String NAME = "file";

	final public static String DESCRIPTION = "File of filesystem";

	private File file;

	public FileResource(FileResourceParameters params)

			throws InitializeException {

		super(params);

		file = null;

	}

	public Object get() throws AccessResourceException {

		return getFile();

	}

	public String getFileName() throws AccessResourceException {

		return (String) getFile().getPath();

	}

	public File getFile() throws AccessResourceException {

		try {

			prepare();

		} catch (PrepareResourceException e) {

			throw new AccessResourceException(this, e);

		}

		return ((FileResourceParameters)getParameters()).getFile();

	}

	// TODO ???

	public FileInputStream getFileInputStream() throws AccessResourceException,

			FileNotFoundException {

		FileInputStream fis = new FileInputStream(getFile());

		try {

			notifyOpen();

		} catch (ResourceNotifyOpenException e) {

			throw new AccessResourceException(this, e);

		}

		return fis;

	}

	public String getName() throws AccessResourceException {

		return MessageFormat.format("FileResource({0})",

				new Object[] { getFileName() });

	}

	public boolean isThis(ResourceParameters parameters)

			throws ResourceException {

		if (!(parameters instanceof FileResourceParameters)) {

			return false;

		}

		FileResourceParameters params;

		params = (FileResourceParameters) parameters.getCopy();

		prepare(params);

		return params.getFileName().equals(this.getFileName());

	}

}

/**

 * 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 3

 * 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.fmap.dal.resource.file;

import java.io.File;

import org.gvsig.fmap.dal.resource.spi.AbstractResourceParameters;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dataTypes.DataTypes;

import org.gvsig.tools.dynobject.DelegatedDynObject;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.persistence.PersistenceManager;

public class FileResourceParameters extends AbstractResourceParameters {

    public static final String DYNCLASS_NAME = "FileResourceParameters";

    private static final String DYNFIELDNAME_FILE = "file";

	private DelegatedDynObject delegatedDynObject;

    public FileResourceParameters() {

		this.delegatedDynObject = (DelegatedDynObject) ToolsLocator

				.getDynObjectManager()

				.createDynObject(registerDynClass());

	}

	public FileResourceParameters(Object[] params) {

		this();

		// XXX puede que sobre

        setDynValue(DYNFIELDNAME_FILE, params[0]);

	}

	public FileResourceParameters(String name) {

		this();

		setDynValue(DYNFIELDNAME_FILE, name);

	}

	public String getFileName() {

		if( this.getFile()== null ) {

			return null;

		}

		return this.getFile().getPath();

	}

	public FileResourceParameters setFileName(String fileName) {

		this.setDynValue(DYNFIELDNAME_FILE, fileName);

		return this;

	}

	public File getFile() {

		return (File) this.getDynValue(DYNFIELDNAME_FILE);

	}

	public FileResourceParameters setFile(File file) {

		this.setDynValue(DYNFIELDNAME_FILE, file);

		return this;

	}

	public FileResourceParameters setFile(String fileName) {

		this.setDynValue(DYNFIELDNAME_FILE, fileName);

		return this;

	}

	public String getTypeName() {

		return FileResource.NAME;

	}

	protected DelegatedDynObject getDelegatedDynObject() {

		return delegatedDynObject;

	}

	/**

	 * Added "static synchronized" because sometimes

	 * there is a "DuplicateDynClassException" when user

	 * selects more than one file (SHP, for example) to be

	 * added to the view. "definition" is null but then there is

	 * an exception because in the meantime another thread has registered it

	 * (I'm not sure this is the cause, but I cannot imagine another

	 * reason)

	 */

    private static synchronized DynClass registerDynClass() {

    	PersistenceManager manager = ToolsLocator.getPersistenceManager();

    	DynClass definition = (DynClass) manager.getDefinition(DYNCLASS_NAME);

    	if( definition == null ) {

    		definition = (DynClass) manager.addDefinition(

    				FileResourceParameters.class,

    				DYNCLASS_NAME, 

    				DYNCLASS_NAME+" persistence definition", 

    				null, 

    				null

    		);

			definition.addDynField(DYNFIELDNAME_FILE).setType(DataTypes.FILE)

					.setDescription("The file");

        }

        return definition;

    }

}

/**

 * 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 3

 * 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.fmap.dal.serverexplorer.filesystem;

import java.io.FileFilter;

public interface FilesystemFileFilter extends FileFilter {

	public String getDataStoreProviderName();

	public String getDescription();

}

/**

 * 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 3

 * 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.fmap.dal.serverexplorer.filesystem;

import org.gvsig.fmap.dal.exception.CreateException;

public class AbsolutePathRequiredException extends CreateException {

	private static final long serialVersionUID = 8723525042950358334L;

	private final static String MESSAGE_FORMAT = "Absolute path required creating '%(resource)'.";

	private final static String MESSAGE_KEY = "_AbsolutePathRequiredException";

	public AbsolutePathRequiredException(String resource) {

		super(MESSAGE_FORMAT, MESSAGE_KEY, serialVersionUID);

		setValue("resource", resource);

	}

}

/**

 * 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 3

 * 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.fmap.dal.serverexplorer.filesystem.spi;

import java.util.Iterator;

public interface FilesystemServerExplorerManager {

	final public static String FILE_FILTER_EPSNAME = "FilesystemExplorerFilters";

	final public String FILE_FILTER_EPSDESCRIPTION = "Registro de filtros asociados al explorador del sistema de ficheros.";

	public void registerProvider(String name, String description,

			Class filesystemServerProvicerClass);

	public Iterator getRegisteredProviders();

}

/**

 * 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 3

 * 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.fmap.dal.serverexplorer.filesystem.spi;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.NewDataStoreParameters;

import org.gvsig.fmap.dal.exception.CreateException;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.exception.RemoveException;

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemFileFilter;

/**

 * @author jmvivo

 *

 */

public interface FilesystemServerExplorerProvider extends FilesystemFileFilter {

	public void initialize(FilesystemServerExplorerProviderServices serverExplorer);

	public boolean canCreate();

	public void create(NewDataStoreParameters parameters, boolean overwrite)

			throws CreateException;

	public NewDataStoreParameters getCreateParameters() throws DataException;

	public void remove(DataStoreParameters parameters) throws RemoveException;

	public boolean canCreate(NewDataStoreParameters parameters);

	public String getResourceRootPathName(DataStore dataStore);

	public int getMode();

	/**

	 * Return true if any mode in the parameter is supported.

	 * 

	 * @param mode

	 * @return

	 */

	public boolean isMode(int mode);

}

/**

 * 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 3

 * 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.fmap.dal.serverexplorer.filesystem.spi;

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemServerExplorer;

import org.gvsig.fmap.dal.spi.DataServerExplorerProvider;

public interface FilesystemServerExplorerProviderServices extends

		DataServerExplorerProvider, FilesystemServerExplorer {

}

/**

 * 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 3

 * 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.fmap.dal.serverexplorer.filesystem;

import java.io.File;

import java.util.Iterator;

import java.util.List;

import org.gvsig.fmap.dal.DataServerExplorer;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.NewDataStoreParameters;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.exception.FileNotFoundException;

public interface FilesystemServerExplorer extends DataServerExplorer {

	public static final String NAME = "FilesystemExplorer";

	public void setCurrentPath(File path) throws FileNotFoundException;

	public File getCurrentPath();

	public File getRoot();

	public List getProviderNameList(File file);

	public String getProviderName(File file);

	public NewDataStoreParameters getAddParameters(File file)

			throws DataException;

	public DataStoreParameters createStoreParameters(File file)

			throws DataException;

	public DataStoreParameters createStoreParameters(File file, String providerName) 

			throws DataException;

//	public DataStore open(File file) throws DataException,

//			ValidateDataParametersException;

	public Iterator getFilters();

	public Iterator getFilters(int mode);

	public FilesystemFileFilter getFilter(int mode, String description);

	public FilesystemFileFilter getGenericFilter();

	public File getResourcePath(DataStore dataStore, String resourceName) throws DataException;

}

/**

 * 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 3

 * 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.fmap.dal.serverexplorer.filesystem;

import org.gvsig.fmap.dal.DataServerExplorerParameters;

import org.gvsig.fmap.dal.DataTypes;

import org.gvsig.fmap.dal.spi.AbstractDataParameters;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DelegatedDynObject;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynObjectManager;

public class FilesystemServerExplorerParameters extends AbstractDataParameters

		implements DataServerExplorerParameters {

    public static final String DYNCLASS_NAME = "FilesystemServerExplorerParameters";

    private static final String FIELD_ROOT = "root";

	private DelegatedDynObject delegatedDynObject;

	public FilesystemServerExplorerParameters() {

		this.delegatedDynObject = (DelegatedDynObject) ToolsLocator

				.getDynObjectManager()

				.createDynObject(this.registerDynClass());

	}

	private DynClass registerDynClass() {

	   	DynObjectManager dynman = ToolsLocator.getDynObjectManager();

    	DynClass dynClass = dynman.get(DYNCLASS_NAME);

    	DynField field;

    	if (dynClass == null) {

    		dynClass = dynman.add(DYNCLASS_NAME);

    		field = dynClass.addDynField(FIELD_ROOT);

    		field.setType(DataTypes.STRING);

    		field.setDescription("Root directory path of the explorer");

    		field.setTheTypeOfAvailableValues(DynField.ANY);

    		field = dynClass.addDynField("initialpath");

			field.setType(DataTypes.STRING);

			field.setDescription("Initial path of the explorer");

			field.setTheTypeOfAvailableValues(DynField.ANY);

    	}

    	return dynClass;

	}

	public void setRoot(String path) {

		this.setDynValue(FIELD_ROOT, path);

	}

	public String getRoot() {

		return (String) this.getDynValue(FIELD_ROOT);

	}

	public void setInitialpath(String path) {

		this.setDynValue("initialpath", path);

	}

	public String getInitialpath() {

		return (String) this.getDynValue("initialpath");

	}

	public String getExplorerName() {

		return FilesystemServerExplorer.NAME;

	}

	protected DelegatedDynObject getDelegatedDynObject() {

		return delegatedDynObject;

	}

}

/**

 * 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 3

 * 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.fmap.dal.serverexplorer.filesystem.impl;

import java.io.File;

import java.util.ArrayList;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.Set;

import org.gvsig.fmap.dal.DALFileLocator;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.DataServerExplorerParameters;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.NewDataStoreParameters;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.exception.FileNotFoundException;

import org.gvsig.fmap.dal.exception.InitializeException;

import org.gvsig.fmap.dal.exception.ProviderNotRegisteredException;

import org.gvsig.fmap.dal.exception.RemoveException;

import org.gvsig.fmap.dal.exception.ServerExplorerAddException;

import org.gvsig.fmap.dal.exception.ValidateDataParametersException;

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemFileFilter;

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemServerExplorer;

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemServerExplorerParameters;

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemStoreParameters;

import org.gvsig.fmap.dal.serverexplorer.filesystem.spi.FilesystemServerExplorerProvider;

import org.gvsig.fmap.dal.serverexplorer.filesystem.spi.FilesystemServerExplorerProviderServices;

import org.gvsig.fmap.dal.spi.DataManagerProviderServices;

import org.gvsig.fmap.dal.spi.DataServerExplorerProviderServices;

import org.gvsig.tools.dispose.impl.AbstractDisposable;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.extensionpoint.ExtensionPoint.Extension;

public class DefaultFilesystemServerExplorer extends AbstractDisposable

		implements FilesystemServerExplorerProviderServices,

		FilesystemFileFilter {

	FilesystemServerExplorerParameters parameters;

	private File root;

	private File current; // Current path

	private DataServerExplorerProviderServices providerServices;

	private List serverProviders;

	public DefaultFilesystemServerExplorer(

			FilesystemServerExplorerParameters parameters,

			DataServerExplorerProviderServices services)

			throws InitializeException {

		this.parameters = parameters;

		this.providerServices = services;

		if (this.parameters.getRoot() != null) {

			this.root = new File(this.parameters.getRoot());

		}

		if (this.parameters.getInitialpath() != null) {

			this.current = new File(this.parameters.getInitialpath());

		}

		if (this.root == null && this.current == null) {

			// throw new InitializeException(this.getName(),

			// new IllegalArgumentException());

		} else if (this.current == null) {

			this.current = new File(this.parameters.getRoot());

		}

	}

	public DataServerExplorerParameters getParameters() {

		return parameters;

	}

	protected void doDispose() throws BaseException {

		this.parameters = null;

		this.root = null;

	}

	public List list(int mode) throws DataException {

		if (this.current == null) {

			throw new IllegalStateException();

		}

		if (!this.current.exists()) {

			new org.gvsig.fmap.dal.exception.FileNotFoundException(this.current);

		}

		if (!this.current.isDirectory()) {

			new IllegalArgumentException(this.getProviderName()

					+ ": Path not a directory '" + this.current + "'");

		}

		List files = new ArrayList(); // return files

		List providers = this.getProviders(mode); 

		String allfiles[] = this.current.list();

		for (int i = 0; i < allfiles.length; i++) {

			File file = new File(this.root, allfiles[i]);

			Iterator providersit = providers.iterator();

			while (providersit.hasNext()) {

				FilesystemServerExplorerProvider provider = (FilesystemServerExplorerProvider) providersit

						.next();

				if( provider.accept(file)) {

					DataStoreParameters dsp = this.createStoreParameters(file);

					if (dsp != null) {

						files.add(dsp);

					}

					break;

				}

			}

		}

		return files;

	}

	public List list() throws DataException {

		if (this.current == null) {

			throw new IllegalStateException(); // FIXME

		}

		if (!this.current.exists()) {

			// TODO crear excepcion de Data??

			new org.gvsig.fmap.dal.exception.FileNotFoundException(this.current);

		}

		if (!this.current.isDirectory()) {

			new IllegalArgumentException(this.getProviderName()

					+ ": Path not a directory '" + this.current + "'");

		}

		String files[] = this.current.list();

		int i;

		File theFile;

		ArrayList list = new ArrayList();

		DataStoreParameters dsp = null;

		for (i = 0; i < files.length; i++) {

			theFile = new File(this.root, files[i]);

			dsp = this.createStoreParameters(theFile);

			if (dsp != null) {

				list.add(dsp);

			}

		}

		return list;

	}

	public void setCurrentPath(File path) throws FileNotFoundException {

		// FIXME Comprobar si es un directorio existente

		if (!path.exists()) {

			throw new FileNotFoundException(path);

		}

		if (!path.isDirectory()) {

			throw new IllegalArgumentException(path.getPath()

					+ " is not a directory");

		}

		if (!isFromRoot(path)) {

			throw new IllegalArgumentException(path.getPath()

					+ " is not from root");

		}

		this.current = path;

	}

	public File getCurrentPath() {

		return this.current;

	}

	public File getRoot() {

		return this.root;

	}

	public void remove(DataStoreParameters dsp) throws RemoveException {

		String providerName = dsp.getDataStoreName();

		try {

			this.checkIsMine(dsp);

			FilesystemServerExplorerProvider provider = this

					.getProvider(providerName);

			provider.remove(dsp);

		} catch (DataException e) {

			throw new RemoveException(this.getProviderName(), e);

		}

	}

	public boolean add(String providerName, NewDataStoreParameters ndsp,

			boolean overwrite) throws DataException {

		try {

			this.checkIsMine(ndsp);

			FilesystemServerExplorerProvider provider = this

					.getProvider(providerName);

			ndsp.validate();

			provider.create(ndsp, overwrite);

			return true; 

		} catch (DataException e) {

			throw new ServerExplorerAddException(this.getProviderName(), e);

		} catch (ValidateDataParametersException e) {

			throw new ServerExplorerAddException(this.getProviderName(), e);

		}

	}

	public boolean canAdd() {

		return this.root.canWrite();

	}

	public String getProviderName() {

		return FilesystemServerExplorer.NAME;

	}

	public NewDataStoreParameters getAddParameters(String storeName)

			throws DataException {

		FilesystemServerExplorerProvider provider = this.getProvider(storeName);

		if (provider == null) {

			throw new IllegalArgumentException(

					"Not registered in this explorer"); // FIXME

		}

		NewDataStoreParameters nParams = provider.getCreateParameters();

		// nParams.setAttribute("path", this.getCurrentPath().getPath());

		return nParams;

	}

	public boolean canAdd(String storeName) throws DataException {

		if (storeName == null) {

			return false;// CanAdd with genericFilter

		}

		FilesystemServerExplorerProvider provider = this.getProvider(storeName);

		if (provider == null) {

			throw new IllegalArgumentException(

					"Not registered in this explorer"); // FIXME

		}

		return provider.canCreate();

	}

	// ==========================================

	private FilesystemServerExplorerProvider getProvider(String storeName)

			throws InitializeException, ProviderNotRegisteredException {

		Iterator providers = getProviders(FilesystemServerExplorer.MODE_ALL).iterator();

		FilesystemServerExplorerProvider provider;

		while (providers.hasNext()) {

			provider = (FilesystemServerExplorerProvider) providers.next();

			if (provider.getDataStoreProviderName().equals(storeName)) {

				return provider;

			}

		}

		return null;

	}

	private DataManagerProviderServices getManager() {

		return (DataManagerProviderServices) DALLocator.getDataManager();

	}

	public DataStoreParameters createStoreParameters(File file, String providerName) throws DataException {

		return this.getParametersFor(file, providerName, true);

	}

	public DataStoreParameters createStoreParameters(File file) throws DataException {

		return this.getParametersFor(file, null, true);

	}

	public DataStoreParameters getParametersFor(File file, String providerName, boolean checksExist) throws DataException {

		if (checksExist) {

			if (!file.exists()) {

				return null;

			}

			if (!file.isFile()) {

				return null;

			}

			if (!file.canRead()) {

				return null;

			}

			if (file.isHidden()) { // XXX ???

				return null;

			}

		}

		if(providerName == null)

			providerName = this.getProviderName(file);

		if (providerName != null) {

			DataStoreParameters params = this.getManager()

			.createStoreParameters(providerName);

			((FilesystemStoreParameters) params).setFile(file);

			return params;

		}

		return null;

	}

	public List getProviderNameList(File file) {

		Iterator filters = getFilters();

		List list = new ArrayList();

		while (filters.hasNext()) {

			FilesystemFileFilter filter = (FilesystemFileFilter) filters.next();

			if (filter.accept(file)) {

				list.add(filter.getDataStoreProviderName());

			}

		}

		return list;

	}

	public String getProviderName(File file) {

		Iterator filters = getFilters();

		while (filters.hasNext()) {

			FilesystemFileFilter filter = (FilesystemFileFilter) filters.next();

			if (filter.accept(file)) {

				return filter.getDataStoreProviderName();

			}

		}

		return null;

	}

	public List getDataStoreProviderNames() {

		Set names = new HashSet();

		Iterator filters = getFilters();

		while (filters.hasNext()) {

			FilesystemFileFilter filter = (FilesystemFileFilter) filters.next();

			names.add(filter.getDataStoreProviderName());

		}

		return new ArrayList(names);	

	}

	private void checkIsMine(DataStoreParameters dsp)

			throws IllegalArgumentException, DataException {

		// FIXME Exception ???

		if (!(dsp instanceof FilesystemStoreParameters)) {

			new IllegalArgumentException(

					"not instance of FilesystemStoreParameters");

		}

		Iterator filters = getFilters();

		File file = ((FilesystemStoreParameters) dsp).getFile();

		if (!this.isFromRoot(file)) {

			throw new IllegalArgumentException("worng explorer");

		}

		FilesystemFileFilter filter;

		while (filters.hasNext()) {

			filter = (FilesystemFileFilter) filters.next();

			if (dsp.getDataStoreName()

					.equals(filter.getDataStoreProviderName())) {

				return;

			}

		}

		throw new IllegalArgumentException("worng explorer");

	}

	private boolean isFromRoot(File file) {

		if (this.root == null) {

			return true;

		}

		return file.getAbsolutePath().startsWith(this.root.getAbsolutePath());

	}

	public List getProviders() {

		if (this.serverProviders == null) {

			Iterator iter = DALFileLocator.getFilesystemServerExplorerManager()

					.getRegisteredProviders();

			this.serverProviders = new ArrayList();

			Extension ext;

			FilesystemServerExplorerProvider provider;

			while (iter.hasNext()) {

				ext = (Extension) iter.next();

				try {

					provider = (FilesystemServerExplorerProvider) ext.create();

				} catch (Exception e) {

					throw new RuntimeException(e);// FIXME !!!

				}

				provider.initialize(this);

				this.serverProviders.add(provider);

			}

		}

		return this.serverProviders;

	}

	public List getProviders(int mode) {

		Iterator iter = DALFileLocator.getFilesystemServerExplorerManager()

				.getRegisteredProviders();

		List providers = new ArrayList();

		Extension ext;

		FilesystemServerExplorerProvider provider;

		while (iter.hasNext()) {

			ext = (Extension) iter.next();

			try {

				provider = (FilesystemServerExplorerProvider) ext.create();

			} catch (Exception e) {

				throw new RuntimeException(e);// FIXME !!!

			}

			if (provider.isMode(mode)) {

				provider.initialize(this);

				providers.add(provider);

			}

		}

		return providers;

	}

	public Iterator getFilters(int mode) {

		return this.getProviders(mode).iterator();

	}

	public Iterator getFilters() {

		return this.getProviders().iterator();

	}

	public FilesystemFileFilter getFilter(int mode, final String description ) {

		final List filters = new ArrayList();

		Iterator it = this.getFilters(mode);

		while( it.hasNext() ) {

			filters.add( it.next() );

		}

		FilesystemFileFilter filter = new FilesystemFileFilter() {

			public boolean accept(File f) {

				if (f.isDirectory()) {

					return true;

				}

				for(int i=0; i<filters.size(); i++) {

					if( ((FilesystemFileFilter)filters.get(i)).accept(f) ) {

						return true;

					}

				}

				return false;

			}

			public String getDescription() {

				return description;

			}

			public String getDataStoreProviderName() {

				return null;

			}

		};

		return filter;

	}

	public FilesystemFileFilter getGenericFilter() {

		// FIXME: Este metodo, getGenericFilter, no tengo claro que deba existir (jjdc)