Package org.exoplatform.documents.legacy.search.data

Class SearchContext

java.lang.Object

org.exoplatform.documents.legacy.search.data.SearchContext

@Deprecated(forRemoval=true,
            since="6.0.0")
public class SearchContext
extends Object

Deprecated, for removal: This API element is subject to removal in a future version.

Copied from commons-search to this module. Should be reworked to be more simple.

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 enum	SearchContext.RouterParams	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
SearchContext(org.exoplatform.web.controller.router.Router router, String siteName)	Deprecated, for removal: This API element is subject to removal in a future version. Contructor to create a context for search service

Method Summary

Modifier and Type	Method	Description
String	getParamValue(org.exoplatform.web.controller.QualifiedName name)	Deprecated, for removal: This API element is subject to removal in a future version.
org.exoplatform.web.controller.router.Router	getRouter()	Deprecated, for removal: This API element is subject to removal in a future version. Get router
String	getSiteName()	Deprecated, for removal: This API element is subject to removal in a future version. Get site name, e.g.
String	getSiteType()	Deprecated, for removal: This API element is subject to removal in a future version. Get site type
SearchContext	handler(String value)	Deprecated, for removal: This API element is subject to removal in a future version. Puts Handler value into QualifiedName map
SearchContext	lang(String value)	Deprecated, for removal: This API element is subject to removal in a future version. Puts Lang value into QualifiedName map
SearchContext	path(String value)	Deprecated, for removal: This API element is subject to removal in a future version. Puts Path value into QualifiedName map
String	renderLink()	Deprecated, for removal: This API element is subject to removal in a future version. Render link base on router and Map<QualifiedName, String>
void	setRouter(org.exoplatform.web.controller.router.Router router)	Deprecated, for removal: This API element is subject to removal in a future version. Set router
SearchContext	siteName(String value)	Deprecated, for removal: This API element is subject to removal in a future version. Puts SiteType value into QualifiedName map
SearchContext	siteType(String value)	Deprecated, for removal: This API element is subject to removal in a future version. 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 Details

SearchContext

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

Deprecated, for removal: This API element is subject to removal in a future version.

Contructor to create a context for search service

Parameters:

router -

siteName -

eXo level API

Experimental

Method Details

getRouter

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

Deprecated, for removal: This API element is subject to removal in a future version.

Get router

Returns:

Router

eXo level API

Experimental

setRouter

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

Deprecated, for removal: This API element is subject to removal in a future version.

Set router

Parameters:

router -

eXo level API

Experimental

getParamValue

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

Deprecated, for removal: This API element is subject to removal in a future version.

getSiteName

public String getSiteName()

Deprecated, for removal: This API element is subject to removal in a future version.

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

Returns:

String

eXo level API

Experimental

getSiteType

public String getSiteType()

Deprecated, for removal: This API element is subject to removal in a future version.

Get site type

Returns:

String

eXo level API

Experimental

handler

public SearchContext handler(String value)

Deprecated, for removal: This API element is subject to removal in a future version.

Puts Handler value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

eXo level API

Experimental

lang

public SearchContext lang(String value)

Deprecated, for removal: This API element is subject to removal in a future version.

Puts Lang value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

eXo level API

Experimental

path

public SearchContext path(String value)

Deprecated, for removal: This API element is subject to removal in a future version.

Puts Path value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

eXo level API

Experimental

siteType

public SearchContext siteType(String value)

Deprecated, for removal: This API element is subject to removal in a future version.

Puts SiteType value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

eXo level API

Experimental

siteName

public SearchContext siteName(String value)

Deprecated, for removal: This API element is subject to removal in a future version.

Puts SiteType value into QualifiedName map

Parameters:

value -

Returns:

SearchContext

eXo level API

Experimental

renderLink

public String renderLink()
                  throws Exception

Deprecated, for removal: This API element is subject to removal in a future version.

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

Returns:

String

Throws:

Exception

eXo level API

Experimental