Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA 02110-1301, USA.

 *

 * 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.fmap.dal.store.simplereader;

import java.io.File;

import java.util.Locale;

import org.apache.commons.lang3.BooleanUtils;

import org.apache.commons.lang3.StringEscapeUtils;

import org.apache.commons.lang3.StringUtils;

import org.cresques.cts.IProjection;

import org.gvsig.basicformats.CPGFile;

import org.gvsig.basicformats.FormatsFile;

import org.gvsig.basicformats.PRJFile;

import org.gvsig.fmap.dal.DALLocator;

import static org.gvsig.fmap.dal.DataParameters.CRS_PARAMTER_NAME;

import org.gvsig.fmap.dal.FileHelper;

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

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

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

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

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemStoreParameters;

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

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

import org.gvsig.tools.dynobject.DelegatedDynObject;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.Tags;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

@SuppressWarnings("UseSpecificCatch")

public class SimpleReaderStoreParameters extends AbstractDataStoreParameters implements

        OpenFeatureStoreParameters, FilesystemStoreParameters {

    protected static final Logger LOGGER = LoggerFactory.getLogger(SimpleReaderStoreParameters.class);

    protected static final String FILE = "file";

    protected static final String IGNOREERRORS = "ignoreErrors";

    protected static final String AUTOMATICTYPESDETECTION = "automaticTypesDetection";

    protected static final String CRS = CRS_PARAMTER_NAME;

    protected static final String FIELDTYPES = "fieldtypes";

    protected static final String CHARSET = "charset"; // Default "UTF-8"

    protected static final String LOCALE = "locale";

    public static final String HEADER = "header";

    private static final String LIMIT = "limit";

    protected DelegatedDynObject parameters;

    protected FeatureType featureType;

    protected boolean all_fields_declare_type = false;

    @SuppressWarnings("OverridableMethodCallInConstructor")

    public SimpleReaderStoreParameters(String parametersDefinitionName, String name) {

        super();

        this.parameters = (DelegatedDynObject) FileHelper.newParameters(parametersDefinitionName);

        this.setDynValue(DataStoreProviderServices.PROVIDER_PARAMTER_NAME, name);

    }

    protected SimpleReaderFeatureTypeLoader getFeatureTypeLoader() {

        return null;

    }

    @Override

    protected DelegatedDynObject getDelegatedDynObject() {

        return parameters;

    }

    @Override

    public void setDynValue(String name, Object value) {

        super.setDynValue(name, value);

        this.featureType = null;

    }

    @Override

    public Object getDynValue(String name) {

        if(StringUtils.equalsIgnoreCase(name, AUTOMATICTYPESDETECTION)){

            //Si tenemos featureType y estan declarados todos los tipos, ya no es necesario hacer la deteccion automatica

            if(this.featureType != null){

                if( this.all_fields_declare_type ){

                    return false;

                }

            }

        }

        return super.getDynValue(name);

    }

    @Override

    public boolean isValid() {

        return getFileName(this) != null;

    }

    @Override

    public File getFile() {

        return (File) this.getDynValue(FILE);

    }

    @Override

    public void setFile(File file) {

        this.setDynValue(FILE, file);

    }

    public static String getHeader(DynObject dynobj) {

        String s = (String) dynobj.getDynValue(HEADER);

        s = StringEscapeUtils.unescapeJava(s);

        if ( StringUtils.isBlank(s) ) {

            return null;

        }

        return s;

    }

    public static String getDelimiter(String line) {

        if( StringUtils.isBlank(line) ) {

            return null;

        }

        String sep = null;

        // Cuidado con los ":", los he puesto al final a proposito

        // ya que podian estar en la cadena para separar el size

        // de cada tipo.

        String seps = ",;-|@#/+$%&!:";

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

            sep = seps.substring(i, 1);

            if ( line.contains(seps.substring(i, 1)) ) {

                break;

            }

            sep = null;

        }

        return sep;

    }

    public static String[] getHeaders(DynObject dynobj) {

        //Este metodo debe sobreescribirlo el CSV por el delimiter

        String s = getHeader(dynobj);

        if ( StringUtils.isBlank(s) ) {

            return null;

        }

        String sep = getDelimiter(s);

        if ( sep == null ) {

            // Chungo

            return null;

        }

        String[] ss = s.split("[" + sep + "]");

        return ss;

    }

    public static IProjection getCRS(DynObject dynobj) {

        return (IProjection) dynobj.getDynValue(CRS);

    }

    public static String getFileName(DynObject dynobj) {

        File f = (File) dynobj.getDynValue(FILE);

        if ( f == null ) {

            return null;

        }

        return f.getPath();

    }

    public static File getFile(DynObject dynobj) {

        File f = (File) dynobj.getDynValue(FILE);

        return f;

    }

    public static boolean isBlankOrDefaultLocale(DynObject dynobj) {

        String s = (String) dynobj.getDynValue(LOCALE);

        if (StringUtils.isBlank(s)) {

            return true;

        }

        return StringUtils.equalsIgnoreCase("DEFAULT",s.trim());

    }

    public static Locale getLocale(DynObject dynobj) {

        try {

            String s = (String) dynobj.getDynValue(LOCALE);

            if ( StringUtils.isBlank(s) ) {

                return null;

            }

            if (StringUtils.equalsIgnoreCase("DEFAULT",s.trim())) {

                return Locale.getDefault();

            }

            Locale locale;

            // locale = Locale.forLanguageTag(s); // Since java 1.7

            String[] ss = s.split("-");

            switch (ss.length) {

            case 1:

                locale = new Locale(ss[0]);

                break;

            case 2:

                locale = new Locale(ss[0], ss[1]);

                break;

            case 3:

            default:

                locale = new Locale(ss[0], ss[1], ss[2]);

                break;

            }

            return locale;

        } catch (Exception ex) {

            LOGGER.warn("Can't get locale from parameters.", ex);

            return null;

        }

    }

    public static String getCharset(DynObject dynobj) {

        String s = (String) dynobj.getDynValue(CHARSET);

        return StringEscapeUtils.unescapeJava(s);

    }

    public static boolean getAutomaticTypesDetection(DynObject dynobj) {

        Boolean b = (Boolean) dynobj.getDynValue(AUTOMATICTYPESDETECTION);

        return BooleanUtils.isTrue(b);

    }

    public static boolean getIgnoreErrors(DynObject dynobj) {

        Boolean b = (Boolean) dynobj.getDynValue(IGNOREERRORS);

        return BooleanUtils.isTrue(b);

    }

    public static String getRawFieldTypes(DynObject dynobj) {

        String s = (String) dynobj.getDynValue(FIELDTYPES);

        if ( StringUtils.isBlank(s) ) {

            return null;

        }

        return s.trim();

    }

    public static String getRawFieldsDefinition(DynObject dynobj) {

        String s = (String) dynobj.getDynValue("fieldsDefinition");

        if ( StringUtils.isBlank(s) ) {

            return null;

        }

        return s.trim();

    }

    public static int getSkipLines(DynObject dynobj) {

        Integer n = (Integer) dynobj.getDynValue("skipLines");

        if ( n == null ) {

            return 0;

        }

        return n;

    }

    public static int getLimit(DynObject dynobj) {

        Integer n = (Integer) dynobj.getDynValue(LIMIT);

        if ( n == null ) {

            return -1;

        }

        return n;

    }

    public static class FieldDefinition {

        private final int start;

        private final int end;

        public FieldDefinition(String def) {

            def = def.trim();

            String[] ss = def.split(":");

            this.start = Integer.parseInt(ss[0]);

            if ( ss.length < 2 ) {

                this.end = -1;

            } else {

                this.end = Integer.parseInt(ss[1]);

            }

        }

        public int getStart() {

            return this.start;

        }

        public int getEnd() {

            return this.end;

        }

        public boolean getToEndOfLine() {

            return this.end == -1;

        }

    }

    public static FieldDefinition[] getFieldsDefinition(DynObject dynobj) {

        String definition = getRawFieldsDefinition(dynobj);

        if ( definition == null ) {

            return null;

        }

        int i=0;

        try {

            String[] defs = StringUtils.split(definition);

            FieldDefinition[] fieldsDefinition = new FieldDefinition[defs.length];

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

                fieldsDefinition[i] = new FieldDefinition(defs[i]);

            }

            return fieldsDefinition;

        } catch (Exception ex) {

            throw  new IllegalArgumentException("Can't recognize the format field definition '"+definition+"' ("+i+").");

        }

    }

    @Override

    public void validate() throws ValidateDataParametersException {

        File f = this.getFile();

        if( f!=null ) {

            IProjection proj = null;

            FeatureType ftype = this.getFeatureType();

            if( ftype!=null ) {

                proj = ftype.getDefaultSRS();

                if( proj!=null ) {

                    this.setDynValue(CRS_PARAMTER_NAME, proj);

                }

                Tags ftypeTags = ftype.getTags();

                for (String tagname : ftypeTags) {

                    if( StringUtils.startsWithIgnoreCase(tagname, "storeparameters.") ||

                            StringUtils.startsWithIgnoreCase(tagname, "csvparameters.") /*por compativilidad*/ ) {

                        String paramname = tagname.substring(14);

                        String paramvalue = ftypeTags.getString(tagname,null);

                        if( paramvalue!=null ) {

                            this.setDynValue(paramname, paramvalue);

                        }

                    }

                }

            }

            if( proj==null ) {

                PRJFile prjfile = FormatsFile.getPRJFile(f);

                if( prjfile!= null ) {

                    this.setDynValue(CRS_PARAMTER_NAME, prjfile.getCRS());

                }

            }

            String charsetName = getCharset(this);

            if( StringUtils.isBlank(charsetName) ) {

                CPGFile cpgfile = FormatsFile.getCPGFile(f);

                if( cpgfile!=null ) {

                    this.setDynValue(CHARSET, cpgfile.getCharsetName());

                }

            }

        }

        super.validate();

    }

    protected FeatureType getFeatureType() {

        if( this.featureType==null ) {

            try {

                SimpleReaderFeatureTypeLoader featureTypeLoader = this.getFeatureTypeLoader();

                if( featureTypeLoader!=null ) {

                    EditableFeatureType ftype = DALLocator.getDataManager().createFeatureType();

                    featureTypeLoader.loadFeatureType(ftype, false, null);

                    this.all_fields_declare_type = featureTypeLoader.isAllFieldsDeclareType();

                    this.featureType = ftype;

                }

            } catch (Exception ex) {

                LOGGER.debug("Can't detect feature of json file", ex);

                // Do nothing, continue

            }

        }

        return this.featureType;

    }

    @Override

    public String getSourceId() {

        return this.toString(); // FIXME: Check if is correnct

    }

}