info.magnolia.module.templatingkit.search

Class SearchResultModel

java.lang.Object

info.magnolia.rendering.model.RenderingModelImpl<RD>

info.magnolia.module.templatingkit.templates.AbstractSTKTemplateModel<info.magnolia.rendering.template.TemplateDefinition>

info.magnolia.module.templatingkit.search.SearchResultModel

All Implemented Interfaces:

STKRenderingModel<info.magnolia.rendering.template.TemplateDefinition>, info.magnolia.rendering.model.RenderingModel<info.magnolia.rendering.template.TemplateDefinition>

public class SearchResultModel
extends AbstractSTKTemplateModel<info.magnolia.rendering.template.TemplateDefinition>

STK renderable model definition dedicated to display and execute Search Result Model.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	count
protected int	currentPage
protected int	maxResultsPerPage
protected long	numPages
protected Set<javax.jcr.Node>	queryResult
protected String	repository
protected List<info.magnolia.cms.core.Content>	result Deprecated. since 2.9, please use queryResult.

Fields inherited from class info.magnolia.module.templatingkit.templates.AbstractSTKTemplateModel

DEFAULT_SITEROOT_TEMPLATE_CATEGORY, stkFunctions, templatingFunctions

Fields inherited from class info.magnolia.rendering.model.RenderingModelImpl

content, contentMap, definition, parentModel

Fields inherited from interface info.magnolia.rendering.model.RenderingModel

SKIP_RENDERING

Constructor Summary

Constructors

Constructor and Description
SearchResultModel(javax.jcr.Node content, info.magnolia.rendering.template.TemplateDefinition definition, info.magnolia.rendering.model.RenderingModel<?> parent, STKTemplatingFunctions stkFunctions, info.magnolia.templating.functions.TemplatingFunctions templatingFunctions)

Method Summary

Modifier and Type	Method and Description
String	execute() The query result is filtered by NodeTypes.Page#NAME type.
protected String	generateSimpleQuery(String input)
int	getBeginIndex()
long	getCount()
int	getCurrentPage()
long	getEndIndex()
protected int	getMaxResultsPerPage()
long	getNumPages()
protected int	getOffset()
String	getPageLink(int i)
String	getPath()
String	getPosition()
List<javax.jcr.Node>	getQueryResult() Deprecated. since 2.9, please use getQueryResult(Iterable) instead.
Set<javax.jcr.Node>	getQueryResult(Iterable<javax.jcr.Node> results)
String	getQueryStr()
Collection<SearchResultItem>	getResult()
protected int	pagedQuery(Collection<info.magnolia.cms.core.Content> queryResult, int offset, int limit) Deprecated. since 2.9, no longer used as the same functionality is achieved in the execute() method with JCR SQL2.

Methods inherited from class info.magnolia.module.templatingkit.templates.AbstractSTKTemplateModel

getSite, getSiteRoot

Methods inherited from class info.magnolia.rendering.model.RenderingModelImpl

getContent, getDef, getDefinition, getNode, getParent, getRoot

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.rendering.model.RenderingModel

getContent, getDefinition, getNode, getParent, getRoot

Field Detail

repository

protected String repository

result

protected List<info.magnolia.cms.core.Content> result

Deprecated. since 2.9, please use queryResult.

queryResult

protected Set<javax.jcr.Node> queryResult

count

protected long count

maxResultsPerPage

protected int maxResultsPerPage

currentPage

protected int currentPage

numPages

protected long numPages

Constructor Detail

SearchResultModel

@Inject
public SearchResultModel(javax.jcr.Node content,
                                 info.magnolia.rendering.template.TemplateDefinition definition,
                                 info.magnolia.rendering.model.RenderingModel<?> parent,
                                 STKTemplatingFunctions stkFunctions,
                                 info.magnolia.templating.functions.TemplatingFunctions templatingFunctions)

Method Detail

getMaxResultsPerPage

protected int getMaxResultsPerPage()

execute

public String execute()

The query result is filtered by NodeTypes.Page#NAME type. This is hardly the most efficient way to perform content research in a large production website where one would probably tweak JR's indexing_configuration to add all relevant content to the search index and perform one single query against it. Or one could resort to a dedicated search service like Solr.

Specified by:

execute in interface info.magnolia.rendering.model.RenderingModel<info.magnolia.rendering.template.TemplateDefinition>

Overrides:

execute in class info.magnolia.rendering.model.RenderingModelImpl<info.magnolia.rendering.template.TemplateDefinition>

getOffset

protected int getOffset()

pagedQuery

@Deprecated
protected int pagedQuery(Collection<info.magnolia.cms.core.Content> queryResult,
                                     int offset,
                                     int limit)
                              throws Exception

Deprecated. since 2.9, no longer used as the same functionality is achieved in the execute() method with JCR SQL2.

Throws:

Exception

generateSimpleQuery

protected String generateSimpleQuery(String input)

getPath

public String getPath()

getQueryResult

@Deprecated
public List<javax.jcr.Node> getQueryResult()

Deprecated. since 2.9, please use getQueryResult(Iterable) instead.

getQueryResult

public Set<javax.jcr.Node> getQueryResult(Iterable<javax.jcr.Node> results)
                                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getResult

public Collection<SearchResultItem> getResult()

getQueryStr

public String getQueryStr()

getCount

public long getCount()

getCurrentPage

public int getCurrentPage()

getNumPages

public long getNumPages()

getPageLink

public String getPageLink(int i)

getBeginIndex

public int getBeginIndex()

getEndIndex

public long getEndIndex()

getPosition

public String getPosition()