org.exoplatform.services.cms.queries.impl

Class QueryServiceImpl

java.lang.Object

org.exoplatform.services.cms.queries.impl.QueryServiceImpl

All Implemented Interfaces:

QueryService, org.picocontainer.Startable

public class QueryServiceImpl
extends Object
implements QueryService, org.picocontainer.Startable

Field Summary

Fields inherited from interface org.exoplatform.services.cms.queries.QueryService

CACHE_NAME

Constructor Summary

Constructors

Constructor and Description

QueryServiceImpl(org.exoplatform.services.jcr.RepositoryService repositoryService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, org.exoplatform.container.xml.InitParams params, org.exoplatform.container.xml.PortalContainerInfo containerInfo, org.exoplatform.services.cache.CacheService cacheService, org.exoplatform.services.organization.OrganizationService organizationService, DMSConfiguration dmsConfiguration) Constructor method

Method Summary

Modifier and Type	Method and Description
void	addQuery(String queryName, String statement, String language, String userName) Add new query by giving the following params : queryName, statement, language, userName
void	addSharedQuery(String queryName, String statement, String language, String[] permissions, boolean cachedResult) Add new shared query by giving the following params: queryName, statement, language, permissions, cachedResult
void	addSharedQuery(String queryName, String statement, String language, String[] permissions, boolean cachedResult, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Add new shared query by giving the following params: queryName, statement, language, permissions, cachedResult, provider
javax.jcr.query.QueryResult	execute(String queryPath, String workspace, org.exoplatform.services.jcr.ext.common.SessionProvider provider, String userId) Execute query by giving the following params : queryPath, workspace, provider, userId
Set<String>	getAllConfiguredQueries() gets all configured queries
List<javax.jcr.query.Query>	getQueries(String userName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get queries by giving the following params : userName, repository, provider
javax.jcr.query.Query	getQuery(String queryPath, String workspace, org.exoplatform.services.jcr.ext.common.SessionProvider provider, String userId) Returns Query object by giving the following params : queryPath, workspace, provider, userId
javax.jcr.query.Query	getQueryByPath(String queryPath, String userName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get query with path by giving the following params : queryPath, userName, provider
String	getRelativePath() Get the relative path
List<javax.jcr.Node>	getSharedQueries(org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get shared queries by giving the following params : provider
List<javax.jcr.Node>	getSharedQueries(String userId, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get shared queries by giving the following params : userId, provider
List<javax.jcr.Node>	getSharedQueries(String queryType, String userId, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get shared queries by giving the following params : queryType, userId, provider
javax.jcr.Node	getSharedQuery(String queryName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get shared queries by giving the following params : queryName, provider
void	init() Init query node with current repository
void	removeQuery(String queryPath, String userName) Remove query by giving the following params : queryPath, userName
void	removeSharedQuery(String queryName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Remove share query by giving the following params : queryName
void	setQueryPlugin(QueryPlugin queryPlugin) Add new QueryPlugin to queryPlugins_
void	start() Implemented method from Startable class init all ManageDrivePlugin
void	stop() Implemented method from Startable class

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryServiceImpl

public QueryServiceImpl(org.exoplatform.services.jcr.RepositoryService repositoryService,
                        org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator,
                        org.exoplatform.container.xml.InitParams params,
                        org.exoplatform.container.xml.PortalContainerInfo containerInfo,
                        org.exoplatform.services.cache.CacheService cacheService,
                        org.exoplatform.services.organization.OrganizationService organizationService,
                        DMSConfiguration dmsConfiguration)
                 throws Exception

Constructor method

Parameters:

repositoryService -

nodeHierarchyCreator -

params -

containerInfo -

cacheService -

organizationService -

dmsConfiguration -

Throws:

Exception

Method Detail

start

public void start()

Implemented method from Startable class init all ManageDrivePlugin

Specified by:

start in interface org.picocontainer.Startable

See Also:

QueryPlugin

stop

public void stop()

Implemented method from Startable class

Specified by:

stop in interface org.picocontainer.Startable

init

public void init()
          throws Exception

Init query node with current repository

Specified by:

init in interface QueryService

Throws:

Exception

See Also:

QueryPlugin

setQueryPlugin

public void setQueryPlugin(QueryPlugin queryPlugin)

Add new QueryPlugin to queryPlugins_

Parameters:

queryPlugin - QueryPlugin

See Also:

QueryPlugin

getRelativePath

public String getRelativePath()

Get the relative path

Specified by:

getRelativePath in interface QueryService

Returns:

getQueries

public List<javax.jcr.query.Query> getQueries(String userName,
                                              org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                       throws Exception

Get queries by giving the following params : userName, repository, provider

Specified by:

getQueries in interface QueryService

Parameters:

userName - String Can be null

provider - SessionProvider

Returns:

queries

Throws:

Exception

See Also:

Query, SessionProvider

addQuery

public void addQuery(String queryName,
                     String statement,
                     String language,
                     String userName)
              throws Exception

Add new query by giving the following params : queryName, statement, language, userName

Specified by:

addQuery in interface QueryService

Parameters:

queryName - String The name of query

statement - String The statement query

language - String The language is requested

userName - String Can be null

Throws:

Exception

removeQuery

public void removeQuery(String queryPath,
                        String userName)
                 throws Exception

Remove query by giving the following params : queryPath, userName

Specified by:

removeQuery in interface QueryService

Parameters:

queryPath - String The path of query

userName - String Can be null

Throws:

Exception

addSharedQuery

public void addSharedQuery(String queryName,
                           String statement,
                           String language,
                           String[] permissions,
                           boolean cachedResult)
                    throws Exception

Add new shared query by giving the following params: queryName, statement, language, permissions, cachedResult

Specified by:

addSharedQuery in interface QueryService

Parameters:

queryName - String The name of query

statement - String The statement query

language - String The language is requested

permissions - String[]

cachedResult - boolean Choosen for caching results

Throws:

Exception

addSharedQuery

public void addSharedQuery(String queryName,
                           String statement,
                           String language,
                           String[] permissions,
                           boolean cachedResult,
                           org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                    throws Exception

Description copied from interface: QueryService

Add new shared query by giving the following params: queryName, statement, language, permissions, cachedResult, provider

Specified by:

addSharedQuery in interface QueryService

Parameters:

queryName - String The name of query

statement - String The statement query

language - String The language is requested

permissions - String[]

cachedResult - boolean Choosen for caching results

provider - Session provider

Throws:

Exception

getSharedQuery

public javax.jcr.Node getSharedQuery(String queryName,
                                     org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                              throws Exception

Get shared queries by giving the following params : queryName, provider

Specified by:

getSharedQuery in interface QueryService

Parameters:

queryName - the name of query

provider - SessionProvider

Returns:

sharedQueries

Throws:

Exception

See Also:

Node, SessionProvider

getSharedQueries

public List<javax.jcr.Node> getSharedQueries(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                      throws Exception

Get shared queries by giving the following params : provider

Specified by:

getSharedQueries in interface QueryService

Parameters:

provider - SessionProvider

Returns:

sharedQueries

Throws:

Exception

See Also:

Node, SessionProvider

getSharedQueries

public List<javax.jcr.Node> getSharedQueries(String userId,
                                             org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                      throws Exception

Get shared queries by giving the following params : userId, provider

Specified by:

getSharedQueries in interface QueryService

Parameters:

userId - String The id of current user

provider - SessionProvider

Returns:

sharedQueries

Throws:

Exception

See Also:

Node, SessionProvider

getSharedQueries

public List<javax.jcr.Node> getSharedQueries(String queryType,
                                             String userId,
                                             org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                      throws Exception

Get shared queries by giving the following params : queryType, userId, provider

Specified by:

getSharedQueries in interface QueryService

Parameters:

queryType - String The type of query

userId - String The id of current user

provider - SessionProvider

Returns:

sharedQueries

Throws:

Exception

See Also:

Node, SessionProvider

getQueryByPath

public javax.jcr.query.Query getQueryByPath(String queryPath,
                                            String userName,
                                            org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                     throws Exception

Get query with path by giving the following params : queryPath, userName, provider

Specified by:

getQueryByPath in interface QueryService

Parameters:

queryPath - String The path of query

userName - String The name of current user

provider - SessionProvider

Returns:

query Query

Throws:

Exception

See Also:

Node, Query, SessionProvider

removeSharedQuery

public void removeSharedQuery(String queryName,
                              org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                       throws Exception

Remove share query by giving the following params : queryName

Specified by:

removeSharedQuery in interface QueryService

Parameters:

queryName - String The name of query

provider - SessionProvider

Throws:

Exception

execute

public javax.jcr.query.QueryResult execute(String queryPath,
                                           String workspace,
                                           org.exoplatform.services.jcr.ext.common.SessionProvider provider,
                                           String userId)
                                    throws Exception

Execute query by giving the following params : queryPath, workspace, provider, userId

Specified by:

execute in interface QueryService

Parameters:

queryPath - String The path of query

workspace - String The name of workspace

provider - SessionProvider

userId - String The id of current user

Returns:

queries QueryResult

Throws:

Exception

See Also:

QueryResult, SessionProvider

getQuery

public javax.jcr.query.Query getQuery(String queryPath,
                                      String workspace,
                                      org.exoplatform.services.jcr.ext.common.SessionProvider provider,
                                      String userId)
                               throws Exception

Returns Query object by giving the following params : queryPath, workspace, provider, userId

Specified by:

getQuery in interface QueryService

Parameters:

queryPath - String The path of query

workspace - String The name of workspace

provider - SessionProvider

userId - String The id of current user

Returns:

queries QueryResult

Throws:

Exception

See Also:

QueryResult, SessionProvider

getAllConfiguredQueries

public Set<String> getAllConfiguredQueries()

Description copied from interface: QueryService

gets all configured queries

Specified by:

getAllConfiguredQueries in interface QueryService

Returns: