info.magnolia.templating.functions

Class SearchTemplatingFunctions

java.lang.Object

info.magnolia.templating.functions.SearchTemplatingFunctions

@Singleton
public class SearchTemplatingFunctions
extends Object

Search related functions especially suitable for being used in templates. They return a collection of ContentMap which is more easily accessible in template scripts via . (dot) notation. Results are sorted by jcr:score() descending. An excerpt from the text containing the query term might be available, depending on the Jackrabbit search configuration. Read permissions for the current user are checked before adding the result to the collection returned. Functions are exposed as searchfn.

Here follows a couple of sample usages.

 [#assign searchResults = searchfn.searchPages('foo', '/somepath') /]
 
 [#if searchResults?has_content]
   [#list searchResults as item]
   <a href="${cmsfn.link(item)}">
      <h4>${item.title!}</h4>
      <p>${item.excerpt!}</p>
   </a>
   [/#list]
 [/#if]
 

and

 [#assign searchResults = searchfn.searchContent('myworkspace', 'foo', '/somepath','qux:baz') /]
 
 [#if searchResults?has_content]
   [#list searchResults as item]
   <a href="${cmsfn.link(item)}">
      <h4>${item.title!}</h4>
      <p>${item.excerpt!}</p>
   </a>
   [/#list]
 [/#if]

 

Constructor Summary

Constructors

Constructor and Description
SearchTemplatingFunctions()

Method Summary

Modifier and Type	Method and Description
Collection<info.magnolia.jcr.util.ContentMap>	searchContent(String workspace, String queryString, String startPath, String returnItemType) Searches content in any workspace.
Collection<info.magnolia.jcr.util.ContentMap>	searchContent(String workspace, String queryString, String startPath, String returnItemType, long limit, long offset) Searches content in any workspace.
Collection<info.magnolia.jcr.util.ContentMap>	searchPages(String queryString, String startPath) Searches the RepositoryConstants.WEBSITE for NodeTypes.Page#NAME.
Collection<info.magnolia.jcr.util.ContentMap>	searchPages(String queryString, String startPath, long limit, long offset) Searches the RepositoryConstants.WEBSITE for NodeTypes.Page#NAME.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchTemplatingFunctions

public SearchTemplatingFunctions()

Method Detail

searchPages

public Collection<info.magnolia.jcr.util.ContentMap> searchPages(String queryString,
                                                                 String startPath)
                                                          throws javax.jcr.RepositoryException

Searches the RepositoryConstants.WEBSITE for NodeTypes.Page#NAME.

Throws:

javax.jcr.RepositoryException

See Also:

searchPages(String, String, long, long)

searchPages

public Collection<info.magnolia.jcr.util.ContentMap> searchPages(String queryString,
                                                                 String startPath,
                                                                 long limit,
                                                                 long offset)
                                                          throws javax.jcr.RepositoryException

Searches the RepositoryConstants.WEBSITE for NodeTypes.Page#NAME.

Throws:

javax.jcr.RepositoryException

See Also:

searchContent(String, String, String, String, long, long)

searchContent

public Collection<info.magnolia.jcr.util.ContentMap> searchContent(String workspace,
                                                                   String queryString,
                                                                   String startPath,
                                                                   String returnItemType)
                                                            throws javax.jcr.RepositoryException

Searches content in any workspace.

Parameters:

returnItemType - if not specified, defaults to nt:base

Throws:

javax.jcr.RepositoryException

See Also:

searchContent(String, String, String, String, long, long)

searchContent

public Collection<info.magnolia.jcr.util.ContentMap> searchContent(String workspace,
                                                                   String queryString,
                                                                   String startPath,
                                                                   String returnItemType,
                                                                   long limit,
                                                                   long offset)
                                                            throws javax.jcr.RepositoryException

Searches content in any workspace.

Throws:

javax.jcr.RepositoryException

See Also:

searchContent(String, String, String, String)