/**
 * 
 * Copyright 2014 The Darks ORM Project (Liu lihua)
 *
 * 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 darks.orm.annotation;

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;

/**
 * Indicates the One to one relation mapping model
 * <p>
 * <h1>OneToOne.java</h1>
 * <p>
 * For example:
 * <p>
 * If you use the "semi-automatic" form, the need to manually write
 * SQL statements
 * 
 * <pre>
 * @OneToOne(resultType = Depart.class, SQL = "select * from t_depart where depart_id = ?")
 * public Depart getUserDepart() {
 *      return userDepart;
 * }
 * </pre>
 * 
 * If you use the "automation" form, only need to specify the target
 * class key attribute
 * 
 * <pre>
 * @OneToOne(resultType = Depart.class, mappedBy = "departId", mappedType = MappedType.EntityType)
 * public Depart getUserDepart() {
 *      return userDepart;
 * }
 * </pre>
 * 
 * @author Liu LiHua
 * @version 1.0.0 v05/01/2012
 * @since JDK1.5
 * @see OneToMany
 * @see ManyToOne
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface OneToOne
{
    
    /**
     * If you use the "automation" form, need to set the mappedBy to
     * the primary key attribute of target class. If not, does not need the
     * assignment.
     */
    String mappedBy() default "";
    
    /**
     * If you use the "semi-automatic" form, need to write SQL query
     * statement. If not, does not need the assignment.
     */
    String SQL() default "";
    
    /**
     * The method returns the class type
     */
    Class<?> resultType();
    
    /**
     * Relation mapping types. "automation" or
     * "semi-automatic"
     * 
     * @see MappedType
     */
    MappedType mappedType() default MappedType.SqlType;
}