org.jbei.ice.storage.hibernate.dao

Class AccountDAO

java.lang.Object

org.jbei.ice.storage.hibernate.HibernateRepository<Account>

org.jbei.ice.storage.hibernate.dao.AccountDAO

All Implemented Interfaces:

IRepository<Account>

public class AccountDAO
extends HibernateRepository<Account>

Data accessor object to manipulate Account objects in the database.

Author:

Hector Plahar, Timothy Ham, Zinovii Dmytriv

Constructor Summary

Constructors

Constructor and Description
AccountDAO()

Method Summary

Modifier and Type	Method and Description
Account	get(long id) Retrieve Account by id from the database.
List<Account>	getAccounts(int offset, int limit, String sort, boolean asc, String filter) Retrieves list of pageable accounts, matching the parameter values
long	getAccountsCount(String filter) Retrieves maximum number of distinct accounts available and, if specified, whose firstName, lastName and email fields match the filter token.
Account	getByEmail(String email) Retrieve an Account by the email field.
List<Account>	getMatchingAccounts(String token, int limit) Retrieves accounts whose firstName, lastName, or email fields match the specified token up to the specified limit.

Methods inherited from class org.jbei.ice.storage.hibernate.HibernateRepository

create, currentSession, delete, get, getBuilder, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccountDAO

public AccountDAO()

Method Detail

get

public Account get(long id)
            throws DAOException

Retrieve Account by id from the database.

Parameters:

id - unique local identifier for object

Returns:

Account

Throws:

DAOException

getMatchingAccounts

public List<Account> getMatchingAccounts(String token,
                                         int limit)

Retrieves accounts whose firstName, lastName, or email fields match the specified token up to the specified limit.

Parameters:

token - filter for the account fields

limit - maximum number of matching accounts to return; 0 to return all

Returns:

list of matching accounts

getByEmail

public Account getByEmail(String email)

Retrieve an Account by the email field.

Parameters:

email - unique email identifier for account

Returns:

Account record referenced by email

getAccounts

public List<Account> getAccounts(int offset,
                                 int limit,
                                 String sort,
                                 boolean asc,
                                 String filter)

Retrieves list of pageable accounts, matching the parameter values

Parameters:

offset - offset to start retrieving matching accounts

limit - maximum number of accounts to retrieve

sort - sort order for retrieval

asc - whether to sort in ascending or descending order

filter - optional filter to for matching text against firstName, lastName or email fields of accounts

Returns:

list of matching accounts

Throws:

DAOException - on HibernateException retrieving accounts

getAccountsCount

public long getAccountsCount(String filter)

Retrieves maximum number of distinct accounts available and, if specified, whose firstName, lastName and email fields match the filter token. This is intended to be used for paging.

Parameters:

filter - optional token used to match against the firstName, lastName and email fields of accounts

Returns:

number of accounts that match the optional filter.

Throws:

DAOException - on HibernateException retrieving the number