gvSIG projects pool

/*

 * 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, see <https://www.gnu.org/licenses/>. 

 * 

 * 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.online.lib.api.workingcopy;

import java.util.List;

import org.apache.commons.lang3.mutable.MutableLong;

import org.apache.commons.lang3.mutable.MutableObject;

import org.gvsig.fmap.dal.OpenDataStoreParameters;

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

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

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

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

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

import org.gvsig.fmap.dal.store.jdbc2.JDBCServerExplorer;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.online.lib.api.OnlineProject;

import org.gvsig.online.lib.api.OnlineSite;

import org.gvsig.online.lib.api.OnlineUserIdentificationRequester;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.task.SimpleTaskStatus;

/**

 *

 * @author gvSIG Team

 */

public interface OnlineWorkingcopy extends Disposable {

    public static final String TABLE_NAME_ENTITIES = "ONLINE_ENTITIES";

    public static final String AUTODETECT_FLAG = "@AUTODETECT";

    public static final String CATEGORY_DETECT = AUTODETECT_FLAG;

    public static final String DATAMODEL_DETECT = AUTODETECT_FLAG;

    public static final String RESOURCES_DETECT = AUTODETECT_FLAG;

    public static final String FIELDFORLABEL_DETECT = AUTODETECT_FLAG;

    public static final String LABEL_DETECT = AUTODETECT_FLAG;

    public String getCode();

    public String getLabel();

    public String getErrorMessage(int errcode);

    public JDBCServerExplorer getExplorer();

    public JDBCServerExplorerParameters getExplorerParameters();

    /** 

     * Return the store associted to the tableName.

     * The store don't by used to edit.

     * The store don't load the associted resources.

     * The store is chached, and next calls return the same instance.

     * 

     * @param tableName

     * @return 

     */

    public FeatureStore getFeatureStore(String tableName);

    /** 

     * Return the store associted to the tableName.

     * The store is not cached, every call to this method create a new store.

     * 

     * @param tableName

     * @param ignoreDALResource

     * @return 

     */

    public FeatureStore openFeatureStore(String tableName, boolean ignoreDALResource);

    public FeatureType getFeatureType(String tableName);

    public void forceReloadWorkspaceEntities();

    public void reloadWorkspaceEntities();    

    public void create_table(String name);

    public void create_table(OnlineEntity entity);

//    public int add(String name, FeatureStore store, String fieldForLabel);

//

//    public int add(String name, FeatureStore store, String fieldForLabel, String category, String label);

//

//    public int add(String name, FeatureStore source, String fieldForLabel, String category, String label, String model, String resources, String pkName, boolean importData, SimpleTaskStatus status);

    public int addEntity(FeatureType featureType, String name, String description, String fieldForLabel, String label, String pkName, int tileSize);

    public OnlineChanges<OnlineRemoteChange> getRemoteChanges();

    public OnlineChanges<OnlineRemoteChange> getRemoteChangesByEntity(String... entityName);

    public OnlineChanges<OnlineWorkingcopyChange> getLocalChanges();

    public OnlineChanges<OnlineWorkingcopyChange> getLocalChanges(List<OnlineEntity> entities);

    public boolean hasLocalChanges(List<OnlineEntity> entities);

    public List<OnlineEntity> getWorkspaceEntities();

    public OnlineEntity getWorkspaceEntity(String entity);

    public OnlineEntity getWorkspaceEntityByName(String entityName);

    public OnlineEntity getWorkspaceEntityByCode(String entityCode);

    public boolean existsInWorkspace(OnlineEntity entity);

    public boolean existsInWorkspace(OpenFeatureStoreParameters parameters);

    public String createUniqueCode();

    public OnlineEntity getEntity(String entityName);

    public OnlineSite getSite();

    public OnlineProject getProject();

    public List<OnlineEntity> getEntitiesOfRemoteChanges();

    public List<OnlineEntity> getEntitiesOfLocalChanges();

    public void addToConnectionPool();

    public boolean isInMyDatabase(FeatureStore store);

    public boolean isInMyDatabase(OpenFeatureStoreParameters parameters);

    public boolean isInMyDatabase(String tableName);

    public Feature getRelatedFeature(OnlineEntity entity, long featureCode);

    public Feature getRelatedFeature(OnlineRemoteChange change);

    public int removeEntity(OnlineEntity entity);

    public int removeEntities(List<String> namesOrCodes);

    public OnlineUserIdentificationRequester getUserIdentificationRequester();

    public void setUserIdentificationRequester(OnlineUserIdentificationRequester userIdentificationRequester);

    public int revert(String nameOrCode);

    public int revert(String nameOrCode, SimpleTaskStatus status);

    public List<OnlineEntity> getEntitiesWithSelectedChanges();

    public List<String> getDataModels();

    public void logout();

    public OpenDataStoreParameters createOpenStoreParameters(String tableName);

    public void registerDataModelRepository(String modelName);

    public void setOffline(boolean offline);

    public boolean isOffline();

    public String getEntityLabelTemplate();

    public String formatEntityLabel(OnlineEntity entity);

    public void setConfigValue(String name, String value);

    public void download_config(boolean overwrite, SimpleTaskStatus status);

    public void download_resources(boolean overwrite, SimpleTaskStatus status);

    public int download(String name, Envelope workingAream, SimpleTaskStatus status);

    public boolean canUpload();

    public boolean canUpload(MutableObject<String> message);

    public boolean canUpload(MutableObject<String> message, List<String> entityCodes);

    public int removeRemoteChanges(String entityName);

    public int removeRemoteChanges(String entityCode, SimpleTaskStatus status);

    public boolean canUpdate(MutableObject<String> msg, String entityName);

    public boolean updateNeedMerge(String entityName);

    public int update(String entityName, SimpleTaskStatus taskStatus);

    public int merge(String tableName, MutableLong localChangesCreated, SimpleTaskStatus simpleTaskStatus);

    public int synchronize(OnlineEntity entity, Envelope workingArea, SimpleTaskStatus taskStatus);

    public WorkingArea getCurrentWorkingArea();

    public void setCurrentWorkingArea(WorkingArea workingArea);

}