org.dbflute.helper.dfmap.DfMapStyle Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014-2020 the original author or authors.
 *
 * 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 org.dbflute.helper.dfmap;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import org.dbflute.helper.dfmap.exception.DfMapDuplicateEntryException;
import org.dbflute.helper.dfmap.exception.DfMapParseFailureException;
import org.dbflute.helper.message.ExceptionMessageBuilder;

/**
 * The parser for DBFlute map style.
 *  * e.g. map-string as one liner
 *   map:{key1=value1;key2=list:{value21;value22;value23},key3=map:{key31=value31}}
 * 
 * e.g. map-string as formatted
 *   map:{
 *       ; key1 = value1
 *       ; key2 = list:{ value21 ; value22 ; value23 }
 *       ; key3 = map:{ key31 ; value31 }
 *   }
 * 
 * e.g. list-string
 *   list:{key1=value1,key2=list:{value21,value22,value23},key3=map:{key31=value31}}
 * 
 * 
 * Detail Specification:
 *  * o all elements are trimmed e.g. map:{ sea   = land    } to {sea=land}
 * o empty or null value is treated as null e.g. map:{ sea = ; land = null } to both null
 * o empty elements are ignored e.g. list:{ ; sea ; ; land } to [sea, land]
 * o can escape control marks e.g. '{', ';' by escape character '\'
 * o but cannot escape escape character itself
 * o basically cannot change control mark, but you can override...
 * o can check duplicate entry of map key by option checkDuplicateEntry()
 * o can print as one liner by option printOneLiner()
 * o non-thread-safe, uses temporary variables
 * o but can recycle in same thread 
 * 
 * @author jflute
 * @since 1.1.8 (2018/05/05 Saturday)
 */
public class DfMapStyle { // migrated MapListString, basically keeping compatible

    // this original code (MapListString) was written when jflute was very young
    // and migrated to this class with small refactoring for performance
    // all lines are very memorable...

    // ===================================================================================
    //                                                                          Definition
    //                                                                          ==========
    /** The object prefix of map. */
    public static final String MAP_PREFIX = "map:";

    /** The object prefix of list. */
    public static final String LIST_PREFIX = "list:";

    /** The control mark of begin-brace. */
    public static final String BEGIN_BRACE = "{";

    /** The control mark of end-brace. */
    public static final String END_BRACE = "}";

    /** The control mark of element-delimiter. */
    public static final String ELEMENT_DELIMITER = ";";

    /** The control mark of value-equal. */
    public static final String VALUE_EQUAL = "=";

    /** The escape character for control marks. */
    protected static final String ESCAPE_CHAR = "\\";

    /** The temporary mark of escaped escape character. */
    protected static final String ESCAPED_ESCAPE_MARK = "$$df:escapedEscape$$";

    // ===================================================================================
    //                                                                           Attribute
    //                                                                           =========
    // -----------------------------------------------------
    //                                         Object Prefix
    //                                         -------------
    /** The object prefix of map. e.g. "map:" (NotNull) */
    protected final String _mapPrefix;

    /** The object prefix of list. e.g. "list:" (NotNull) */
    protected final String _listPrefix;

    // -----------------------------------------------------
    //                                          Control Mark
    //                                          ------------
    /** The control mark of begin-brace. e.g. "{" (NotNull) */
    protected final String _beginBrace;

    /** The control mark of end-brace. e.g. "}" (NotNull) */
    protected final String _endBrace;

    /** The control mark of element-delimiter. e.g. ";" (NotNull) */
    protected final String _elementDelimiter;

    /** The control mark of value-equal. e.g. "=" (NotNull) */
    protected final String _valueEqual;

    /** The escape character for control marks. "\\" (NotNull) */
    protected final String _escapeChar;

    // -----------------------------------------------------
    //                                     Cached Expression
    //                                     -----------------
    /** The cached expression of begin-brace for map. e.g. "map:{" */
    protected final String _mappingBeginBrace;

    /** The cached expression of begin-brace for list. e.g. "list:{" */
    protected final String _listingBeginBrace;

    // -----------------------------------------------------
    //                                             Temporary
    //                                             ---------
    /** The whole map-string of logical remainder as temporary variable for parsing process. (NullAllowed: when no process) */
    protected String _remainderString;

    /** The current index of remainder string for parsing process. */
    protected int _currentRemainderIndex;

    // -----------------------------------------------------
    //                                                Option
    //                                                ------
    /** Does it check duplicate entry of map for generation? */
    protected boolean _checkDuplicateEntry;

    /** Does it print as one-liner for building? */
    protected boolean _printOneLiner;

    /** Is it without display side spaces? */
    protected boolean _withoutDisplaySideSpace;

    // ===================================================================================
    //                                                                         Constructor
    //                                                                         ===========
    /**
     * Constructor for settings as default.
     */
    public DfMapStyle() {
        this(MAP_PREFIX, LIST_PREFIX, BEGIN_BRACE, END_BRACE, ELEMENT_DELIMITER, VALUE_EQUAL, ESCAPE_CHAR);
    }

    // you can use as public in your constructor of sub-class
    protected DfMapStyle(String mapPrefix, String listPrefix, String beginBrace, String endBrace, String elementDelimiter,
            String valueEqual, String escapeChar) {
        assertStringNotNullAndNotTrimmedEmpty("mapPrefix", mapPrefix);
        assertStringNotNullAndNotTrimmedEmpty("listPrefix", listPrefix);
        assertStringNotNullAndNotTrimmedEmpty("beginBrace", beginBrace);
        assertStringNotNullAndNotTrimmedEmpty("endBrace", endBrace);
        assertStringNotNullAndNotTrimmedEmpty("delimiter", elementDelimiter);
        assertStringNotNullAndNotTrimmedEmpty("valueEqual", valueEqual);
        assertStringNotNullAndNotTrimmedEmpty("escapeChar", escapeChar);
        _mapPrefix = mapPrefix;
        _listPrefix = listPrefix;
        _beginBrace = beginBrace;
        _endBrace = endBrace;
        _elementDelimiter = elementDelimiter;
        _valueEqual = valueEqual;
        _escapeChar = escapeChar;
        _mappingBeginBrace = _mapPrefix + _beginBrace;
        _listingBeginBrace = _listPrefix + _beginBrace;
    }

    // -----------------------------------------------------
    //                                                Option
    //                                                ------
    /**
     * Check duplicate entry of map for generation. (throws exception if found)
     * @return this. (NotNull)
     */
    public DfMapStyle checkDuplicateEntry() {
        _checkDuplicateEntry = true;
        return this;
    }

    /**
     * Print as one liner for building.
     * @return this. (NotNull)
     */
    public DfMapStyle printOneLiner() {
        _printOneLiner = true;
        return this;
    }

    /**
     * Print without display side spaces. 

     * e.g. map:{ sea = mystic ; land = oneman } to map:{sea=mystic;land=oneman}.
     * @return this. (NotNull)
     */
    public DfMapStyle withoutDisplaySideSpace() {
        _withoutDisplaySideSpace = true;
        return this;
    }

    // ===================================================================================
    //                                                                    Object to String
    //                                                                    ================
    // -----------------------------------------------------
    //                                          to MapString
    //                                          ------------
    /**
     * Convert to map-string from the map object.
     * @param map The map object that has string keys. (NotNull, EmptyAllowed)
     * @return The string as map expression. (NotNull)
     */
    public String toMapString(Map map) {
        assertObjectNotNull("map", map);
        final StringBuilder sb = new StringBuilder();
        @SuppressWarnings("unchecked")
        final Map casted = (Map) map;
        final boolean printOneLiner = isPrintOneLiner();
        final boolean withoutDisplaySideSpace = isWithoutDisplaySideSpace();
        buildMapString(sb, casted, printOneLiner, "", printOneLiner ? "" : "    ", withoutDisplaySideSpace);
        return sb.toString();
    }

    protected void buildMapString(StringBuilder sb, Map map, boolean printOneLiner, String previousIndent,
            String currentIndent, boolean withoutDisplaySideSpace) {
        doBuildMapStringBegin(sb, map, printOneLiner, previousIndent, currentIndent);
        if (!map.isEmpty()) {
            int index = 0;
            for (Entry entry : map.entrySet()) {
                doBuildMapStringCurrentEntry(sb, printOneLiner, previousIndent, currentIndent, withoutDisplaySideSpace, index,
                        entry.getKey(), entry.getValue());
                ++index;
            }
            if (printOneLiner) {
                appendDisplaySideSpace(sb, withoutDisplaySideSpace);
            } else {
                sb.append(ln()).append(previousIndent);
            }
        }
        doBuildMapStringEnd(sb, map, printOneLiner, previousIndent, currentIndent);
    }

    protected void doBuildMapStringBegin(StringBuilder sb, Map map, boolean printOneLiner, String previousIndent,
            String currentIndent) {
        sb.append(_mapPrefix).append(_beginBrace);
    }

    protected void doBuildMapStringCurrentEntry(StringBuilder sb, boolean printOneLiner, String previousIndent, String currentIndent,
            boolean withoutDisplaySideSpace, int index, String key, Object value) {
        if (printOneLiner) {
            if (index > 0) {
                if (!isWithoutDisplaySideSpace()) {
                    sb.append(" ");
                }
                sb.append(_elementDelimiter);
            }
        } else {
            sb.append(ln()).append(currentIndent).append(_elementDelimiter);
        }
        appendDisplaySideSpace(sb, withoutDisplaySideSpace);
        sb.append(escapeControlMarkAsMap(key));
        appendDisplaySideSpace(sb, withoutDisplaySideSpace);
        sb.append(_valueEqual);
        if (!isWithoutDisplaySideSpace()) {
            sb.append(" ");
        }
        if (value instanceof Map) {
            @SuppressWarnings("unchecked")
            final Map valueMap = (Map) value;
            final String nextIndent = deriveNextIndentOfBuildingMapString(printOneLiner, previousIndent, currentIndent);
            buildMapString(sb, valueMap, printOneLiner, currentIndent, nextIndent, withoutDisplaySideSpace);
        } else if (value instanceof List) {
            @SuppressWarnings("unchecked")
            final List