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.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.store.gml.GMLFeatureTypeLoader;

import org.gvsig.fmap.dal.store.simplereader.SimpleReaderFeatureTypeLoader;

import org.gvsig.fmap.dal.store.simplereader.SimpleReaderStoreParameters;

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 SimpleReaderStoreParameters 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 CHARSET = "charset"; // Default "UTF-8"

//    private static final String LOCALE = "locale";

    private static final String POINT_COLUMN_NAME = "pointColumnName";

    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";

    public CSVStoreParameters() {

        this(PARAMETERS_DEFINITION_NAME);

    }

    protected CSVStoreParameters(String parametersDefinitionName) {

        super(parametersDefinitionName, CSVStoreProvider.NAME);

    }

    protected FeatureType getFeatureType() {

        if( this.featureType==null ) {

            try {

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

                SimpleReaderFeatureTypeLoader featureTypeLoader = new CSVFeatureTypeLoader(this);

                featureTypeLoader.loadFeatureType(ftype, false, null);

                boolean all_fields_declare_type = featureTypeLoader.isAllFieldsDeclareType();

                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

    public void validate() throws ValidateDataParametersException {

        super.validate();

        FeatureType ftype = this.getFeatureType();

        if( ftype!=null ) {

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

            }

        }

    }

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

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

        return BooleanUtils.isTrue(b);

    }

}