Package 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.

eXo level API

Experimental

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchContext.RouterParams

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getParamValue(org.exoplatform.web.controller.QualifiedName name)
org.exoplatform.web.controller.router.Router	getRouter()	Get router
String	getSiteName()	Get site name, e.g.
String	getSiteType()	Get site type
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<QualifiedName, String>
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 -

eXo level API

Experimental

Method Detail

getRouter

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

Get router

Returns:

Router

eXo level API

Experimental

setRouter

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

Set router

Parameters:

router -

eXo level API

Experimental

getParamValue

public String getParamValue(org.exoplatform.web.controller.QualifiedName name)

getSiteName

public String getSiteName()

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

Returns:

String

eXo level API

Experimental

getSiteType

public String getSiteType()

Get site type

Returns:

String

eXo level API

Experimental

handler

public SearchContext handler(String value)

Puts Handler value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

eXo level API

Experimental

lang

public SearchContext lang(String value)

Puts Lang value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

eXo level API

Experimental

path

public SearchContext path(String value)

Puts Path value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

eXo level API

Experimental

siteType

public SearchContext siteType(String value)

Puts SiteType value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

eXo level API

Experimental

siteName

public SearchContext siteName(String value)

Puts SiteType value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

eXo level API

Experimental

renderLink

public String renderLink()
                  throws Exception

Render link base on router and Map<QualifiedName, String>

Returns:

String

Throws:

Exception

eXo level API

Experimental