io.tarantool.driver.api.conditions.Condition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cartridge-driver Show documentation

Tarantool Cartridge driver for Tarantool versions 1.10+ based on Netty framework

There is a newer version: 0.14.0

package io.tarantool.driver.api.conditions;

import io.tarantool.driver.metadata.TarantoolMetadataOperations;
import io.tarantool.driver.metadata.TarantoolSpaceMetadata;

import java.util.List;

/**
 * Represents a condition which is evaluated against the tuple fields
 *
 * @author Alexey Kuzin
 */
public interface Condition {
    /**
     * Filtering operator (<. <=, =, =>, >)
     *
     * @return operator
     */
    Operator operator();

    /**
     * Filtering operand, may be a field or index
     *
     * @return operand
     */
    FieldIdentifier field();

    /**
     * Filtering value for the operand
     *
     * @return operand value
     */
    Object value();

    /**
     * Serializes the condition into a form of Java list
     *
     * @param metadataOperations metadata operations
     * @param spaceMetadata space metadata
     * @return list of serialized conditions
     */
    List toList(TarantoolMetadataOperations metadataOperations, TarantoolSpaceMetadata spaceMetadata);
}