org.elasticsearch.xpack.esql.parser.QueryParams Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of x-pack-esql Show documentation
The plugin that powers ESQL for Elasticsearch
There is a newer version: 8.16.1
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */

package org.elasticsearch.xpack.esql.parser;

import org.antlr.v4.runtime.Token;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Objects;

public class QueryParams {

    private final List params; // This matches the named or unnamed parameters specified in an EsqlQueryRequest.params
    private final Map nameToParam; // This matches the named parameters specified in an EsqlQueryRequest.params
    private Map tokenToParam; // This is populated by EsqlParser, each parameter marker has an entry
    private List parsingErrors;
    private final int paramsCount;

    public QueryParams() {
        this(null);
    }

    public QueryParams(List params) {
        this.tokenToParam = new HashMap<>();
        this.parsingErrors = new ArrayList<>();

        if (params == null || params.isEmpty()) {
            this.params = List.of();
            this.nameToParam = Map.of();
            this.paramsCount = 0;
        } else {
            this.paramsCount = params.size();
            this.params = new ArrayList<>(paramsCount);
            Map tempNameToParam = new HashMap<>(paramsCount);
            for (QueryParam p : params) {
                this.params.add(p);
                String name = p.name();
                if (name != null) {
                    tempNameToParam.put(name, p);
                }
            }
            this.nameToParam = Collections.unmodifiableMap(tempNameToParam);
        }
    }

    public int size() {
        return this.paramsCount;
    }

    public QueryParam get(int index) {
        return (index <= 0 || index > this.paramsCount) ? null : params.get(index - 1);
    }

    public Map namedParams() {
        return this.nameToParam;
    }

    public boolean contains(String paramName) {
        return this.nameToParam.containsKey(paramName);
    }

    public QueryParam get(String paramName) {
        return nameToParam.get(paramName);
    }

    public boolean contains(Token token) {
        return this.tokenToParam.containsKey(token);
    }

    public QueryParam get(Token tokenLocation) {
        return this.tokenToParam.get(tokenLocation);
    }

    public void addTokenParam(Token token, QueryParam param) {
        this.tokenToParam.put(token, param);
    }

    public Iterator parsingErrors() {
        return this.parsingErrors.iterator();
    }

    public void addParsingError(ParsingException e) {
        this.parsingErrors.add(e);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        QueryParams that = (QueryParams) o;
        return paramsCount == that.paramsCount
            && params.equals(that.params)
            && nameToParam.equals(that.nameToParam)
            && tokenToParam.equals(that.tokenToParam)
            && parsingErrors.equals(that.parsingErrors);
    }

    @Override
    public int hashCode() {
        return Objects.hash(params, nameToParam, tokenToParam, parsingErrors, paramsCount);
    }
}