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.csv;

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 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.FeatureAttributeDescriptor;

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.AbstractDataParameters;

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

import org.gvsig.fmap.geom.Geometry;

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;

import org.supercsv.prefs.CsvPreference;

import org.supercsv.quote.AlwaysQuoteMode;

import org.supercsv.quote.NormalQuoteMode;

import org.supercsv.quote.QuoteMode;

@SuppressWarnings("UseSpecificCatch")

public class CSVStoreParameters extends AbstractDataParameters implements

        OpenFeatureStoreParameters, FilesystemStoreParameters {

    private static final Logger LOGGER = LoggerFactory.getLogger(CSVStoreParameters.class);

    public static final String PARAMETERS_DEFINITION_NAME = "CSVStoreParameters";

    private static final String FILE = "file";

    private static final String IGNOREERRORS = "ignoreErrors";

    private static final String PROFILE = "profile";

    private static final String QUOTEPOLICY = "quotePolicy";

    private static final String QUOTECHAR = "quoteCharacter";

    private static final String RECORDSEPARATOR = "recordSeparator";

    private static final String DELIMITER = "delimiter";

    private static final String COMMENTSTARTMARKER = "commentStartMarker";

    private static final String AUTOMATICTYPESDETECTION = "automaticTypesDetection";

    private static final String ESCAPECHARACTER = "escapeCharacter";

    public static final String FIRST_LINE_HEADER = "firstLineHeader";

    public static final String HEADER = "header";

    private static final String SURROUNDINGSPACESNEEDQUOTES = "surroundingSpacesNeedQuotes";

    //private static final String IGNOREEMPTYLINES = "ignoreEmptyLines";

    private static final String CRS = CRS_PARAMTER_NAME;

    private static final String FIELDTYPES = "fieldtypes";

//    private static final String NULLTO = "nullTo";

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

    private static final String LOCALE = "locale";

    private static final String POINT_COLUMN_NAME = "pointColumnName";

    private static final String LIMIT = "limit";

    private static final String INCLUDE_METADATA_IN_HEADER = "includeMetadataInHeader";

    private static final String GEOMETRY_COLUMN = "geometry_column";

    private static final String GEOMETRY_TYPE = "GeometryType";

    private static final String GEOMETRY_SUBTYPE = "GeometrySubtype";

    private static final String GEOMETRY_FORMAT = "GeometryFormat";

    private DelegatedDynObject parameters;

    private FeatureType featureType;

    private boolean defaultValueOfAutomaticTypesDetection = true;

    public CSVStoreParameters() {

        this(PARAMETERS_DEFINITION_NAME);

    }

    protected CSVStoreParameters(String parametersDefinitionName) {

        this(parametersDefinitionName, CSVStoreProvider.NAME);

    }

    @SuppressWarnings("OverridableMethodCallInConstructor")

    public CSVStoreParameters(String parametersDefinitionName, String name) {

        super();

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

        this.setDynValue(DataStoreProviderServices.PROVIDER_PARAMTER_NAME, name);

    }

    private FeatureType getFeatureType() {

        if( this.featureType==null ) {

            try {

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

                boolean all_fields_declare_type = CSVUtils.loadFeatureType(this, ftype, false, null);

                defaultValueOfAutomaticTypesDetection = !all_fields_declare_type;

                this.featureType = ftype;

            } catch (Exception ex) {

                LOGGER.debug("Can't detect feature type from csv header", ex);

                // Do nothing, continue

            }

        }

        return this.featureType;

    }

    @Override

    protected DelegatedDynObject getDelegatedDynObject() {

        return parameters;

    }

    @Override

    public void setDynValue(String name, Object value) {

        super.setDynValue(name, value);

    }

    @Override

    public void validate() throws ValidateDataParametersException {

        File f = this.getFile();

        if( f!=null ) {

            IProjection proj = null;

            FeatureType ftype = this.getFeatureType();

            if( ftype!=null ) {

                this.setDynValue(AUTOMATICTYPESDETECTION, defaultValueOfAutomaticTypesDetection);

                proj = ftype.getDefaultSRS();

                if( proj!=null ) {

                    this.setDynValue(CRS_PARAMTER_NAME, proj);

                }

                FeatureAttributeDescriptor attrgeom = ftype.getDefaultGeometryAttribute();

                if( attrgeom!=null ) {

                    this.setDynValue(GEOMETRY_COLUMN, attrgeom.getName());

                    this.setDynValue(GEOMETRY_TYPE, attrgeom.getGeomType().getType());

                    this.setDynValue(GEOMETRY_SUBTYPE, attrgeom.getGeomType().getSubType());

                } else {

                    this.setDynValue(GEOMETRY_COLUMN, null);

                    this.setDynValue(GEOMETRY_TYPE, Geometry.TYPES.UNKNOWN);

                    this.setDynValue(GEOMETRY_SUBTYPE, Geometry.SUBTYPES.UNKNOWN);

                }

                Tags ftypeTags = ftype.getTags();

                for (String tagname : ftypeTags) {

                    if( StringUtils.startsWithIgnoreCase(tagname, "csvparameters.") ) {

                        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();

    }

    @Override

    public boolean isValid() {

        if ( getFileName(this) == null ) {

            return false;

        }

        return true;

    }

    @Override

    public File getFile() {

        return (File) this.getDynValue(FILE);

    }

    @Override

    public void setFile(File file) {

        this.setDynValue(FILE, file);

    }

    public static CsvPreference getPredefinedCSVPreferences(DynObject dynobj) {

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

        if ( "NONE".equalsIgnoreCase(s) ) {

            return null;

        }

        if ( "STANDARD_PREFERENCE".equalsIgnoreCase(s) ) {

            return CsvPreference.STANDARD_PREFERENCE;

        }

        if ( "EXCEL_PREFERENCE".equalsIgnoreCase(s) ) {

            return CsvPreference.EXCEL_PREFERENCE;

        }

        if ( "EXCEL_NORTH_EUROPE_PREFERENCE".equalsIgnoreCase(s) ) {

            return CsvPreference.EXCEL_NORTH_EUROPE_PREFERENCE;

        }

        if ( "TAB_PREFERENCE".equalsIgnoreCase(s) ) {

            return CsvPreference.TAB_PREFERENCE;

        }

        return null;

    }

    public static QuoteMode getQuoteMode(DynObject dynobj) {

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

        if ( "AlwaysQuoteMode".equalsIgnoreCase(s) ) {

            return new AlwaysQuoteMode();

        }

        if ( "NormalQuoteMode".equalsIgnoreCase(s) ) {

            return new NormalQuoteMode();

        }

        return null;

    }

    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 String getRecordSeparator(DynObject dynobj) {

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

        return StringEscapeUtils.unescapeJava(s);

    }

    public static String getGeometryColumn(DynObject dynobj) {

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

        return s;

    }

    public static int getGeometryType(DynObject dynobj) {

        Integer gtype = (Integer) dynobj.getDynValue(GEOMETRY_TYPE);

        if( gtype == null ) {

            return Geometry.TYPES.UNKNOWN;

        }

        return gtype;

    }

    public static String getGeometryFormat(DynObject dynobj) {

        String gformat = (String) dynobj.getDynValue(GEOMETRY_FORMAT);

        if( StringUtils.isBlank(gformat) ) {

            return "WKT";

        }

        return gformat;

    }

    public static int getGeometrySubType(DynObject dynobj) {

        Integer gsubtype = (Integer) dynobj.getDynValue(GEOMETRY_SUBTYPE);

        if( gsubtype == null ) {

            return Geometry.SUBTYPES.UNKNOWN;

        }

        return gsubtype;

    }

    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 CSV parameters.", ex);

            return null;

        }

    }

    public static String getCommentStartMarker(DynObject dynobj) {

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

        return StringEscapeUtils.unescapeJava(s);

    }

    public static String getPointColumnName(DynObject dynobj) {

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

        return s;

    }

    public static String getQuoteCharacter(DynObject dynobj) {

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

        s = StringEscapeUtils.unescapeJava(s);

        if ( StringUtils.isBlank(s) ) {

            return null;

        }

        return s.substring(0, 1);

    }

    public static String getDelimiter(DynObject dynobj) {

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

        s = StringEscapeUtils.unescapeJava(s);

        if ( StringUtils.isBlank(s) ) {

            return null;

        }

        return s.substring(0, 1);

    }

    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[] getHeaders(DynObject dynobj) {

        String s = getHeader(dynobj);

        if ( StringUtils.isBlank(s) ) {

            return null;

        }

        String sep = getDelimiter(dynobj);

        if ( sep == null ) {

            sep = getDelimiter(s);

            if ( sep == null ) {

                // Chungo

                return null;

            }

        }

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

        return ss;

    }

    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 getCharset(DynObject dynobj) {

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

        return StringEscapeUtils.unescapeJava(s);

    }

    public static String[] getPointDimensionNames(DynObject dynobj) {

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

        if ( StringUtils.isBlank(s) ) {

            return null;

        }

        return s.split(",");

    }

    public static boolean getSurroundingSpacesNeedQuotes(DynObject dynobj) {

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

        return BooleanUtils.isTrue(b);

    }

    public static boolean getIncludeMetadataInHeader(DynObject dynobj) {

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

        return BooleanUtils.isTrue(b);

    }

    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 boolean isFirstLineHeader(DynObject dynobj) {

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

        return BooleanUtils.isTrue(b);

    }

//    static int[] getFieldTypes(DynObject dynobj) {

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

//        if ( StringUtils.isBlank(s) ) {

//            return null;

//        }

//        String sep = getDelimiter(s);

//        if ( sep == null ) {

//            return null;

//        }

//        DataTypesManager dataTypeManager = ToolsLocator.getDataTypesManager();

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

//        int fieldTypes[] = new int[fieldTypeNames.length];

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

//            s = fieldTypeNames[i].trim();

//            if ( s.contains(":") ) {

//                s = s.split(":")[0];

//            }

//            fieldTypes[i] = dataTypeManager.getType(s);

//        }

//        return fieldTypes;

//    }

//

//    static int[] getFieldSizes(DynObject dynobj) {

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

//        if ( StringUtils.isBlank(s) ) {

//            return null;

//        }

//        String sep = getDelimiter(s);

//        if ( sep == null ) {

//            return null;

//        }

//        DataTypesManager dataTypeManager = ToolsLocator.getDataTypesManager();

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

//        int fieldSizes[] = new int[fieldTypeNames.length];

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

//            String fieldtypeDef = fieldTypeNames[i].trim();

//            if ( fieldtypeDef.contains(":") ) {

//                try {

//                    String[] parts = fieldtypeDef.split(":");

//                    int fieldType = dataTypeManager.getType(parts[0]);

//                    if( fieldType == DataTypes.GEOMETRY ) {

//                        fieldSizes[i] = 1;

//                    } else {

//                        s = parts[1];

//                        fieldSizes[i] = Integer.parseInt(s);

//                    }

//                } catch (Exception ex) {

//                    logger.warn("Can't get size of field " + i + " (" + fieldtypeDef + ").", ex);

//                }

//            } else {

//                fieldSizes[i] = 0;

//            }

//        }

//        return fieldSizes;

//    }

    public static String getRawFieldTypes(DynObject dynobj) {

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

        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 String getRawFieldsDefinition(DynObject dynobj) {

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

        if ( StringUtils.isBlank(s) ) {

            return null;

        }

        return s.trim();

    }

    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+").");

        }

    }

}