com.redhat.lightblue.query.RegexMatchExpression Maven / Gradle / Ivy

Go to download
/*
 Copyright 2013 Red Hat, Inc. and/or its affiliates.

 This file is part of lightblue.

 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, see .
 */
package com.redhat.lightblue.query;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.redhat.lightblue.util.Error;
import com.redhat.lightblue.util.Path;

/**
 * Represents a regular expression match query of the form
 *  * { field: , regex: ,
 *      caseInsensitive: false, extended: false, multiline: false, dotall: false }
 * 
 *
 */
public class RegexMatchExpression extends RelationalExpression {
    private static final long serialVersionUID = 1L;

    private final Path field;
    private final String regex;
    private final boolean caseInsensitive;
    private final boolean multiline;
    private final boolean extended;
    private final boolean dotall;

    /**
     * Constructs a regular expression match expression using the values
     */
    public RegexMatchExpression(Path field, String regex,
                                boolean caseInsensitive,
                                boolean multiline,
                                boolean extended,
                                boolean dotall) {
        this.field = field;
        this.regex = regex;
        this.caseInsensitive = caseInsensitive;
        this.multiline = multiline;
        this.extended = extended;
        this.dotall = dotall;
    }

    /**
     * Returns the field to me matched
     */
    public Path getField() {
        return this.field;
    }

    /**
     * Returns the regular expression
     */
    public String getRegex() {
        return this.regex;
    }

    /**
     * Determines if the regex match will be case sensitive
     */
    public boolean isCaseInsensitive() {
        return caseInsensitive;
    }

    /**
     * (from regex javadoc) In multiline mode the expressions ^ and $ match just
     * after or just before, respectively, a line terminator or the end of the
     * input sequence. By default these expressions only match at the beginning
     * and the end of the entire input sequence.
     */
    public boolean isMultiline() {
        return multiline;
    }

    /**
     * (from regex javadoc) In this mode, whitespace is ignored, and embedded
     * comments starting with # are ignored until the end of a line.
     */
    public boolean isExtended() {
        return extended;
    }

    /**
     * (from regex javadoc) In dotall mode, the expression . matches any
     * character, including a line terminator. By default this expression does
     * not match line terminators.
     */
    public boolean isDotAll() {
        return dotall;
    }

    @Override
    public JsonNode toJson() {
        ObjectNode node = getFactory().objectNode().
                put("field", field.toString()).
                put("regex", regex);
        if (caseInsensitive) {
            node.put("caseInsensitive", true);
        }
        if (multiline) {
            node.put("multiline", true);
        }
        if (extended) {
            node.put("extended", true);
        }
        if (dotall) {
            node.put("dotall", true);
        }
        return node;
    }

    public static RegexMatchExpression fromJson(ObjectNode node) {
        JsonNode x = node.get("field");
        if (x != null) {
            Path field = new Path(x.asText());
            x = node.get("regex");
            if (x != null) {
                String regex = x.asText();
                return new RegexMatchExpression(field, regex,
                        asBoolean(node.get("caseInsensitive")),
                        asBoolean(node.get("multiline")),
                        asBoolean(node.get("extended")),
                        asBoolean(node.get("dotall")));
            }
        }
        throw Error.get(QueryConstants.ERR_INVALID_REGEX_EXPRESSION, node.toString());
    }

    private static boolean asBoolean(JsonNode node) {
        if (node != null) {
            return node.asBoolean();
        }
        return false;
    }
}