org.sakaiproject.component.app.help

Class HelpManagerImpl

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

org.sakaiproject.component.app.help.HelpManagerImpl

All Implemented Interfaces:

org.sakaiproject.api.app.help.HelpManager, org.springframework.beans.factory.InitializingBean

public class HelpManagerImpl
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements org.sakaiproject.api.app.help.HelpManager

HelpManager provides database and search capabilitites for the Sakai help tool.

Version:

$Id: HelpManagerImpl.java 311262 2014-07-29 20:38:43Z ottenhoff@longsight.com $

Author:

Jarrod Lannan

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface org.sakaiproject.api.app.help.HelpManager

HELP_DOC_REGEXP, TOOLCONFIG_HELP_COLLECTIONS

Constructor Summary

Constructors

Constructor and Description
HelpManagerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addContexts(Map session, String mappedView)
org.sakaiproject.api.app.help.Category	createCategory()
org.sakaiproject.api.app.help.Resource	createResource()
void	deleteContext(Long contextId)
void	deleteResource(Long resourceId)
void	deleteSource(Long sourceId)
List	getActiveContexts(Map session)
org.sakaiproject.api.app.help.Category	getCategoryByName(String name) Find a Category by name
org.sakaiproject.api.app.help.Context	getContext(Long id)
List	getContexts(String mappedView)
int	getContextSize() Get ContextSize.
protected org.apache.lucene.document.Document	getDocument(org.sakaiproject.component.app.help.model.ResourceBean resource) Get Document.
String	getExternalLocation()
org.sakaiproject.api.app.help.Glossary	getGlossary()
org.sakaiproject.api.app.help.Resource	getResource(Long id)
org.sakaiproject.api.app.help.Resource	getResourceByDocId(String docId)
protected org.sakaiproject.component.app.help.model.ResourceBean	getResourceFromDocument(org.apache.lucene.document.Document document) Get Resource From Document.
protected Collection<? extends org.sakaiproject.api.app.help.Resource>	getResources() Get entire Collection of Resources.
Set<org.sakaiproject.api.app.help.Resource>	getResources(Long contextId) return list of resources matching context id
Map	getResourcesForActiveContexts(Map session)
org.sakaiproject.api.app.help.RestConfiguration	getRestConfiguration()
org.sakaiproject.component.api.ServerConfigurationService	getServerConfigurationService()
org.sakaiproject.api.app.help.Source	getSource(Long id)
String	getSupportEmailAddress() Get Support Email Address.
org.sakaiproject.api.app.help.TableOfContents	getTableOfContents()
org.sakaiproject.component.app.help.model.TableOfContentsBean	getToc() Get Table Of Contents Bean.
org.sakaiproject.tool.api.ToolManager	getToolManager() get tool manager
String	getWelcomePage()
void	initialize() Synchronize first access to tool.
void	recursiveExternalReg(Node n, org.sakaiproject.api.app.help.Category category, Set<org.sakaiproject.api.app.help.Category> categories) Parse external help reg doc recursively
void	registerCorpusDocs(Document doc) Parse corpus document
void	registerExternalHelpContent(String helpFile) register external help content build document from external reg file
void	registerStaticContent() register local content
void	reInitialize() Reinitialize help content from UI
org.sakaiproject.api.app.help.GlossaryEntry	searchGlossary(String keyword)
protected Set<org.sakaiproject.api.app.help.Resource>	searchResources(org.apache.lucene.search.Query query) Search Resources
Set<org.sakaiproject.api.app.help.Resource>	searchResources(String queryStr)
protected Set<org.sakaiproject.api.app.help.Resource>	searchResources(String queryStr, String defaultField) Search Lucene
void	setContextSize(int contextSize) Set ContextSize
void	setGlossary(org.sakaiproject.api.app.help.Glossary glossary) Set Glossary.
void	setPreferencesService(org.sakaiproject.user.api.PreferencesService preferencesService)
void	setRestConfiguration(org.sakaiproject.api.app.help.RestConfiguration restConfiguration) set REST configuration
void	setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService s)
void	setSupportEmailAddress(String email) set Support Email Address.
void	setTableOfContents(org.sakaiproject.api.app.help.TableOfContents toc)
void	setToc(org.sakaiproject.component.app.help.model.TableOfContentsBean toc) Set Table Of Contents Bean.
void	setToolManager(org.sakaiproject.tool.api.ToolManager toolManager) set tool manager
void	setTxManager(org.springframework.orm.hibernate3.HibernateTransactionManager txManager)
void	setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)
void	storeCategory(org.sakaiproject.api.app.help.Category category)
void	storeContext(org.sakaiproject.api.app.help.Context context)
void	storeResource(org.sakaiproject.api.app.help.Resource resource) Store resource
void	storeSource(org.sakaiproject.api.app.help.Source source)

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpManagerImpl

public HelpManagerImpl()

Method Detail

getServerConfigurationService

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

Specified by:

getServerConfigurationService in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getServerConfigurationService()

setServerConfigurationService

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

Specified by:

setServerConfigurationService in interface org.sakaiproject.api.app.help.HelpManager

See Also:

org.sakaiproject.api.app.help.HelpManager#setServerConfigurationService(org.sakaiproject.service.framework.config.ServerConfigurationService)

setPreferencesService

public void setPreferencesService(org.sakaiproject.user.api.PreferencesService preferencesService)

setUserDirectoryService

public void setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)

getContexts

public List getContexts(String mappedView)

Specified by:

getContexts in interface org.sakaiproject.api.app.help.HelpManager

getActiveContexts

public List getActiveContexts(Map session)

Specified by:

getActiveContexts in interface org.sakaiproject.api.app.help.HelpManager

addContexts

public void addContexts(Map session,
               String mappedView)

Specified by:

addContexts in interface org.sakaiproject.api.app.help.HelpManager

getResources

public Set<org.sakaiproject.api.app.help.Resource> getResources(Long contextId)

return list of resources matching context id

Specified by:

getResources in interface org.sakaiproject.api.app.help.HelpManager

Parameters:

contextId -

Returns:

storeResource

public void storeResource(org.sakaiproject.api.app.help.Resource resource)

Store resource

Specified by:

storeResource in interface org.sakaiproject.api.app.help.HelpManager

See Also:

org.sakaiproject.api.app.help.HelpManager#storeResource(org.sakaiproject.api.help.Entity)

getResource

public org.sakaiproject.api.app.help.Resource getResource(Long id)

Specified by:

getResource in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getResource(java.lang.Long)

deleteResource

public void deleteResource(Long resourceId)

Specified by:

deleteResource in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.deleteResource(java.lang.Long)

getSource

public org.sakaiproject.api.app.help.Source getSource(Long id)

Specified by:

getSource in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getSource(java.lang.Long)

storeSource

public void storeSource(org.sakaiproject.api.app.help.Source source)

Specified by:

storeSource in interface org.sakaiproject.api.app.help.HelpManager

See Also:

org.sakaiproject.api.app.help.HelpManager#storeSource(org.sakaiproject.api.help.Source)

deleteSource

public void deleteSource(Long sourceId)

Specified by:

deleteSource in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.deleteSource(java.lang.Long)

getContext

public org.sakaiproject.api.app.help.Context getContext(Long id)

Specified by:

getContext in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getContext(java.lang.Long)

storeContext

public void storeContext(org.sakaiproject.api.app.help.Context context)

Specified by:

storeContext in interface org.sakaiproject.api.app.help.HelpManager

See Also:

org.sakaiproject.api.app.help.HelpManager#storeContext(org.sakaiproject.api.help.Context)

deleteContext

public void deleteContext(Long contextId)

Specified by:

deleteContext in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.deleteContext(java.lang.Long)

getResourcesForActiveContexts

public Map getResourcesForActiveContexts(Map session)

Specified by:

getResourcesForActiveContexts in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getResourcesForActiveContexts(java.util.Map)

searchResources

public Set<org.sakaiproject.api.app.help.Resource> searchResources(String queryStr)

Specified by:

searchResources in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.searchResources(java.lang.String)

getTableOfContents

public org.sakaiproject.api.app.help.TableOfContents getTableOfContents()

Specified by:

getTableOfContents in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getTableOfContents()

setTableOfContents

public void setTableOfContents(org.sakaiproject.api.app.help.TableOfContents toc)

Specified by:

setTableOfContents in interface org.sakaiproject.api.app.help.HelpManager

See Also:

org.sakaiproject.api.app.help.HelpManager#setTableOfContents(org.sakaiproject.api.help.TableOfContents)

searchGlossary

public org.sakaiproject.api.app.help.GlossaryEntry searchGlossary(String keyword)

Specified by:

searchGlossary in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.searchGlossary(java.lang.String)

searchResources

protected Set<org.sakaiproject.api.app.help.Resource> searchResources(org.apache.lucene.search.Query query)

Search Resources

Parameters:

query -

Returns:

Set of matching results.

searchResources

protected Set<org.sakaiproject.api.app.help.Resource> searchResources(String queryStr,
                                                          String defaultField)
                                                               throws org.apache.lucene.queryparser.classic.ParseException

Search Lucene

Parameters:

queryStr -

defaultField -

Returns:

Throws:

org.apache.lucene.queryparser.classic.ParseException

getResourceFromDocument

protected org.sakaiproject.component.app.help.model.ResourceBean getResourceFromDocument(org.apache.lucene.document.Document document)

Get Resource From Document.

Parameters:

document -

Returns:

resource bean

getResources

protected Collection<? extends org.sakaiproject.api.app.help.Resource> getResources()

Get entire Collection of Resources.

Returns:

collection of resources

getContextSize

public int getContextSize()

Get ContextSize.

Returns:

size of Context.

setContextSize

public void setContextSize(int contextSize)

Set ContextSize

Parameters:

contextSize -

getDocument

protected org.apache.lucene.document.Document getDocument(org.sakaiproject.component.app.help.model.ResourceBean resource)
                                                   throws IOException,
                                                          MalformedURLException

Get Document.

Parameters:

resource -

Returns:

document

Throws:

IOException

MalformedURLException

getToc

public org.sakaiproject.component.app.help.model.TableOfContentsBean getToc()

Get Table Of Contents Bean.

Returns:

table of contents bean

setToc

public void setToc(org.sakaiproject.component.app.help.model.TableOfContentsBean toc)

Set Table Of Contents Bean.

Parameters:

toc -

getGlossary

public org.sakaiproject.api.app.help.Glossary getGlossary()

Specified by:

getGlossary in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getGlossary()

setGlossary

public void setGlossary(org.sakaiproject.api.app.help.Glossary glossary)

Set Glossary.

Parameters:

glossary -

storeCategory

public void storeCategory(org.sakaiproject.api.app.help.Category category)

Specified by:

storeCategory in interface org.sakaiproject.api.app.help.HelpManager

See Also:

org.sakaiproject.api.app.help.HelpManager#storeCategory(org.sakaiproject.api.help.Category)

createCategory

public org.sakaiproject.api.app.help.Category createCategory()

Specified by:

createCategory in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.createCategory()

createResource

public org.sakaiproject.api.app.help.Resource createResource()

Specified by:

createResource in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.createResource()

getResourceByDocId

public org.sakaiproject.api.app.help.Resource getResourceByDocId(String docId)

Specified by:

getResourceByDocId in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getResourceByDocId(java.lang.String)

getWelcomePage

public String getWelcomePage()

Specified by:

getWelcomePage in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getWelcomePage()

getCategoryByName

public org.sakaiproject.api.app.help.Category getCategoryByName(String name)

Find a Category by name

Parameters:

name -

Returns:

Category

getSupportEmailAddress

public String getSupportEmailAddress()

Get Support Email Address.

Specified by:

getSupportEmailAddress in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getSupportEmailAddress()

setSupportEmailAddress

public void setSupportEmailAddress(String email)

set Support Email Address.

Parameters:

email -

getToolManager

public org.sakaiproject.tool.api.ToolManager getToolManager()

get tool manager

Returns:

Returns the toolManager.

setToolManager

public void setToolManager(org.sakaiproject.tool.api.ToolManager toolManager)

set tool manager

Parameters:

toolManager - The toolManager to set.

setTxManager

public void setTxManager(org.springframework.orm.hibernate3.HibernateTransactionManager txManager)

Parameters:

txManager - The txManager to set.

getRestConfiguration

public org.sakaiproject.api.app.help.RestConfiguration getRestConfiguration()

Specified by:

getRestConfiguration in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getRestConfiguration()

setRestConfiguration

public void setRestConfiguration(org.sakaiproject.api.app.help.RestConfiguration restConfiguration)

set REST configuration

Parameters:

restConfiguration -

reInitialize

public void reInitialize()

Reinitialize help content from UI

Specified by:

reInitialize in interface org.sakaiproject.api.app.help.HelpManager

initialize

public void initialize()

Synchronize first access to tool.

Specified by:

initialize in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.initialize()

getExternalLocation

public String getExternalLocation()

Specified by:

getExternalLocation in interface org.sakaiproject.api.app.help.HelpManager

See Also:

HelpManager.getExternalLocation()

registerExternalHelpContent

public void registerExternalHelpContent(String helpFile)

register external help content build document from external reg file

Parameters:

externalHelpReg -

registerStaticContent

public void registerStaticContent()

register local content

recursiveExternalReg

public void recursiveExternalReg(Node n,
                        org.sakaiproject.api.app.help.Category category,
                        Set<org.sakaiproject.api.app.help.Category> categories)

Parse external help reg doc recursively

Parameters:

n -

category -

registerCorpusDocs

public void registerCorpusDocs(Document doc)

Parse corpus document

Parameters:

doc - document