com.codeslap.persistence.SqlAdapter Maven / Gradle / Ivy
/*
* Copyright 2013 CodeSlap
*
* 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.codeslap.persistence;
import java.util.List;
public interface SqlAdapter {
/**
* Persist an object in the database
*
* @param object the object to insert into the database
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return an object containing the ID of the inserted object
*/
Object store(T object);
/**
* Persist an object in the database attached to another object
*
* @param bean the object to insert into the database
* @param attachedTo the object that bean is attached to
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @param attached type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return an object containing the ID of the inserted object
*/
Object store(T bean, G attachedTo);
/**
* Persist a collection of objects into the database
*
* @param collection a collection with objects to insert
* @param listener callback to notify progress. Can be null.
*/
void storeCollection(List collection, ProgressListener listener);
/**
* Persist a collection of objects into the database
*
* @param collection a collection with objects to insert
* @param listener callback to notify progress. Can be null.
* @param attachedTo the object that each bean of this collection is attached to
*/
void storeCollection(List collection, G attachedTo, ProgressListener listener);
/**
* Persist a collection of objects into the database. It will delete the objects from the
* database that are not in the collection.
*
* @param collection a collection with objects to insert
* @param listener callback to notify progress. Can be null.
*/
void storeUniqueCollection(List collection, ProgressListener listener);
/**
* Updates one of more records in the database
*
* Note: You must clean the variable where, for instance: entry = 'don't' should be 'dont''t'
*
* @param object the object to insert into the database
* @param where the sample object
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return how many items were updated
*/
int update(T object, T where);
/**
* Updates one of more records in the database
*
* Note: You must clean the variables where and whereArgs, for instance: entry = 'don't' should be 'dont''t'
*
* @param object the object to insert into the database
* @param where a SQL query. It is recommended to use wildcards like: something = ? AND another = ?
* @param whereArgs the list of values used in the wildcards
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return how many items were updated
*/
int update(T object, String where, String[] whereArgs);
/**
* Retrieves an object from the database
*
* Note: You must clean the variable where, for instance: entry = 'don't' should be 'dont''t'
*
* @param where sample object
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return the first found element using the passed sample
*/
T findFirst(T where);
/**
* Retrieves an object from the database
*
* Note: You must clean the variables where and whereArgs, for instance: entry = 'don't' should be 'dont''t'
*
* @param theClass the type of the object to retrieve
* @param where a SQL query. It is recommended to use wildcards like: something = ? AND another = ?
* @param whereArgs the list of values used in the wildcards
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return the first found element using the raw query parameters
*/
T findFirst(Class theClass, String where, String[] whereArgs);
/**
* Retrieves all elements from the database of the specified type
*
* @param theClass the class of the object that we want to retrieve
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return a list of T objects
*/
List findAll(Class theClass);
/**
* Retrieves all elements from the database that matches the specified sample
*
* Note: You must clean the variable where, for instance: entry = 'don't' should be 'dont''t'
*
* @param where sample object
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return a list of T objects
*/
List findAll(T where);
/**
* Retrieves all elements from the database that matches the specified sample. And follows the specified constraint.
*
* Note: You must clean the variable where, for instance: entry = 'don't' should be 'dont''t'
*
* @param where sample object
* @param constraint constrains for this query
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return a list of T objects
*/
List findAll(T where, Constraint constraint);
/**
* Retrieves all elements from the database that are attached to the specified object
*
* Note: You must clean the variable where, for instance: entry = 'don't' should be 'dont''t'
*
* @param where the sample object
* @param attachedTo the object that is attached to the sample object
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return a list of T objects
*/
List findAll(T where, G attachedTo);
/**
* Retrieves all elements from the database that matches the specified sample
*
* Note: You must clean the variables where and whereArgs, for instance: entry = 'don't' should be 'dont''t'
*
* @param theClass the class to find all items
* @param where a SQL query. It is recommended to use wildcards like: something = ? AND another = ?
* @param whereArgs the list of values used in the wildcards
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return a list of T objects
*/
List findAll(Class theClass, String where, String[] whereArgs);
/**
* Deletes one or more elements from the database
*
* Note: You must clean the variable where, for instance: entry = 'don't' should be 'dont''t'
*
* @param where sample object
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return how many items were deleted
*/
int delete(T where);
/**
* Deletes one or more elements from the database
*
*
* Note: You must clean the variable where, for instance: entry = 'don't' should be 'dont''t'
*
* @param where sample object
* @param onCascade true if it must delete relations on cascade
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return how many items were deleted
*/
int delete(T where, boolean onCascade);
/**
* Deletes one or more elements from the database
*
* Note: You must clean the variables where and whereArgs, for instance: entry = 'don't' should be 'dont''t'
*
* @param theClass the type of the object to delete
* @param where a SQL query. It is recommended to use wildcards like: something = ? AND another = ?
* @param whereArgs the list of values used in the wildcards
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return how many items were deleted
*/
int delete(Class theClass, String where, String[] whereArgs);
/**
* Deletes one or more elements from the database
*
* Note: You must clean the variables where and whereArgs, for instance: entry = 'don't' should be 'dont''t'
*
* @param theClass the type of the object to delete
* @param where a SQL query. It is recommended to use wildcards like: something = ? AND another = ?
* @param onCascade true if it must delete relations on cascade
* @param whereArgs the list of values used in the wildcards
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return how many items were deleted
*/
int delete(Class theClass, String where, String[] whereArgs, boolean onCascade);
/**
* Truncates a table. This will also remove the autoincrement counters
*
* @param classes the type of the object to delete
*/
void truncate(Class... classes);
/**
* Counts how many items there are in the database and match the specified condition
*
* Note: You must clean the variables where, for instance: entry = 'don't' should be 'dont''t'
*
* @param where the sample object
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return number of elements in the table of the specified object
*/
int count(T where);
/**
* Counts how many items there are in the database and match the specified condition
*
* Note: You must clean the variables where and whereArgs, for instance: entry = 'don't' should be 'dont''t'
*
* @param theClass the class of the object that we want to count
* @param where a SQL query. It is recommended to use wildcards like: something = ? AND another = ?
* @param whereArgs the list of values used in the wildcards
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return number of elements in the table of the specified object
*/
int count(Class theClass, String where, String[] whereArgs);
/**
* Counts how many items there are in the database
*
* @param theClass the class of the object that we want to count
* @param object type. Must be already registered using {@link DatabaseSpec#match(Class[])}
* @return number of elements in the table of the specified object
*/
int count(Class theClass);
/**
* Callback used when storing a collection to notify the progress.
* Note: when doing a bulk insert, we use the BEGIN TRANSACTION; ...; COMMIT; technique. So, if you are inserting
* 99 records, each record will consume 1% and the COMMIT phase another 1%.
*/
interface ProgressListener {
/**
* Called each time the progress percentage changes
*
* @param percentage the current progress
*/
void onProgressChange(int percentage);
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy