Application: gvSIG desktop

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package com.iver.cit.gvsig.fmap.layers;

import java.io.File;

import java.io.IOException;

import java.sql.SQLException;

import java.sql.Types;

import java.util.Hashtable;

import java.util.TreeMap;

import org.apache.log4j.Logger;

import org.cresques.cts.IProjection;

import com.hardcode.driverManager.Driver;

import com.hardcode.driverManager.DriverLoadException;

import com.hardcode.driverManager.DriverManager;

import com.hardcode.driverManager.IDelayedDriver;

import com.hardcode.driverManager.WriterManager;

import com.hardcode.gdbms.driver.exceptions.InitializeDriverException;

import com.hardcode.gdbms.driver.exceptions.ReadDriverException;

import com.hardcode.gdbms.driver.exceptions.WriteDriverException;

import com.hardcode.gdbms.engine.customQuery.QueryManager;

import com.hardcode.gdbms.engine.data.DataSource;

import com.hardcode.gdbms.engine.data.DataSourceFactory;

import com.hardcode.gdbms.engine.data.NoSuchTableException;

import com.hardcode.gdbms.engine.data.driver.DriverException;

import com.hardcode.gdbms.engine.data.edition.DataWare;

import com.hardcode.gdbms.engine.values.Value;

import com.hardcode.gdbms.engine.values.ValueFactory;

import com.iver.cit.gvsig.exceptions.layers.LegendLayerException;

import com.iver.cit.gvsig.exceptions.layers.LoadLayerException;

import com.iver.cit.gvsig.fmap.DriverNotLoadedExceptionType;

import com.iver.cit.gvsig.fmap.LegendDriverExceptionType;

import com.iver.cit.gvsig.fmap.ProgressListener;

import com.iver.cit.gvsig.fmap.core.symbols.ISymbol;

import com.iver.cit.gvsig.fmap.drivers.ConnectionFactory;

import com.iver.cit.gvsig.fmap.drivers.DBException;

import com.iver.cit.gvsig.fmap.drivers.DBLayerDefinition;

import com.iver.cit.gvsig.fmap.drivers.DriverIOException;

import com.iver.cit.gvsig.fmap.drivers.IVectorialDatabaseDriver;

import com.iver.cit.gvsig.fmap.drivers.IVectorialJDBCDriver;

import com.iver.cit.gvsig.fmap.drivers.VectorialDriver;

import com.iver.cit.gvsig.fmap.drivers.VectorialFileDriver;

import com.iver.cit.gvsig.fmap.drivers.WithDefaultLegend;

import com.iver.cit.gvsig.fmap.operations.arcview.ArcJoin;

import com.iver.cit.gvsig.fmap.rendering.IVectorLegend;

import com.iver.cit.gvsig.fmap.rendering.LegendFactory;

import com.iver.cit.gvsig.fmap.rendering.styling.AttrInTableLabeling;

import com.iver.cit.gvsig.fmap.rendering.styling.ILabelingStrategy;

/**

 * Crea un adaptador del driver que se le pasa como par?metro en los m?todos

 * createLayer. Si hay memoria suficiente se crea un FLyrMemory que pasa todas

 * las features del driver a memoria

 */

public class LayerFactory {

        private static Logger logger = Logger.getLogger(LayerFactory.class

                        .getName());

        private static String driversPath = "../FMap 03/drivers";

        private static String writersPath = "../FMap 03/drivers";

        private static DriverManager driverManager;

        private static WriterManager writerManager;

        private static DataSourceFactory dataSourceFactory;

        /**

         * Map en el que se guarda para cada fuente de datos a?adida al sistema, el

         * adaptador que la maneja. Ha de ser un TreeMap ya que esta clase define la

         * igualdad entre las claves a traves del m?todo equals de las mismas. Los

         * objetos FileSource, DBSource y WFSSource tienen definido el m?todo equals

         * de forma que devuelven true cuando dos objetos apuntan a la misma fuente

         * de datos

         */

        private static TreeMap sourceAdapter;

        /**

         * This Hashtable allows to register an alternative LayerClass for

         * an specific LayerClass than is attempting to create this factory

         */

        private static Hashtable layerClassMapping = new Hashtable();

        /*

         * Crea un RandomVectorialFile con el driver que se le pasa como par?metro y

         * guard?ndose el nombre del fichero para realizar los accesos, la capa

         * tendr? asociada la proyecci?n que se pasa como parametro tambi?n

         *

         * @param layerName Nombre de la capa. @param driverName Nombre del driver.

         * @param f fichero. @param proj Proyecci?n.

         *

         * @return FLayer. @throws DriverException

         *

         * @throws DriverException @throws DriverIOException

         */

        public static FLayer createLayer(String layerName, String driverName,

                        File f, IProjection proj) throws LoadLayerException  {

                // Se obtiene el driver que lee

                DriverManager dm = getDM();

                try {

                        Driver d = dm.getDriver(driverName);

                        if (d instanceof VectorialFileDriver) {

                                return createLayer(layerName, (VectorialFileDriver) d, f, proj);

                        }

                } catch (DriverLoadException e) {

                        //hay un poco de lio sobre que excepciones se dejan subir

                        //arriba y que excepciones se quedan en LayerFactory

                        //(esto se debe a que queremos intentar recuperar ciertas capas)

                        //las excepciones de este metodo se dejan subir todas, puesto

                        //que las excepciones de los dos otros metodos createLayer si que

                        //se atrapan

                        DriverNotLoadedExceptionType exceptionType =

                                new DriverNotLoadedExceptionType();

                        exceptionType.setDriverName(driverName);

//                        DriverException exception =

//                                new DriverException(e, exceptionType);

                        throw new LoadLayerException(layerName,e);

                }

                return null;

        }

        /**

         * It creates a FLayer (FLyrVect) which reads its data from a file driver,

         * projected in the specified projection.

         *

         * @param layerName

         *            name of the layer

         * @param d

         *            vectorial file driver to read layer's data

         * @param f

         *            file associated to the driver

         * @param proj

         *            layer projection

         *

         * @return FLayer new vectorial layer

         * @throws LoadLayerException

         *

         * @throws DriverException

         */

        public static FLayer createLayer(String layerName, VectorialFileDriver d,

                        File f, IProjection proj)

        /*throws DriverException*/ {

                FLyrVect layer = new FLyrVect();

                try {

                // TODO Comprobar si hay un adaptador ya

                VectorialFileAdapter adapter = new VectorialFileAdapter(f);

                adapter.setDriver(d);

                //TODO azo: adapter needs a reference to projection and to spatial index (review)

                adapter.setProjection(proj);

                layer.setName(layerName);

                // TODO Meter esto dentro de la comprobaci?n de si hay memoria

                if (false) {

                } else {

                        layer.setSource(adapter);

                        layer.setProjection(proj);

                }

                        // Le asignamos tambi?n una legenda por defecto acorde con

                        // el tipo de shape que tenga. Tampoco s? si es aqu? el

                        // sitio adecuado, pero en fin....

                        if (d instanceof WithDefaultLegend) {

                                WithDefaultLegend aux = (WithDefaultLegend) d;

                                        adapter.start();

                                        layer.setLegend((IVectorLegend) aux.getDefaultLegend());

                                        ILabelingStrategy labeler = aux.getDefaultLabelingStrategy();

                                        if (labeler instanceof AttrInTableLabeling) {

                                                ((AttrInTableLabeling) labeler).setLayer(layer);

                                        }

                                        layer.setLabelingStrategy(labeler);

                                        layer.setIsLabeled(true); // TODO: ac? no s'hauria de detectar si t? etiquetes?????

                                        adapter.stop();

                        } else {

                                IVectorLegend leg = LegendFactory.createSingleSymbolLegend(layer

                                                .getShapeType());

                                layer.setLegend(leg);

                        }

        } catch (ReadDriverException e) {

                layer.setAvailable(false);

                layer.addError(e);

        } catch (LegendLayerException e) {

                layer.setAvailable(false);

                layer.addError(e);

        }

                return layer;

        }

        /**

         * Creates a new vectorial layer from a generic layer (by generic whe mean

         * that we dont know a priory its origin: file, memory, jdbc database, etc.

         *

         * @param layerName

         * @param d

         * @param proj

         * @return

         * @throws DriverException

         */

        public static FLayer createLayer(String layerName, VectorialDriver d,

                        IProjection proj)

        /*

        throws DriverException

        */{

                VectorialAdapter adapter = null;

                if (d instanceof VectorialFileDriver) {

                        adapter = new VectorialFileAdapter(((VectorialFileDriver) d)

                                        .getFile());

                } else if (d instanceof IVectorialDatabaseDriver) {

                        adapter = new VectorialDBAdapter();

                } else {

                        adapter = new VectorialDefaultAdapter();

                }

                adapter.setDriver((VectorialDriver) d);

                //TODO azo:adapter needs a reference to the projection

                adapter.setProjection(proj);

                FLyrVect layer = new FLyrVect();

                layer.setName(layerName);

                layer.setSource(adapter);

                layer.setProjection(proj);

                try {

                        // Le asignamos tambi?n una legenda por defecto acorde con

                        // el tipo de shape que tenga. Tampoco s? si es aqu? el

                        // sitio adecuado, pero en fin....

                        if (d instanceof WithDefaultLegend) {

                                WithDefaultLegend aux = (WithDefaultLegend) d;

                                adapter.start();

                                layer.setLegend((IVectorLegend) aux.getDefaultLegend());

                                ILabelingStrategy labeler = aux.getDefaultLabelingStrategy();

                                if (labeler instanceof AttrInTableLabeling) {

                                        ((AttrInTableLabeling) labeler).setLayer(layer);

                                }

                                layer.setLabelingStrategy(labeler);

                                layer.setIsLabeled(true); // TODO: ac? no s'hauria de detectar si t? etiquetes?????

                                adapter.stop();

                        } else {

                                layer.setLegend(LegendFactory.createSingleSymbolLegend(layer

                                                .getShapeType()));

                        }

                } catch (LegendLayerException e) {

                        layer.setAvailable(false);

                        layer.addError(e);

                } catch (ReadDriverException e) {

                        layer.setAvailable(false);

                        layer.addError(e);

                }

                return layer;

        }

        public static FLayer createArcSDELayer(String layerName,

                        IVectorialDatabaseDriver driver, IProjection proj) {

                // throw new UnsupportedOperationException();

                FLyrVect layer = new FLyrVect();

                VectorialAdapter adapter = new VectorialDBAdapter();

                adapter.setDriver(driver);

                adapter.setProjection(proj);

                layer.setName(layerName);

                layer.setSource(adapter);

                layer.setProjection(proj);

                try {

                        if (driver instanceof WithDefaultLegend) {

                                WithDefaultLegend aux = (WithDefaultLegend) driver;

                                adapter.start();

                                layer.setLegend((IVectorLegend) aux.getDefaultLegend());

                                ILabelingStrategy labeler = aux.getDefaultLabelingStrategy();

                                if (labeler instanceof AttrInTableLabeling) {

                                        ((AttrInTableLabeling) labeler).setLayer(layer);

                                }

                                layer.setLabelingStrategy(labeler);layer.setIsLabeled(true); // TODO: ac? no s'hauria de detectar si t? etiquetes?????

                                adapter.stop();

                        } else {

                                layer.setLegend(LegendFactory.createSingleSymbolLegend(layer

                                                .getShapeType()));

                        }

                } catch (LegendLayerException e) {

                        throw new UnsupportedOperationException(e.getMessage());

                } catch (InitializeDriverException e) {

                        throw new UnsupportedOperationException(e.getMessage());

                } catch (ReadDriverException e) {

                        throw new UnsupportedOperationException(e.getMessage());

                }

                try {

                        layer.setLegend(LegendFactory.createSingleSymbolLegend(layer

                                        .getShapeType()));

                } catch (LegendLayerException e) {

                        e.printStackTrace();

                } catch (ReadDriverException e) {

                        e.printStackTrace();

                }

                return layer;

        }

        /**

         * Crea un RandomVectorialWFS con el driver que se le pasa como par?metro y

         * guard?ndose la URL del servidor que se pasa como par?metro

         *

         * @param driver

         * @param host

         * @param port

         * @param user

         * @param password

         * @param dbName

         * @param tableName

         * @param proj

         *

         * @return Capa creada.

         *

         * @throws UnsupportedOperationException

         */

        public static FLayer createLayer(IVectorialDatabaseDriver driver,

                        String host, int port, String user, String password, String dbName,

                        String tableName, IProjection proj) {

                throw new UnsupportedOperationException();

        }

        public static FLayer createDBLayer(IVectorialDatabaseDriver driver,

                        String layerName, IProjection proj) {

                FLyrVect layer = new FLyrVect();

                layer.setName(layerName);

                VectorialDBAdapter dbAdapter = new VectorialDBAdapter();

                dbAdapter.setDriver(driver);

                dbAdapter.setProjection(proj);//adapter needs also a ref to prj. review (azo)

                layer.setSource(dbAdapter);

                layer.setProjection(proj);

                try {

                        if (driver instanceof WithDefaultLegend) {

                                WithDefaultLegend aux = (WithDefaultLegend) driver;

                                dbAdapter.start();

                                layer.setLegend((IVectorLegend) aux.getDefaultLegend());

                                ILabelingStrategy labeler = aux.getDefaultLabelingStrategy();

                                if (labeler instanceof AttrInTableLabeling) {

                                        ((AttrInTableLabeling) labeler).setLayer(layer);

                                }

                                layer.setLabelingStrategy(labeler);

                                layer.setIsLabeled(true); // TODO: ac? no s'hauria de detectar si t? etiquetes?????

                                dbAdapter.stop();

                        } else {

                                layer.setLegend(LegendFactory.createSingleSymbolLegend(layer

                                                .getShapeType()));

                        }

                        if (driver instanceof IDelayedDriver){

                                // Por defecto, los drivers est?n listos para entregar

                                // features al terminar su initialize. Pero con los drivers

                                // que implementan IDelayedDriver, el driver es responsable

                                // de avisar cu?ndo est? listo

                                layer.getFLayerStatus().setDriverLoaded(false);

                                ((IDelayedDriver) driver).addDriverEventListener(new DefaultDelayedDriverListener(layer));

                        }

                } catch (LegendLayerException e) {

                        LegendDriverExceptionType excepType =

                                new LegendDriverExceptionType("Error al construir la leyenda, campo no encontrado");

                        //TODO Para hacer esto extensible tiene que usarse puntos

                        //de extension, y comparar las clases de leyendas registradas

//                        IVectorialLegend legend = (IVectorialLegend)

//                                ((WithDefaultLegend)driver).getDefaultLegend();

//

//                        excepType.setLegendLabelField(legend.getLabelField());

//                        excepType.setLegendHeightField(legend.getLabelHeightField());

//                        excepType.setLegendRotationField(legend.getLabelRotationField());

//                        DriverException exception = new DriverException(e, excepType);

                        layer.setAvailable(false);

                        layer.addError(null);

                        return layer;

                        // throw new UnsupportedOperationException(e.getMessage());

                } catch (Exception e) {

//                        ExceptionDescription excepType = new GenericDriverExceptionType();

//                        DriverException exception = new DriverException(e, excepType);

                        layer.addError(null);

                        layer.setAvailable(false);

                        return layer;

                }

                return layer;

        }

        /**

         * @param driver

         * @param layerName

         * @param object

         * @return

         * @throws SQLException

         * @throws DriverIOException

         * @throws IOException

         * @throws DriverLoadException

         * @throws com.hardcode.gdbms.engine.data.driver.DriverException

         * @throws NoSuchTableException

         * @throws ClassNotFoundException

         * @throws ReadDriverException

         * @throws IOException

         * @throws WriteDriverException

         * @throws

         */

        public static FLayer createDisconnectedDBLayer(IVectorialJDBCDriver driver,

                        String layerName, IProjection proj, ProgressListener listener)

                        throws DBException,

                        DriverLoadException, NoSuchTableException,

                        ClassNotFoundException, ReadDriverException, IOException, WriteDriverException {

                VectorialDisconnectedDBAdapter dbAdapter = new VectorialDisconnectedDBAdapter();

                dbAdapter.setDriver(driver);

                dbAdapter.setProjection(proj);

                DataSource ds = dbAdapter.getRecordset();

                ds.start();

                String database = dataSourceFactory.getTempFile();

                String[] fieldNames = new String[ds.getFieldCount() + 1];

                System.arraycopy(ds.getFieldNames(), 0, fieldNames, 1, ds

                                .getFieldCount());

                fieldNames[0] = "the_geom";

                int[] types = new int[fieldNames.length];

                types[0] = Types.BINARY;

                for (int i = 1; i < types.length; i++) {

                        types[i] = ds.getFieldType(i - 1);

                }

                String dsName=null;

                try {

                        dsName = dataSourceFactory.createTable(database,

                                        ds.getPKNames(), fieldNames, types);

                } catch (ReadDriverException e) {

                        // TODO Auto-generated catch block

                        e.printStackTrace();

                } catch (SQLException e) {

                        throw new DBException(e);

                }

                DBLayerDefinition lyrDef = new DBLayerDefinition();

                lyrDef.setTableName(dsName);

                lyrDef.setName(layerName);

                lyrDef.setFieldNames(ds.getFieldNames());

                lyrDef.setFieldGeometry("the_geom");

                lyrDef.setFieldID(ds.getPKNames()[0]);

                lyrDef.setClassToInstantiate("org.hsqldb.jdbcDriver");

                dataSourceFactory.addDBDataSourceByTable(dsName, null, 0, "sa", "",

                                database, dsName, "GDBMS HSQLDB Transactional driver");

                DataSource local = dataSourceFactory.createRandomDataSource(dsName,

                                DataSourceFactory.AUTOMATIC_OPENING);

                local.start();

                DataWare dw = local

                                .getDataWare(DataSourceFactory.DATA_WARE_COHERENT_ROW_ORDER);

                dw.start();

                long t1 = System.currentTimeMillis();

                dw.beginTrans();

                if (listener == null) {

                        listener = new ProgressListener() {

                                /**

                                 * @see com.iver.cit.gvsig.fmap.ProgressListener#progress(int)

                                 */

                                public void progress(int n) {

                                        // do nothing

                                }

                        };

                }

                for (int i = 0; i < dbAdapter.getShapeCount(); i++) {

                        Value[] row = new Value[ds.getFieldCount() + 1];

                        byte[] bytes = dbAdapter.getShape(i).toWKB();

                        row[0] = ValueFactory.createValue(bytes);

                        for (int j = 0; j < ds.getFieldCount(); j++) {

                                row[j + 1] = ds.getFieldValue(i, j);

                        }

                        dw.insertFilledRow(row);

                        listener.progress(100 * i / dbAdapter.getShapeCount());

                }

                long t2 = System.currentTimeMillis();

                dw.commitTrans();

                long t3 = System.currentTimeMillis();

                System.out.println((t2 - t1) + " - " + (t3 - t2));

                dw.stop();

                local.stop();

                ds.stop();

                IVectorialJDBCDriver cacheDriver = (IVectorialJDBCDriver) LayerFactory

                                .getDM().getDriver("HSQLDB Driver");

                Class.forName("org.hsqldb.jdbcDriver");

                cacheDriver.setData(ConnectionFactory.createConnection(

                                "jdbc:hsqldb:file:" + database, "sa", ""), lyrDef);

                cacheDriver.setWorkingArea(driver.getWorkingArea());

                return createDBLayer(cacheDriver, layerName, proj);

        }

        /**

         * Devuelve el DriverManager.

         *

         * @return DriverManager.

         */

        public static DriverManager getDM() {

                initializeDriverManager();

                return driverManager;

        }

        /**

         * Devuelve el WriterManager.

         *

         * @return WriterManager.

         */

        public static WriterManager getWM() {

                initializeWriterManager();

                return writerManager;

        }

        /**

         * Inicializa el DriverManager.

         */

        private static void initializeDriverManager() {

                if (driverManager == null) {

                        driverManager = new DriverManager();

                        driverManager.loadDrivers(new File(LayerFactory.driversPath));

                        Throwable[] failures = driverManager.getLoadFailures();

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

                                logger.error("", failures[i]);

                        }

                        getDataSourceFactory().setDriverManager(driverManager);

                        getDataSourceFactory().initialize();

                        QueryManager.registerQuery(new ArcJoin());

                }

        }

        /**

         * Inicializa el DriverManager.

         */

        private static void initializeWriterManager() {

                if (writerManager == null) {

                        writerManager = new WriterManager();

                        writerManager.loadWriters(new File(LayerFactory.writersPath));

                        Throwable[] failures = writerManager.getLoadFailures();

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

                                logger.error("", failures[i]);

                        }

                        getDataSourceFactory().setWriterManager(writerManager);

                        getDataSourceFactory().initialize();

                        // QueryManager.registerQuery(new ArcJoin());

                }

        }

        /**

         * sets drivers Directory

         *

         * @param path

         */

        public static void setDriversPath(String path) {

                LayerFactory.driversPath = path;

                initializeDriverManager();

        }

        /**

         * sets writers Directory

         *

         * @param path

         */

        public static void setWritersPath(String path) {

                LayerFactory.writersPath = path;

                initializeWriterManager();

        }

        /**

         * @return Returns the dataSourceFactory.

         */

        public static DataSourceFactory getDataSourceFactory() {

                if (dataSourceFactory == null) {

                        dataSourceFactory = new DataSourceFactory();

                }

                return dataSourceFactory;

        }

        public static void initialize() {

                initializeDriverManager();

                initializeWriterManager();

        }

        /**

         * Set a class to use instead of the originalLayerClassName.

         *

         * @param originalLayerClassName name of class to relpace

         * @param layerClassToUse Class than implements FLayer interface to use

         *

         * @see  getLayerClassForLayerClassName(String,Class)

         * @see  unregisterLayerClassForName(String)

        */

        public static void registerLayerClassForName (String originalLayerClassName, Class layerClassToUse){

                Class[] interfaces = layerClassToUse.getInterfaces();

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

                        if (interfaces[i] == FLayer.class)

                                break;

                }

                layerClassMapping.put(originalLayerClassName,layerClassToUse);

        }

        /**

         * Unregister the originalLayerClassName class replacement.

         *

         * @param originalLayerClassName name of class to relpace

         * @param layerClassToUse Class than implements FLayer interface to use

         * @return true if the class had been registered

         *

         * @see  getLayerClassForLayerClassName(String,Class)

         * @see  unregisterLayerClassForName(String)

        */

        public static boolean unregisterLayerClassForName (String originalLayerClassName){

                return layerClassMapping.remove(originalLayerClassName) != null;

        }

        /**

         * Gets the class to use for the layerClassName.

         * If isn't registered an alternative class for this layerClass

         * the this returns 'Class.forName(layerClassName)'

         *

         * @param layerClassName

         * @return Class implements FLayer to use

         * @throws ClassNotFoundException

         *

         * @see  registerLayerClassForName(String,Class)

         * @see  unregisterLayerClassForName(String)

         */

        public static Class getLayerClassForLayerClassName(String layerClassName) throws ClassNotFoundException{

                Class layerClass = (Class)layerClassMapping.get(layerClassName);

                if (layerClass == null)

                        layerClass = Class.forName(layerClassName);

                return layerClass;

        }

}