com.webmethods.caf.faces.search.saved

Class DboSavedSearchProvider

java.lang.Object

com.webmethods.caf.faces.search.saved.DboSavedSearchProvider

All Implemented Interfaces:

ISavedSearchProvider, Serializable

public class DboSavedSearchProvider
extends Object
implements ISavedSearchProvider, Serializable

Saved Search Provider based on DBO instances published into one of several folders. Separate folders are maintained for each user as well as a global common folder

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FOLDER_SAVE_ROOT_ALIAS
protected static String	FOLDER_SAVE_ROOT_NAME
protected static String	FOLDER_SYSTEM_ALIAS
protected Map<String,String>	fSavedSearchCaseInsensitiveNames
protected static String	GLOBAL_SEARCH_FOLDER_NAME
protected IThingID	m_rootSavedSearchFolder
protected String	m_rootSearchFolderName
protected Map<String,ISavedSearch>	m_savedSearchesMap
protected ISearchQueryFactory	m_searchQueryFactory
protected static String	SAVED_SEARCH_DBO_XTYPE
protected static String	SEARCH_TERMS_PROPERTY

Constructor Summary

Constructors

Constructor and Description
DboSavedSearchProvider(ISearchQueryFactory searchQueryFactory, IThingID rootFolder)
DboSavedSearchProvider(ISearchQueryFactory searchQueryFactory, String rootSearchFolderName)

Method Summary

Modifier and Type	Method and Description
IThingID	addOrUpdateSearch(IURI principalURI, ISavedSearch savedSearch) Add or update a saved search storage DBO with the supplied search criteria returns IThingID of updated object
boolean	canUserSavePublic()
protected ISavedSearch	convertDboToSavedSearch(IThingID dboThingID, boolean globalSearch)
protected Map<String,Object>	convertSavedSearchToPropertiesMap(ISavedSearch savedSearch)
protected IThingID	createFolder(IThingID parentFolder, String folderName, IThingID folderOwner)
protected IThingID	createRootFolder()
ISavedSearch	createSavedSearch() Creates and returns a new SavedSearch object for the SearchBar control.
IThingID	createSearch(IURI principalURI, ISavedSearch savedSearch)
void	deleteSavedSearch(String savedSearchID) Deletes a saved search
void	deleteSavedSearch(String savedSearchID, IURI principalURI)
protected void	deleteSearch(IURI principalURI, String searchID)
protected IThingID	getAdminThingID()
protected static IContainerPolicy	getContainerBizPolicy(IThingID containerID)
protected static IContainerMechanics	getContainerMech(IThingID containerID)
protected static IURI	getCurrentPrincipalURI()
IThingID	getCurrentUserSavedSearchByID(String searchID)
IThingID	getGlobalSearchContainer()
protected IThingID	getOrCreateFolder(IThingID parentFolder, String folderName, IThingID folderOwner)
IThingID	getRootSavedSearchFolder()
ISavedSearch	getSavedSearch(String savedSearchID) Gets a saved search
ISavedSearch	getSavedSearch(String savedSearchID, IURI principalURI)
IThingID	getSavedSearchByID(IURI principalURI, String searchName)
ISavedSearch[]	getSavedSearches() Get array of all the saved searches
ISavedSearch[]	getSavedSearches(IURI principalURI)
protected Map<String,ISavedSearch>	getSavedSearchesMap()
protected Map<String,ISavedSearch>	getSavedSearchesMap(IURI principalURI)
static IThing	getSavedSearchFromURI(IURI searchURI)
IThingIDList	getSavedSearchThings(IURI principalURI)
IThingID	getSearchContainer(IURI principalURI)
boolean	getSupportsPublicSavedSearch() Returns whether is saved search provider supports public saved searches
IThingID	getUserSearchContainer(IURI principalURI)
boolean	hasSavedSearches() Returns whether the saved search provider has any saved searches
void	saveSearch(ISavedSearch savedSearch) Save a search
void	saveSearch(ISavedSearch savedSearch, IURI principalURI)
boolean	searchExists(IURI principalURI, String searchName)
void	setRootSavedSearchFolder(IThingID savedSearchFolder)
void	setSearchQueryFactory(ISearchQueryFactory factory) Sets the factory that should be used to create search query objects
void	updateSavedSearch(String savedSearchID, ISavedSearch savedSearch) Updates a saved search
void	updateSavedSearch(String savedSearchID, ISavedSearch savedSearch, IURI principalURI)

Methods inherited from class java.lang.Object

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

Field Detail

FOLDER_SYSTEM_ALIAS

protected static final String FOLDER_SYSTEM_ALIAS

See Also:

Constant Field Values

FOLDER_SAVE_ROOT_ALIAS

protected static final String FOLDER_SAVE_ROOT_ALIAS

See Also:

Constant Field Values

FOLDER_SAVE_ROOT_NAME

protected static final String FOLDER_SAVE_ROOT_NAME

See Also:

Constant Field Values

m_searchQueryFactory

protected ISearchQueryFactory m_searchQueryFactory

m_savedSearchesMap

protected Map<String,ISavedSearch> m_savedSearchesMap

fSavedSearchCaseInsensitiveNames

protected Map<String,String> fSavedSearchCaseInsensitiveNames

m_rootSavedSearchFolder

protected IThingID m_rootSavedSearchFolder

m_rootSearchFolderName

protected String m_rootSearchFolderName

SAVED_SEARCH_DBO_XTYPE

protected static final String SAVED_SEARCH_DBO_XTYPE

See Also:

Constant Field Values

GLOBAL_SEARCH_FOLDER_NAME

protected static final String GLOBAL_SEARCH_FOLDER_NAME

See Also:

Constant Field Values

SEARCH_TERMS_PROPERTY

protected static final String SEARCH_TERMS_PROPERTY

See Also:

Constant Field Values

Constructor Detail

DboSavedSearchProvider

public DboSavedSearchProvider(ISearchQueryFactory searchQueryFactory,
                              IThingID rootFolder)

DboSavedSearchProvider

public DboSavedSearchProvider(ISearchQueryFactory searchQueryFactory,
                              String rootSearchFolderName)

Method Detail

setSearchQueryFactory

public void setSearchQueryFactory(ISearchQueryFactory factory)

Description copied from interface: ISavedSearchProvider

Sets the factory that should be used to create search query objects

Specified by:

setSearchQueryFactory in interface ISavedSearchProvider

Parameters:

factory - the factory to use to create search query objects

createSavedSearch

public ISavedSearch createSavedSearch()

Creates and returns a new SavedSearch object for the SearchBar control. Sub-classes may override to provide an alternate ISavedSearch implementation.

Specified by:

createSavedSearch in interface ISavedSearchProvider

Returns:

Returns a new ISavedSearch object

hasSavedSearches

public boolean hasSavedSearches()

Description copied from interface: ISavedSearchProvider

Returns whether the saved search provider has any saved searches

Specified by:

hasSavedSearches in interface ISavedSearchProvider

Returns:

true if saved searches are available, false otherwise

deleteSavedSearch

public void deleteSavedSearch(String savedSearchID)

Description copied from interface: ISavedSearchProvider

Deletes a saved search

Specified by:

deleteSavedSearch in interface ISavedSearchProvider

Parameters:

savedSearchID - the id of the saved search to delete

deleteSavedSearch

public void deleteSavedSearch(String savedSearchID,
                              IURI principalURI)

getSavedSearch

public ISavedSearch getSavedSearch(String savedSearchID)

Description copied from interface: ISavedSearchProvider

Gets a saved search

Specified by:

getSavedSearch in interface ISavedSearchProvider

Parameters:

savedSearchID - the id of the saved search to get

Returns:

the saved search or null if it is not found

getSavedSearch

public ISavedSearch getSavedSearch(String savedSearchID,
                                   IURI principalURI)

getSavedSearches

public ISavedSearch[] getSavedSearches()

Description copied from interface: ISavedSearchProvider

Get array of all the saved searches

Specified by:

getSavedSearches in interface ISavedSearchProvider

Returns:

array of all saved searches

getSavedSearches

public ISavedSearch[] getSavedSearches(IURI principalURI)

saveSearch

public void saveSearch(ISavedSearch savedSearch)

Description copied from interface: ISavedSearchProvider

Save a search

Specified by:

saveSearch in interface ISavedSearchProvider

Parameters:

savedSearch - the saved search to save

saveSearch

public void saveSearch(ISavedSearch savedSearch,
                       IURI principalURI)

updateSavedSearch

public void updateSavedSearch(String savedSearchID,
                              ISavedSearch savedSearch)

Description copied from interface: ISavedSearchProvider

Updates a saved search

Specified by:

updateSavedSearch in interface ISavedSearchProvider

Parameters:

savedSearchID - the id of the saved search to update

savedSearch - the saved search to save

updateSavedSearch

public void updateSavedSearch(String savedSearchID,
                              ISavedSearch savedSearch,
                              IURI principalURI)

getSupportsPublicSavedSearch

public boolean getSupportsPublicSavedSearch()

Description copied from interface: ISavedSearchProvider

Returns whether is saved search provider supports public saved searches

Specified by:

getSupportsPublicSavedSearch in interface ISavedSearchProvider

Returns:

true if public saved searches are supported, false otherwise

getSavedSearchesMap

protected Map<String,ISavedSearch> getSavedSearchesMap()

getSavedSearchesMap

protected Map<String,ISavedSearch> getSavedSearchesMap(IURI principalURI)

getCurrentPrincipalURI

protected static IURI getCurrentPrincipalURI()
                                      throws PortalException

Throws:

PortalException

getSearchContainer

public IThingID getSearchContainer(IURI principalURI)
                            throws PortalException

Throws:

PortalException

getGlobalSearchContainer

public IThingID getGlobalSearchContainer()
                                  throws PortalException

Throws:

PortalException

getUserSearchContainer

public IThingID getUserSearchContainer(IURI principalURI)
                                throws PortalException

Throws:

PortalException

getSavedSearchThings

public IThingIDList getSavedSearchThings(IURI principalURI)
                                  throws PortalException

Throws:

PortalException

getContainerMech

protected static IContainerMechanics getContainerMech(IThingID containerID)
                                               throws PortalException

Throws:

PortalException

getContainerBizPolicy

protected static IContainerPolicy getContainerBizPolicy(IThingID containerID)
                                                 throws PortalException

Throws:

PortalException

getSavedSearchFromURI

public static IThing getSavedSearchFromURI(IURI searchURI)
                                    throws PortalException

Throws:

PortalException

addOrUpdateSearch

public IThingID addOrUpdateSearch(IURI principalURI,
                                  ISavedSearch savedSearch)
                           throws PortalException

Add or update a saved search storage DBO with the supplied search criteria returns IThingID of updated object

Throws:

PortalException

createSearch

public IThingID createSearch(IURI principalURI,
                             ISavedSearch savedSearch)
                      throws PortalException

Throws:

PortalException

getCurrentUserSavedSearchByID

public IThingID getCurrentUserSavedSearchByID(String searchID)
                                       throws PortalException

Throws:

PortalException

getSavedSearchByID

public IThingID getSavedSearchByID(IURI principalURI,
                                   String searchName)
                            throws PortalException

Throws:

PortalException

searchExists

public boolean searchExists(IURI principalURI,
                            String searchName)
                     throws PortalException

Throws:

PortalException

deleteSearch

protected void deleteSearch(IURI principalURI,
                            String searchID)
                     throws PortalException

Throws:

PortalException

convertDboToSavedSearch

protected ISavedSearch convertDboToSavedSearch(IThingID dboThingID,
                                               boolean globalSearch)
                                        throws PortalException

Throws:

PortalException

convertSavedSearchToPropertiesMap

protected Map<String,Object> convertSavedSearchToPropertiesMap(ISavedSearch savedSearch)

getAdminThingID

protected IThingID getAdminThingID()

getOrCreateFolder

protected IThingID getOrCreateFolder(IThingID parentFolder,
                                     String folderName,
                                     IThingID folderOwner)
                              throws PortalException

Throws:

PortalException

createFolder

protected IThingID createFolder(IThingID parentFolder,
                                String folderName,
                                IThingID folderOwner)
                         throws PortalException

Throws:

PortalException

createRootFolder

protected IThingID createRootFolder()
                             throws PortalException

Throws:

PortalException

getRootSavedSearchFolder

public IThingID getRootSavedSearchFolder()
                                  throws PortalException

Throws:

PortalException

setRootSavedSearchFolder

public void setRootSavedSearchFolder(IThingID savedSearchFolder)

canUserSavePublic

public boolean canUserSavePublic()