Application: gvSIG desktop » gvSIG data provider for WFS

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

* 2009 {Iver T.I.}   {Task}

*/

package org.gvsig.fmap.dal.store.wfs;

import org.apache.commons.lang3.BooleanUtils;

import org.gvsig.fmap.dal.DataParameters;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.DataTypes;

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

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

import org.gvsig.fmap.dal.spi.AbstractDataParameters;

import org.gvsig.fmap.geom.Geometry;

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

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DelegatedDynObject;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

/**

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public class WFSStoreParameters extends AbstractDataParameters implements

 DataStoreParameters{

        protected static DynClass DYNCLASS = null;

        public static final String DYNCLASS_NAME = "WFSStoreParameters";

        public static final String DYNFIELDNAME_URL = "url";

        public static final String DYNFIELDNAME_VERSION = "version";

        public static final String DYNFIELDNAME_TYPENAME = "typeName";

        public static final String DYNFIELDNAME_NAMESPACE = "namespace";

        public static final String DYNFIELDNAME_NAMESPACEPREFIX = "namespacePrefix";

        public static final String DYNFIELDNAME_FIELDS = "fields";

        public static final String DYNFIELDNAME_FILTER_ENCODING_BY_ATTRIBUTE = "filterEncodingByAttribute";

        public static final String DYNFIELDNAME_MAXFEATURES = "maxFeatures";

        public static final String DYNFIELDNAME_TIMEOUT = "timeOut";

        public static final String DYNFIELDNAME_USER = "user";

        public static final String DYNFIELDNAME_PASSWORD = "password";

        public static final String DYNFIELDNAME_FILTER_BY_AREA_GEOMETRY = "filterByAreaGeometry";

        public static final String DYNFIELDNAME_FILTER_BY_AREA_ENVELOPE = "filterByAreaEnvelope";

        public static final String DYNFIELDNAME_FILTER_BY_AREA_OPERATION = "filterByAreaOperation";

        public static final String DYNFIELDNAME_FILTER_BY_AREA_ATTRIBUTE = "filterByAreaAttribute";

        public static final String DYNFIELDNAME_FILTER_BY_AREA_CRS = "filterByAreaCrs";

        private DelegatedDynObject delegatedDynObject;

        public WFSStoreParameters() {

                super();

                this.delegatedDynObject = (DelegatedDynObject) ToolsLocator

                .getDynObjectManager().createDynObject(

                        WFSStoreParameters.DYNCLASS);

        }

        @Override

        protected DelegatedDynObject getDelegatedDynObject() {

                return delegatedDynObject;

        }

        public WFSStoreParameters(DataParameters dataParameters) throws InitializeException, ProviderNotRegisteredException{

                this();

                setUrl((String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_URL));

                String namespace = null;

                String namespacePrefix = null;

                if (dataParameters.hasDynValue(WFSStoreParameters.DYNFIELDNAME_NAMESPACE)){

                        namespace = (String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_NAMESPACE);

                }

                if (dataParameters.hasDynValue(WFSStoreParameters.DYNFIELDNAME_NAMESPACEPREFIX)){

                        namespacePrefix = (String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_NAMESPACEPREFIX);

                }

                setFeatureType(namespacePrefix, namespace,

                                (String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_TYPENAME));

                if (dataParameters.hasDynValue(WFSStoreParameters.DYNFIELDNAME_MAXFEATURES)){

                        setMaxFeatures((Integer)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_MAXFEATURES));

                }else{

                        setMaxFeatures(1000);

                }

                if (dataParameters.hasDynValue(WFSStoreParameters.DYNFIELDNAME_TIMEOUT)){

                        setTimeOut((Integer)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_TIMEOUT));

                }else{

                        setTimeOut(10000);

                }

                if (dataParameters.hasDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_BY_AREA_GEOMETRY)){

                        setFilterByAreaGeometry((Geometry)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_BY_AREA_GEOMETRY));

                        setFilterByAreaAttribute((String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_BY_AREA_ATTRIBUTE));

                        setFilterByAreaCrs((String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_BY_AREA_CRS));

                        setFilterByAreaOperation((Integer)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_BY_AREA_OPERATION));

                }

                if (dataParameters.hasDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_BY_AREA_ENVELOPE)){

                        setFilterByAreaEnvelope((Envelope)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_BY_AREA_ENVELOPE));

                        setFilterByAreaAttribute((String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_BY_AREA_ATTRIBUTE));

                        setFilterByAreaCrs((String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_BY_AREA_CRS));

                        setFilterByAreaOperation((Integer)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_BY_AREA_OPERATION));

                }

                if (dataParameters.hasDynValue(WFSStoreParameters.DYNFIELDNAME_VERSION)){

                        setVersion((String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_VERSION));

                }

                if (dataParameters.hasDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_ENCODING_BY_ATTRIBUTE)){

                        setFilterEncodingByAttribute((String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_FILTER_ENCODING_BY_ATTRIBUTE));

                }

                if (dataParameters.hasDynValue(WFSStoreParameters.DYNFIELDNAME_USER)){

                        setUser((String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_USER));

                }

                if (dataParameters.hasDynValue(WFSStoreParameters.DYNFIELDNAME_PASSWORD)){

                        setPassword((String)dataParameters.getDynValue(WFSStoreParameters.DYNFIELDNAME_PASSWORD));

                }

        }

        protected static void registerDynClass() {

                if (DYNCLASS == null) {

                        PersistenceManager manager = ToolsLocator.getPersistenceManager();

                        DynStruct definition = manager.addDefinition(

                                        WFSStoreParameters.class,

                                        DYNCLASS_NAME,

                                        "WFSStoreParameters Persistence definition",

                                        null,

                                        null

                        );

                        definition.addDynFieldString(DYNFIELDNAME_URL)

                                .setDescription("URL of the WFS server")

                                .setMandatory(true);

                        definition.addDynFieldString(DYNFIELDNAME_VERSION)

                                .setDescription("Version of the WFS server")

                                .setMandatory(false);

                        definition.addDynFieldString(DYNFIELDNAME_TYPENAME)

                                .setDescription("Feature type to retrieve")

                                .setMandatory(true);

                        definition.addDynFieldString(DYNFIELDNAME_NAMESPACE)

                                .setDescription("Namespace of the feature type to retrieve")

                                .setMandatory(false);

                        definition.addDynFieldString(DYNFIELDNAME_NAMESPACEPREFIX)

                                .setDescription("Prefix of the namespace of the feature type to retrieve")

                                .setMandatory(false);

                        definition.addDynFieldString(DYNFIELDNAME_FIELDS)

                                .setDescription("Fields to retrieve separated by ','")

                                .setMandatory(false);

                        definition.addDynFieldString(DYNFIELDNAME_FILTER_ENCODING_BY_ATTRIBUTE)

                                .setDescription("Filter encoding request")

                                .setMandatory(false);

                        definition.addDynFieldInt(DYNFIELDNAME_MAXFEATURES)

                                .setDescription("Number of features to retrieve")

                                .setMandatory(false);

                        definition.addDynFieldInt(DYNFIELDNAME_TIMEOUT)

                                .setDescription("Timeout")

                                .setMandatory(false);

                        definition.addDynFieldString(DYNFIELDNAME_USER)

                                .setDescription("User name (not used at this moment)")

                                .setMandatory(false);

                        definition.addDynFieldString(DYNFIELDNAME_PASSWORD)

                                .setDescription("Password (not used at this moment")

                                .setMandatory(false);

                        definition.addDynFieldObject(DYNFIELDNAME_FILTER_BY_AREA_GEOMETRY)

                                .setType(DataTypes.GEOMETRY)

                                .setDescription("Geometry used to do the filter")

                                .setMandatory(false);

                        definition.addDynFieldObject(DYNFIELDNAME_FILTER_BY_AREA_ENVELOPE)

                        .setType(DataTypes.ENVELOPE)

                        .setDescription("Envelope used to do the filter")

                        .setMandatory(false);

                        definition.addDynFieldInt(DYNFIELDNAME_FILTER_BY_AREA_OPERATION)

                                .setDescription("Geometry operation used to do the filter")

                                .setMandatory(false);

                        definition.addDynFieldString(DYNFIELDNAME_FILTER_BY_AREA_ATTRIBUTE)

                                .setDescription("Attribute that contains the geometry")

                                .setMandatory(false);

                        definition.addDynFieldString(DYNFIELDNAME_FILTER_BY_AREA_CRS)

                                .setDescription("CRS to do the query")

                                .setMandatory(false);

                        definition.addDynFieldBoolean("useAxisOrderYX")

                                .setDefaultFieldValue("false")

                                .setMandatory(false);

                        definition.addDynFieldBoolean("ignoreCache")

                                .setDefaultFieldValue("false")

                                .setMandatory(false);

                        DYNCLASS = (DynClass) definition;

                }

        }

        /* (non-Javadoc)

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

         */

        public String getDataStoreName() {

                return WFSStoreProvider.NAME;

        }

        /* (non-Javadoc)

         * @see org.gvsig.fmap.dal.DataStoreParameters#getDescription()

         */

        public String getDescription() {

                return WFSStoreProvider.DESCRIPTION;

        }

        /* (non-Javadoc)

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

         */

        public boolean isValid() {

                // TODO Auto-generated method stub

                return false;

        }

        public String getUrl(){

                return (String) this.getDynValue(DYNFIELDNAME_URL);

        }

        public void setUrl(String url){

                this.setDynValue(DYNFIELDNAME_URL, url);

        }

        public String getVersion(){

                return (String) this.getDynValue(DYNFIELDNAME_VERSION);

        }

        public void setVersion(String version){

                this.setDynValue(DYNFIELDNAME_VERSION, version);

        }

        public String getFeatureType(){

                return (String) this.getDynValue(DYNFIELDNAME_TYPENAME);

        }

        public void setFeatureType(String featureType){

                this.setDynValue(DYNFIELDNAME_TYPENAME, featureType);

        }

        public void setFeatureType(String namespace, String featureType){

                this.setDynValue(DYNFIELDNAME_NAMESPACE, namespace);

                this.setDynValue(DYNFIELDNAME_TYPENAME, featureType);

        }

        public void setFeatureType(String prefix, String namespace, String featureType){

                this.setDynValue(DYNFIELDNAME_NAMESPACEPREFIX, prefix);

                this.setDynValue(DYNFIELDNAME_NAMESPACE, namespace);

                this.setDynValue(DYNFIELDNAME_TYPENAME, featureType);

        }

        public String getFeatureNamespace(){

                return (String) this.getDynValue(DYNFIELDNAME_NAMESPACE);

        }

        public String getFeaturePrefix(){

                return (String) this.getDynValue(DYNFIELDNAME_NAMESPACEPREFIX);

        }

        public String getFields(){

                return (String) this.getDynValue(DYNFIELDNAME_FIELDS);

        }

        public void setFields(String fields){

                this.setDynValue(DYNFIELDNAME_FIELDS, fields);

        }

        public String getFilterEncodingByAttribute(){

                return (String) this.getDynValue(DYNFIELDNAME_FILTER_ENCODING_BY_ATTRIBUTE);

        }

        public void setFilterEncodingByAttribute(String filter){

                this.setDynValue(DYNFIELDNAME_FILTER_ENCODING_BY_ATTRIBUTE, filter);

        }

        public Integer getMaxFeatures(){

                return (Integer) this.getDynValue(DYNFIELDNAME_MAXFEATURES);

        }

        public void setMaxFeatures(Integer maxFeatures){

                this.setDynValue(DYNFIELDNAME_MAXFEATURES, maxFeatures);

        }

        public Integer getTimeOut(){

                return (Integer) this.getDynValue(DYNFIELDNAME_TIMEOUT);

        }

        public void setTimeOut(Integer timeOut){

                this.setDynValue(DYNFIELDNAME_TIMEOUT, timeOut);

        }

        public String getUser(){

                return (String) this.getDynValue(DYNFIELDNAME_USER);

        }

        public void setUser(String user){

                this.setDynValue(DYNFIELDNAME_USER, user);

        }

        public String getPassword(){

                return (String) this.getDynValue(DYNFIELDNAME_PASSWORD);

        }

        public void setPassword(String password){

                this.setDynValue(DYNFIELDNAME_PASSWORD, password);

        }

        public Geometry getFilterByAreaGeometry(){

                return (Geometry) this.getDynValue(DYNFIELDNAME_FILTER_BY_AREA_GEOMETRY);

        }

        public void setFilterByAreaGeometry(Geometry area){

                this.setDynValue(DYNFIELDNAME_FILTER_BY_AREA_GEOMETRY, area);

        }

        public Envelope getFilterByAreaEnvelope(){

                return (Envelope) this.getDynValue(DYNFIELDNAME_FILTER_BY_AREA_ENVELOPE);

        }

        public void setFilterByAreaEnvelope(Envelope area){

                this.setDynValue(DYNFIELDNAME_FILTER_BY_AREA_ENVELOPE, area);

        }

        public Integer getFilterByAreaOperation(){

                return (Integer) this.getDynValue(DYNFIELDNAME_FILTER_BY_AREA_OPERATION);

        }

        public void setFilterByAreaOperation(Integer operation){

                this.setDynValue(DYNFIELDNAME_FILTER_BY_AREA_OPERATION, operation);

        }

        public String getFilterByAreaCrs(){

                return (String) this.getDynValue(DYNFIELDNAME_FILTER_BY_AREA_CRS);

        }

        public void setFilterByAreaCrs(String crs){

                this.setDynValue(DYNFIELDNAME_FILTER_BY_AREA_CRS, crs);

        }

        public String getFilterByAreaAttribute(){

                return (String) this.getDynValue(DYNFIELDNAME_FILTER_BY_AREA_ATTRIBUTE);

        }

        public void setFilterByAreaAttribute(String attribute){

                this.setDynValue(DYNFIELDNAME_FILTER_BY_AREA_ATTRIBUTE, attribute);

        }

        public boolean getUseAxisOrderYX() {

            Boolean x = (Boolean) this.getDynValue("useAxisOrderYX");

            return BooleanUtils.isTrue(x);

        }

        public void setUseAxisOrderYX(boolean useAxisOrderYX){

            this.setDynValue("useAxisOrderYX", new Boolean(useAxisOrderYX));

        }

        public boolean getIgnoreCache() {

            Boolean x = (Boolean) this.getDynValue("ignoreCache");

            return BooleanUtils.isTrue(x);

        }

        public void setIgnoreCache(boolean ignoreCache){

            this.setDynValue("ignoreCache", new Boolean(ignoreCache));

        }

}