com.arangodb.model.ZKDIndexOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Core module for ArangoDB Java Driver

There is a newer version: 7.16.0

/*
 * DISCLAIMER
 *
 * Copyright 2016 ArangoDB GmbH, Cologne, Germany
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb.model;

import com.arangodb.entity.IndexType;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * @author Michele Rastelli
 * @since ArangoDB 3.9
 * @deprecated since ArangoDB 3.12, use {@link MDIndexOptions} instead.
 */
@Deprecated
public final class ZKDIndexOptions extends IndexOptions {

    final IndexType type = IndexType.zkd;
    private Iterable fields;
    private Boolean unique;
    private FieldValueTypes fieldValueTypes;

    public ZKDIndexOptions() {
        super();
    }

    @Override
    ZKDIndexOptions getThis() {
        return this;
    }

    public Iterable getFields() {
        return fields;
    }

    /**
     * @param fields A list of attribute paths
     * @return options
     */
    ZKDIndexOptions fields(final Iterable fields) {
        this.fields = fields;
        return this;
    }

    public IndexType getType() {
        return type;
    }

    public Boolean getUnique() {
        return unique;
    }

    /**
     * @param unique if true, then create a unique index
     * @return options
     */
    public ZKDIndexOptions unique(final Boolean unique) {
        this.unique = unique;
        return this;
    }

    public FieldValueTypes getFieldValueTypes() {
        return fieldValueTypes;
    }

    /**
     * @param fieldValueTypes must be {@link FieldValueTypes#DOUBLE}, currently only doubles are supported as values.
     * @return options
     */
    public ZKDIndexOptions fieldValueTypes(final FieldValueTypes fieldValueTypes) {
        this.fieldValueTypes = fieldValueTypes;
        return this;
    }

    public enum FieldValueTypes {
        @JsonProperty("double")
        DOUBLE
    }

}