gvSIG projects pool

package org.gvsig.vcsgis.lib.workspace.tables;

import java.util.List;

import javax.json.JsonObject;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

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

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

import org.gvsig.fmap.dal.feature.FeatureSet.DisposableFeatureSetIterable;

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

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

import org.gvsig.json.Json;

import org.gvsig.json.JsonObjectBuilder;

import org.gvsig.tools.dataTypes.DataTypes;

import org.gvsig.tools.dispose.DisposeUtils;

import org.gvsig.tools.dynobject.DynObjectValueItem;

import org.gvsig.vcsgis.lib.VCSGisEntity;

import org.gvsig.vcsgis.lib.VCSGisEntityEditable;

import static org.gvsig.vcsgis.lib.VCSGisManager.STATE_CONFLICT;

import static org.gvsig.vcsgis.lib.VCSGisManager.STATE_LOCAL_MODIFIED;

import static org.gvsig.vcsgis.lib.VCSGisManager.STATE_LOCAL_NEW;

import static org.gvsig.vcsgis.lib.VCSGisManager.STATE_LOCAL_OUTDATED;

import static org.gvsig.vcsgis.lib.VCSGisManager.STATE_LOCAL_OUTDATED_AND_MODIFIED;

import static org.gvsig.vcsgis.lib.VCSGisManager.STATE_LOCAL_UNMODIFIED;

import static org.gvsig.vcsgis.lib.VCSGisManager.TOPOLOGYPLAN_MODE_MANDATORY;

import static org.gvsig.vcsgis.lib.VCSGisManager.TOPOLOGYPLAN_MODE_RECOMMENDED;

import static org.gvsig.vcsgis.lib.VCSGisManager.VCSGISCODELEN;

import org.gvsig.vcsgis.lib.VCSGisUser;

import org.gvsig.vcsgis.lib.VCSGisUtils;

import org.gvsig.vcsgis.lib.workspace.VCSGisWorkspace;

import org.gvsig.vcsgis.lib.workspace.VCSGisWorkspaceEntity;

import org.gvsig.vcsgis.lib.workspace.tables.AbstractTable.AbstractRow;

/**

 *

 * @author gvSIG Team

 */

@SuppressWarnings("UseSpecificCatch")

public class EntitiesTable extends AbstractTable {

    public static final String TABLE_NAME = "VCSGIS_ENTITIES";

    public static final String COD_ENTITY = "COD_ENTITY";

    private static final String ENTITY_NAME = "ENT_NAME";

    private static final String ENTITY_STATE = "ENT_STATE";

    private static final String DATATABLE_NAME = "ENT_DATATABLE";

    private static final String FEATUREID_FIELD_NAME = "ENT_FEATURECODE";

    private static final String GEOMETRY_FIELD_NAME = "ENT_GEOMNAME";

    private static final String DESCRIPTION = "ENT_DESCRIPTION";

    private static final String FIELD_FOR_LABEL = "ENT_FIELDFORLABEL";

    private static final String FEATURETYPE = "ENT_FEATURETYPE";

    private static final String COD_LOCAL_REVISION = "COD_LOCAL_REVISION";

    private static final String COD_REPOSITORY_REVISION = "COD_REPO_REVISION";

    private static final String COD_USER = "COD_USER";

    private static final String COD_TOPOLOGYPLAN = "COD_TOPOLOGYPLAN";

    private static final String CATEGORY = "ENT_CATEGORY";

    private static final String LABEL = "ENT_LABEL";

    private static final String AUTHORIZATIONS = "ENT_AUTORIZATIONS";

    private static final String TOPOLOGYPLAN_MODE = "ENT_TOPOLOGYPLAN_MODE";

    private static final String RESOURCES = "ENT_RESOURCES";

    private static final String DATA_MODELS = "ENT_DATA_MODELS";

    public static class EntityRow extends AbstractRow implements VCSGisWorkspaceEntity {

        private FeatureType featureType;

        public EntityRow(VCSGisWorkspace workspace) {

            super(workspace, TABLE_NAME, COD_ENTITY);

        }

        public EntityRow(VCSGisWorkspace workspace, Feature feature) {

            super(workspace, TABLE_NAME, COD_ENTITY,feature);

        }

        @Override

        public String getEntityName() {

            return this.getString(ENTITY_NAME);

        }

        @Override

        public String getDataTableName() {

            return this.getString(DATATABLE_NAME);

        }

        @Override

        public String getFeatureIdFieldName() {

            return this.getString(FEATUREID_FIELD_NAME);

        }

        @Override

        public String getGeometryFieldName() {

            return this.getString(GEOMETRY_FIELD_NAME);

        }

        @Override

        public String getDescription() {

            return this.getString(DESCRIPTION);

        }

        @Override

        public String getFieldForLabel() {

            return this.getString(FIELD_FOR_LABEL);

        }

        @Override

        public String getUserCode() {

            return this.getString(COD_USER);

        }

        @Override

        public String getTopologyPlanCode() {

            return this.getString(COD_TOPOLOGYPLAN);

        }

        @Override

        public String getEntityCode() {

            return this.getCode();

        }

        @Override

        public String getLocalRevisionCode() {

            return this.getString(COD_LOCAL_REVISION);

        }

        @Override

        public String getRepositoryRevisionCode() {

            return this.getString(COD_REPOSITORY_REVISION);

        }

        @Override

        public String getCategory() {

            return this.getString(CATEGORY);

        }

        @Override

        public List<String> getCategoriesAsList() {

            String s = getCategory();

            return VCSGisUtils.getAsList(s);

        }

        @Override

        public String getAuthorizations() {

            return "";

//            return this.getString(AUTHORIZATIONS);

        }

        @Override

        public int getTopologyPlanMode() {

            return this.getInt(TOPOLOGYPLAN_MODE, TOPOLOGYPLAN_MODE_RECOMMENDED);

        }

        @Override

        public String getLabel() {

            return this.getString(LABEL);

        }

        @Override

        public String getFeatureTypeAsJson() {

            return this.getString(FEATURETYPE);

        }

        @Override

        public FeatureType getFeatureType() {

            if (this.featureType == null) {

                JsonObject json = Json.createObject(this.getFeatureTypeAsJson());

                this.featureType = DALLocator.getDataManager().createFeatureType(json);

            }

            return this.featureType;

        }

        @Override

        public EntityRow setEntityName(String entityName) {

            this.set(ENTITY_NAME, entityName);

            if( StringUtils.isBlank(this.getLabel())) {

                this.setLabel(entityName);

            }

            return this;

        }

        @Override

        public EntityRow setDataTableName(String dataTableName) {

            this.set(DATATABLE_NAME, dataTableName);

            return this;

        }

        @Override

        public EntityRow setFeatureIdFieldName(String name) {

            this.set(FEATUREID_FIELD_NAME, name);

            return this;

        }

        @Override

        public EntityRow setGeometryFieldName(String name) {

            this.set(GEOMETRY_FIELD_NAME, name);

            return this;

        }

        @Override

        public EntityRow setDescription(String description) {

            this.set(DESCRIPTION, description);

            return this;

        }

        @Override

        public EntityRow setFieldForLabel(String fieldForLabel) {

            this.set(FIELD_FOR_LABEL, fieldForLabel);

            return this;

        }

        @Override

       public EntityRow setFeatureTypeAsJson(String json) {

            this.set(FEATURETYPE, json);

            this.featureType = null;

            return this;

        }

        public EntityRow setFeatureType(FeatureType featureType) {

            this.set(FEATURETYPE, featureType.toJson().toString());

            return this;

        }

        @Override

        public EntityRow setLocalRevisionCode(String code) {

            this.set(COD_LOCAL_REVISION, code);

            return this;

        }

        @Override

        public EntityRow setRepositoryRevisionCode(String code) {

            this.set(COD_REPOSITORY_REVISION, code);

            return this;

        }

        @Override

        public VCSGisEntityEditable setUserCode(String userCode) {

            this.set(COD_USER, userCode);

            return this;

        }

        @Override

        public VCSGisEntityEditable setTopologyPlanCode(String topologyplanCode) {

            this.set(COD_TOPOLOGYPLAN, topologyplanCode);

            return this;

        }

        @Override

        public VCSGisEntityEditable setCategory(String category) {

            this.set(CATEGORY, category);

            return this;

        }

        @Override

        public VCSGisEntityEditable setAuthorizations(String authorizations) {

//            this.set(AUTHORIZATIONS, authorizations);

            return this;

        }

        @Override

        public VCSGisEntityEditable setTopologyPlanMode(int topologyPlanMode) {

            this.set(TOPOLOGYPLAN_MODE, topologyPlanMode);

            return this;

        }

        @Override

        public VCSGisEntityEditable setLabel(String label) {

            if(label != null){

                this.set(LABEL, label);

            }

            return this;

        }

        @Override

        public long getCountLocalChanges() {

            WorkspaceChangesTable changesTable = new WorkspaceChangesTable();

            return changesTable.getCountLocalChangesOfEntity(workspace, this.getCode());

        }

        private void updateState() {

            long countChanges;

            int state = this.getInt(ENTITY_STATE, -1);

            if( state == -1 ) {

                state = STATE_LOCAL_UNMODIFIED;

                this.setState(state);

            }

            switch (state) {

                case STATE_LOCAL_UNMODIFIED:

                    countChanges = this.getCountLocalChanges();

                    if (countChanges > 0) {

                        state = STATE_LOCAL_MODIFIED;

                        if(this.isOutdated()){

                            state = STATE_LOCAL_OUTDATED_AND_MODIFIED;

                        }

                        this.setState(state);

                    } else if(this.isOutdated()){

                        state = STATE_LOCAL_OUTDATED;

                        this.setState(state);

                    }

                    break;

                case STATE_LOCAL_OUTDATED:

                    if(!this.isOutdated()){

                        countChanges = this.getCountLocalChanges();

                        if (countChanges > 0) {

                            state = STATE_LOCAL_MODIFIED;

                        } else {

                            state = STATE_LOCAL_UNMODIFIED;

                        }

                    } else {

                        countChanges = this.getCountLocalChanges();

                        if (countChanges > 0) {

                            state = STATE_LOCAL_OUTDATED_AND_MODIFIED;

                            this.setState(state);

                        }

                    }

                    this.setState(state);

                    break;

                case STATE_LOCAL_MODIFIED:

                    countChanges = this.getCountLocalChanges();

                    if (countChanges == 0) {

                        state = STATE_LOCAL_UNMODIFIED;

                        if(this.isOutdated()){

                            state = STATE_LOCAL_OUTDATED;

                        }

                    } else {

                        if(this.isOutdated()){

                            state = STATE_LOCAL_OUTDATED_AND_MODIFIED;

                        }

                    }

                    this.setState(state);

                    break;

                case STATE_LOCAL_OUTDATED_AND_MODIFIED:

                    if(!this.isOutdated()){

                        countChanges = this.getCountLocalChanges();

                        if (countChanges > 0) {

                            state = STATE_LOCAL_MODIFIED;

                            this.setState(state);

                        } else {

                            state = STATE_LOCAL_UNMODIFIED;

                        }

                    } else {

                        countChanges = this.getCountLocalChanges();

                        if (countChanges > 0) {

                            state = STATE_LOCAL_OUTDATED_AND_MODIFIED;

                            this.setState(state);

                        } else {

                            state = STATE_LOCAL_OUTDATED;

                        }

                    }

                    this.setState(state);

                    break;

                case STATE_LOCAL_NEW:

                    countChanges = this.getCountLocalChanges();

                    if (countChanges > 0) {

                        state = STATE_LOCAL_MODIFIED;

                        if(this.isOutdated()){

                            state = STATE_LOCAL_OUTDATED_AND_MODIFIED;

                        }

                        this.setState(state);

                    } else {

                        state = STATE_LOCAL_UNMODIFIED;

                    }

                    this.setState(state);

                    break;

                case STATE_CONFLICT:

                    break;

                default:

                    if(this.isOutdated()){

                        state = STATE_LOCAL_OUTDATED;

                        this.setState(state);

                    }

            }

        }

        @Override

        public int getState() {

            this.updateState();

            int state = this.getInt(ENTITY_STATE);

            return state;

        }

        @Override

        public boolean isOutdated() {

            final String repositoryRevisionCode = this.getRepositoryRevisionCode();

            if(StringUtils.isBlank(repositoryRevisionCode)){

                return false;

            }

            return !StringUtils.equalsIgnoreCase(repositoryRevisionCode,this.getLocalRevisionCode());

        }

        public String getStateLabel() {

            return VCSGisUtils.getStateLabel(this.getState());

        }

        public void setState(int state) {

            this.set(ENTITY_STATE, state);

        }

        @Override

        public void update() {

            this.updateState();

            super.update();

        }

        @Override

        public VCSGisWorkspaceEntity getValue() {

            return this;

        }

        @Override

        public String toString() {

            if( StringUtils.isBlank(this.getLabel()) ) {

                return this.getEntityName();

            }

            return this.getLabel();

        }

        @Override

        public EntityRow setEntityCode(String code) {

            this.setCode(code);

            return this;

        }

        @Override

        public void copyfrom(VCSGisEntity entity) {

            VCSGisUtils.copy(entity, this, null);

        }

        @Override

        public void copyto(VCSGisEntityEditable entity) {

            VCSGisUtils.copy(this, entity, null);

        }

        @Override

        public JsonObject toJson() {

            return this.toJsonBuilder().build();

        }

        @Override

        public JsonObjectBuilder toJsonBuilder() {

            return VCSGisUtils.toJsonBuilder(this, null);

        }

        @Override

        public void fromJson(JsonObject json) {

            VCSGisUtils.fromJson(this, json);

        }

        @Override

        public boolean isAuthorized(VCSGisUser user, String operation) {

            return VCSGisUtils.isAuthorized(this, operation, user);

        }

        @Override

        public VCSGisEntityEditable setResources(String resources) {

            this.set(RESOURCES, resources);

            return this;

        }

        @Override

        public String getResources() {

            return this.getString(RESOURCES);

        }

        @Override

        public VCSGisEntityEditable setDataModels(String dataModels) {

            this.set(DATA_MODELS, dataModels);

            return this;

        }

        @Override

        public String getDataModels() {

            return this.getString(DATA_MODELS);

        }

        @Override

        public List<String> getDataModelsAsList() {

            String s = getDataModels();

            return VCSGisUtils.getAsList(s, false);

        }

    }

    public EntitiesTable() {

        super(TABLE_NAME, featureType());

    }

    public EntityRow getByEntityName(VCSGisWorkspace workspace, String entityName) {

        FeatureStore store = null;

        try {

            store = workspace.getFeatureStore(TABLE_NAME);

            Feature f = store.findFirst("\"" + ENTITY_NAME + "\"='" + entityName + "'");

            if (f == null) {

                return null;

            }

            EntityRow row = new EntityRow(workspace, f);

            return row;

        } catch (Exception ex) {

            throw new RuntimeException("Can't retrieve entity '" + entityName + "'.", ex);

        } finally {

            DisposeUtils.disposeQuietly(store);

        }

    }

    public EntityRow getByEntityCode(VCSGisWorkspace workspace, String entityCode) {

        FeatureStore store = null;

        try {

            store = workspace.getFeatureStore(TABLE_NAME);

            Feature f = store.findFirst("\"" + COD_ENTITY + "\"='" + entityCode + "'");

            if (f == null) {

                return null;

            }

            EntityRow row = new EntityRow(workspace, f);

            return row;

        } catch (Exception ex) {

            throw new RuntimeException("Can't retrieve entity '" + entityCode + "'.", ex);

        } finally {

            DisposeUtils.disposeQuietly(store);

        }

    }

    public DisposableFeatureSetIterable getAll(VCSGisWorkspace workspace) {

        FeatureStore store = null;

        try {

            store = workspace.getFeatureStore(TABLE_NAME);

            DisposableFeatureSetIterable items = store.getFeatureSet().iterable();

            return items;

        } catch (Exception ex) {

            throw new RuntimeException("Can't retrieve all entities.", ex);

        } finally {

            if (store != null) {

                DisposeUtils.dispose(store);

            }

        }

    }

    public static final FeatureType featureType() {

        DataManager dataManager = DALLocator.getDataManager();

        EditableFeatureType ft = dataManager.createFeatureType();

        ft.setLabel("VCSGIS Entities");

        ft.getTags().set("ID", TABLE_NAME);

        ft.add(COD_ENTITY, DataTypes.STRING)

                .setSize(VCSGISCODELEN)

                .setIsPrimaryKey(true)

                .setLabel("Code");

        ft.add(COD_USER, DataTypes.STRING)

                .setSize(VCSGISCODELEN)

                .setIsPrimaryKey(false)

                .setLabel("Code");

        ft.add(COD_TOPOLOGYPLAN, DataTypes.STRING)

                .setSize(VCSGISCODELEN)

                .setIsPrimaryKey(false)

                .setLabel("Code");

        ft.add(ENTITY_NAME, DataTypes.STRING)

                .setIsIndexed(true)

                .setAllowIndexDuplicateds(false)

                .setSize(200)

                .setLabel("Name");

        ft.add(DATATABLE_NAME, DataTypes.STRING)

                .setSize(200)

                .setLabel("Table name")

                .setDescription("Name of the table in which the data is stored");

        ft.add(FEATUREID_FIELD_NAME, DataTypes.STRING)

                .setSize(200)

                .setLabel("Pk field name")

                .setDescription("Name of the primary key of the table.");

        ft.add(COD_LOCAL_REVISION, DataTypes.STRING)

                .setSize(VCSGISCODELEN)

                .setLabel("Revision")

                .setDescription("Local revision.");

        ft.add(COD_REPOSITORY_REVISION, DataTypes.STRING)

                .setSize(VCSGISCODELEN)

                .setLabel("Revision")

                .setDescription("Last revision in repository.");

        ft.add(ENTITY_STATE, DataTypes.INTEGER)

                .setLabel("State")

                .setDescription("State of entity.");

        ft.add(GEOMETRY_FIELD_NAME, DataTypes.STRING)

                .setSize(200)

                .setLabel("Geometry field name")

                .setDescription("Name of the geometry attribute.");

        ft.add(FIELD_FOR_LABEL, DataTypes.STRING)

                .setSize(200)

                .setLabel("Field for label");

        ft.add(CATEGORY, DataTypes.STRING)

                .setSize(200)

                .setLabel("Category");

        ft.add(LABEL, DataTypes.STRING)

                .setSize(200)

                .setLabel("Label");

        ft.add(AUTHORIZATIONS, DataTypes.STRING)

                .setSize(10240)

                .setLabel("Authorizations")

//                .setDefaultFieldValue("{\n" +

//"  \"add\": [ \"*\" ],\n" +

//"  \"checkout\": [ \"*\" ],\n" +

//"  \"commit\": [ \"*\" ],\n" +

//"  \"entities\": [ \"*\" ],\n" +

//"  \"history\": [ \"*\" ],\n" +

//"  \"topologyplans\": [ \"*\" ],\n" +

//"  \"update\": [ \"*\" ],\n" +

//"  \"users\": [ \"*\" ]\n" +

//"}")

                .setDescription("Json with the information of what operations the different users can do.\nExample:\n{\n" +

"  \"add\": [ \"user1\", \"$admin\"],\n" +

"  \"checkout\": [ \"user1\", \"user2\"],\n" +

"  \"commit\": [ \"user1\" ],\n" +

"  \"entities\": [ \"user1\", \"user2\"],\n" +

"  \"history\": [ \"user1\" ],\n" +

"  \"topologyplans\": [ \"user1\", \"user2\"],\n" +

"  \"update\": [ \"user1\", \"user2\"],\n" +

"  \"users\": [ \"user1\", \"user2\"]\n" +

"}\n\n" +

"use $ before the name to indicate a role name instead of a username.");

        ft.add(DESCRIPTION, DataTypes.STRING)

                .setSize(10240)

                .setLabel("Description");

        ft.add(FEATURETYPE, DataTypes.STRING)

                .setSize(10240)

                .setLabel("Feature type");

        ft.add(TOPOLOGYPLAN_MODE, DataTypes.INTEGER)

                .setLabel("Topology plan mode")

                .setAvailableValues(new DynObjectValueItem[] {

                    new DynObjectValueItem(TOPOLOGYPLAN_MODE_RECOMMENDED, "Recommended"),

                    new DynObjectValueItem(TOPOLOGYPLAN_MODE_MANDATORY, "Mandatory")

                })

                ;

        ft.add(RESOURCES, DataTypes.STRING)

                .setSize(200)

                .setLabel("Resources");

        ft.add(DATA_MODELS, DataTypes.STRING)

                .setSize(200)

                .setLabel("Data models");

        return ft.getNotEditableCopy();

    }

}