com.arangodb.entity.IndexEntity 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
/*
 * Copyright (C) 2012 tamtam180
 *
 * 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.
 */

package com.arangodb.entity;

import java.util.List;

/**
 * An entity representing an index on a collection
 *
 * @author tamtam180 - kirscheless at gmail.com
 *
 */
public class IndexEntity extends BaseEntity {

  /**
   * the index id
   */
  String id;

  /**
   * the type of the index
   * @see com.arangodb.entity.IndexType
   */
  IndexType type;

  /**
   * the fields the index is defined on
   */
  List fields;

  /**
   * if the index is a geoIndex and *geoJson* is true, then the order within the list is longitude followed by latitude.
   * This corresponds to the format described in http://geojson.org/geojson-spec.html#positions
   */
  boolean geoJson;

  /**
   * is a newly created index
   */
  boolean isNewlyCreated;

  /**
   * if true the index is a unique index.
   */
  boolean unique;
  
  /**
   * if true the index is sparse
   */
  boolean sparse;

  /**
   * the maximum amount of documents in case the index type is capped
   */
  int size;

  /**
   * minimum character length of words to index in case the index type is a fulltext
   */
  int minLength;
  
  /**
   * index selectivity estimate (if provided by the index)
   */
  double selectivityEstimate;

  public String getId() {
    return id;
  }
  public IndexType getType() {
    return type;
  }
  public List getFields() {
    return fields;
  }
  public boolean isGeoJson() {
    return geoJson;
  }
  public boolean isNewlyCreated() {
    return isNewlyCreated;
  }
  public boolean isUnique() {
    return unique;
  }
  public boolean isSparse() {
    return sparse;
  }
  public int getSize() {
    return size;
  }
  public double getSelectivityEstimate() {
    return selectivityEstimate;
  }
  public void setId(String id) {
    this.id = id;
  }
  public void setType(IndexType type) {
    this.type = type;
  }
  public void setFields(List fields) {
    this.fields = fields;
  }
  public void setGeoJson(boolean getJson) {
    this.geoJson = getJson;
  }
  public void setNewlyCreated(boolean isNewlyCreated) {
    this.isNewlyCreated = isNewlyCreated;
  }
  public void setUnique(boolean unique) {
    this.unique = unique;
  }
  public void setSparse(boolean sparse) {
    this.sparse = sparse;
  }
  public void setSize(int size) {
    this.size = size;
  }
  public int getMinLength() {
    return minLength;
  }
  public void setMinLength(int minLength) {
    this.minLength = minLength;
  }
  public void setSelectivityEstimate(double selectivityEstimate) {
    this.selectivityEstimate = selectivityEstimate;
  }
  
}