com.github.helenusdriver.driver.info.TableInfo Maven / Gradle / Ivy

Go to download

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

JPA-like syntax for annotating POJO classes for persistence via Cassandra's Java driver - API

The newest version!

/*
 * Copyright (C) 2015-2015 The Helenus Driver Project 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 com.github.helenusdriver.driver.info;

import java.util.Iterator;

import com.github.helenusdriver.persistence.Table;

/**
 * The TableInfo class provides information about a specific table
 * for a particular POJO class.
 *
 * @copyright 2015-2015 The Helenus Driver Project Authors
 *
 * @author  The Helenus Driver Project Authors
 * @version 1 - Jan 15, 2015 - paouelle - Creation
 *
 * @param  The type of POJO represented by this class
 *
 * @since 2.0
 */
public interface TableInfo {
  /**
   * Gets the class of POJO represented by this class info object.
   *
   * @author paouelle
   *
   * @return the non-null type of POJO represented by this class
   *         info
   */
  public Class getObjectClass();

  /**
   * Gets the class info for the POJO.
   *
   * @author paouelle
   *
   * @return the non-null class info for the POJO
   */
  public ClassInfo getClassInfo();

  /**
   * Gets the table annotation for this info object.
   *
   * @author paouelle
   *
   * @return the non-null table annotation
   */
  public Table getTable();

  /**
   * Gets the table name. The returned table name will be cleaned up
   * according to the Cassandra guidelines. So it might not be the exact same
   * value as was defined in the @Table annotation.
   *
   * @author paouelle
   *
   * @return the non-null name for the table
   */
  public String getName();

  /**
   * Gets an iterator of all fields defined as columns in this table.
   * 
   * Note: The {@link Iterator#remove} method is fully supported and if
   * called, will remove this field from the persisted state of the entity. This
   * can be useful for filters.
   *
   * @author paouelle
   *
   * @return a non-null iterator of all fields defined as columns
   *         in this table
   */
  public Iterator> columns();
}