Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2020 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.store.jdbc2;

import java.util.List;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.NewDataStoreParameters;

import org.gvsig.fmap.dal.SupportTransactions;

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

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

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

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

import org.gvsig.fmap.dal.store.jdbc.JDBCNewStoreParameters;

import org.gvsig.fmap.dal.store.jdbc.JDBCServerExplorerParameters;

import org.gvsig.fmap.dal.store.jdbc.JDBCStoreParameters;

import org.gvsig.fmap.dal.store.jdbc.exception.JDBCException;

public interface JDBCServerExplorer extends ResourceConsumer, org.gvsig.fmap.dal.store.jdbc.JDBCServerExplorer, SupportTransactions  {

    public static final String QUERY_DONT_ADD_PRIMARY_KEY_IN_THE_ORDER = "DONT_ADD_PRIMARY_KEY_IN_THE_ORDER";

    public static int SHOW_TABLES_AND_VIEWS = 0;

    public static int SHOW_TABLES = 1;

    public static int SHOW_VIEWS = 2;

    @Override

    public JDBCServerExplorerParameters getParameters();

    @Override

    public String getProviderName();

    @Override

    public String getStoreName();

    @Override

    public boolean canAdd();

    @Override

    public boolean add(

            String providerName, 

            NewDataStoreParameters theParams, 

            boolean overwrite

    ) throws DataException;

    @Override

    public List<DataStoreParameters> list(int mode) throws DataException;

    @Override

    public DataStore open(DataStoreParameters params) throws DataException;

    public DataStore open(String tableName) throws DataException;

    @Override

    public void remove(DataStoreParameters theParams) throws RemoveException;

    @Override

    public void updateTableStatistics(String database, String schema, String table) throws JDBCException;

    @Override

    public JDBCNewStoreParameters getAddParameters() throws DataException;

    @Override

    public JDBCStoreParameters getOpenParameters() throws DataException;

    @Override

    public JDBCStoreParameters get(String name) throws DataException;

    @Override

    public List getDataStoreProviderNames();

    @Override

    public FeatureType getFeatureType(DataStoreParameters theParams) throws DataException;

    public void setCustomResources(String tableName, String resourcesTableName);

    public void setCustomResources(String tableName, String resourcesTableName, boolean readonly);

    /**

     * Provides a list of available stores in the server of a type.

     *

     * @param mode , filter store from a type: {@link #MODE_ALL},

     *            {@link #MODE_FEATURE}, {@link #MODE_FEATURE_GEOMETRY},

     *            {@link #MODE_RASTER}

     *

     * @param tablesOrViews , filter store between tables and views: {@link #SHOW_TABLES_AND_VIEWS},

     *            {@link #SHOW_TABLES}, {@link #SHOW_VIEWS}

     *

     * @return list of DataStoreParameters

     *

     * @throws DataException

     */

    public List<DataStoreParameters> list(int mode, int tablesOrViews) throws DataException;

    /**

     * Check if the explorer defined by this parameters reference to a database.

     * @return true if database exists, false if not.

     */

    public boolean exists();

    public String getConnectionProviderStatus();

}