| 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):

* 2008 IVER T.I   {{Task}}

*/

/**

 *

 */

package org.gvsig.fmap.data.feature.joinstore;

import java.util.HashMap;

import java.util.Map;

import org.gvsig.fmap.data.DataManager;

import org.gvsig.fmap.data.DataStoreParameters;

import org.gvsig.fmap.data.exceptions.InitializeException;

import org.gvsig.fmap.data.impl.DefaultDataManager;

import com.iver.utiles.NotExistInXMLEntity;

import com.iver.utiles.XMLEntity;

/**

 * Class for {@link JoinFeatureStore} parameters. <br>

 * <br>

 * For create a new JoinFeatureStore you need to fill the follow parameters:<br>

 * <b>storePrimary</b>: Principal Store of the <code>join</code> operation<br>

 * <b>storeSecondary</b>: Subordinate Store of the <code>join</code> operation<br>

 * <b>linkFieldPrimary</b>: Field of the Principal Store to use for the join

 * operation<br>

 * <b>linkFieldSecondary</b>: Field of the Principal Store to use for the join

 * operation<br>

 * <br>

 * <!--Optionally you can define a limited number of fields for each stores

 * using the <b>featureTypePrimary</b> and <b>featureTypeSecondary</b>

 * parameters. -->

 *

 * You can set in <b>defautlGeomerty</b> the name of the field to use as the

 * Store defaultGeometry.

 *

 * @author jmvivo

 *

 */

public class JoinFeatureStoreParameters extends DataStoreParameters {

        private Map internalMap;

        private static String defaultFieldNamePrefix = "join_";

        protected Map createDefaultValuesMap() {

                Map defaultValues = new HashMap(7);

                defaultValues.put("storePrimary", null);

                defaultValues.put("storeSecondary", null);

                defaultValues.put("linkFieldPrimary", null);

                defaultValues.put("linkFieldSecondary", null);

                defaultValues.put("defaultGeometry", null);

                defaultValues.put("fieldNamePrefix", defaultFieldNamePrefix);

                defaultValues.put("fieldsStorePrimary", null);

                defaultValues.put("fieldsStoreSecondary", null);

                return defaultValues;

        }

        public String[] getFieldsStorePrimary() {

                return (String[]) this.getAttribute("fieldsStorePrimary");

        }

        public void setFieldsStorePrimary(String[] fieldsStorePrimary) {

                this.put("fieldsStorePrimary", fieldsStorePrimary);

        }

        public String[] getFieldsStoreSecondary() {

                return (String[]) this.getAttribute("fieldsStoreSecondary");

        }

        public void setFieldsStoreSecondary(String[] fieldsStoreSecondary) {

                this.put("fieldsStoreSecondary", fieldsStoreSecondary);

        }

        /* (non-Javadoc)

         * @see org.gvsig.fmap.data.DataStoreParameters#getDataStoreName()

         */

        public String getDataStoreName() {

                return JoinFeatureStore.DATASTORE_NAME;

        }

        /* (non-Javadoc)

         * @see org.gvsig.fmap.data.DataStoreParameters#isValid()

         */

        public boolean isValid() {

                if (this.getStorePrimary() == null || this.getStoreSecondary() == null) {

                        return false;

                }

                if (this.getLinkFieldPrimary() == null

                                || this.getLinkFieldSecondary() == null) {

                        return false;

                }

                if (this.getLinkFieldPrimary().length() < 1

                                || this.getLinkFieldSecondary().length() < 1) {

                        return false;

                }

                if (this.getFieldNamePrefix() == null

                                || this.getFieldNamePrefix().length() < 1) {

                        return false;

                }

                return true;

        }

        public String getDefaultGeometry() {

                return (String) this.getAttribute("defaultGeometry");

        }

        public void setDefaultGeometry(String defaultGeometry) {

                this.put("defaultGeometry", defaultGeometry);

        }

        public String getLinkFieldPrimary() {

                return (String) this.getAttribute("linkFieldPrimary");

        }

        public void setLinkFieldPrimary(String linkFieldPrimary) {

                this.put("linkFieldPrimary", linkFieldPrimary);

        }

        public String getLinkFieldSecondary() {

                return (String) this.getAttribute("linkFieldSecondary");

        }

        public void setLinkFieldSecondary(String linkFieldSecondary) {

                this.put("linkFieldSecondary", linkFieldSecondary);

        }

        public DataStoreParameters getStorePrimary() {

                return (DataStoreParameters) this.getAttribute("storePrimary");

        }

        public void setStorePrimary(DataStoreParameters storePrimary) {

                this.put("storePrimary", storePrimary);

        }

        public DataStoreParameters getStoreSecondary() {

                return (DataStoreParameters) this.getAttribute("storeSecondary");

        }

        public void setStoreSecondary(DataStoreParameters storeSecondary) {

                this.put("storeSecondary", storeSecondary);

        }

        public String getFieldNamePrefix() {

                return (String) this.getAttribute("fieldNamePrefix");

        }

        public void setFieldNamePrefix(String fieldNamePrefix) {

                this.put("fieldNamePrefix", fieldNamePrefix);

        }

        public String getDescription() {

                return "Join of two Stores";

        }

        public XMLEntity getXMLEntity() {

                XMLEntity xmlEntity = super.getXMLEntity();

                XMLEntity params = this.getStorePrimary().getXMLEntity();

                params.putProperty("store", "primary");

                xmlEntity.addChild(params);

                params = this.getStoreSecondary().getXMLEntity();

                params.putProperty("store", "secondary");

                xmlEntity.addChild(params);

                xmlEntity.putProperty("linkFieldPrimary", this.getLinkFieldPrimary());

                xmlEntity.putProperty("linkFieldSecondary", this

                                .getLinkFieldSecondary());

                xmlEntity.putProperty("defaultGeometry", this.getDefaultGeometry());

                xmlEntity.putProperty("fieldNamePrefix", this.getFieldNamePrefix());

                if (this.getFieldsStorePrimary() != null

                                && this.getFieldsStorePrimary().length > 0) {

                        xmlEntity.putProperty("fieldsStorePrimary",

                                        arrayToString(this

                                        .getFieldsStorePrimary()));

                }

                if (this.getFieldsStoreSecondary() != null

                                && this.getFieldsStoreSecondary().length > 0) {

                        xmlEntity.putProperty("fieldsStoreSecondary",

                                        arrayToString(this

                                        .getFieldsStoreSecondary()));

                }

                return xmlEntity;

        }

        public void loadFromXMLEntity(XMLEntity xmlEntity)

                        throws InitializeException {

                DataManager manager = DefaultDataManager.getManager();

                XMLEntity params;

                params = xmlEntity.firstChild("store", "primary");

                if (params == null) {

                        throw new InitializeException("store params(primary) not found",

                                        this.getDataStoreName());

                }

                try {

                        this.setStorePrimary(manager.createStoreParameters(params));

                } catch (InitializeException e) {

                        new InitializeException("store params(primary) error", this

                                        .getDataStoreName(), e);

                }

                params = xmlEntity.firstChild("store", "secondary");

                if (params == null) {

                        throw new InitializeException("store params(secondary) not found",

                                        this.getDataStoreName());

                }

                try {

                        this.setStoreSecondary(manager.createStoreParameters(params));

                } catch (InitializeException e) {

                        new InitializeException("store params(secondary) error", this

                                        .getDataStoreName(), e);

                }

                try {

                        this.setLinkFieldPrimary(xmlEntity

                                        .getStringProperty("linkFieldPrimary"));

                } catch (NotExistInXMLEntity e) {

                        throw new InitializeException("linkFieldPrimary property not found", this

                                        .getDataStoreName());

                }

                try {

                        this.setLinkFieldSecondary(xmlEntity

                                        .getStringProperty("linkFieldSecondary"));

                } catch (NotExistInXMLEntity e) {

                        throw new InitializeException(

                                        "linkFieldSecondary property not found", this

                                                        .getDataStoreName());

                }

                try {

                        this.setDefaultGeometry(xmlEntity

                                        .getStringProperty("defaultGeometry"));

                } catch (NotExistInXMLEntity e) {

                        this.remove("defaultGeometry");

                }

                try {

                        this.setFieldNamePrefix(xmlEntity

                                        .getStringProperty("fieldNamePrefix"));

                } catch (NotExistInXMLEntity e) {

                        this.remove("fieldNamePrefix");

                }

                String tmp = null;

                try {

                        tmp = xmlEntity.getStringProperty("fieldsStoreSecondary");

                        this.setFieldsStoreSecondary(tmp.split(","));

                } catch (NotExistInXMLEntity e) {

                        this.remove("fieldsStoreSecondary");

                }

        }

        private String arrayToString(Object[] array) {

                StringBuffer buff = new StringBuffer();

                if (array.length < 1) {

                        return "";

                }

                for (int i = 0; i < array.length; i++) {

                        buff.append(array[i] + ",");

                }

                String r = buff.toString();

                return r.substring(0, r.length() - 1);

        }

}