org.eclipse.jnosql.communication.query.QueryCondition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jnosql-communication-query Show documentation

There is a newer version: 1.1.3

Show newest version

/*
 *  Copyright (c) 2023 Contributors to the Eclipse Foundation
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *  The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *  and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *  You may elect to redistribute this code under either of these licenses.
 *  Contributors:
 *  Otavio Santana
 */
package org.eclipse.jnosql.communication.query;


import org.eclipse.jnosql.communication.Condition;

/**
 * Condition performs different computations or actions depending on whether a boolean query
 * condition evaluates to true or false.
 * The conditions are composed of three elements.
 * The condition's name
 * The Operator
 * The Value
 *
 * @see QueryCondition#name() ()
 * @see QueryCondition#condition() ()
 * @see QueryCondition#value()
 */
public interface QueryCondition {

    /**
     * the data source or target, to apply the operator
     *
     * @return the name
     */
    String name();

    /**
     * that defines comparing process between the name and the value.
     *
     * @return the operator
     */
    Condition condition();

    /**
     * that data that receives the operation.
     *
     * @return the value
     */
    QueryValue value();
}