org.exoplatform.commons.api.search.data

Class SearchContext

java.lang.Object

org.exoplatform.commons.api.search.data.SearchContext

public class SearchContext
extends Object

Search Context contains a set of data needed for SearchService and all connectors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchContext.RouterParams

Constructor Summary

Constructors

Constructor and Description
SearchContext(org.exoplatform.web.controller.router.Router router, String siteName) Contructor to create a context for search service

Method Summary

Methods

Modifier and Type	Method and Description
org.exoplatform.web.controller.router.Router	getRouter() Get router
String	getSiteName() Get site name, e.g.
SearchContext	handler(String value) Puts Handler value into QualifiedName map
SearchContext	lang(String value) Puts Lang value into QualifiedName map
SearchContext	path(String value) Puts Path value into QualifiedName map
String	renderLink() Render link base on router and Map
void	setRouter(org.exoplatform.web.controller.router.Router router) Set router
SearchContext	siteName(String value) Puts SiteType value into QualifiedName map
SearchContext	siteType(String value) Puts SiteType value into QualifiedName map

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchContext

public SearchContext(org.exoplatform.web.controller.router.Router router,
             String siteName)

Contructor to create a context for search service

Parameters:

router -

siteName -

Method Detail

getRouter

public org.exoplatform.web.controller.router.Router getRouter()

Get router

Returns:

Router

setRouter

public void setRouter(org.exoplatform.web.controller.router.Router router)

Set router

Parameters:

router -

getSiteName

public String getSiteName()

Get site name, e.g. intranet, acme, ..

Returns:

String

handler

public SearchContext handler(String value)

Puts Handler value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

lang

public SearchContext lang(String value)

Puts Lang value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

path

public SearchContext path(String value)

Puts Path value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

siteType

public SearchContext siteType(String value)

Puts SiteType value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

siteName

public SearchContext siteName(String value)

Puts SiteType value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

renderLink

public String renderLink()
                  throws Exception

Render link base on router and Map

Returns:

String

Throws:

Exception