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.vcsgis.lib.workspace;

import java.sql.Timestamp;

import java.util.Collection;

import java.util.Iterator;

import java.util.List;

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

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

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

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

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

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

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

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

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.task.SimpleTaskStatus;

import org.gvsig.tools.util.GetItemWithSize64;

import org.gvsig.vcsgis.lib.VCSGisEntity;

import org.gvsig.vcsgis.lib.VCSGisRevision;

import org.gvsig.vcsgis.lib.VCSGisUser;

import org.gvsig.vcsgis.lib.VCSGisUserIdentificationRequester;

import org.gvsig.vcsgis.lib.repository.VCSGisRepository;

import org.gvsig.vcsgis.lib.repository.VCSGisRepositoryChange;

/**

 *

 * @author gvSIG Team

 */

public interface VCSGisWorkspace extends Disposable {

    public static final String ALL_REVISIONS = "ALL";

    public String getCode();

    public String getLabel();

    public String getErrorMessage(int errcode);

    public JDBCServerExplorer getExplorer();

    public JDBCServerExplorerParameters getExplorerParameters();

    public FeatureStore getFeatureStore(String tableName);

    public FeatureStore openFeatureStore(String tableName);

    public FeatureType getFeatureType(String tableName);

    public void forceReloadWorkspaceEntities();

    public void reloadWorkspaceEntities();    

    public void create_table(String name);

    public void create_table(VCSGisEntity entity);

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

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

    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 pkName, SimpleTaskStatus status);

    public int addChange(int changeCode, FeatureStore store, Feature feature);

    public int addChanges(

            FeatureStore store, 

            Iterator<Feature> insertedsFeatures, 

            Iterator<Feature> updatedsFeatures, 

            Iterator<FeatureReference> deletedsFeatures

    );

    public boolean canCommit();

    public boolean canCommit(MutableObject<String> message);

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

    public int commit();

    public int commit(Timestamp date, String comment, SimpleTaskStatus status);

    public int commit(Timestamp revisionDate, Timestamp efectiveDate, String comment, SimpleTaskStatus status);

    public int commit(List<String> entityCodes, Timestamp revisiondate, Timestamp efectivedate, String comment, SimpleTaskStatus status);

    public int checkout(String tableName);

    public int checkout(String tableName, String revisionCode);

    public int checkout(String tableName, String revisionCode, SimpleTaskStatus status);

    public int checkout(List<String> tableNames, SimpleTaskStatus status);

    public int updatePrepare(String tableName);

    public int updatePrepare(String tableName, SimpleTaskStatus status);

    public int update(String tableName);

    public int update(String tableName, SimpleTaskStatus status);

    public int merge(String tableName);

    public int merge(String tableName, SimpleTaskStatus status);

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

    public int updateClean(String entityCode);

    public int updateClean(String entityCode, SimpleTaskStatus status);

    public boolean updateNeedMerge(String entityName);

    public int updateEntitiesFromRepository();

    public int updateEntitiesFromRepository(SimpleTaskStatus status);

    public VCSGisWorkspaceChanges<VCSGisRepositoryChange> getRemoteChanges();

    public VCSGisWorkspaceChanges<VCSGisRepositoryChange> getRemoteChangesByEntity(String entityName);

    public VCSGisWorkspaceChanges<VCSGisWorkspaceChange> getLocalChanges();

    public VCSGisWorkspaceChanges<VCSGisWorkspaceChange> getLocalChanges(List<VCSGisEntity> entities);

    public void reloadRepositoryEntities(SimpleTaskStatus status);

    public List<VCSGisEntity> getRepositoryEntities();

    public List<VCSGisWorkspaceEntity> getWorkspaceEntities();

    public VCSGisWorkspaceEntity getWorkspaceEntity(String entity);

    public VCSGisWorkspaceEntity getWorkspaceEntityByName(String entityName);

    public VCSGisWorkspaceEntity getWorkspaceEntityByCode(String entityCode);

    public boolean existsInWorkspace(String entity);

    public boolean existsInWorkspace(VCSGisEntity entity);

    public VCSGisEntity getRepositoryEntity(String entity);

    public VCSGisEntity getRepositoryEntityByCode(String entityCode);

    public VCSGisEntity getRepositoryEntityByName(String entityName);

    public String createUniqueCode();

    public VCSGisEntity getEntity(String entityName);

    public VCSGisRepository getRepository();

    public List<VCSGisEntity> getEntitiesOfRemoteChanges();

    public List<VCSGisEntity> getEntitiesOfLocalChanges();

    public void addToConnectionPool();

    public int history(String entityName, String group, Timestamp minDate, Timestamp maxDate, int maxNumberOfRevisions, SimpleTaskStatus status);

    public int history(String entityName, String group, int maxNumberOfRevisions, SimpleTaskStatus status);

    public GetItemWithSize64<VCSGisRevision> getRevisions(String entityName, String group);

    public String getUserName(String userCode);

    public VCSGisUser getUser(String userCode);

    public boolean isInMyDatabase(FeatureStore store);

    public Feature getRelatedFeature(VCSGisEntity entity, String featureCode);

    public Feature getRelatedFeature(VCSGisRepositoryChange change);

    public int removeEntity(String nameOrCode);

    public int removeEntities(List<String> namesOrCodes);

    public VCSGisUserIdentificationRequester getUserIdentificationRequester();

    public void setUserIdentificationRequester(VCSGisUserIdentificationRequester userIdentificationRequester);

    public Collection<String> getEntityCategories();

    public String getTopologyPlan(String topologyPlanCode);

    public int importHistory( FeatureStore sourceStore,

            String name,

            String label,

            String category,

            String attrNameForLabel,

            String fieldCodeName,

            String fieldDateName,

            String fieldOrderName);

    public int revert(String nameOrCode);

    public int revert(String nameOrCode, SimpleTaskStatus status);

    public List<VCSGisWorkspaceEntity> getEntitiesWithChanges();

    public int export(String entityName, String tableName, String revisionCode, Timestamp efectiveDate, SimpleTaskStatus status);

    public List<String> getDataModels();

    public int authenticate(String userId, String password, SimpleTaskStatus status);

    public boolean authenticate(SimpleTaskStatus status);

}