apoc.export.csv.CsvLoaderConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apoc-core Show documentation
Core package for Neo4j Procedures
The newest version!
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package apoc.export.csv;

import static java.nio.charset.StandardCharsets.UTF_8;

import apoc.util.CompressionAlgo;
import apoc.util.CompressionConfig;
import apoc.util.Util;
import java.util.Map;

/**
 * Config class to store the configuration for loading the CSV file. Names and defaults are based on the import tool's
 * command line options.
 */
public class CsvLoaderConfig extends CompressionConfig {

    public static final String DELIMITER = "delimiter";
    private static final String ARRAY_DELIMITER = "arrayDelimiter";
    private static final String QUOTATION_CHARACTER = "quotationCharacter";
    private static final String STRING_IDS = "stringIds";
    private static final String SKIP_LINES = "skipLines";
    private static final String BATCH_SIZE = "batchSize";
    private static final String IGNORE_DUPLICATE_NODES = "ignoreDuplicateNodes";
    private static final String IGNORE_BLANK_STRING = "ignoreBlankString";
    private static final String IGNORE_EMPTY_CELL_ARRAY = "ignoreEmptyCellArray";

    private static char DELIMITER_DEFAULT = ',';
    private static char ARRAY_DELIMITER_DEFAULT = ';';
    private static char QUOTATION_CHARACTER_DEFAULT = '"';
    private static boolean STRING_IDS_DEFAULT = true;
    private static int SKIP_LINES_DEFAULT = 1;
    private static int BATCH_SIZE_DEFAULT = 2000;
    private static boolean IGNORE_DUPLICATE_NODES_DEFAULT = false;
    private static boolean IGNORE_BLANK_STRING_DEFAULT = false;
    private static boolean IGNORE_EMPTY_CELL_ARRAY_DEFAULT = false;

    private final char delimiter;
    private final char arrayDelimiter;
    private final char quotationCharacter;
    private final boolean stringIds;
    private final int skipLines;
    private final int batchSize;
    private final boolean ignoreDuplicateNodes;
    private final boolean ignoreBlankString;
    private final boolean ignoreEmptyCellArray;

    private CsvLoaderConfig(Builder builder) {
        super(Map.of(COMPRESSION, builder.compressionAlgo, CHARSET, builder.charset));
        this.delimiter = builder.delimiter;
        this.arrayDelimiter = builder.arrayDelimiter;
        this.quotationCharacter = builder.quotationCharacter;
        this.stringIds = builder.stringIds;
        this.skipLines = builder.skipLines;
        this.batchSize = builder.batchSize;
        this.ignoreDuplicateNodes = builder.ignoreDuplicateNodes;
        this.ignoreBlankString = builder.ignoreBlankString;
        this.ignoreEmptyCellArray = builder.ignoreEmptyCellArray;
    }

    public char getDelimiter() {
        return delimiter;
    }

    public char getArrayDelimiter() {
        return arrayDelimiter;
    }

    public char getQuotationCharacter() {
        return quotationCharacter;
    }

    public boolean getStringIds() {
        return stringIds;
    }

    public int getSkipLines() {
        return skipLines;
    }

    public int getBatchSize() {
        return batchSize;
    }

    public boolean getIgnoreDuplicateNodes() {
        return ignoreDuplicateNodes;
    }

    public boolean isIgnoreBlankString() {
        return ignoreBlankString;
    }

    public boolean isIgnoreEmptyCellArray() {
        return ignoreEmptyCellArray;
    }

    /**
     * Creates builder to build {@link CsvLoaderConfig}.
     *
     * @return created builder
     */
    public static Builder builder() {
        return new Builder();
    }

    public static Character getCharacterOrString(Map config, String name) {
        Object o = config.get(name);
        if (o instanceof String) {
            String s = (String) o;
            if (s.length() != 1) {
                throw new IllegalStateException(name + " must have a length of one.");
            }
            return s.charAt(0);
        }
        if (o instanceof Character) {
            return (Character) o;
        }
        return null;
    }

    public static CsvLoaderConfig from(Map config) {
        Builder builder = builder();

        if (config.get(DELIMITER) != null) builder.delimiter(getCharacterOrString(config, DELIMITER));
        if (config.get(ARRAY_DELIMITER) != null) builder.arrayDelimiter(getCharacterOrString(config, ARRAY_DELIMITER));
        if (config.get(QUOTATION_CHARACTER) != null)
            builder.quotationCharacter(getCharacterOrString(config, QUOTATION_CHARACTER));
        if (config.get(STRING_IDS) != null) builder.stringIds((boolean) config.get(STRING_IDS));
        if (config.get(SKIP_LINES) != null) builder.skipLines(Util.toInteger(config.get(SKIP_LINES)));
        if (config.get(BATCH_SIZE) != null) builder.batchSize(Util.toInteger(config.get(BATCH_SIZE)));
        if (config.get(IGNORE_DUPLICATE_NODES) != null)
            builder.ignoreDuplicateNodes((boolean) config.get(IGNORE_DUPLICATE_NODES));
        if (config.get(IGNORE_BLANK_STRING) != null)
            builder.ignoreBlankString((boolean) config.get(IGNORE_BLANK_STRING));
        if (config.get(IGNORE_EMPTY_CELL_ARRAY) != null)
            builder.ignoreEmptyCellArray((boolean) config.get(IGNORE_EMPTY_CELL_ARRAY));
        builder.binary((String) config.getOrDefault(COMPRESSION, CompressionAlgo.NONE.name()));
        builder.charset((String) config.getOrDefault(CHARSET, UTF_8.name()));

        return builder.build();
    }

    /**
     * Builder to build {@link CsvLoaderConfig}.
     */
    public static final class Builder {
        private char delimiter = DELIMITER_DEFAULT;
        private char arrayDelimiter = ARRAY_DELIMITER_DEFAULT;
        private char quotationCharacter = QUOTATION_CHARACTER_DEFAULT;
        private boolean stringIds = STRING_IDS_DEFAULT;
        private int skipLines = SKIP_LINES_DEFAULT;
        private int batchSize = BATCH_SIZE_DEFAULT;
        private boolean ignoreDuplicateNodes = IGNORE_DUPLICATE_NODES_DEFAULT;
        private boolean ignoreBlankString = IGNORE_BLANK_STRING_DEFAULT;
        private boolean ignoreEmptyCellArray = IGNORE_EMPTY_CELL_ARRAY_DEFAULT;
        private String compressionAlgo = null;
        private String charset = UTF_8.name();

        private Builder() {}

        public Builder delimiter(char delimiter) {
            this.delimiter = delimiter;
            return this;
        }

        public Builder arrayDelimiter(char arrayDelimiter) {
            this.arrayDelimiter = arrayDelimiter;
            return this;
        }

        public Builder quotationCharacter(char quotationCharacter) {
            this.quotationCharacter = quotationCharacter;
            return this;
        }

        public Builder stringIds(boolean stringIds) {
            this.stringIds = stringIds;
            return this;
        }

        public Builder skipLines(int skipLines) {
            this.skipLines = skipLines;
            return this;
        }

        public Builder batchSize(int batchSize) {
            this.batchSize = batchSize;
            return this;
        }

        public Builder ignoreDuplicateNodes(boolean ignoreDuplicateNodes) {
            this.ignoreDuplicateNodes = ignoreDuplicateNodes;
            return this;
        }

        public Builder binary(String binary) {
            this.compressionAlgo = binary;
            return this;
        }

        public Builder charset(String charset) {
            this.charset = charset;
            return this;
        }

        public Builder ignoreBlankString(boolean ignoreBlankString) {
            this.ignoreBlankString = ignoreBlankString;
            return this;
        }

        public Builder ignoreEmptyCellArray(boolean ignoreArrayEmptyCell) {
            this.ignoreEmptyCellArray = ignoreArrayEmptyCell;
            return this;
        }

        public CsvLoaderConfig build() {
            return new CsvLoaderConfig(this);
        }
    }
}