com.datastax.oss.driver.api.mapper.annotations.Entity Maven / Gradle / Ivy

Go to download
/*
 * Copyright DataStax, Inc.
 *
 * 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.datastax.oss.driver.api.mapper.annotations;

import com.datastax.oss.driver.api.core.session.SessionBuilder;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotates a class that will be mapped to a Cassandra table or UDT.
 *
 * Example:
 *
 * 
 * @Entity
 * public class Product {
 *   @PartitionKey private UUID id;
 *   private String description;
 *
 *   public UUID getId() { return id; }
 *   public void setId(UUID id) { this.id = id; }
 *   public String getDescription() { return description; }
 *   public void setDescription(String description) { this.description = description; }
 * }
 * 
 *
 * Entity classes follow the usual "POJO" conventions. Each property will be mapped to a CQL column.
 * In order to detect a property:
 *
 * 
 *   there must be a getter method that follows the usual naming convention (e.g. {@code
 *       getDescription}) and has no parameters. The name of the property is obtained by removing
 *       the "get" prefix and decapitalizing ({@code description}), and the type of the property is
 *       the return type of the getter.
 *   
unless the entity is {@linkplain PropertyStrategy#mutable() immutable}, there must
 *       be a matching setter method ({@code setDescription}), with a single parameter that has the
 *       same type as the property (the return type does not matter).
 * 
 *
 * There may also be a matching field ({@code description}) that has the same type as the
 * property, but this is not mandatory: a property can have only a getter and a setter (for example
 * if the value is computed, or the field has a different name, or is nested into another field,
 * etc.)
 *
 * Properties can be annotated to configure various aspects of the mapping. The annotation can be
 * either on the field, or on the getter (if both are specified, the mapper processor issues a
 * compile-time warning, and the field annotation will be ignored). The available annotations are:
 *
 * 

 *   {@link PartitionKey}
 *   
{@link ClusteringColumn}
 *   
{@link Computed}
 *   
{@link Transient}
 *   
{@link CqlName}
 * 
 *
 * The class must expose a no-arg constructor that is at least package-private.
 *
 * 
Entities are used as arguments or return types of {@link Dao} methods. They can also be nested
 * inside other entities (to map UDT columns).
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Entity {
  /**
   * Specifies a default keyspace to use when doing operations on this entity.
   *
   * 
This will be used when you build a DAO without an explicit keyspace parameter:
   *
   * 
   * @Entity(defaultKeyspace = "inventory")
   * public class Product { ... }
   *
   * @Mapper
   * public interface InventoryMapper {
   *   @DaoFactory
   *   ProductDao productDao();
   *
   *   @DaoFactory
   *   ProductDao productDao(@DaoKeyspace String keyspace);
   * }
   *
   * ProductDao productDao = mapper.productDao();
   * productDao.insert(product); // inserts into inventory.product
   *
   * ProductDao productDaoTest = mapper.productDao("test");
   * productDaoTest.insert(product); // inserts into test.product
   * 
   *
   * The default keyspace optional: if it is not specified, and you build a DAO without a keyspace,
   * then the session must have a default keyspace (set with {@link
   * SessionBuilder#withKeyspace(String)}), otherwise an error will be thrown:
   *
   *    * @Entity
   * public class Product { ... }
   *
   * CqlSession session = CqlSession.builder()
   *     .withKeyspace("default_ks")
   *     .build();
   * InventoryMapper mapper = new InventoryMapperBuilder(session).build();
   *
   * ProductDao productDao = mapper.productDao();
   * productDao.insert(product); // inserts into default_ks.product
   * 
   *
   * If you want the name to be case-sensitive, it must be enclosed in double-quotes, for example:
   *
   *    * @Entity(defaultKeyspace = "\"defaultKs\"")
   * 
   */
  String defaultKeyspace() default "";
}