MaterializedView.java

/*
 * 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.*;

/**

 * Marks a class as a materialized view and let Achilles manage it
 * <pre class="code"><code class="java">
 * <strong>{@literal @}MaterializedView(baseEntity = UserEntity.class)</strong>
 * public class UserByCountryView {...}
 * </code></pre>
 *
 * @see <a href="https://github.com/doanduyhai/Achilles/wiki/Achilles-Annotations#materializedview" target="_blank">@MaterializedView</a>
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface MaterializedView {

    /**
     * (<strong>Mandatory</strong>) The entity class from which this materialized view is derived.
     *
     * <br/>
     * <pre class="code"><code class="java">
     * <strong>{@literal @}MaterializedView(baseEntity = UserEntity.class, keyspace="production_data", view = "user_by_country")</strong>
     * public class UserByCountryView {...}
     * </code></pre>
     */
    Class<?> baseEntity();

    /**
     * (<strong>Optional</strong>) The name of the keyspace in which this materialized view belongs to.
     * If not set explicitly on the entity, <strong>Achilles</strong> will use the current
     * keyspace of the java driver <em>Session</em> object.
     * <br/>
     * <pre class="code"><code class="java">
     * <strong>{@literal @}MaterializedView(baseEntity = UserEntity.class, keyspace="production_data", view = "user_by_country")</strong>
     * public class UserByCountryView {...}
     * </code></pre>
     */
    String keyspace() default "";

    /**
     * (<strong>Optional</strong>) The name of the materialized view. Defaults to the short class name. <br/>
     * Ex: for the class <em>xxx.xxx.UserByCountryView</em>, the
     * default table name will be <strong>userbycountryview</strong> if the attribute <em>view</em> is not set.
     * <br/>
     * <pre class="code"><code class="java">

     * <strong>{@literal @}MaterializedView(baseEntity = UserEntity.class, view = "user_by_country")</strong>
     * public class UserByCountryView {...}
     * </code></pre>
     */
    String view() default "";
}