org.cqframework.cql.cql2elm.StringEscapeUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cql-to-elm Show documentation

The cql-to-elm library for the Clinical Quality Language Java reference implementation

There is a newer version: 3.18.0

package org.cqframework.cql.cql2elm;

import java.util.HashMap;
import java.util.Map;
import org.apache.commons.text.translate.*;

/**
 * Created by Bryn on 3/22/2017.
 */
@SuppressWarnings("checkstyle:methodname")
public class StringEscapeUtils {

    /**
     * Mapping to escape the CQL control characters.
     *
     * Namely: {@code \n \t \f \r}
     * @return the mapping table
     */
    public static Map CQL_CTRL_CHARS_ESCAPE() {
        return new HashMap(CQL_CTRL_CHARS_ESCAPE);
    }

    private static final Map CQL_CTRL_CHARS_ESCAPE =
            new HashMap() {
                {
                    put("\n", "\\n");
                    put("\t", "\\t");
                    put("\f", "\\f");
                    put("\r", "\\r");
                }
            };

    /**
     * Reverse of {@link #CQL_CTRL_CHARS_ESCAPE()} for unescaping purposes.
     * @return the mapping table
     */
    public static Map CQL_CTRL_CHARS_UNESCAPE() {
        return new HashMap(CQL_CTRL_CHARS_UNESCAPE);
    }

    private static final Map CQL_CTRL_CHARS_UNESCAPE =
            new HashMap() {
                {
                    put("\\n", "\n");
                    put("\\t", "\t");
                    put("\\f", "\f");
                    put("\\r", "\r");
                }
            };

    public static final CharSequenceTranslator ESCAPE_CQL = new LookupTranslator(
                    new HashMap() {
                        {
                            put("\"", "\\\"");
                            put("\\", "\\\\");
                            put("'", "\\'");
                        }
                    })
            .with(new LookupTranslator(CQL_CTRL_CHARS_ESCAPE()))
            .with(JavaUnicodeEscaper.outsideOf(32, 0x7f));

    public static final CharSequenceTranslator UNESCAPE_CQL = new AggregateTranslator(
            new UnicodeUnescaper(),
            new LookupTranslator(CQL_CTRL_CHARS_UNESCAPE()),
            new LookupTranslator(new HashMap() {
                {
                    put("\\\\", "\\");
                    put("\\\"", "\"");
                    put("\\'", "\'");
                    put("\\`", "`");
                    put("\\/", "/");
                    put("\\", "");
                }
            }));

    public static final String escapeCql(final String input) {
        return ESCAPE_CQL.translate(input);
    }

    public static final String unescapeCql(final String input) {
        // CQL supports the following escape characters in both strings and identifiers:
        // \" - double-quote
        // \' - single-quote
        // \` - backtick
        // \\ - backslash
        // \/ - slash
        // \f - form feed
        // \n - newline
        // \r - carriage return
        // \t - tab
        // \\u - unicode hex representation (e.g. \u0020)
        return UNESCAPE_CQL.translate(input);
    }
}