com.googlecode.genericdao.dao.hibernate.GeneralDAO Maven / Gradle / Ivy
/* Copyright 2013 David Wolverton
*
* 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.googlecode.genericdao.dao.hibernate;
import java.io.Serializable;
import java.util.List;
import com.googlecode.genericdao.search.ExampleOptions;
import com.googlecode.genericdao.search.Filter;
import com.googlecode.genericdao.search.ISearch;
import com.googlecode.genericdao.search.SearchResult;
/**
* Interface for general Data Access Object that can be used for any type domain
* object. A single instance implementing this interface can be used for
* multiple types of domain objects.
*
* @author dwolverton
*/
public interface GeneralDAO {
/**
*
* Get the entity with the specified type and id from the datastore.
*
*
* If none is found, return null.
*/
public T find(Class type, Serializable id);
/**
* Get all entities of the specified type from the datastore that have one
* of these ids. An array of entities is returned that matches the same
* order of the ids listed in the call. For each entity that is not found in
* the datastore, a null will be inserted in its place in the return array.
*/
public T[] find(Class type, Serializable... ids);
/**
*
* Get a reference to the entity with the specified type and id from the
* datastore.
*
*
* This does not require a call to the datastore and does not populate any
* of the entity's values. Values may be fetched lazily at a later time.
* This increases performance if a another entity is being saved that should
* reference this entity but the values of this entity are not needed.
*
* @throws a
* HibernateException if no matching entity is found
*/
public T getReference(Class type, Serializable id);
/**
*
* Get a reference to the entities of the specified type with the given ids
* from the datastore. An array of entities is returned that matches the
* same order of the ids listed in the call.
*
*
* This does not require a call to the datastore and does not populate any
* of the entities' values. Values may be fetched lazily at a later time.
* This increases performance if a another entity is being saved that should
* reference these entities but the values of these entities are not needed.
*
* @throws a
* HibernateException if any of the matching entities are not
* found.
*/
public T[] getReferences(Class type, Serializable... ids);
/**
*
* If the id of the entity is null or zero, add it to the datastore and
* assign it an id; otherwise, update the corresponding entity in the
* datastore with the properties of this entity. In either case the entity
* passed to this method will be attached to the session.
*
*
* If an entity to update is already attached to the session, this method
* will have no effect. If an entity to update has the same id as another
* instance already attached to the session, an error will be thrown.
*
* @return true if create; false if update.
*/
public boolean save(Object entity);
/**
*
* For each entity, if the id of the entity is null or zero, add it to the
* datastore and assign it an id; otherwise, update the corresponding entity
* in the datastore with the properties of this entity. In either case the
* entity passed to this method will be attached to the session.
*
*
* If an entity to update is already attached to the session, this method
* will have no effect. If an entity to update has the same id as another
* instance already attached to the session, an error will be thrown.
*/
public boolean[] save(Object... entities);
/**
* Remove the specified entity from the datastore.
*
* @return true if the entity is found in the datastore and
* removed, false if it is not found.
*/
public boolean remove(Object entity);
/**
* Remove all of the specified entities from the datastore.
*/
public void remove(Object... entities);
/**
* Remove the entity with the specified type and id from the datastore.
*
* @return true if the entity is found in the datastore and
* removed, false if it is not found.
*/
public boolean removeById(Class type, Serializable id);
/**
* Remove all the entities of the given type from the datastore that have
* one of these ids.
*/
public void removeByIds(Class type, Serializable... ids);
/**
* Get a list of all the objects of the specified type.
*/
public List findAll(Class type);
/**
* Search for objects given the search parameters in the specified
* ISearch object.
*/
@SuppressWarnings("unchecked")
public List search(ISearch search);
/**
* Search for a single result using the given parameters.
*/
public Object searchUnique(ISearch search);
/**
* Returns the total number of results that would be returned using the
* given ISearch if there were no paging or maxResults limits.
*/
public int count(ISearch search);
/**
* Returns a SearchResult object that includes both the list of
* results like search() and the total length like
* count().
*/
@SuppressWarnings("unchecked")
public SearchResult searchAndCount(ISearch search);
/**
* Returns true if the object is connected to the current
* Hibernate session.
*/
public boolean isAttached(Object entity);
/**
* Refresh the content of the given entity from the current datastore state.
*/
public void refresh(Object... entities);
/**
* Flushes changes in the Hibernate session to the datastore.
*/
public void flush();
/**
* Generates a search filter from the given example using default options.
*/
public Filter getFilterFromExample(Object example);
/**
* Generates a search filter from the given example using the specified options.
*/
public Filter getFilterFromExample(Object example, ExampleOptions options);
}