org.canedata.entity.EntityFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cane-api Show documentation

Cane is based on the coding behaviour analysis of data manipulation interface to allow coders are close to their habit of thinking of ways to manipulate the data. API definition for Cane.

The newest version!

/**
 * Copyright 2010 CaneData.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.canedata.entity;

import org.canedata.CaneProvider;
import org.canedata.cache.CacheProvider;
import org.canedata.resource.Resource;

/**
 * Usage:
 *
 *  * 		CaneProvider provider = ...
 * 		ResourceProvider rp = ...
 * 		EntityFactory factory = provider.getFactory("name", rp);
 * 
 * 		Entity e = factory.get("entity name");
 * 		...
 * 
 *
 * @author Yat-ton
 * @version 1.00.000 Sep 2, 2010 5:46:45 PM
 */
public interface EntityFactory {
	public String getName();

	/**
	 * Get the entity from factory, by specifying the name of entity.
	 * 
	 * 
	 * The name can be name or name with schema. 
	 * 
	 * 
	 * Directly use name: 
	 * 
	 * 	 * get("name");
	 * 
	 * 
	 * Name with schema: 
	 * 
	 * 	 * get("schema.name");
	 * 
	 *
	 * 
	 * Can use the following two ways to assign a short alias to entity, easy to
	 * join multiple entities.
	 * 
	 * 
	 * Name+space+alias: 
	 * 
	 * 	 * get("tableName a1");
	 * 
	 * 
	 * Name+AS/as+alias: 
	 * 
	 * 	 * get("tableName as a1");
	 * 
	 * 
	 *
	 * @param name
	 *            Entity name.
	 * @return
	 */
	public Entity get(String name);

	/**
	 * @see #get(String)
	 * 
	 * @param schema
	 * @param name
	 * @return
	 */
	public Entity get(String schema, String name);

	/**
	 * @see #get(String)
	 * 
	 * @param res
	 * @param name
	 * @return
	 */
	public Entity get(Resource res, String name);

	/**
	 * @see #get(String, String)
	 * 
	 * @param res
	 * @param schema
	 * @param name
	 * @return
	 */
	public Entity get(Resource res, String schema, String name);

	public CacheProvider getCacheProvider();

	public CaneProvider getProvider();
}