/**
 *Copyright [2010-2011] [dennis zhuang(killme2008@gmail.com)]
 *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 com.google.code.hs4j;

/**
 * A factory to create HandlerSocket commands
 * 
 * @author dennis
 * @date 2010-11-27
 */
public interface CommandFactory {
	/**
	 * Set commands encoding
	 * 
	 * @param encoding
	 */
	public void setEncoding(String encoding);

	/**
	 * Returns protocol type
	 * 
	 * @return
	 */
	Protocol getProtocol();

	/**
	 * Create an open-index command
	 * 
	 * @param id
	 * @param db
	 * @param tableName
	 * @param indexName
	 * @param fieldList
	 * @return
	 */
	public Command createOpenIndexCommand(String id, String db,
			String tableName, String indexName, String[] fieldList, String[] filterFieldList);

	/**
	 * Create an insert command
	 * 
	 * @param id
	 * @param values
	 * @return
	 */
	public Command createInsertCommand(String id, byte[][] values);

	/**
     * Create an insert ignore command
     * 
     * @param id
     * @param values
     * @return
     */
    public Command createInsertIgnoreCommand(String id, byte[][] values);

	/**
	 * create a find command
	 * 
	 * @param id
	 * @param operator
	 * @param keys
	 * @param limit
	 * @param offset
	 * @param fieldList
	 * @return
	 */
	public Command createFindCommand(String id, FindOperator operator,
			String[] keys, int limit, int offset, String[] fieldList, Filter[] filterFieldList);

	/**
	 * Create a update command
	 * 
	 * @param id
	 * @param operator
	 * @param keys
	 * @param values
	 * @param limit
	 * @param offset
	 * @return
	 */
	public Command createUpdateCommand(String id, FindOperator operator,
			String[] keys, byte[][] values, int limit, int offset);

	/**
	 * create delete command
	 * 
	 * @param id
	 * @param operator
	 * @param keys
	 * @param limit
	 * @param offset
	 * @return
	 */
	public Command createDeleteCommand(String id, FindOperator operator,
			String[] keys, int limit, int offset);

	/**
	 * Create a increment command
	 *
	 * @param id
	 * @param operator
	 * @param keys
	 * @param values
	 * @param limit
	 * @param offset
	 * @return
	 */
	public Command createIncrCommand(String id, FindOperator operator,
		String[] keys, byte[][] values, int limit, int offset);


	/**
	 * Create a decrement command
	 *
	 * @param id
	 * @param operator
	 * @param keys
	 * @param values
	 * @param limit
	 * @param offset
	 * @return
	 */
	public Command createDecrCommand(String id, FindOperator operator,
		String[] keys, byte[][] values, int limit, int offset);
}