| gvSIG desktop 1

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

*

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

*

*/

/*

* AUTHORS (In addition to CIT):

* 2009 IVER T.I   {{Task}}

*/

/**

 *

 */

package org.gvsig.fmap.dal.store.jdbc;

import java.sql.Connection;

import java.sql.ResultSet;

import java.sql.SQLException;

import java.sql.Statement;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.List;

import org.gvsig.fmap.dal.DataServerExplorer;

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

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

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

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

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.fmap.dal.feature.FeatureAttributeDescriptor;

import org.gvsig.fmap.dal.feature.FeatureQuery;

import org.gvsig.fmap.dal.feature.FeatureType;

import org.gvsig.fmap.dal.feature.exception.PerformEditingException;

import org.gvsig.fmap.dal.feature.spi.AbstractFeatureStoreProvider;

import org.gvsig.fmap.dal.feature.spi.FeatureData;

import org.gvsig.fmap.dal.feature.spi.FeatureReferenceProviderServices;

import org.gvsig.fmap.dal.feature.spi.FeatureSetProvider;

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

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

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

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

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

import org.gvsig.tools.persistence.PersistenceException;

import org.gvsig.tools.persistence.PersistentState;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * @author jmvivo

 *

 */

public abstract class JDBCStoreProvider extends AbstractFeatureStoreProvider

                implements ResourceConsumer {

        final static private Logger logger = LoggerFactory

                        .getLogger(JDBCStoreProvider.class);

        private List resulsetList;

        public JDBCStoreProvider() {

                super();

                resulsetList = new ArrayList(10);

        }

        /**

         * Permform a {@link Resource#begin()} to the current provider resources.

         *

         */

        protected abstract void resourceBegin() throws ResourceBeginException;

        /**

         * Permform a {@link Resource#end()} to the current provider resources.

         */

        protected abstract void resourceEnd();

        public abstract String compoundSelect(FeatureType type,

                        String filter,

                        String order,

                        long limit, long offset) throws DataException;

        /**

         * Get feature count for a <code>filter</code>.<br>

         *

         * <code>filter</code> can be <code>null</code>.<br>

         *

         * <strong>Note:</strong><br>

         * this method have to perform <code>resouceBegin</code> at the begining and

         * <code>resourceEnd</code> at the end of execution.

         *

         *

         * @param filter

         * @return

         * @throws DataException

         */

        protected abstract long getCount(String filter) throws DataException;

        /**

         * Load data form a resulset.<br>

         *

         * <strong>Note:</strong><br>

         * this method have to perform <code>resouceBegin</code> at the begining and

         * <code>resourceEnd</code> at the end of execution.

         *

         *

         * @param data

         * @param resulsetID

         *

         * @return

         * @throws DataException

         */

        public void loadFeatureData(FeatureData data, int resultsetID)

                        throws DataException {

                this.resourceBegin();

                try {

                        ResultSet rs = getResultSet(resultsetID);

                        FeatureAttributeDescriptor attr;

                        Iterator iter = data.getType().iterator();

                        while (iter.hasNext()) {

                                attr = (FeatureAttributeDescriptor) iter.next();

                                loadFeatureDataValue(data, rs, attr);

                        }

                } finally {

                        this.resourceEnd();

                }

        }

        protected void loadFeatureDataValue(FeatureData data, ResultSet rs,

                        FeatureAttributeDescriptor attr) throws DataException {

                try {

                        data.set(attr.getIndex(), rs.getObject(attr.getIndex() + 1));

                } catch (SQLException e) {

                        throw new JDBCSQLException(e);

                }

        }

        public final int createResultSet(String sql)

                        throws DataException {

                return createResultSet(sql, null);

        }

        public final int createResultSet(String sql, Object[] values)

                        throws DataException {

                synchronized (this) {

                        resourceBegin();

                        try {

                                ResultSet newRs = createNewResultSet(sql, values);

                                int newId = getNewId();

                                if (newId < 0) {

                                        newId = resulsetList.size();

                                        resulsetList.add(newRs);

                                } else {

                                        resulsetList.set(newId, newRs);

                                }

                                if (logger.isDebugEnabled()) {

                                        logger.debug(" id: " + newId + " (total "

                                                        + getResultsetOpenCount() + ")");

                                }

                                return newId;

                        } finally {

                                resourceEnd();

                        }

                }

        }

        protected abstract ResultSet createNewResultSet(String sql, Object[] values)

                        throws DataException;

        private int getNewId() {

                int newId;

                if (resulsetList.size() < 1) {

                        return -1;

                }

                for (newId = 0; newId < resulsetList.size(); newId++) {

                        if (resulsetList.get(newId) == null) {

                                return newId;

                        }

                }

                return -1;

        }

        protected final void forceCloseAllResultSet()

                        throws ResourceBeginException,

                        JDBCException {

                synchronized (this) {

                        Iterator iter = resulsetList.iterator();

                        Integer rsID = null;

                        while (iter.hasNext()) {

                                rsID = (Integer) iter.next();

                                if (rsID != null) {

                                        try {

                                                logger.warn("Close forced of resultSet ({})", rsID);

                                                closeResulset(rsID.intValue());

                                        } catch (InvalidResultSetIdException e) {

                                                continue;

                                        }

                                }

                                iter.remove();

                        }

                }

        }

        protected final ResultSet getResultSet(int resultsetID)

                        throws InvalidResultSetIdException {

                if (resultsetID >= resulsetList.size()) {

                        throw new InvalidResultSetIdException(resultsetID);

                }

                ResultSet rs = (ResultSet) resulsetList.get(resultsetID);

                if (rs == null) {

                        throw new InvalidResultSetIdException(resultsetID);

                }

                return rs;

        }

        private ResultSet dropResultSet(int resultsetID)

                        throws InvalidResultSetIdException {

                if (resultsetID >= resulsetList.size()) {

                        throw new InvalidResultSetIdException(resultsetID);

                }

                ResultSet rs = (ResultSet) resulsetList.get(resultsetID);

                if (rs == null) {

                        throw new InvalidResultSetIdException(resultsetID);

                }

                if (resultsetID == resulsetList.size() - 1) {

                        resulsetList.remove(resultsetID);

                } else {

                        resulsetList.set(resultsetID, null);

                }

                return rs;

        }

        public final boolean resulsetNext(int resultsetID) throws JDBCException,

                        InvalidResultSetIdException, ResourceBeginException {

                ResultSet rs = getResultSet(resultsetID);

                resourceBegin();

                try {

                        return rs.next();

                } catch (SQLException e) {

                        throw new JDBCSQLException(e);

                } finally {

                        resourceEnd();

                }

        }

        public final void closeResulset(int resultsetID)

                        throws JDBCException,

                        InvalidResultSetIdException, ResourceBeginException {

                synchronized (this) {

                        resourceBegin();

                        try {

                                ResultSet rs = dropResultSet(resultsetID);

                                closeResulset(rs);

                                if (logger.isDebugEnabled()) {

                                        logger.debug(" id: " + resultsetID + " (total "

                                                        + getResultsetOpenCount() + ")");

                                }

                        } finally {

                                resourceEnd();

                        }

                }

        }

        private int getResultsetOpenCount() {

                int count = 0;

                Iterator iter = resulsetList.iterator();

                while (iter.hasNext()) {

                        if (iter.next() != null) {

                                count++;

                        }

                }

                return count;

        }

        protected void closeResulset(ResultSet rs) throws JDBCException,

                        ResourceBeginException {

                resourceBegin();

                try {

                        Statement st = rs.getStatement();

                        Connection con = st.getConnection();

                        try {

                                rs.close();

                        } finally {

                                // TODO revisar esto

                                try{ st.close();  } catch (Exception ex){ };

                                try{ con.close(); } catch (Exception ex){ };

                        }

                } catch (SQLException e) {

                        throw new JDBCSQLException(e);

                } finally {

                        resourceEnd();

                }

        }

        protected final int openResulsetCount() {

                int count = 0;

                Iterator iter = resulsetList.iterator();

                while (iter.hasNext()) {

                        if (iter.next() != null) {

                                count++;

                        }

                }

                return count;

        }

        public boolean closeResourceRequested(ResourceProvider resource) {

                try {

                        return openResulsetCount() == 0 && closeResource(resource);

                } catch (ResourceNotifyCloseException e) {

                        return false;

                }

        }

        protected abstract boolean closeResource(ResourceProvider resource)

                        throws ResourceNotifyCloseException;

        public void dispose() throws CloseException {

                this.close();

                resulsetList = null;

                super.dispose();

        }

        public DataServerExplorer getExplorer() throws ReadException {

                // TODO Auto-generated method stub

                return null;

        }

        public void performEditing(Iterator deleteds, Iterator inserteds,

                        Iterator updateds, Iterator originalFeatureTypesUpdated) throws PerformEditingException {

                // TODO Auto-generated method stub

        }

        public PersistentState getState() throws PersistenceException {

                // TODO Auto-generated method stub

                return null;

        }

        public void loadState(PersistentState state) throws PersistenceException {

                // TODO Auto-generated method stub

        }

        public void setState(PersistentState state) throws PersistenceException {

                // TODO Auto-generated method stub

        }

        public Iterator getChilds() {

                // TODO Auto-generated method stub

                return null;

        }

        public Object getSourceId() {

                // TODO Auto-generated method stub

                return null;

        }

        public void open() throws OpenException {

                // TODO Auto-generated method stub

        }

        public void append(Feature feature) throws DataException {

                // TODO Auto-generated method stub

        }

        public void beginAppend() throws DataException {

                // TODO Auto-generated method stub

        }

        public boolean canWriteGeometry(int geometryType) throws DataException {

                // TODO Auto-generated method stub

                return false;

        }

        public Object createNewOID() {

                // TODO Auto-generated method stub

                return null;

        }

        public FeatureSetProvider createSet(FeatureQuery query,

                        FeatureType featureType) throws DataException {

                // TODO Auto-generated method stub

                return null;

        }

        public void endAppend() throws DataException {

                // TODO Auto-generated method stub

        }

        public FeatureData getFeatureDataByReference(

                        FeatureReferenceProviderServices reference, FeatureType featureType)

                        throws DataException {

                // TODO Auto-generated method stub

                return null;

        }

        public FeatureData getFeatureDataByReference(

                        FeatureReferenceProviderServices reference) throws DataException {

                // TODO Auto-generated method stub

                return null;

        }

        public int getFeatureReferenceOIDType() {

                // TODO Auto-generated method stub

                return 0;

        }

        public String getName() {

                // TODO Auto-generated method stub

                return null;

        }

        public boolean supportsAppendMode() {

                // TODO Auto-generated method stub

                return false;

        }

        public void resourceChanged(ResourceProvider resource) {

                // TODO Auto-generated method stub

        }

        public void close() throws CloseException {

                super.close();

                try {

                        resourceBegin();

                } catch (ResourceBeginException e) {

                        new CloseException(this.getName(), e);

                }

                try {

                        forceCloseAllResultSet();

                } catch (DataException e) {

                        new CloseException(this.getName(), e);

                } finally {

                        resourceEnd();

                }

        }

}