com.influxdb.query.dsl.functions.AbstractFunctionCallFlux Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flux-dsl Show documentation

Specify the Flux query by the Query Builder.

There is a newer version: 7.2.0

/*
 * The MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.influxdb.query.dsl.functions;

import java.util.Map;
import javax.annotation.Nonnull;

import com.influxdb.query.dsl.IsVariableAssignment;
import com.influxdb.query.dsl.utils.ImportUtils;

/**
 * Base class defining a function invocation.
 *
 * 
 * Example
 * 
 *  public static class MyCustomFunctionCall extends AbstractFunctionCallFlux {
 *     public MyCustomFunctionCall(@Nonnull String name) {
 *         super(name);
 *     }
 *
 *     public MyCustomFunctionCall withN(final String n) {
 *         this.withPropertyValueEscaped("n", n);
 *         return this;
 *     }
 * }
 * 
 */
public abstract class AbstractFunctionCallFlux extends AbstractParametrizedFlux implements IsVariableAssignment {

    private final String name;

    /**
     * Will be called by the {@link AbstractFunctionFlux#invoke()} method of the function definition.
     *
     * @param name the name of the variable holding the implementation of the function
     */
    protected AbstractFunctionCallFlux(@Nonnull final String name) {
        this.name = name;
    }

    @Nonnull
    @Override
    public String getVariableName() {
        return name;
    }


    @Nonnull
    @Override
    protected String operatorName() {
        return name;
    }

    @Override
    public String toString(@Nonnull final Map parameters, final boolean prependImports) {
        StringBuilder builder = new StringBuilder();

        if (prependImports) {
            builder.append(ImportUtils.getImportsString(this));
        }
        appendActual(parameters, builder);

        return builder.toString();
    }
}