org.sakaiproject.citation.impl

Class BaseSearchManager

java.lang.Object

org.sakaiproject.citation.impl.BaseSearchManager

All Implemented Interfaces:

Observer, org.sakaiproject.citation.api.SearchManager

public class BaseSearchManager
extends Object
implements org.sakaiproject.citation.api.SearchManager, Observer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BaseSearchManager.BasicObjectIterator
class	BaseSearchManager.BasicSearch
class	BaseSearchManager.BasicSearchDatabaseHierarchy
class	BaseSearchManager.BasicSearchProperties
class	BaseSearchManager.BasicType

Field Summary

Fields

Modifier and Type	Field and Description
protected static BaseSearchManager.BasicType	categoryAssetType
protected static BaseSearchManager.BasicType	databaseAssetType
protected String	databaseHierarchyResourceRef
protected Map<String,String>	hierarchyMap
protected org.sakaiproject.citation.api.ConfigurationService	m_configService
protected org.sakaiproject.tool.api.SessionManager	m_sessionManager
protected static int	MAX_DUPLICATES Maximum number of consecutive duplicate result records we'll accept before disabling the duplicate record check for the current search.
protected static BaseSearchManager.BasicType	repositoryType
static String	SAKAI_HOST
static String	SAKAI_KEY
static String	SAKAI_SESSION
protected static BaseSearchManager.BasicType	searchType
protected org.sakaiproject.component.api.ServerConfigurationService	serverConfigurationService Dependency: ServerConfigurationService.
static String	SERVLET_NAME
protected SortedSet<String>	updatableResources
static String	WINDOW_PREFIX

Fields inherited from interface org.sakaiproject.citation.api.SearchManager

ASSET_NOT_FETCHED, DEFAULT_PAGE_SIZE, DEFAULT_SORT_BY, DEFAULT_START_RECORD, METASEARCH_ERROR, MIN_START_RECORD, SESSION_TIMED_OUT

Constructor Summary

Constructors

Constructor and Description
BaseSearchManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
org.sakaiproject.citation.api.ActiveSearch	doNextPage(org.sakaiproject.citation.api.ActiveSearch search)
org.sakaiproject.citation.api.ActiveSearch	doPrevPage(org.sakaiproject.citation.api.ActiveSearch search)
org.sakaiproject.citation.api.ActiveSearch	doSearch(org.sakaiproject.citation.api.ActiveSearch search)
protected org.sakaiproject.authz.api.SecurityAdvisor	enableSecurityAdvisor() Establish a security advisor to allow the "embedded" azg work to occur with no need for additional security permissions.
protected org.osid.shared.Type	getCategoryType(org.osid.repository.Repository repository)
String	getExternalSearchWindowName(String resourceId)
String	getGoogleScholarUrl(String resourceId)
org.sakaiproject.memory.api.MemoryService	getMemoryService()
protected org.osid.shared.Type	getPropertyType(org.osid.repository.Repository repository)
String	getResourceContent(org.sakaiproject.content.api.ContentResource resource) Fetch the content from a Resource
String	getResourceContent(String resourceReference) Fetch content from a resource reference (a named resource)
String	getSaveciteUrl(String resourceId, String saveciteClientId) Supply the url for the savecite servlet to add a citation to a particular citation list.
org.sakaiproject.citation.api.SearchDatabaseHierarchy	getSearchHierarchy()
protected String	getSearchStatusMessage(org.osid.repository.Repository repository)
protected org.osid.shared.Type	getSearchType(org.osid.repository.Repository repository)
org.sakaiproject.component.api.ServerConfigurationService	getServerConfigurationService()
void	init()
org.sakaiproject.citation.api.ActiveSearch	newSearch()
org.sakaiproject.citation.api.ActiveSearch	newSearch(org.sakaiproject.citation.api.CitationCollection savedResults)
protected String	newSearchId()
protected boolean	paramIsEmpty(String param)
void	setConfigurationService(org.sakaiproject.citation.api.ConfigurationService configService)
void	setMemoryService(org.sakaiproject.memory.api.MemoryService memoryService)
void	setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)
void	setSessionManager(org.sakaiproject.tool.api.SessionManager sessionManager)
protected void	setupTypes()
void	update(Observable arg0, Object arg1)
void	updateHierarchy(String databaseXmlReference)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_DUPLICATES

protected static int MAX_DUPLICATES

Maximum number of consecutive duplicate result records we'll accept before disabling the duplicate record check for the current search. The idea is to avoid displaying occasional duplicates, but don't discard forever in the pathological case where we're only getting duplicate results.

SAKAI_SESSION

public static final String SAKAI_SESSION

See Also:

Constant Field Values

SAKAI_KEY

public static final String SAKAI_KEY

See Also:

Constant Field Values

SAKAI_HOST

public static final String SAKAI_HOST

See Also:

Constant Field Values

SERVLET_NAME

public static final String SERVLET_NAME

See Also:

Constant Field Values

WINDOW_PREFIX

public static final String WINDOW_PREFIX

See Also:

Constant Field Values

categoryAssetType

protected static BaseSearchManager.BasicType categoryAssetType

databaseAssetType

protected static BaseSearchManager.BasicType databaseAssetType

searchType

protected static BaseSearchManager.BasicType searchType

repositoryType

protected static BaseSearchManager.BasicType repositoryType

hierarchyMap

protected Map<String,String> hierarchyMap

updatableResources

protected SortedSet<String> updatableResources

m_sessionManager

protected org.sakaiproject.tool.api.SessionManager m_sessionManager

m_configService

protected org.sakaiproject.citation.api.ConfigurationService m_configService

serverConfigurationService

protected org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService

Dependency: ServerConfigurationService.

databaseHierarchyResourceRef

protected String databaseHierarchyResourceRef

Constructor Detail

BaseSearchManager

public BaseSearchManager()

Method Detail

setSessionManager

public void setSessionManager(org.sakaiproject.tool.api.SessionManager sessionManager)

setConfigurationService

public void setConfigurationService(org.sakaiproject.citation.api.ConfigurationService configService)

destroy

public void destroy()

doNextPage

public org.sakaiproject.citation.api.ActiveSearch doNextPage(org.sakaiproject.citation.api.ActiveSearch search)
                                                      throws org.sakaiproject.citation.util.api.SearchException

Specified by:

doNextPage in interface org.sakaiproject.citation.api.SearchManager

Throws:

org.sakaiproject.citation.util.api.SearchException

doPrevPage

public org.sakaiproject.citation.api.ActiveSearch doPrevPage(org.sakaiproject.citation.api.ActiveSearch search)
                                                      throws org.sakaiproject.citation.util.api.SearchException

Specified by:

doPrevPage in interface org.sakaiproject.citation.api.SearchManager

Throws:

org.sakaiproject.citation.util.api.SearchException

doSearch

public org.sakaiproject.citation.api.ActiveSearch doSearch(org.sakaiproject.citation.api.ActiveSearch search)
                                                    throws org.sakaiproject.citation.util.api.SearchException,
                                                           org.sakaiproject.citation.util.api.SearchCancelException

Specified by:

doSearch in interface org.sakaiproject.citation.api.SearchManager

Throws:

org.sakaiproject.citation.util.api.SearchException

org.sakaiproject.citation.util.api.SearchCancelException

newSearchId

protected String newSearchId()

getPropertyType

protected org.osid.shared.Type getPropertyType(org.osid.repository.Repository repository)
                                        throws org.sakaiproject.citation.util.api.SearchException

Throws:

org.sakaiproject.citation.util.api.SearchException

getCategoryType

protected org.osid.shared.Type getCategoryType(org.osid.repository.Repository repository)
                                        throws org.sakaiproject.citation.util.api.SearchException

Throws:

org.sakaiproject.citation.util.api.SearchException

getSearchType

protected org.osid.shared.Type getSearchType(org.osid.repository.Repository repository)
                                      throws org.sakaiproject.citation.util.api.SearchException

Throws:

org.sakaiproject.citation.util.api.SearchException

getSearchStatusMessage

protected String getSearchStatusMessage(org.osid.repository.Repository repository)
                                 throws org.sakaiproject.citation.util.api.SearchException

Throws:

org.sakaiproject.citation.util.api.SearchException

init

public void init()

setupTypes

protected void setupTypes()

getSearchHierarchy

public org.sakaiproject.citation.api.SearchDatabaseHierarchy getSearchHierarchy()
                                                                         throws org.sakaiproject.citation.util.api.SearchException

Specified by:

getSearchHierarchy in interface org.sakaiproject.citation.api.SearchManager

Throws:

org.sakaiproject.citation.util.api.SearchException

updateHierarchy

public void updateHierarchy(String databaseXmlReference)

newSearch

public org.sakaiproject.citation.api.ActiveSearch newSearch()

Specified by:

newSearch in interface org.sakaiproject.citation.api.SearchManager

newSearch

public org.sakaiproject.citation.api.ActiveSearch newSearch(org.sakaiproject.citation.api.CitationCollection savedResults)

Specified by:

newSearch in interface org.sakaiproject.citation.api.SearchManager

paramIsEmpty

protected boolean paramIsEmpty(String param)

getGoogleScholarUrl

public String getGoogleScholarUrl(String resourceId)

Specified by:

getGoogleScholarUrl in interface org.sakaiproject.citation.api.SearchManager

getSaveciteUrl

public String getSaveciteUrl(String resourceId,
                    String saveciteClientId)

Supply the url for the savecite servlet to add a citation to a particular citation list.

Specified by:

getSaveciteUrl in interface org.sakaiproject.citation.api.SearchManager

Parameters:

resourceId - The identifier for the citation list.

getExternalSearchWindowName

public String getExternalSearchWindowName(String resourceId)

Specified by:

getExternalSearchWindowName in interface org.sakaiproject.citation.api.SearchManager

getServerConfigurationService

public org.sakaiproject.component.api.ServerConfigurationService getServerConfigurationService()

Returns:

the serverConfigurationService

setServerConfigurationService

public void setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)

Parameters:

serverConfigurationService - the serverConfigurationService to set

update

public void update(Observable arg0,
          Object arg1)

Specified by:

update in interface Observer

enableSecurityAdvisor

protected org.sakaiproject.authz.api.SecurityAdvisor enableSecurityAdvisor()

Establish a security advisor to allow the "embedded" azg work to occur with no need for additional security permissions.

getResourceContent

public String getResourceContent(org.sakaiproject.content.api.ContentResource resource)
                          throws IOException,
                                 org.sakaiproject.exception.ServerOverloadException

Fetch the content from a Resource

Parameters:

resource - Content hosting resource

Throws:

IOException

org.sakaiproject.exception.ServerOverloadException

getResourceContent

public String getResourceContent(String resourceReference)
                          throws IOException,
                                 org.sakaiproject.exception.IdUnusedException,
                                 org.sakaiproject.exception.PermissionException,
                                 org.sakaiproject.exception.ServerOverloadException,
                                 org.sakaiproject.exception.TypeException

Fetch content from a resource reference (a named resource)

Parameters:

resourceReference - Resource reference

Returns:

Resource content (null if none)

Throws:

IOException

org.sakaiproject.exception.IdUnusedException

org.sakaiproject.exception.PermissionException

org.sakaiproject.exception.ServerOverloadException

org.sakaiproject.exception.TypeException

getMemoryService

public org.sakaiproject.memory.api.MemoryService getMemoryService()

Returns:

the memoryService

setMemoryService

public void setMemoryService(org.sakaiproject.memory.api.MemoryService memoryService)

Parameters:

memoryService - the memoryService to set