Store.java

/*
 * Copyright 2013 cruxframework.org.
 * 
 * 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 org.cruxframework.crux.core.client.db.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

import org.cruxframework.crux.core.client.db.annotation.DatabaseDef.IndexDef;

/**
 * Maps a class to an object store into the Crux Database.
 * @author Thiago da Rosa de Bustamante
 */
@Target(ElementType.TYPE)
public @interface Store
{
	/**
	 * Define the object store name
	 * @return
	 */
	String value();

	/**
	 * Defines complex indexes for this object store
	 * @author Thiago da Rosa de Bustamante
	 */
	IndexDef[] indexes() default {};

	/**
	 * Identifies a key on the object store
	 * @author Thiago da Rosa de Bustamante
	 *
	 */
	@Target(ElementType.METHOD)
	public @interface Key
	{
		int order() default -1;
		boolean autoIncrement() default false; 
	}

	/**
	 * Defines an index for a column on this object store
	 * @author Thiago da Rosa de Bustamante
	 */
	@Target(ElementType.METHOD)
	public @interface Indexed
	{
		boolean unique() default false;
	}
}