com.arangodb.entity.arangosearch.StoredValue Maven / Gradle / Ivy

Go to download

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

ArangoDB Java Driver

There is a newer version: 7.15.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.entity.arangosearch;


import java.util.List;

/**
 * @author Michele Rastelli
 * @see API Documentation
 * @since ArangoDB 3.7
 */
public class StoredValue {

    private final List fields;
    private final ArangoSearchCompression compression;

    public StoredValue(List fields, ArangoSearchCompression compression) {
        this.fields = fields;
        this.compression = compression;
    }

    public StoredValue(List fields) {
        this(fields, null);
    }

    /**
     * @return an array of strings with one or more document attribute paths. The specified attributes are placed into a
     * single column of the index. A column with all fields that are involved in common search queries is ideal for
     * performance. The column should not include too many unneeded fields however.
     */
    public List getFields() {
        return fields;
    }

    /**
     * @return defines the compression type used for the internal column-store
     */
    public ArangoSearchCompression getCompression() {
        return compression;
    }

}