IndexDefinition.java

/**
 * Copyright 2014 Sunny Gleason and original author or authors
 *
 * 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 io.kazuki.v0.store.schema.model;

import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import javax.annotation.Nullable;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.google.common.base.Preconditions;


/**
 * Object class for an index definition, including name and column definitions.
 */
public class IndexDefinition {
  private final String name;
  private final List<IndexAttribute> indexColumns;
  private final List<String> attributeNames;
  private final boolean unique;
  private final Map<String, IndexAttribute> indexAttributeMap;
  private final String renameOf;

  @JsonCreator
  public IndexDefinition(@JsonProperty("name") String name,
      @JsonProperty("cols") List<IndexAttribute> cols,
      @JsonProperty("unique") @Nullable Boolean unique,
      @JsonProperty("renameOf") @Nullable String renameOf) {
    Preconditions.checkNotNull(name, "name");
    Preconditions.checkNotNull(cols, "cols");
    Preconditions.checkArgument(!cols.isEmpty(), "cols");

    this.name = name;
    this.unique = (unique != null && unique);

    List<String> newAttributeNames = new ArrayList<String>();
    Map<String, IndexAttribute> newIndexAttributeMap = new LinkedHashMap<String, IndexAttribute>();

    for (IndexAttribute attr : cols) {
      String attrName = attr.getName();

      if (newIndexAttributeMap.containsKey(attrName)) {
        throw new IllegalArgumentException("index definition contains duplicate attribute: "
            + attrName);
      }

      newAttributeNames.add(attrName);
      newIndexAttributeMap.put(attrName, attr);
    }

    if (newIndexAttributeMap.containsKey("id")) {
      throw new IllegalArgumentException("index definition must not contain 'id' attribute");
    }

    this.indexColumns = Collections.unmodifiableList(cols);
    this.attributeNames = Collections.unmodifiableList(newAttributeNames);
    this.indexAttributeMap = Collections.unmodifiableMap(newIndexAttributeMap);
    this.renameOf = renameOf;
  }

  public String getName() {
    return name;
  }

  public boolean isUnique() {
    return unique;
  }

  @JsonIgnore
  public List<String> getAttributeNames() {
    return attributeNames;
  }

  @JsonIgnore
  public IndexAttribute getIndexAttribute(String attrName) {
    return this.indexAttributeMap.get(attrName);
  }

  @JsonProperty("cols")
  public List<IndexAttribute> getIndexAttributes() {
    return indexColumns;
  }

  @JsonIgnore
  public Map<String, IndexAttribute> getIndexAttributeMap() {
    return indexAttributeMap;
  }

  @JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
  public String getRenameOf() {
    return renameOf;
  }
}