info.archinnov.achilles.annotations.PartitionKey Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of achilles-model Show documentation

There is a newer version: 6.1.0

/*
 * Copyright (C) 2012-2016 DuyHai DOAN
 *
 * 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 info.archinnov.achilles.annotations;

import java.lang.annotation.*;

/**
 * Indicates that this component is part of the partition key.Useful to define a composite partition key.
 * Please note that the ordering starts at 1
 * 

 * {@literal @}Table
 * public class Entity {

 * // Partition key component 1
 * {@literal @}PartitionKey(1)
 * private Long id;

 * // Partition key component 2. Date in YYYYMMDD
 * {@literal @}PartitionKey(2)
 * private int date;
 * }
 * 
 *
 * @see @PartitionKey
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
@Documented
public @interface PartitionKey {

    /**
     * The order of this partition key, starting at 1
     */
    int value() default 1;

}