search Taglib documentation

Tag forEachPage search:forEachPage(...)

Iterates over the results page.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported scoped variable for the current page number. This scoped variable has nested visibility.
varStatus	false	false	java.lang.String
Name of the exported scoped variable for the status of the iteration. This scoped variable has nested visibility.
varUrl	false	false	java.lang.String
Name of the exported scoped variable for the current page URL. This scoped variable has nested visibility.
varIsSelected	false	false	java.lang.String
Name of the exported scoped variable for the status of the current page. This scoped variable has nested visibility.
nbPageToShow	false	true	int
Specifies the number of page to show. It will displays pages both before and after the current page.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed to use for the pagination. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed to use for the pagination. Object is of type Map(String, ResultFeed).

↑

Tag forEachFeed search:forEachFeed(...)

Iterates over the results feeds.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported scoped variable for the current ResultFeed. This scoped variable has nested visibility.
varStatus	false	false	java.lang.String
Name of the exported scoped variable for the status of the iteration. This scoped variable has nested visibility.
feeds	true	true	java.util.Map
The ResultFeed to iterate over. Object is of type Map(String, ResultFeed).
begin	false	true	int
The index on which to begin the iteration. Defaults to '0'.
end	false	true	int
The index on which to end the iteration. 0 is interpreted as 'unbounded'. Defaults to '0'.
iteration	false	true	int
The number of iteration to perform, replace the 'end' attribute. 0 is interpreted as 'unbounded'. Defaults to '0'.

↑

Tag forEachEntry search:forEachEntry(...)

Iterates over the feed entries.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported scoped variable for the current Entry. This scoped variable has nested visibility.
varStatus	false	false	java.lang.String
Name of the exported scoped variable for the status of the iteration. This scoped variable has nested visibility.
feed	true	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the entries to iterate over. Object is of type ResultFeed.
begin	false	true	int
The index on which to begin the iteration. Defaults to '0'.
end	false	true	int
The index on which to end the iteration. 0 is interpreted as 'unbounded'. Defaults to '0'.
iteration	false	true	int
The number of iteration to perform, replace the 'end' attribute. 0 is interpreted as 'unbounded'. Defaults to '0'.

↑

Tag forEachMeta search:forEachMeta(...)

Iterates over the entry metas.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported scoped variable for the current Meta. This scoped variable has nested visibility.
varStatus	false	false	java.lang.String
Name of the exported scoped variable for the status of the iteration. This scoped variable has nested visibility.
entry	true	true	com.exalead.access.feedapi.Entry
The Entry containing the metas to iterate over.
metasList	false	true	java.lang.String
A list of metas separated by a comma. Example: "file_name,file_extension".
filterMode	false	true	java.lang.String
Specifies how the metas list is handled. The possible values are: 'NO_FILTERING' (ignored), 'EXCLUDE', 'INCLUDE'. Defaults to 'NO_FILTERING'.
sortMode	false	true	java.lang.String
Specifies the sort mode for the metas. The possible values are 'DEFAULT', 'DESCRIPTION-ASC', 'DESCRIPTION-DESC', 'SHUFFLE'. Defaults to 'DEFAULT'.
begin	false	true	int
The index on which to begin the iteration. Defaults to '0'.
end	false	true	int
The index on which to end the iteration. 0 is interpreted as 'unbounded'. Defaults to '0'.
iteration	false	true	int
The number of iteration to perform, replace the 'end' attribute. 0 is interpreted as 'unbounded'. Defaults to '0'.
showEmptyMetas	false	true	java.lang.String
deprecated

↑

Tag forEachMetaValue search:forEachMetaValue(...)

Iterates over the metas values.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported scoped variable for the current Meta highlighted value. This scoped variable has nested visibility.
varStatus	false	false	java.lang.String
Name of the exported scoped variable for the status of the iteration. This scoped variable has nested visibility.
varUrl	false	false	java.lang.String
Name of the exported scoped variable for the Meta URL. This scoped variable has nested visibility.
varRaw	false	false	java.lang.String
Name of the exported scoped variable for the Meta raw value. This scoped variable has nested visibility.
meta	true	true	com.exalead.access.feedapi.Meta
The Meta containing the values we iterate from.
entry	true	true	com.exalead.access.feedapi.Entry
The Entry containing the Meta we iterate from.
begin	false	true	int
The index on which to begin the iteration. Defaults to '0'.
end	false	true	int
The index on which to end the iteration. 0 is interpreted as 'unbounded'. Defaults to '0'.
iteration	false	true	int
The number of iteration to perform, replace the 'end' attribute. 0 is interpreted as 'unbounded'. Defaults to '0'.

↑

Tag forEachFacet search:forEachFacet(...)

Iterates over the facets.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported scoped variable for the current MergedFacet. This scoped variable has nested visibility.
varStatus	false	false	java.lang.String
Name of the exported scoped variable for the status of the iteration. This scoped variable has nested visibility.
feeds	false	true	java.util.Map
The ResultFeed containing the facets to iterate over. Object is of type Map(String, ResultFeed).
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the facets to iterate over. Object is of type ResultFeed.
entry	false	true	com.exalead.access.feedapi.Entry
If entry is specified: Only the facets contained in the Entry will be processed.
facetsList	false	true	java.lang.String
A list of facet roots separated by a comma. Example: "country,filetype".
filterMode	false	true	java.lang.String
Specifies how the facets list is handled. The possible values are: 'NO_FILTERING' (ignored), 'EXCLUDE', 'INCLUDE'. Defaults to 'NO_FILTERING'.
sortMode	false	true	java.lang.String
Specifies the sort mode for the facets. The possible values are 'DEFAULT', 'DESCRIPTION-ASC', 'DESCRIPTION-DESC', 'SHUFFLE'. Defaults to 'DEFAULT'.
begin	false	true	int
The index on which to begin the iteration. Defaults to '0'.
end	false	true	int
The index on which to end the iteration. 0 is interpreted as 'unbounded'. Defaults to '0'.
iteration	false	true	int
The number of iteration to perform, replace the 'end' attribute. 0 is interpreted as 'unbounded'. Defaults to '0'.
showEmptyFacets	false	true	java.lang.String
deprecated

↑

Tag forEachCategory search:forEachCategory(...)

Iterates over the facet categories.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported scoped variable for the current MergedCategory. This scoped variable has nested visibility.
varStatus	false	false	java.lang.String
Name of the exported scoped variable for the status of the iteration. This scoped variable has nested visibility.
varLevel	false	true	java.lang.String
Current iteration depth (0 denoting base level)
varPreviousLevel	false	true	java.lang.String
Previous iteration depth (0 denoting base level)
root	true	true	com.exalead.access.feedapi.CategoryTreeContainer
A node of a Category tree (facet, mergedfacet, category, mergedcategory) on which the iteration will be performed.
begin	false	true	int
The index on which to begin the iteration. Defaults to '0'.
end	false	true	int
The index on which to end the iteration. 0 is interpreted as 'unbounded'. Defaults to '0'.
iteration	false	true	int
The number of iteration to perform, replace the 'end' attribute. 0 is interpreted as 'unbounded'. Defaults to '0'.
iterationMode	false	true	java.lang.String
Specifies the iteration mode. Possible values are: 'ALL' (hierarchical view), 'LEAVES' (flat view of leaf nodes), 'FLAT' (flat view of the first level). Defaults to 'FLAT'.
sortMode	false	true	java.lang.String
Controls th e ordering in which categories are returned by the iterator. Can be set to either 'description-asc' (sort by category name/desc), 'score-desc' (sort by category's combined score, desc'), 'count-desc' (sort by number of sub-hits, desc) and 'default' (elements preserve natural order). Note that all options except 'default' incur a performance penalty. Default is "default".
showState	false	true	java.lang.String
If specified, only categories of the given state will be displayed. Possible values are 'DISPLAYED', 'REFINED' or 'EXCLUDED'.
drillDown	false	true	boolean
Specifies whether or not the iteration should begin at the deepest refined category. Defaults to 'false'.
showEmptyCategories	false	true	boolean
deprecated

↑

Tag forEachCategoryPath search:forEachCategoryPath(...)

Iterates through a category path, from the top category to the specified one.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported scoped variable for the current MergedCategory. This scoped variable has nested visibility.
varStatus	false	false	java.lang.String
Name of the exported scoped variable for the status of the iteration. This scoped variable has nested visibility.
category	true	true	com.exalead.access.feedapi.AbstractCategory
Specifies a MergedCategory to iterate to.
reverse	false	true	boolean
Specifies if the iteration should be reverse, thus from the child category to the parent category.

Example

			<search:forEachCategoryPath var="category" varStatus="status" category="${parentCategory}">
				<search:getCategoryLabel category="category" />
				<c:if test="${status.last == false}">
					>>
				</c:if>
			</search:forEachCategoryPath>

↑

Tag forEachSpellCheckSuggestion search:forEachSpellCheckSuggestion(...)

Iterates over the spellcheck suggestions.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported scoped variable for the current suggestion. This scoped variable has nested visibility.
varNhits	false	false	java.lang.String
Name of the exported scoped variable for the current suggestion NHits.
varUrl	false	false	java.lang.String
Name of the exported scoped variable for the current suggestion URL. This scoped variable has nested visibility.
varStatus	false	false	java.lang.String
Name of the exported scoped variable for the status of the iteration. This scoped variable has nested visibility.
urlQueryParameter	false	false	java.lang.String
Name of the query parameter for the suggestion URL. Defaults to 'q'.
begin	false	true	int
The index on which to begin the iteration. Defaults to '0'.
end	false	true	int
The index on which to end the iteration. 0 is interpreted as 'unbounded'. Defaults to '0'.
iteration	false	true	int
The number of iteration to perform, replace the 'end' attribute. 0 is interpreted as 'unbounded'. Defaults to '0'.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed to retrieve suggestions from. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed to retrieve suggestions from. Object is of type Map(String, ResultFeed).

↑

Tag getFeed search:getFeed(...)

Returns a ResultFeed either the first in position or by its name.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported variable for the retrieved ResultFeed.
name	false	true	java.lang.String
Specifies the name of the ResultFeed to retrieve. If none given it will returns the first ResultFeed found.
feeds	false	true	java.util.Map
The ResultFeed to retrieve from. Object is of type Map(String, ResultFeed).
entry	false	true	com.exalead.access.feedapi.Entry
The Entry to retrieve from.

↑

Tag getFeedUri search:getFeedUri(...)

Returns the ResultFeed URI.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved ResultFeed URI.
base	false	true	java.lang.String
Specifies a base path for the ResultFeed URI.
feed	true	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed to retrieve the URI from. Object is of type ResultFeed.

↑

Tag getFeedInfo search:getFeedInfo(...)

Returns a ResultFeed info.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved ResultFeed info. Object is of type String.
name	true	true	java.lang.String
Name of the ResultFeed info to retrieve.
defaultValue	false	false	java.lang.String
Specifies a default value in case of missing ResultFeed info.
feed	true	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed we want the info from.

↑

Tag getFacet search:getFacet(...)

Returns a MergedFacet from the given Entry or ResultFeed.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported variable for the retrieved MergedFacet.
feeds	false	true	java.util.Map
The ResultFeed containing the facet to retrieve. Object is of type Map(String, ResultFeed).
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the facet to retrieve. Object is of type ResultFeed.
entry	false	true	com.exalead.access.feedapi.Entry
The Entry containing the facet to retrieve.
facetId	true	true	java.lang.String
The Facet ID we want to retrieve ("ex: country").
required	false	true	boolean

↑

Tag getFacetLabel search:getFacetLabel(...)

Returns the localized label for the MergedFacet or the given MergedFacet path.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved MergedFacet label.
facet	false	true	com.exalead.access.feedapi.MergedFacet
The MergedFacet to retrieve the label from.
facetPath	false	true	java.lang.String
The MergedFacet path (Facet) to use for the label.

↑

Tag getFacetType search:getFacetType(...)

Returns the type of the MergedFacet.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved MergedFacet label.
facet	false	true	com.exalead.access.feedapi.MergedFacet
The MergedFacet to retrieve the type from.

↑

Tag getFacetValue search:getFacetValue(...)

Returns the aggregated value of a MergedFacet as a Double.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved MergedFacet aggregation value.
facet	true	true	com.exalead.access.feedapi.AbstractCategory
MergedFacet that contains the value we want to retrieve.
name	true	true	java.lang.String
The name of the aggregated value we want to retrieve.
defaultValue	false	true	java.lang.Double
Specifies the default value if the aggregation value does not exists. Defaults to '0'.

↑

Tag getFacet2D search:getFacet2D(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported variable for the retrieved Facet2D. Object exported is of type Map(String, Map(String, MergedCategory)).
varVerticalCategories	true	false	java.lang.String
Name of the exported variable for the retrieved vertical categories. Object exported is of type Map(String, MergedCategory).
varHorizontalCategories	true	false	java.lang.String
Name of the exported variable for the retrieved horizontal categories. Object exported is of type Map(String, MergedCategory).
varHorizontalRefinedCategories	true	false	java.lang.String
Name of the exported variable for the retrieved horizontal refined categories. Object exported is of type List(MergedCategory).
varVerticalRefinedCategories	true	false	java.lang.String
Name of the exported variable for the retrieved vertical refined categories. Object exported is of type List(MergedCategory).
facetId	false	true	java.lang.String
The Facet ID we want to retrieve ("ex: country").
facetType	false	true	java.lang.String
Specify how to exploit the facet. Can be LEGACY_2D (old 2D category style in v5), MULTI_DIMENSION (new in V6) or HIERARCHICAL_2D (new in V6). Default is MULTI_DIMENSION
feeds	false	true	java.util.Map
The ResultFeed containing the facets to retrieve. Object is of type Map(String, ResultFeed).
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the facets to retrieve. Object is of type ResultFeed.

↑

Tag getFacetAsJson search:getFacetAsJson(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved MergedFacet JSON.
facet	true	true	com.exalead.access.feedapi.MergedFacet
baseUrl	false	true	java.lang.String
The base URL to use to create refinement links.
forceRefineOn	false	true	java.util.List
A list of additional feeds name to refine.
aggregation	false	true	java.lang.String
The name of the aggregation value to use. Defaults is "count".
iterations	false	true	int
How many subcategories to iterate over. Leave blank or set to 0 for infinite iteration
feeds	false	true	java.util.Map
The ResultFeed containing the facet to retrieve. Object is of type Map(String, ResultFeed).
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the facet to retrieve. Object is of type ResultFeed.
sortMode	false	true	java.lang.String
iterationMode	false	true	java.lang.String
Specifies the iteration mode. Possible values are: 'ALL' (hierarchical view), 'LEAVES' (flat view of leaf nodes), 'FLAT' (flat view of the first level). Defaults to 'FLAT'.
forceState	false	false	java.lang.String
Force a refine url to be REFINED, EXCLUDED or CANCELED.
zapRefinements	false	false	boolean
Specifies whether the refinements should be completely cancelled ("false") or only the last level ("true"). Defaults to "false".
drillDown	false	true	boolean
Specifies whether or not the iteration should begin at the deepest refined category. Defaults to 'false'.

↑

Tag getFacetsList search:getFacetsList(...)

Retrieves a list of entry facets ids.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the list of facet ids. Object is of type List(String).
varPaths	false	false	java.lang.String
Name of the exported variable for the list of facet paths. Object is of type List(String).
entry	false	true	com.exalead.access.feedapi.Entry
The Entry containing the facets to retrieve. Object is of type Entry.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the facets to retrieve. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed containing the facets to retrieve. Object is of type Map(String, ResultFeed).
filterMode	false	true	java.lang.String
Specifies how the facets list is handled. The possible values are: 'NO_FILTERING' (ignored), 'EXCLUDE', 'INCLUDE'. Defaults to 'NO_FILTERING'.
facetsList	false	true	java.lang.String
A list of facets separated by a comma. Example: "mime,file_extension".
sortMode	false	true	java.lang.String
Specifies the sort mode for the facets. The possible values are 'DEFAULT', 'DESCRIPTION-ASC', 'DESCRIPTION-DESC', 'SHUFFLE'. Defaults to 'DEFAULT'.

↑

Tag getCategory search:getCategory(...)

Returns a MergedCategory from either a MergedFacet, another MergedCategory, an Entry or a ResultFeed.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported variable for the retrieved MergedCategory.
categoryId	false	true	java.lang.String
Returns the MergedCategory for the given ID.
categoryPath	false	true	java.lang.String
Returns the MergedCategory for the given path.
categoryPosition	false	true	int
Returns the MergedCategory at the given position. The index is '0' based.
facet	false	true	com.exalead.access.feedapi.MergedFacet
The MergedFacet containing the MergedCategory to retrieve.
category	false	true	com.exalead.access.feedapi.AbstractCategory
The MergedCategory containing the MergedCategory to retrieve.
facetId	false	true	java.lang.String
If you specifies an Entry or a ResultFeed, you must specify the facet ID containing the MergedCategory to retrieve.
entry	false	true	com.exalead.access.feedapi.Entry
The Entry containing the MergedCategory to retrieve.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the MergedCategory to retrieve.
iterationMode	false	true	java.lang.String
Specifies the iteration mode. Possible values are: 'ALL' (hierarchical view), 'LEAVES' (flat view of leaf nodes), 'FLAT' (flat view of the first level). Defaults to 'FLAT'.

↑

Tag getCategoryValue search:getCategoryValue(...)

Returns the aggregated value of a MergedCategory as a Double.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved MergedCategory aggregation value.
category	false	true	com.exalead.access.feedapi.AbstractCategory
Category that contains the value we want to retrieve.
parentCategory	false	true	com.exalead.access.feedapi.CategoryTreeContainer
Specifies a parent Category to retrieve the SUM of its categories' aggregated values.
iterationMode	false	true	java.lang.String
Sets th e iteration mode if parentCategory is specified. Possible values are: 'ALL' (hierarchical view), 'LEAVES' (flat view of leaf nodes), 'FLAT' (flat view of the first level). Defaults to 'FLAT'.
name	true	true	java.lang.String
The name of the aggregated value we want to retrieve.
defaultValue	false	true	java.lang.Object
Specifies the default value if the aggregation value does not exists. Defaults to '0'.

↑

Tag getCategoryState search:getCategoryState(...)

Returns the current State of a MergedCategory. It can be either "DISPLAYED", "EXCLUDED" or "REFINED".

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved MergedCategory state.
varClassName	false	false	java.lang.String
Name of the exported variable for the retrieved MergedCategory CSS class name.
category	true	true	com.exalead.access.feedapi.AbstractCategory
The MergedCategory to retrieve state from.

↑

Tag getCategoryLabel search:getCategoryLabel(...)

Returns the localized label for the MergedCategory or the given MergedCategory path.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved MergedCategory label.
category	false	true	com.exalead.access.feedapi.AbstractCategory
The MergedCategory to retrieve label from.
categoryPath	false	true	java.lang.String
The MergedCategory path (Facet/Category) to use for the label.

↑

Tag getCategoryUrl search:getCategoryUrl(...)

Returns the category refinement URL depending on its current state.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved MergedCategory refinement URL. NULL if not refinable.
varClassName	false	false	java.lang.String
Name of the exported variable for the css class of te URL.
category	false	true	com.exalead.access.feedapi.AbstractCategory
categories	false	true	java.util.List
baseUrl	false	true	java.lang.String
The URL to be processed. It can be either relative or absolute.
feeds	false	true	java.util.Map
The ResultFeed to use for the URL creation. Object is of type Map(String, ResultFeed).
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed to use for the URL creation. Object is of type ResultFeed.
forceState	false	true	java.lang.String
Force the refine state. The possible values are: "REFINED", "EXCLUDED" or "DISPLAYED".
forceRefineOn	false	true	java.util.List
A list of additional feeds name to refine.
zapRefinements	false	true	boolean
Specifies whether the refinements should be completely cancelled ("false") or only the last level ("true"). Defaults to "false".
forHtml	false	false	java.lang.Boolean
if true & will be replaced by & amp;. Default is true.

↑

Tag getCategory2DUrl search:getCategory2DUrl(...)

Returns the matrix category refinement URL depending on its current state.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved MergedCategory refinement URL. NULL if not refinable.
category	true	true	com.exalead.access.feedapi.AbstractCategory
baseUrl	false	true	java.lang.String
The URL to be processed. It can be either relative or absolute.
feeds	false	true	java.util.Map
The ResultFeed to use for the URL creation. Object is of type Map(String, ResultFeed).
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed to use for the URL creation. Object is of type ResultFeed.
forceState	false	true	java.lang.String
Force the refine state. The possible values are: "REFINED", "EXCLUDED" or "DISPLAYED".
forceRefineOn	false	true	java.util.List
A list of additional feeds name to refine.
zapRefinements	false	true	boolean
Specifies whether the refinements should be completely cancelled ("false") or only the last level ("true"). Defaults to "false".

↑

Tag getEntry search:getEntry(...)

Returns an Entry of a ResultFeed.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported variable for the retrieved Entry.
position	false	true	int
The position of the Entry to retrieve. Defaults to '0'.
feeds	false	true	java.util.Map
The ResultFeed containing the Entry to retrieve. Object is of type Map(String, ResultFeed).
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the Entry to retrieve. Object is of type ResultFeed.

↑

Tag getEntryInfo search:getEntryInfo(...)

Returns an info from a given Entry.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved Entry info. Object is of type String.
name	true	true	java.lang.String
Name of the Entry info to retrieve.
defaultValue	false	false	java.lang.String
Specifies a default value in case of missing Entry info.
entry	true	true	com.exalead.access.feedapi.Entry
The Entry we want the info from.

↑

Tag getEntryIconUrl search:getEntryIconUrl(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved Entry icon URL.
entry	true	true	com.exalead.access.feedapi.Entry
The Entry we want the icon URL from.
facetsList	false	false	java.lang.String
A list of facet roots separated by a comma to use to retrieve the mapped Entry icon. Example: "mime,file_extension".

↑

Tag getEntryThumbnailUrl search:getEntryThumbnailUrl(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved Entry thumbnail URL.
varKind	false	false	java.lang.String
Name of the exported variable for the retrieved thumbnail kind. Possible values are: "CLOUDVIEW_THUMBNAIL", "ENTRY_THUMBNAIL", "DEFAULT_THUMBNAIL", "MAPPED_THUMBNAIL".
entry	true	true	com.exalead.access.feedapi.Entry
The Entry we want the thumbnail URL from.
feed	true	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the Entry. Object is of type ResultFeed.
facetsList	false	true	java.lang.String
A list of facet roots separated by a comma to use to retrieve the mapped Entry thumbnail. Example: "mime,file_extension".
mimeFacetsList	false	true	java.lang.String
A list of facet roots separated by a comma to use to retrieve the Entry Mime-Type. Example: "mime".
useFetchClient	false	true	boolean
defaultThumbnail	false	true	java.lang.String
urlEscape	false	false	boolean

↑

Tag getEntryDownloadUrl search:getEntryDownloadUrl(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved Entry download URL.
entry	true	true	com.exalead.access.feedapi.Entry
The Entry we want the download URL from.
feed	true	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the Entry. Object is of type ResultFeed.
urlEscape	false	false	boolean
inline	false	true	boolean
Specify whether the download should be inlined (ie: opened by the browser).
mimeFacetsList	false	true	java.lang.String
A list of facet roots separated by a comma to use to retrieve the Entry Mime-Type. Example: "mime".

↑

Tag getEntryHtmlPreviewUrl search:getEntryHtmlPreviewUrl(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved Entry HTML preview URL.
entry	true	true	com.exalead.access.feedapi.Entry
The Entry we want the HTML preview URL from.
feed	true	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the Entry. Object is of type ResultFeed.
urlEscape	false	false	boolean
mimeFacetsList	false	true	java.lang.String
A list of facet roots separated by a comma to use to retrieve the Entry Mime-Type. Example: "mime".

↑

Tag getEntryImagePreviewUrl search:getEntryImagePreviewUrl(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved Entry image preview URL.
entry	true	true	com.exalead.access.feedapi.Entry
The Entry we want the image preview URL from.
feed	true	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the Entry. Object is of type ResultFeed.
urlEscape	false	false	boolean
mimeFacetsList	false	true	java.lang.String
A list of facet roots separated by a comma to use to retrieve the Entry Mime-Type. Example: "mime".

↑

Tag getEntryUri search:getEntryUri(...)

Returns the Entry URI.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved Entry URI.
base	false	true	java.lang.String
Specifies a base path for the Entry URI.
entry	true	true	com.exalead.access.feedapi.Entry
The Entry to retrieve the URI from. Object is of type Entry.

↑

Tag getMeta search:getMeta(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported variable for the retrieved Meta. Object exported is of type Meta.
entry	true	true	com.exalead.access.feedapi.Entry
The Entry containing the meta to retrieve.
metaName	true	true	java.lang.String
Specifies the name of the meta to retrieve.

↑

Tag getMetaValue search:getMetaValue(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved Meta value. Object exported is of type String.
entry	false	true	com.exalead.access.feedapi.Entry
The Entry containing the meta value to retrieve.
metaName	false	true	java.lang.String
If 'entry' is set: Specifies the name of the meta to retrieve the value from.
meta	false	true	com.exalead.access.feedapi.Meta
The Meta containing the value to retrieve.
isHighlighted	false	true	boolean
Specifies whether to retrieve the highlighted meta value or not. Defaults to 'true'.

↑

Tag getMetaValues search:getMetaValues(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved Meta values. Object exported is of type List(String) if no glue is given, String otherwise.
entry	false	true	com.exalead.access.feedapi.Entry
The Entry containing the meta values to retrieve.
metaName	false	true	java.lang.String
If 'entry' is set: Specifies the name of the meta to retrieve the values from.
meta	false	true	com.exalead.access.feedapi.Meta
The Meta containing the values to retrieve.
isHighlighted	false	true	boolean
Specifies whether to retrieve the highlighted meta value or not. Defaults to 'true'.
glue	false	true	java.lang.String

↑

Tag getMetaLabel search:getMetaLabel(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved Meta label.
meta	false	true	com.exalead.access.feedapi.Meta
metaName	false	true	java.lang.String

↑

Tag getMetasList search:getMetasList(...)

Retrieves a list of metas names.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	true	false	java.lang.String
Name of the exported variable for the list of Meta names. Object is of type List(String).
entry	false	true	com.exalead.access.feedapi.Entry
The Entry containing the metas to retrieve. Object is of type Entry.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed containing the metas to retrieve. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed containing the metas to retrieve. Object is of type Map(String, ResultFeed).
filterMode	false	true	java.lang.String
Specifies how the metas list is handled. The possible values are: 'NO_FILTERING' (ignored), 'EXCLUDE', 'INCLUDE'. Defaults to 'NO_FILTERING'.
metasList	false	true	java.lang.String
A list of metas separated by a comma. Example: "file_name,file_extension".
sortMode	false	true	java.lang.String
Specifies the sort mode for the metas. The possible values are 'DEFAULT', 'DESCRIPTION-ASC', 'DESCRIPTION-DESC', 'SHUFFLE'. Defaults to 'DEFAULT'.

↑

Tag getPaginationInfos search:getPaginationInfos(...)

Returns various informations about the pagination.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
varFeed	false	false	java.lang.String
Name of the exported variable for the ResultFeed with the most results.
varCurrentPage	false	false	java.lang.String
Name of the exported variable for the current page.
varLastPage	false	false	java.lang.String
Name of the exported variable for the last page.
varPerPage	false	false	java.lang.String
Name of the exported variable for the per page value.
varStart	false	false	java.lang.String
Name of the exported variable for the start index.
varEnd	false	false	java.lang.String
Name of the exported variable for the end index.
varTotal	false	false	java.lang.String
Name of the exported variable for the total results.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed we paginate from. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed we paginate from. Object is of type Map(String, ResultFeed).

↑

Tag getPage search:getPage(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved page number.
varUrl	false	false	java.lang.String
Name of the exported variable for the retrieved page URL.
pageNumber	true	true	int
The page to retrieve. The page number must be between 1 and the last page otherwise NULL is returned.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed we paginate from. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed we paginate from. Object is of type Map(String, ResultFeed).

↑

Tag getPageFirst search:getPageFirst(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved page number.
varUrl	false	false	java.lang.String
Name of the exported variable for the retrieved page URL.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed we paginate from. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed we paginate from. Object is of type Map(String, ResultFeed).

↑

Tag getPageLast search:getPageLast(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved page number.
varUrl	false	false	java.lang.String
Name of the exported variable for the retrieved page URL.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed we paginate from. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed we paginate from. Object is of type Map(String, ResultFeed).

↑

Tag getPagePrevious search:getPagePrevious(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved page number.
varUrl	false	false	java.lang.String
Name of the exported variable for the retrieved page URL.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed we paginate from. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed we paginate from. Object is of type Map(String, ResultFeed).

↑

Tag getPageNext search:getPageNext(...)

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved page number.
varUrl	false	false	java.lang.String
Name of the exported variable for the retrieved page URL.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed we paginate from. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed we paginate from. Object is of type Map(String, ResultFeed).

↑

Tag getPageName search:getPageName(...)

Returns the name of the current page.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved page name.

↑

Tag getPageFeed search:getPageFeed(...)

Returns the ResultFeed of the current page.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the retrieved page ResultFeed.

↑

Tag getSpellCheckSuggestions search:getSpellCheckSuggestions(...)

Returns the spellcheck suggestions of the given ResultFeed.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the suggestions. Object is of type List(String), NULL if no suggestions.
varObject	false	false	java.lang.String
Name of the exported variable for the suggestions. Object is of type List(SpellCheckSuggestion), NULL if no suggestions.
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed we retrieve spellcheck suggestions from. Object is of type ResultFeed.
feeds	false	true	java.util.Map
The ResultFeed we retrieve spellcheck suggestions from. Object is of type Map(String, ResultFeed).
max	false	true	int
The maximum number of suggestions to returns. By defaults all the suggestions are returned.

↑

Tag getSortUrl search:getSortUrl(...)

Returns a contextual sort URL that can use whether the given sort expression, its reversed version or without it.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the sort URL.
varState	false	false	java.lang.String
Name of the exported variable for whether the var is the sort currently active. The values can be "ordered", "ordered_asc", "ordered_desc" or "".
baseUrl	false	true	java.lang.String
The URL to be processed. It can be either relative or absolute.
feeds	false	true	java.util.Map
The ResultFeed to use for the URL creation. Object is of type Map(String, ResultFeed).
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed to use for the URL creation. Object is of type ResultFeed.
expr	false	true	java.lang.String
Specifies the sort expression.
defaultOrder	false	true	java.lang.String
Specifies a default order when no sort is applied yet. Possible values are: 'DESC' or 'ASC'.
forceReverse	false	true	boolean
Specifies whether we want to force the reversed or the not reversed version of the given expression.

↑

Tag serializeFeed search:serializeFeed(...)

Serialize in JSON the given ResultFeed.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the JSON.
serializeFacets	false	true	boolean
Specifies whether to serialize or not the facets.
serializeHits	false	true	boolean
Specifies whether to serialize or not the hits.
feeds	false	true	java.util.Map
The ResultFeed to serialize. Object is of type Map(String, ResultFeed).
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed to serialize. Object is of type ResultFeed.

↑

Function hasFeeds search:hasFeeds(...)

Returns whether the given set of ResultFeed has entries or not.

Function Class: com.exalead.cv360.searchui.view.jspapi.search.Functions

Function Signature: boolean hasFeeds(java.util.Map)

Example

			 < c:if test="${search:hasFeeds(feeds)}" >

↑

Function hasEntries search:hasEntries(...)

Returns whether the given set of ResultFeed has entries or not.

Function Class: com.exalead.cv360.searchui.view.jspapi.search.Functions

Function Signature: boolean hasEntries(java.util.Map)

Example

			 < c:if test="${search:hasEntries(feeds)}" >

↑

Function hasCategories search:hasCategories(...)

Returns whether the given MergedFacet or MergedCategory has categories or not.

Function Class: com.exalead.cv360.searchui.view.jspapi.search.Functions

Function Signature: boolean hasCategories(com.exalead.access.feedapi.AbstractCategory)

Example

			 < c:if test="${search:hasCategories(category)}" >

↑

Function hasSpellCheckSuggestions search:hasSpellCheckSuggestions(...)

Returns whether the given set of ResultFeed has spellcheck suggestions or not.

Function Class: com.exalead.cv360.searchui.view.jspapi.search.Functions

Function Signature: boolean hasSpellCheckSuggestions(java.util.Map)

Example

			 < c:if test="${search:hasSpellCheckSuggestions(feeds)}" >

↑

Function hasEntryDownloadUrl search:hasEntryDownloadUrl(...)

Returns whether the given Entry has a download URL or not.

Function Class: com.exalead.cv360.searchui.view.jspapi.search.Functions

Function Signature: boolean hasEntryDownloadUrl(com.exalead.access.feedapi.Entry)

Example

			 < c:if test="${search:hasEntryDownloadUrl(entry)}" >

↑

Function hasEntryHtmlPreviewUrl search:hasEntryHtmlPreviewUrl(...)

Returns whether the given Entry has an HTML preview URL or not.

Function Class: com.exalead.cv360.searchui.view.jspapi.search.Functions

Function Signature: boolean hasEntryHtmlPreviewUrl(com.exalead.access.feedapi.Entry)

Example

			 < c:if test="${search:hasEntryHtmlPreviewUrl(entry)}" >

↑

Function hasEntryImagePreviewUrl search:hasEntryImagePreviewUrl(...)

Returns whether the given Entry has an image preview URL or not.

Function Class: com.exalead.cv360.searchui.view.jspapi.search.Functions

Function Signature: boolean hasEntryImagePreviewUrl(com.exalead.access.feedapi.Entry)

Example

			 < c:if test="${search:hasEntryImagePreviewUrl(entry)}" >

search Taglib documentation

Tag forEachPage search:forEachPage(...)

Tag forEachFeed search:forEachFeed(...)

Tag forEachEntry search:forEachEntry(...)

Tag forEachMeta search:forEachMeta(...)

Tag forEachMetaValue search:forEachMetaValue(...)

Tag forEachFacet search:forEachFacet(...)

Tag forEachCategory search:forEachCategory(...)

Tag forEachCategoryPath search:forEachCategoryPath(...)

Example

Tag forEachSpellCheckSuggestion search:forEachSpellCheckSuggestion(...)

Tag getFeed search:getFeed(...)

Tag getFeedUri search:getFeedUri(...)

Tag getFeedInfo search:getFeedInfo(...)

Tag getFacet search:getFacet(...)

Tag getFacetLabel search:getFacetLabel(...)

Tag getFacetType search:getFacetType(...)

Tag getFacetValue search:getFacetValue(...)

Tag getFacet2D search:getFacet2D(...)

Tag getFacetAsJson search:getFacetAsJson(...)

Tag getFacetsList search:getFacetsList(...)

Tag getCategory search:getCategory(...)

Tag getCategoryValue search:getCategoryValue(...)

Tag getCategoryState search:getCategoryState(...)

Tag getCategoryLabel search:getCategoryLabel(...)

Tag getCategoryUrl search:getCategoryUrl(...)

Tag getCategory2DUrl search:getCategory2DUrl(...)

Tag getEntry search:getEntry(...)

Tag getEntryInfo search:getEntryInfo(...)

Tag getEntryIconUrl search:getEntryIconUrl(...)

Tag getEntryThumbnailUrl search:getEntryThumbnailUrl(...)

Tag getEntryDownloadUrl search:getEntryDownloadUrl(...)

Tag getEntryHtmlPreviewUrl search:getEntryHtmlPreviewUrl(...)

Tag getEntryImagePreviewUrl search:getEntryImagePreviewUrl(...)

Tag getEntryUri search:getEntryUri(...)

Tag getMeta search:getMeta(...)

Tag getMetaValue search:getMetaValue(...)

Tag getMetaValues search:getMetaValues(...)

Tag getMetaLabel search:getMetaLabel(...)

Tag getMetasList search:getMetasList(...)

Tag getPaginationInfos search:getPaginationInfos(...)

Tag getPage search:getPage(...)

Tag getPageFirst search:getPageFirst(...)

Tag getPageLast search:getPageLast(...)

Tag getPagePrevious search:getPagePrevious(...)

Tag getPageNext search:getPageNext(...)

Tag getPageName search:getPageName(...)

Tag getPageFeed search:getPageFeed(...)

Tag getSpellCheckSuggestions search:getSpellCheckSuggestions(...)

Tag getSortUrl search:getSortUrl(...)

Tag serializeFeed search:serializeFeed(...)

Function hasFeeds search:hasFeeds(...)

Example

Function hasEntries search:hasEntries(...)

Example

Function hasCategories search:hasCategories(...)

Example

Function hasSpellCheckSuggestions search:hasSpellCheckSuggestions(...)

Example

Function hasEntryDownloadUrl search:hasEntryDownloadUrl(...)

Example

Function hasEntryHtmlPreviewUrl search:hasEntryHtmlPreviewUrl(...)

Example

Function hasEntryImagePreviewUrl search:hasEntryImagePreviewUrl(...)

Example

Function cleanEntryId search:cleanEntryId(...)

Example

Function cleanMetaId search:cleanMetaId(...)

Example

Function cleanFacetId search:cleanFacetId(...)

Example