springdao.Dao Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sd4j Show documentation
Spring Dao Libray for easy using JPA
There is a newer version: 1.0.2
package springdao;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.persistence.EntityManagerFactory;

/**
 * Inject a {@link Dao} implemention  into {@link RepositoryManager}.

 * 將{@link Dao}注入{@link RepositoryManager}.

 * Usage(用法):

 * Initializate a {@link DaoAnnotationBeanPostProcessor} bean in your spring context.

 * 在您的Spring環境內建立一個{@link DaoAnnotationBeanPostProcessor} bean 就可以了.

 *  *     @Dao(value = Entity.class, name = "customDao")
 *     public DaoRepository<Entity> entityDao;
 * 
 * 
 * Note(備註):
 * It's not recommend to use this annotation,
 * because of {@link DaoManager} may also create  the same name {@link DaoRepository}, and @Dao can't  assure instantiation order 
 * of {@link DaoRepository}, please use carefully.

 *我建議不要使用此標記， 因為{@link DaoManager}也有可能建立同名的{@link DaoRepository}，而@Dao並無法保證其建立順序，所以要用時，
 * 請自求多福。
 * 
 * @author Kent Yeh
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
@Documented
@Inherited
public @interface Dao {

    /**
     * Class assoicated with {@link DaoRepository}.

     * {@link DaoRepository} 相關的一般化類別
     * @return taget entity class
     */
    Class value() default Object.class;

    /**
     * Deinfe {@link EntityManagerFactory} bean's name.

     * 設定 {@link EntityManagerFactory}  bean的名稱.
     * @return {@link EntityManagerFactory} bean's name, default is "entityManagerFactory"
     */
    String factory() default "entityManagerFactory";

    /**
     * Naming object to be turned into a Spring bean in case of an autodetected component.

     * Spring beand 的名稱., 若已存在則取用，若不存在則建立
     * @return spring bean's name
     */
    String name() default "";

    /**
     * Auto register bean with ${@link #value() value}'s simple class name suffix with "Dao" if not assigned ${@link #name() name}.

     * 如果沒有指定${@link #name() name}，則自動以${@link #value() value}的類別名稱加上"Dao"註冊
     * @return spring bean's name
     */
    boolean autoRegister() default true;

}