io.nosqlbench.engine.api.activityconfig.ParsedStmtOp Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2022 nosqlbench
 *
 * 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 io.nosqlbench.engine.api.activityconfig;

import io.nosqlbench.engine.api.activityconfig.yaml.OpTemplate;
import io.nosqlbench.api.config.params.Element;
import io.nosqlbench.api.config.params.NBParams;
import io.nosqlbench.virtdata.core.templates.BindPoint;
import io.nosqlbench.virtdata.core.templates.ParsedStringTemplate;

import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;

public class ParsedStmtOp {

    private final OpTemplate optpl;
    private final ParsedStringTemplate parsed;

    /**
     * Construct a new ParsedStatement from the provided stmtDef and anchor token.
     *
     * @param optpl An existing statement def as read from the YAML API.
     */
    public ParsedStmtOp(OpTemplate optpl) {
        this.optpl = optpl;
        String transformed = getStmt();
        parsed = new ParsedStringTemplate(transformed, optpl.getBindings());
    }

    public ParsedStmtOp orError() {
        if (hasError()) {
            throw new RuntimeException("Unable to parse statement: " + this);
        }
        return this;
    }

    public String toString() {
        return parsed.toString();
    }

    /**
     * @return true if the parsed statement is not usable.
     */
    public boolean hasError() {
        return parsed.hasError();
    }


    /**
     * Returns a list of binding names which were referenced
     * in either {anchor}
 or ?anchor form,
     * but which were not present in the provided bindings map.
     * If any binding names are present in the returned set, then
     * this binding will not be usable.
     *
     * @return A list of binding names which were referenced but not defined*
     */
    public Set getMissingBindings() {
        return parsed.getMissing();
    }

    /**
     * Return the statement that can be used as-is by any driver specific version.
     * This uses the anchor token as provided to yield a version of the statement
     * which contains positional anchors, but no named bindings.
     * @param tokenMapper A function which maps the anchor name to the needed form
     *                    in the callers driver context
     * @return A driver or usage-specific format of the statement, with anchors
     */
    public String getPositionalStatement(Function tokenMapper) {
        return parsed.getPositionalStatement(tokenMapper);
    }

    /**
     * @return the statement name from the enclosed {@link OpTemplate}
     */
    public String getName() {
        return optpl.getName();
    }

    /**
     * @return the raw statement from the enclosed {@link OpTemplate}
     */
    public String getStmt() {
        return optpl.getStmt().orElseThrow();
    }

    /**
     * @return the tags from the enclosed {@link OpTemplate}
     */
    public Map getTags() {
        return optpl.getTags();
    }

    /**
     * @return the bindings from the enclosed {@link OpTemplate}
     */
    public Map getBindings() {
        return optpl.getBindings();
    }

    /**
     * @return a params reader from the enclosed {@link OpTemplate} params map
     */
    public Element getParamReader() {
        return NBParams.one(getName(),optpl.getParams());
    }

    public List getBindPoints() {
        return parsed.getBindPoints();
    }

}