io.tarantool.driver.api.conditions.FieldIdentifier 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;

/**
 * Represents filtering operand in conditions, it may be an index or a field
 *
 * @param  metadata type
 * @author Alexey Kuzin
 */
public interface FieldIdentifier {
    /**
     * Returns metadata object corresponding to the field identifier type
     *
     * @param metadataOperations for retrieving the operand metadata and checking the filed or index availability
     * @param spaceMetadata space metadata this field or index belongs to
     * @return name to be used in filter condition
     */
    T metadata(TarantoolMetadataOperations metadataOperations, TarantoolSpaceMetadata spaceMetadata);

    /**
     * Get serializable form of the identifier
     *
     * @return an object serializable into MessagePack
     */
    O toIdentifier();
}