org.jbei.ice.storage.hibernate.dao

Class FolderDAO

java.lang.Object

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

org.jbei.ice.storage.hibernate.dao.FolderDAO

All Implemented Interfaces:

IRepository<Folder>

public class FolderDAO
extends HibernateRepository<Folder>

Manipulate Folder objects in the database.

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
FolderDAO()

Method Summary

Modifier and Type	Method and Description
Folder	addFolderContents(Folder folder, List<Entry> entrys)
List<Folder>	filterByName(String token, int limit)
Folder	get(long id) Retrieves stored folder by locally unique identifier
List<Folder>	getCanEditFolders(Account account, Set<Group> accountGroups) Retrieves folders that the specified account owns, or has write privileges on based on the permissions
List<Long>	getEntryIds(Folder folder) Retrieve the list of ids of entries contained in a folder.
List<Long>	getFolderContentIds(long folderId, EntryType type, boolean visibleOnly) Retrieves the ids of any entries that are contained in the specified folder; optionally filtered by entry type
List<Folder>	getFoldersByOwner(Account account) Retrieve all Folders owned by given the Account.
List<Folder>	getFoldersByType(FolderType type)
Long	getFolderSize(long id, String filter, boolean visibleOnly) Retrieves the count of the number of contents in the folder.
Folder	removeFolderEntries(Folder folder, List<Long> entries) Removes, from the list of entries in the specified folder, those whose ids match the ids passed in the parameter
List<Entry>	retrieveFolderContents(long folderId, PageParameters pageParameters, boolean visibleOnly) Retrieves list of entries that conforms to the parameters

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

FolderDAO

public FolderDAO()

Method Detail

get

public Folder get(long id)

Retrieves stored folder by locally unique identifier

Parameters:

id - locally unique identifier for folder

Returns:

retrieved folder

Throws:

DAOException

removeFolderEntries

public Folder removeFolderEntries(Folder folder,
                                  List<Long> entries)

Removes, from the list of entries in the specified folder, those whose ids match the ids passed in the parameter

Parameters:

folder - folder to remove entries from

entries - unique identifiers for list of entries to remove from the folder

Returns:

folder whose entries where removed

getFolderSize

public Long getFolderSize(long id,
                          String filter,
                          boolean visibleOnly)

Retrieves the count of the number of contents in the folder. Currently, it is assumed that the contents of folders are only entries. The entries that are counted are those that have a visibility of "OK"

Parameters:

id - unique folder identifier

filter - optional filter for entry fields

visibleOnly - if true, counts only entries with visibility "OK"

Returns:

number of child contents in the folder

getFolderContentIds

public List<Long> getFolderContentIds(long folderId,
                                      EntryType type,
                                      boolean visibleOnly)

Retrieves the ids of any entries that are contained in the specified folder; optionally filtered by entry type

Parameters:

folderId - unique folder identifier

type - optional filter for entries. If null, all entries will be retrieved

Returns:

List of entry ids found in the folder with the filter applied if applicable and which have a visibility of "OK"

retrieveFolderContents

public List<Entry> retrieveFolderContents(long folderId,
                                          PageParameters pageParameters,
                                          boolean visibleOnly)

Retrieves list of entries that conforms to the parameters

Parameters:

folderId - unique identifier for folder whose entries are being retrieved

pageParameters - paging params

visibleOnly - whether to only include entries with "OK" visibility

Returns:

list of found entries

Throws:

DAOException - on Exception retrieving

addFolderContents

public Folder addFolderContents(Folder folder,
                                List<Entry> entrys)

getFoldersByOwner

public List<Folder> getFoldersByOwner(Account account)

Retrieve all Folders owned by given the Account.

Parameters:

account - owner account

Returns:

List of Folder objects.

Throws:

DAOException

getFoldersByType

public List<Folder> getFoldersByType(FolderType type)

getCanEditFolders

public List<Folder> getCanEditFolders(Account account,
                                      Set<Group> accountGroups)

Retrieves folders that the specified account owns, or has write privileges on based on the permissions

Parameters:

account - account that is expected to have write privileges on the folders that are returned

accountGroups - groups that account belongs to that is expected to have write privileges

Returns:

list of folders that the account or groups that the account belongs to has write privileges on

Throws:

DAOException

filterByName

public List<Folder> filterByName(String token,
                                 int limit)

getEntryIds

public List<Long> getEntryIds(Folder folder)

Retrieve the list of ids of entries contained in a folder. Using this method is much faster (especially for larger number of entries in a folder) that iterating through all the entries of a folder

Parameters:

folder - folder whose entries are being retrieved

Returns:

list of ids of entries in a folder