- GeoFilter - Class in com.endeca.infront.navigation.model
-
A geocode range filter.
- GeoFilter() - Constructor for class com.endeca.infront.navigation.model.GeoFilter
-
Creates a geocode range filter.
- GeoFilter(String, double, double, double) - Constructor for class com.endeca.infront.navigation.model.GeoFilter
-
- GeoFilterBreadcrumb - Class in com.endeca.infront.cartridge.model
-
GeoFilterBreadcrumb is the model for a view of a geo range filter
a.k.a., a breadcrumb.
- GeoFilterBreadcrumb() - Constructor for class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
- GeoSortSpec - Class in com.endeca.infront.navigation.model
-
- GeoSortSpec() - Constructor for class com.endeca.infront.navigation.model.GeoSortSpec
-
- GeoSortSpec(String, boolean, double, double) - Constructor for class com.endeca.infront.navigation.model.GeoSortSpec
-
- getActionPathProvider() - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
-
Gets the
ActionPathProvider used to determine the site root
path and content path when creating
Action objects.
- getAdjustedSearches() - Method in class com.endeca.infront.cartridge.SearchAdjustments
-
Gets automatically modified search terms from
spell correction or phrasing.
- getAdjustedTerms() - Method in class com.endeca.infront.cartridge.model.AdjustedSearch
-
- getAggregateRecordSpecParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getAggrERec() - Method in interface com.endeca.soleng.urlformatter.AggrERecUrlParam
-
The AggrERec contained by this parameter.
- getAggrERec() - Method in class com.endeca.soleng.urlformatter.UrlState
-
Returns the associated AggrERec for this UrlState.
- getAggrERecFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
The AggrERecFormatter used to render aggregate record
attributes to the URL path keywords.
- getAggrERecParamKey() - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
-
- getAggrERecParamKey() - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
-
The parameter key used for aggregate record detail links - typically "A".
- getAncestors() - Method in class com.endeca.infront.cartridge.model.DimensionSearchValue
-
- getAncestors() - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
- getAncestors() - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Returns the ancestors up to but excluding the Dimension root for this RefinementMenu.
- getAppendAncestors() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
Indicates whether or not to append ancestor DimVal
names to the URL.
- getAppendDescriptor() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
Indicates whether or not to append the descriptor DimVal
name to the URL.
- getAppendRoot() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
Indicates whether or not to append the root DimVal
name to the URL.
- getAscending() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
-
- getAscendingAction() - Method in class com.endeca.infront.cartridge.model.Sort
-
This label's action when the sort is "ascending"
- getAttributes() - Method in class com.endeca.infront.cartridge.model.Record
-
Record attribute (property and dimension) values, indexed by name string.
- getAuditContents(String, int) - Method in class com.endeca.infront.content.MdexContentRequestBroker
-
This method is for internal Oracle use only and should never be called.
If audit is enabled, returns the audit contents.
- getAuditContents(List<String>, List<String>, List<String>, int) - Method in class com.endeca.infront.content.MdexContentRequestBroker
-
This method is for internal Oracle use only and should never be called.
If audit is enabled, returns the audit contents.
- getAutocorrectTo() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getAutophraseParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
The parameter key used for autophrase - defaults to "Ntp"
- getBaseAggrERecUrlENEQuery() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
- getBaseERecUrlENEQuery() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
- getBaseNavigationUrlENEQuery() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
- getBaseUrlENEQuery() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
- getBoostRefinements() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Returns a list of DVal Specs.
- getBoostStrata() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Returns filters which allow items to be boosted to the top of the results.
- getBound1() - Method in class com.endeca.infront.navigation.model.RangeFilter
-
A bound value used for comparison operations.
- getBound2() - Method in class com.endeca.infront.navigation.model.RangeFilter
-
A second bound value used only by the between operation (Operation.BTWN).
- getBuryRefinements() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Returns a list of DVal Specs.
- getBuryStrata() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Returns filters which allow items to be buried at the bottom of the results.
- getCanonicalLink() - Method in interface com.endeca.infront.navigation.NavigationState
-
Retrieves the canonical link relative to this RecordState.
- getCanonicalLink() - Method in interface com.endeca.infront.navigation.RecordState
-
Retrieves the canonical link relative to this RecordState.
- getCanonicalLink() - Method in class com.endeca.soleng.urlformatter.UrlState
-
Returns a canonical link for this UrlState.
- getCollapseAction() - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Returns the action for collapsing this RefinementMenu.
- getContent(ContentLocator) - Method in class com.endeca.infront.cartridge.RedirectAwareContentIncludeHandler
-
Adds keyword redirect information, if a redirect was triggered.
- getContentBytes() - Method in class com.endeca.infront.cartridge.model.MediaObject
-
- getContentHeight() - Method in class com.endeca.infront.cartridge.model.MediaObject
-
- getContentItemInitializer() - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
-
Returns the ContentItemInitializer used to create the full cartridge
configuration.
- getContentPath() - Method in class com.endeca.infront.cartridge.model.Action
-
- getContentPath() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getContentPaths(String, int) - Method in class com.endeca.infront.content.MdexContentRequestBroker
-
This method is for internal Oracle use only and should never be called.
Query for rule-triggered content paths from a specified content collection.
- getContentPaths(List<String>, List<String>, List<String>, int) - Method in class com.endeca.infront.content.MdexContentRequestBroker
-
This method is for internal Oracle use only and should never be called.
Query for rule-triggered content paths given list of content paths, template types and template IDs.
- getContentSource() - Method in class com.endeca.infront.assembler.servlet.AbstractPreviewLinkServlet
-
A method to retrieve a ContentSource to use for
creating links.
- getContentSource() - Method in class com.endeca.infront.assembler.servlet.spring.SpringPreviewLinkServlet
-
Retrieves an ContentSource using the Spring Framework.
- getContentSource() - Method in class com.endeca.infront.cartridge.MediaBannerHandler
-
Returns the content source that will be used to create
Action objects.
- getContentSrcKey() - Method in class com.endeca.infront.cartridge.model.MediaObject
-
Gets the key that will be used to identify the content source of the
object.
- getContentType() - Method in class com.endeca.infront.cartridge.model.MediaObject
-
- getContentWidth() - Method in class com.endeca.infront.cartridge.model.MediaObject
-
- getCorrectedTerms() - Method in class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
- getCount() - Method in class com.endeca.infront.cartridge.model.Refinement
-
- getCount() - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
- getCount() - Method in class com.endeca.infront.cartridge.model.SuggestedSearch
-
Gets the number of records that will be returned if this suggested search is applied.
- getDefaultEncoding() - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
-
Returns the default encoding for this URL formatter.
- getDefaultEncoding() - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
-
Returns the default character encoding that should be used when
transforming URLs to and from various string forms.
- getDefaultFilterState() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
If null, a new FilterState will be created and
its standard defaults will be used.
- getDefaultMatchMode() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getDefaultNavigationActionContentPath() - Method in interface com.endeca.infront.navigation.url.ActionPathProvider
-
- getDefaultNavigationActionSiteRootPath() - Method in interface com.endeca.infront.navigation.url.ActionPathProvider
-
- getDefaultRecordActionContentPath() - Method in interface com.endeca.infront.navigation.url.ActionPathProvider
-
- getDefaultRecordActionSiteRootPath() - Method in interface com.endeca.infront.navigation.url.ActionPathProvider
-
- getDefaultSearchKey() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getDefaultUrlENEQuery() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
- getDescendingAction() - Method in class com.endeca.infront.cartridge.model.Sort
-
This label's action when the sort is "descending"
- getDetailsAction() - Method in class com.endeca.infront.cartridge.model.Record
-
- getDidYouMeanTo() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getDimensionId() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Returns the Dimension ID which identifies the Endeca Dimension to be used for this RefinementMenu.
- getDimensionList() - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
Returns the dimensions that will be used for dimension search.
- getDimensionName() - Method in class com.endeca.infront.cartridge.model.DimensionSearchGroup
-
- getDimensionName() - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
- getDimensionName() - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Returns the dimension name associated with this RefinementMenu.
- getDimensionName() - Method in class com.endeca.infront.navigation.model.DimensionFilter
-
The name of the parent dimension.
- getDimensions() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getDimensionSearchFilter(NavigationState) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsHandler
-
Gets the SearchFilter used for the dimension search.
- getDimensionSearchGroups() - Method in class com.endeca.infront.cartridge.DimensionSearchResults
-
Returns a List of dimension search groups.
- getDimensionSearchValues() - Method in class com.endeca.infront.cartridge.model.DimensionSearchGroup
-
- getDimensionValues() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getDimLocation(String) - Method in interface com.endeca.infront.navigation.NavigationState
-
This method is for internal Oracle use only and should never be
called.
Returns the meta-information pertaining to the given dimension value ID.
- getDimLocationFormatters() - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
-
- getDimLocationFormatters() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
-
The list of DimLocationFormatters that will be used to format the UrlState.
- getDimLocationList() - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam
-
Internal method delegated from an UrlState.
- getDimValStringFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
The StringFormatter that is used to process the
ancestor and descriptor DimVal names.
- getDisplayName() - Method in class com.endeca.infront.cartridge.model.DimensionSearchGroup
-
- getDisplayName() - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
- getDisplayName() - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Returns the localized display name for the dimension associated with this RefinementMenu.
- getDvalId() - Method in class com.endeca.infront.navigation.model.DimensionFilter
-
The selected dimension value ID.
- getEncodedKey() - Method in interface com.endeca.soleng.urlformatter.UrlParam
-
The encoded key.
- getEncodedValue() - Method in interface com.endeca.soleng.urlformatter.UrlParam
-
The encoded string value.
- getEncoding() - Method in class com.endeca.soleng.urlformatter.UrlState
-
Returns the character encoding that is used when marshaling parameters
and strings contained within this UrlState.
- getEneTime() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getEqlExpression() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getEqlFilter() - Method in class com.endeca.infront.navigation.model.FilterState
-
Returns the EQL filter associated with this filter state.
- getEqlParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getERec() - Method in interface com.endeca.soleng.urlformatter.ERecUrlParam
-
The ERec contained by this parameter.
- getERec() - Method in class com.endeca.soleng.urlformatter.UrlState
-
Returns the associated ERec for this UrlState.
- getERecFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
The ERecFormatter used to render endeca record
attributes to the URL path keywords.
- getERecParamKey() - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
-
- getERecParamKey() - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
-
The parameter key used for record detail links - typically "R".
- getExpandAction() - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Returns the action for expanding this RefinementMenu.
- getExpression() - Method in class com.endeca.infront.navigation.model.EqlFilter
-
Returns the EQL expression.
- getFeaturedRecords() - Method in class com.endeca.infront.navigation.model.FilterState
-
Returns a List of featured records, or an empty list
if no featured records are specified.
- getFeaturedRecordsParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getFieldName() - Method in class com.endeca.infront.cartridge.model.Sort
-
name of the field that will be sorted
- getFilterState(NavigationState) - Method in class com.endeca.infront.cartridge.RecordDetailsHandler
-
Retrieves the filter state to use when making record detail queries.
- getFilterState() - Method in class com.endeca.infront.cartridge.RecordSpotlightSelection
-
Returns the filter state.
- getFilterState() - Method in interface com.endeca.infront.navigation.NavigationState
-
The FilterState object that is returned from this
method is immutable, and never null.
- getFirstRecNum() - Method in class com.endeca.infront.cartridge.ResultsList
-
One-based index of the first record in the records list.
- getGeoFilter() - Method in class com.endeca.infront.navigation.model.FilterState
-
- getGeoFilterCrumb() - Method in class com.endeca.infront.cartridge.Breadcrumbs
-
The active geo filter.
- getGeoFilterParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getHost() - Method in class com.endeca.infront.navigation.model.MdexResource
-
- getId() - Method in class com.endeca.infront.navigation.model.DvalSpec
-
- getIgnoreCase() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
-
- getIncludedParameters() - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
-
- getInnerFilter() - Method in class com.endeca.infront.navigation.model.CollectionFilter
-
- getInterpretedTerms() - Method in class com.endeca.infront.cartridge.SearchAdjustments
-
Gets debug information on how search terms are interpreted.
- getIsPathParam() - Method in interface com.endeca.soleng.urlformatter.seo.SeoUrlParam
-
- getKey() - Method in class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
- getKey() - Method in class com.endeca.infront.navigation.model.SearchFilter
-
The Endeca search key.
- getKey() - Method in class com.endeca.infront.navigation.model.SortSpec
-
The name of the sort attribute or interface.
- getKey() - Method in interface com.endeca.soleng.urlformatter.seo.DimLocationFormatter
-
The dimension name or id used to associate a DimLocationFormatter
with a specific dimension.
- getKey() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
The dimension name or id used to associate a DimLocationFormatter
with a specific dimension.
- getKey() - Method in interface com.endeca.soleng.urlformatter.UrlParam
-
The parameter key.
- getLabel() - Method in class com.endeca.infront.cartridge.model.Action
-
- getLabel() - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
- getLabel() - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
- getLabel() - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
- getLabel() - Method in class com.endeca.infront.cartridge.model.SortOptionConfig
-
Text used to demonstrate sort information.
- getLabel() - Method in class com.endeca.infront.navigation.model.SortOption
-
The display name for this sorting option (optional).
- getLanguageId() - Method in class com.endeca.infront.navigation.model.FilterState
-
- getLanguageParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getLastRecNum() - Method in class com.endeca.infront.cartridge.ResultsList
-
One-based index of the last record in the records list.
- getLatitude() - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
- getLatitude() - Method in class com.endeca.infront.navigation.model.GeoFilter
-
- getLessLink() - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Returns the action for collapsing the RefinementMenu.
- getLessLinkText() - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Returns display text for 'less' links.
- getLessLinkText() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
When showMoreLink and isShowMore() is true, this text is used in the creation of the 'less' link.
- getLimit() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
A helper method for resolving the number of refinements to include.
- getLink() - Method in class com.endeca.infront.cartridge.MediaBanner
-
Returns the
Action object used to construct the link
which fires when the media is clicked.
- getLink() - Method in class com.endeca.infront.cartridge.MediaBannerConfig
-
Returns the
LinkBuilder object used to construct the link
which fires when the media is clicked (if desired).
- getLinkType() - Method in class com.endeca.infront.cartridge.model.LinkBuilder
-
- getLocation() - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
The cached result of a reverse geocode lookup,
for instance '101 Main Street, Cambridge MA'.
- getLongitude() - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
- getLongitude() - Method in class com.endeca.infront.navigation.model.GeoFilter
-
- getLowerBound() - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
- getMatchMode() - Method in class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
- getMatchMode() - Method in class com.endeca.infront.navigation.model.SearchFilter
-
The Endeca match mode.
- getMaxNumRecords() - Method in class com.endeca.infront.cartridge.RecordSpotlightConfig
-
The maximum number of records that will be returned.
- getMaxNumRefinements() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
The maximum number of refinements which will be shown when showMore has a value of "true".
- getMaxResults() - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
Returns the maximum total number of dimension search results.
- getMaxResultsPerDimension() - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
Returns the maximum number of dimension search results returned
for each dimension.
- getMdexRequestBroker() - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
-
Used to construct MDEX requests.
- getMdexRequestBroker() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Used to construct MDEX requests.
- getMdexResource() - Method in class com.endeca.infront.navigation.MdexRequestBroker
-
This method is for internal Oracle use only and should never be called.
Gets the MDEX resource that will be used to create requests.
- getMedia() - Method in class com.endeca.infront.cartridge.MediaBanner
-
Returns the media object to be displayed.
- getMedia() - Method in class com.endeca.infront.cartridge.MediaBannerConfig
-
Returns the media object to be displayed.
- getMediaSourceList() - Method in class com.endeca.infront.cartridge.MediaBannerHandler
-
- getMoreLink() - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Returns the action for expanding the RefinementMenu.
- getMoreLinkText() - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Returns display text for 'more' links.
- getMoreLinkText() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
When showMoreLink is true, and more refinements are available than are included in the RefinementMenu,
this text is used in the link creation.
- getName() - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
- getName() - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
- getName() - Method in class com.endeca.infront.navigation.model.DvalSpec
-
- getName() - Method in class com.endeca.infront.navigation.model.PropertyFilter
-
The property name.
- getNavigation() - Method in class com.endeca.infront.cartridge.NavigationContainer
-
Returns a list of RefinementMenu items in this NavigationContainer.
- getNavigationFilters() - Method in class com.endeca.infront.navigation.model.FilterState
-
Returns a List of navigation filters (dimension value IDs), or an empty
list if no navigation filters are specified.
- getNavigationFiltersParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getNavigationState() - Method in class com.endeca.infront.cartridge.model.NavigationAction
-
- getNavigationState() - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
-
Gets the navigation state represented by the current request.
- getNavigationStateBuilder() - Method in class com.endeca.infront.assembler.servlet.AbstractPreviewLinkServlet
-
- getNavigationStateBuilder() - Method in class com.endeca.infront.assembler.servlet.spring.SpringPreviewLinkServlet
-
- getNavigationStateBuilder() - Method in class com.endeca.infront.cartridge.MediaBannerHandler
-
Returns the NavigationStateBuilder that will be used by
the LinkBuilder to create a navigation state and
generate links.
- getNavigationStateId() - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
-
- getNavState() - Method in class com.endeca.soleng.urlformatter.UrlState
-
Returns the navigation state for this UrlState or null
if there is no navigation state.
- getNavStateCanonicalizer() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
Returns the canonicalizer used to sort the navigation state before
rendering an UrlState.
- getNavStateFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
The NavStateFormatter property used to render navigation
state information to the URL path keywords.
- getNavStateParamKey() - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
-
- getNavStateParamKey() - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
-
The parameter key used for navigation state - typically "N".
- getNumRecords() - Method in class com.endeca.infront.cartridge.model.Record
-
If aggregate record is enabled, gets the total number of
records in the aggregate.
- getNumRecords() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getNumRefinements() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
The maximum number of refinements which will be shown when showMore has a value of "false"
- getNumRefinements() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getObjectLocator() - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
-
- getOffset() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Returns the record offset.
- getOperands() - Method in class com.endeca.infront.navigation.model.ComboFilter
-
- getOperation() - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
- getOperation() - Method in class com.endeca.infront.navigation.model.RangeFilter
-
- getOriginalTerms() - Method in class com.endeca.infront.cartridge.SearchAdjustments
-
Gets the original, unaltered search terms.
- getPagingActionTemplate() - Method in class com.endeca.infront.cartridge.ResultsList
-
Gets an action that can be modified to retrieve a page in the ResultsList.
- getParam(String) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Returns the value associated with the specified key in the underlying
parameter map.
- getParamBinding(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
- getParamBindings() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
- getParameters() - Method in class com.endeca.soleng.urlformatter.UrlState
-
Returns a collection of all
UrlParam mappings contained within
this
UrlState.
- getParamKey() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder.ParamBinding
-
- getParamKey() - Method in class com.endeca.soleng.urlformatter.seo.UrlParamEncoder
-
- getPath() - Method in class com.endeca.infront.cartridge.model.LinkBuilder
-
- getPathKeyValueSeparator() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
The character used to separate key/value pairs in the path
parameter section of the URL.
- getPathParamKeys() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
The parameter keys that will be appended to the path.
- getPathSeparatorToken() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
The separator token that is used to separate the misc-path
section of the URL from the path parameter section.
- getPattern() - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
-
- getPort() - Method in class com.endeca.infront.navigation.model.MdexResource
-
- getPrecomputedSorts() - Method in class com.endeca.infront.cartridge.ResultsList
-
Returns the list of precomputed sorts (as configured in the mdex engine)
- getPrependQuestionMark() - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
-
- getProperties() - Method in class com.endeca.infront.cartridge.model.Ancestor
-
- getProperties() - Method in class com.endeca.infront.cartridge.model.Refinement
-
- getProperties() - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
- getPropertyFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
-
- getPropertyKeys() - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
-
- getPropertyName() - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
- getPropertyName() - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
- getPropertyName() - Method in class com.endeca.infront.navigation.model.GeoFilter
-
- getPropertyName() - Method in class com.endeca.infront.navigation.model.RangeFilter
-
- getQueryEncoding() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
- getQueryString() - Method in class com.endeca.infront.cartridge.model.LinkBuilder
-
- getRadius() - Method in class com.endeca.infront.navigation.model.GeoFilter
-
Returns the geo filter radius in kilometers
- getRadiusKM() - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
- getRadiusMiles() - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
- getRangeFilterCrumbs() - Method in class com.endeca.infront.cartridge.Breadcrumbs
-
The list of active range filters.
- getRangeFilters() - Method in class com.endeca.infront.navigation.model.FilterState
-
Returns a List of range filters, or an empty
list if no range filters are specified.
- getRangeFiltersParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getRecord() - Method in class com.endeca.infront.cartridge.RecordDetails
-
Gets the Record object (which may be an AggregateRecord object).
- getRecordDetailsDimensionNames() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Gets the list of dimensions which have been configured to be retrieved
from records and added to the navigation state on record detail pages.
- getRecordDisplayFieldName() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Returns the field that is considered to hold the name of the record
- getRecordFilterParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getRecordFilters() - Method in class com.endeca.infront.navigation.model.FilterState
-
Returns a List of record filters, or an empty
list if no record filters are specified.
- getRecordLimit() - Method in class com.endeca.infront.cartridge.RecordSpotlightSelection
-
Gets the record limit.
- getRecordNames() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getRecords() - Method in class com.endeca.infront.cartridge.model.Record
-
If aggregate records is enabled, retrieves the list of Records in this aggregate.
- getRecords() - Method in class com.endeca.infront.cartridge.RecordSpotlight
-
The list of records.
- getRecords() - Method in class com.endeca.infront.cartridge.ResultsList
-
Returns the list of records.
- getRecordSelection() - Method in class com.endeca.infront.cartridge.RecordSpotlightConfig
-
A record selection that could contain a navigation state.
- getRecordSpec() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getRecordSpec() - Method in interface com.endeca.infront.navigation.RecordState
-
- getRecordSpecName() - Method in class com.endeca.infront.navigation.model.MdexResource
-
- getRecordSpecParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getRecordsPerPage() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Returns records displayed per page.
- getRecordState() - Method in class com.endeca.infront.cartridge.model.RecordAction
-
- getRecordStateId() - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
-
- getRecsPerPage() - Method in class com.endeca.infront.cartridge.ResultsList
-
Returns the records per page in the rendering code.
- getRedirectPath() - Method in class com.endeca.infront.content.MdexContentRequestBroker
-
Returns the keyword redirect path if there is one associated with the user search term
- getReferenceLatitude() - Method in class com.endeca.infront.navigation.model.GeoSortSpec
-
- getReferenceLongitude() - Method in class com.endeca.infront.navigation.model.GeoSortSpec
-
- getRefinementCrumbs() - Method in class com.endeca.infront.cartridge.Breadcrumbs
-
The list of active dimensional refinements.
- getRefinementMenuType() - Method in class com.endeca.infront.cartridge.NavigationContainerHandler
-
- getRefinements() - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Returns the list of refinements.
- getRefinementsShown() - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Returns a map between dimension IDs and the amount of refinements to show (i.e 123 -> some, 324 -> all)
- getRefinementsShown() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Returns the amount of refinements to show.
- getRefinementsShownByDefault() - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Returns the amount of refinements to show by default.
- getRelRank() - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
- getRelRank() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
- getRelRankEffectiveMatchMode() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getRelRankEffectiveSearchKey() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getRelRankEffectiveSearchTerms() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getRelRankKey() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Returns the relevance ranking key to be used with the relevance ranking strategy.
- getRelRankMatchMode() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Returns the relevance ranking match mode.
- getRelRankStrategy() - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
Returns the relevance ranking strategy.
- getRelRankStrategy() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Returns the relevance ranking strategy.
- getRelRankStrategy() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getRelRankTerms() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Returns the relevance ranking terms to be used with the relevance ranking strategy.
- getRemoveAction() - Method in interface com.endeca.infront.cartridge.model.Breadcrumb
-
Returns a navigation action with the necessary information to remove
this breadcrumb.
- getRemoveAction() - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
Returns a navigation action with the necessary information to remove
this breadcrumb.
- getRemoveAction() - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
Returns a navigation action with the necessary information to remove
this breadcrumb.
- getRemoveAction() - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
Returns a navigation action with the necessary information to remove
this breadcrumb.
- getRemoveAction() - Method in class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
Returns a navigation action with the necessary information to remove
this breadcrumb.
- getRemoveAllAction() - Method in class com.endeca.infront.cartridge.Breadcrumbs
-
Gets the action that will clear/remove all breadcrumbs.
- getRemoveAlways() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the list of URL parameters that will get removed "always".
- getRemoveOnClearFilterState() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getRemoveOnUpdateFilterState() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Gets the list of URL parameters that will get removed when any method that
updates the filter state is called on NavigationState
(removeSearches, removeFilters, selectNavigationFilter, etc.)
- getReplaceAll() - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
-
- getReplacement() - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
-
- getRequestType() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getRollupKey() - Method in class com.endeca.infront.navigation.model.FilterState
-
- getRootStringFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
The StringFormatter that is used to process the
root DimVal name.
- getSearchCrumbs() - Method in class com.endeca.infront.cartridge.Breadcrumbs
-
The list of active search terms.
- getSearchFilters() - Method in class com.endeca.infront.navigation.model.FilterState
-
Returns a List of search filters, or an empty
list if no search filters are specified.
- getSearchFiltersKeyParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getSearchFiltersMatchModeParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getSearchFiltersParam() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- getSearchKey() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getSearchMode() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getSearchTerms() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getSecurityFilter() - Method in class com.endeca.infront.navigation.model.FilterState
-
- getSeeAllLink() - Method in class com.endeca.infront.cartridge.RecordSpotlight
-
Returns a
NavigationAction to a page with the nav state
specified by the record selection.
- getSeeAllLinkText() - Method in class com.endeca.infront.cartridge.RecordSpotlightConfig
-
- getSeparator() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
The separator character that is used to separate root, ancestor, and
descriptor DimVal names.
- getSeparator() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
-
The separator character that is used to separate fully formatted
DimLocation objects.
- getShowMoreIds() - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
- getShowSeeAllLink() - Method in class com.endeca.infront.cartridge.RecordSpotlightConfig
-
- getSiteIdParamForAction(NavigationAction) - Method in class com.endeca.infront.assembler.servlet.AbstractPreviewLinkServlet
-
Returns the site id parameter and parameter value to append to the preview URL.
- getSiteManager() - Method in class com.endeca.infront.assembler.servlet.AbstractPreviewLinkServlet
-
A method to retrieve a SiteManager to use for
creating links.
- getSiteManager() - Method in class com.endeca.infront.assembler.servlet.spring.SpringPreviewLinkServlet
-
Retrieves an SiteManager using the Spring Framework.
- getSiteManager() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Returns the siteManager
- getSiteRootPath() - Method in class com.endeca.infront.cartridge.model.Action
-
- getSiteRootPath() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getSiteState() - Method in class com.endeca.infront.cartridge.model.Action
-
- getSiteState() - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
-
Gets the site state of the current request.
- getSiteState() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Returns the siteState
- getSiteStateId() - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
-
- getSort() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Returns the specification of sort type which governs how the returned refinements
will be ordered in the
RefinementMenu.
- getSortByDimension() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
-
- getSortByName() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
-
- getSortKeys() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getSortOption() - Method in class com.endeca.infront.cartridge.RecordSpotlightSelection
-
- getSortOption() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Returns the sort option, may be null.
- getSortOptions() - Method in class com.endeca.infront.cartridge.ResultsList
-
Returns the list of sort options to display.
- getSortOptions() - Method in class com.endeca.infront.cartridge.ResultsListHandler
-
A list of sort options to display to the end user.
- getSortOptionValue() - Method in class com.endeca.infront.navigation.model.SortSpec
-
retrieved key is followed by a suffix of "|1", indicating descending order, or
"|0", indicating ascending order (the default)
- getSorts() - Method in class com.endeca.infront.navigation.model.SortOption
-
The list of sort specifications.
- getSourceName() - Method in class com.endeca.infront.cartridge.model.MediaSourceConfig
-
- getSourceValue() - Method in class com.endeca.infront.cartridge.model.MediaSourceConfig
-
- getSpotlights() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- getStringFormatters() - Method in class com.endeca.soleng.urlformatter.seo.StringFormatterChain
-
- getSubRecordsPerAggregateRecord() - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
For aggregate records, the number of sub records that should be included in the results.
- getSuggestedSearches() - Method in class com.endeca.infront.cartridge.SearchAdjustments
-
Gets the search suggestions.
- getTerms() - Method in class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
- getTerms() - Method in class com.endeca.infront.navigation.model.SearchFilter
-
Text to search for.
- getTotalNumRecs() - Method in class com.endeca.infront.cartridge.ResultsList
-
Total number of records in the result set; not the same as the number
of records in this ResultsList.
- getTotalNumResults() - Method in class com.endeca.infront.cartridge.DimensionSearchResults
-
- getUpperBound() - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
- getUri() - Method in class com.endeca.infront.cartridge.model.MediaObject
-
- getUrl() - Method in class com.endeca.infront.cartridge.model.UrlAction
-
- getUrlFilterState() - Method in interface com.endeca.infront.navigation.NavigationState
-
- getUrlForAction(NavigationAction) - Method in class com.endeca.infront.assembler.servlet.AbstractPreviewLinkServlet
-
Constructs and returns a URL representing the given NavigationAction.
- getUrlFormatter() - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Returns the UrlFormatter associated with this class.
- getUrlParam(String) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Returns the full UrlParam value associated with the specified
key in the underlying parameter map.
- getUrlParamEncoder() - Method in interface com.endeca.soleng.urlformatter.seo.SeoUrlParam
-
- getUseDimensionNameAsKey() - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
-
Indicates whether DimLocationFormatter objects should be associated
to this formatter by dimension name or id.
- getUseDimensionNameAsKey() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
-
Indicates whether DimLocationFormatter objects should be associated
to this formatter by dimension name or id.
- getUseShowMoreIdsParam() - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Deprecated.
As of release 3.1.1.
Returns true if the show more and less actions should use the deprecated showMoreIds parameter.
The default value of this property is true.
- getUseShowMoreIdsParam() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Deprecated.
As of release 3.1.1.
Returns true if the show more and less actions should use the deprecated showMoreIds parameter.
The default value of this property is true.
- getValue() - Method in class com.endeca.infront.cartridge.model.SortOptionConfig
-
- getValue(String) - Static method in enum com.endeca.infront.cartridge.RefinementMenuConfig.RefinementsShown
-
- getValue(String) - Static method in enum com.endeca.infront.navigation.model.MatchMode
-
- getValue() - Method in class com.endeca.infront.navigation.model.PropertyFilter
-
The property value.
- getValue() - Method in interface com.endeca.soleng.urlformatter.UrlParam
-
The parameter string value.
- getWhyPrecedenceRuleFired() - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Returns "why precedence rule fired" debug information.
- SearchAdjustments - Class in com.endeca.infront.cartridge
-
- SearchAdjustments(SearchAdjustmentsConfig) - Constructor for class com.endeca.infront.cartridge.SearchAdjustments
-
- SearchAdjustmentsConfig - Class in com.endeca.infront.cartridge
-
- SearchAdjustmentsConfig() - Constructor for class com.endeca.infront.cartridge.SearchAdjustmentsConfig
-
Creates a SearchAdjustmentsConfig with the following default settings:
phraseSuggestionEnabled = false
spellSuggestionEnabled = false
- SearchAdjustmentsConfig(String) - Constructor for class com.endeca.infront.cartridge.SearchAdjustmentsConfig
-
Creates a SearchAdjustmentsConfig with the specified type and
the following default settings:
phraseSuggestionEnabled = false
spellSuggestionEnabled = false
- SearchAdjustmentsConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.SearchAdjustmentsConfig
-
Creates a copy of the specified ContentItem, and returns it as an instance of
SearchAdjustmentsConfig.
- SearchAdjustmentsHandler - Class in com.endeca.infront.cartridge
-
- SearchAdjustmentsHandler() - Constructor for class com.endeca.infront.cartridge.SearchAdjustmentsHandler
-
- SearchAdjustmentsRequestParamMarshaller - Class in com.endeca.infront.cartridge
-
Creates SearchSuggestionsHandler configuration from the parameters present
in a request URL.
- SearchAdjustmentsRequestParamMarshaller() - Constructor for class com.endeca.infront.cartridge.SearchAdjustmentsRequestParamMarshaller
-
- SearchBreadcrumb - Class in com.endeca.infront.cartridge.model
-
SearchBreadcrumb is a Breadcrumbs element that contains information about
an active keyword search.
- SearchBreadcrumb() - Constructor for class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
- SearchFilter - Class in com.endeca.infront.navigation.model
-
A text search filter.
- SearchFilter() - Constructor for class com.endeca.infront.navigation.model.SearchFilter
-
Creates a text search filter.
- SearchFilter(String, String) - Constructor for class com.endeca.infront.navigation.model.SearchFilter
-
Creates a text search filter.
- SearchFilter(String, String, MatchMode) - Constructor for class com.endeca.infront.navigation.model.SearchFilter
-
Creates a text search filter.
- selectAncestor(DimVal, DimVal) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam
-
Internal method delegated from an UrlState.
- selectAncestor(DimVal, DimVal, boolean) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Selects an ancestor DimVal for the specified descriptor
DimVal.
- selectNavigationFilter(String) - Method in interface com.endeca.infront.navigation.NavigationState
-
- selectRecord(String, boolean) - Method in interface com.endeca.infront.navigation.NavigationState
-
Create a new RecordState from the given record spec.
- selectRefinement(Dimension, DimVal) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam
-
Internal method delegated from an UrlState.
- selectRefinement(DimLocation) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam
-
Internal method delegated from an UrlState.
- selectRefinement(Dimension, DimVal, boolean) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Selects a navigation refinement DimVal from the specified
refinement Dimension.
- selectRefinement(DimLocation, boolean) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Selects a navigation refinement using a DimLocation object.
- SeoAggrERecFormatter - Class in com.endeca.soleng.urlformatter.seo
-
An ERecFormatter that formats an Aggregate record in SEO Optimized
format, by formatting its representative record using the SeoERecFormatter.
- SeoAggrERecFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoAggrERecFormatter
-
- SeoDimLocationFormatter - Class in com.endeca.soleng.urlformatter.seo
-
A formatter that generates URL path keywords from a DimLocation
object in the order [root][ancestors][descriptor].
- SeoDimLocationFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
- SeoDimLocationFormatter(Object, boolean, boolean, boolean, char) - Constructor for class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
- SeoERecFormatter - Class in com.endeca.soleng.urlformatter.seo
-
An ERecFormatter that formats the UrlState
associated with an Endecan record in SEO Optimized format,
taking into account record Dimension Values and Properties.
- SeoERecFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
-
- SeoNavStateCanonicalizer - Class in com.endeca.soleng.urlformatter.seo
-
A class that creates a canonical sort order for a NavStateUrlParam.
- SeoNavStateCanonicalizer() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
-
- SeoNavStateEncoder - Class in com.endeca.soleng.urlformatter.seo
-
Specifies the encoding of a URL parameter, can be aggregated by the SeoUrlFormatter
in an UrlParamEncoder[] array using the toString method of the Long class to perform base 36 encoding.
- SeoNavStateEncoder() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoNavStateEncoder
-
- SeoNavStateFormatter - Class in com.endeca.soleng.urlformatter.seo
-
A NavStateFormatter that formats an UrlState in SEO Optimized format,
formatting each of the the Navigation state's DimLocations with SeoNavStateFormatters.
- SeoNavStateFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
-
- SeoUrlFormatter - Class in com.endeca.soleng.urlformatter.seo
-
An UrlFormatter that parses and formats optimized URLs.
- SeoUrlFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
- SeoUrlParam - Interface in com.endeca.soleng.urlformatter.seo
-
An interface that specifies the storage of an SeoUrlParam.
- setActionPathProvider(ActionPathProvider) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
-
Sets the
ActionPathProvider used to determine the site root
path and content path when creating
Action objects.
- setAdjustedSearches(Map<String, List<AdjustedSearch>>) - Method in class com.endeca.infront.cartridge.SearchAdjustments
-
Sets automatically modified search terms from
- setAdjustedTerms(String) - Method in class com.endeca.infront.cartridge.model.AdjustedSearch
-
Sets the adjusted terms of the search.
- setAggregateRecordSpecParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the aggregateRecordSpecParam.
- setAggrERec(AggrERec) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Sets the associated AggrERec for this UrlState.
- setAggrERecFormatter(AggrERecFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
Sets the aggrERecFormatter property, which is used to render
directory-style (path-encoded) keywords for UrlState objects
containing an Endeca aggregate record.
- setAggrERecParamKey(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
-
Sets the AggrERecParamKey.
- setAncestors(List<Ancestor>) - Method in class com.endeca.infront.cartridge.model.DimensionSearchValue
-
Sets the ancestors for this dimension.
- setAncestors(List<Ancestor>) - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
Sets the ancestors for this refinement, if any.
- setAncestors(List<Ancestor>) - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Sets the ancestors up to but excluding the Dimension root for this RefinementMenu.
- setAppendAncestors(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
Specifies whether or not to append ancestor DimVal
names to the URL.
- setAppendDescriptor(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
Specifies whether or not to append the descriptor DimVal
name to the URL.
- setAppendRoot(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
Specifies whether or not to append the root DimVal
name to the URL.
- setAscending(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
-
Specifies whether or not canonicalization is done in ascending or descending order.
- setAscendingAction(SortOptionLabel) - Method in class com.endeca.infront.cartridge.model.Sort
-
- setAttributes(Map<String, Attribute>) - Method in class com.endeca.infront.cartridge.model.Record
-
Sets the attributes for this record.
- setAugment(boolean) - Method in class com.endeca.infront.cartridge.RecordSpotlightSelection
-
Sets whether current record selection should be augmented by the
current navigation state.
- setAutocorrectTo(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setAutoPhrased(boolean) - Method in class com.endeca.infront.cartridge.model.AdjustedSearch
-
Sets the auto-phrased flag.
- setAutoPhrased(boolean) - Method in class com.endeca.infront.cartridge.model.SuggestedSearch
-
Sets the auto-phrased flag.
- setAutoPhraseEnabled(boolean) - Method in class com.endeca.infront.navigation.model.FilterState
-
Turns on autophrase in the engine.
- setAutophraseParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the autophraseParam
- setBaseAggrERecUrlENEQuery(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
Sets the baseAggrERecUrlENE Query.
- setBaseERecUrlENEQuery(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
Sets the baseERecUrlENEQuery.
- setBaseNavigationUrlENEQuery(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
Sets the baseNavigationUrlENEQuery.
- setBaseUrlENEQuery(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
Sets the baseUrlENEQuery.
- setBoostRefinements(List<DvalSpec>) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Sets the list of DVal Specs to boost.
- setBoostStrata(List<CollectionFilter>) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets filters which allow items to be boosted to the top of the results.
- setBound1(double) - Method in class com.endeca.infront.navigation.model.RangeFilter
-
- setBound2(double) - Method in class com.endeca.infront.navigation.model.RangeFilter
-
- setBuryRefinements(List<DvalSpec>) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Sets the list of DVal Specs to bury.
- setBuryStrata(List<CollectionFilter>) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets filters which allow items to be buried at the bottom of the results.
- setCollapseAction(NavigationAction) - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Sets the action for collapsing this RefinementMenu.
- setContentBroker(MdexContentRequestBroker) - Method in class com.endeca.infront.cartridge.RedirectAwareContentIncludeHandler
-
Provider of essential services to dynamic content handlers.
- setContentBytes(int) - Method in class com.endeca.infront.cartridge.model.MediaObject
-
Sets the size of the media object in bytes.
- setContentHeight(int) - Method in class com.endeca.infront.cartridge.model.MediaObject
-
If the media object is an image, it sets the image height.
- setContentItemInitializer(ContentItemInitializer) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
-
- setContentPath(String) - Method in class com.endeca.infront.cartridge.model.Action
-
Sets the path that identifies the content associated with this
Action within its containing site.
- setContentPath(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setContentSource(ContentSource) - Method in class com.endeca.infront.cartridge.MediaBannerHandler
-
Sets the content source that will be used to create
Action objects.
- setContentSrcKey(String) - Method in class com.endeca.infront.cartridge.model.MediaObject
-
Sets the content source key that should be used to retrieve this media object.
- setContentType(String) - Method in class com.endeca.infront.cartridge.model.MediaObject
-
Sets the content type of this MediaObject.
- setContentWidth(int) - Method in class com.endeca.infront.cartridge.model.MediaObject
-
If the media object is an image, it sets the image width.
- setCorrectedTerms(String) - Method in class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
Sets the terms that were corrected.
- setCount(Integer) - Method in class com.endeca.infront.cartridge.model.Refinement
-
Sets the number of records that will be returned if this refinement is applied.
- setCount(Integer) - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
Sets the number of records that will be returned if this refinement is applied.
- setCount(Long) - Method in class com.endeca.infront.cartridge.model.SuggestedSearch
-
Sets the number of records that will be returned if this suggested search is applied.
- setDefault(boolean) - Method in class com.endeca.infront.navigation.model.SortOption
-
- setDefaultEncoding(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
-
Sets the default encoding for this URL formatter.
- setDefaultFilterState(FilterState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets a default FilterState object that will be used as
the initial FilterState in NavigationState
instances created by this NavigationStateBuilder.
- setDefaultFullAssembleOnRedirect(boolean) - Method in class com.endeca.infront.cartridge.RedirectAwareContentIncludeHandler
-
Sets the default value for the property of whether or not full assembly should be
done if a keyword redirect exists.
- setDefaultMatchMode(MatchMode) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- setDefaultRedirectCollection(String) - Method in class com.endeca.infront.cartridge.RedirectAwareContentIncludeHandler
-
Sets the default redirect collection name.
- setDefaultSearchKey(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- setDefaultUrlENEQuery(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
Sets the detaultUrlENEQuery.
- setDescending(boolean) - Method in class com.endeca.infront.navigation.model.SortSpec
-
- setDescendingAction(SortOptionLabel) - Method in class com.endeca.infront.cartridge.model.Sort
-
- setDetailsAction(RecordAction) - Method in class com.endeca.infront.cartridge.model.Record
-
Sets the detail action of this record.
- setDidYouMeanTo(List<String>) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setDimensionId(String) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Specifies the Dimension ID which identifies the Endeca Dimension to be used for this
RefinementMenu.
- setDimensionList(List<String>) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
Sets the dimensions to be used for dimension search.
- setDimensionName(String) - Method in class com.endeca.infront.cartridge.model.DimensionSearchGroup
-
Sets the name for this dimension search group.
- setDimensionName(String) - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
Sets the dimension name for this refinement bread crumb.
- setDimensionName(String) - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Sets the dimension name associated with this RefinementMenu.
- setDimensionName(String) - Method in class com.endeca.infront.navigation.model.DimensionFilter
-
- setDimensions(List<String>) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setDimensionSearchGroups(List<DimensionSearchGroup>) - Method in class com.endeca.infront.cartridge.DimensionSearchResults
-
Sets the List of dimension search groups.
- setDimensionSearchValues(List<DimensionSearchValue>) - Method in class com.endeca.infront.cartridge.model.DimensionSearchGroup
-
Sets the list of dimensions values associated with this group.
- setDimensionValues(List<String>) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setDimLocationFormatters(DimLocationFormatter[]) - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
-
Specifies a list of DimLocationFormatters that will be used to format the DimLocations in the UrlState.
- setDimLocationFormatters(DimLocationFormatter[]) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
-
Specifies a list of DimLocationFormatters that will be used to format the UrlState.
- setDimLocationList(DimLocationList) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam
-
Internal method delegated from an UrlState.
- setDimLocationList(DimensionList) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam
-
Internal method delegated from an UrlState.
- setDimLocationList(ERec, DimValList) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam
-
Internal method delegated from an UrlState.
- setDimValStringFormatter(StringFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
Specifies the StringFormatter that is used to process the
ancestor and descriptor DimVal names.
- setDisplayName(String) - Method in class com.endeca.infront.cartridge.model.DimensionSearchGroup
-
- setDisplayName(String) - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
Sets the display name for this refinement bread crumb.
- setDisplayName(String) - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Sets the localized display name for the dimension associated with this RefinementMenu.
- setDvalId(String) - Method in class com.endeca.infront.navigation.model.DimensionFilter
-
- setEnabled(boolean) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
Enables or disables the dimension search cartridge.
- setEnableRecordsPerPage(boolean) - Method in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
-
- setEneTime(Long) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setEqlExpression(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setEqlFilter(EqlFilter) - Method in class com.endeca.infront.navigation.model.FilterState
-
Sets the EQL filter associated with this filter state.
- setEqlParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the parameter used for specifying the EQL filter.
- setERec(ERec) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Sets the associated ERec for this UrlState.
- setERecFormatter(ERecFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
Sets the ERecFormatter property, which is used to render
directory-style (path-encoded) keywords for UrlState objects
containing an Endeca record.
- setERecParamKey(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
-
Sets the ERecParamKey.
- setExpandAction(NavigationAction) - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Sets the action for expanding this RefinementMenu.
- setExpression(String) - Method in class com.endeca.infront.navigation.model.EqlFilter
-
Sets the EQL expression on this filter.
- setFeaturedRecords(List<String>) - Method in class com.endeca.infront.navigation.model.FilterState
-
The List of featured records.
- setFeaturedRecordsParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the featuredRecordsParam.
- setFieldName(String) - Method in class com.endeca.infront.cartridge.model.Sort
-
- setFilterState(FilterState) - Method in class com.endeca.infront.cartridge.RecordSpotlightSelection
-
Sets the filter state.
- setFirstRecNum(long) - Method in class com.endeca.infront.cartridge.ResultsList
-
Sets the one-based index of the first record in the record list.
- setGeoFilter(GeoFilter) - Method in class com.endeca.infront.navigation.model.FilterState
-
The GeoFilter
- setGeoFilterCrumb(GeoFilterBreadcrumb) - Method in class com.endeca.infront.cartridge.Breadcrumbs
-
Sets the active geo filter.
- setGeoFilterParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the geoFilterParam.
- setHost(String) - Method in class com.endeca.infront.navigation.model.MdexResource
-
- setId(String) - Method in class com.endeca.infront.navigation.model.DvalSpec
-
- setIgnoreCase(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
-
Specifies whether or not canonicalization ignores case.
- setIncludedParameters(List<String>) - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
-
- setIncludePrecomputedSorts(boolean) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets if default sorts (precomputed mdex sorts) are included in the results list model
- setInnerFilter(Filter) - Method in class com.endeca.infront.navigation.model.CollectionFilter
-
- setInterpretedTerms(Map<String, Map<String, String>>) - Method in class com.endeca.infront.cartridge.SearchAdjustments
-
Sets interpreted terms.
- setKey(String) - Method in class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
Sets the search key of this SearchBreadcrumb.
- setKey(String) - Method in class com.endeca.infront.navigation.model.SearchFilter
-
- setKey(String) - Method in class com.endeca.infront.navigation.model.SortSpec
-
- setKey(Object) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
Specifies the dimension name or id used to associate a DimLocationFormatter
with a specific dimension.
- setLabel(String) - Method in class com.endeca.infront.cartridge.model.Action
-
Sets the user-visible text for the application to use when constructing
a link for this Action.
- setLabel(String) - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
Sets the label that describes this breadcrumb.
- setLabel(String) - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
Sets the user friendly label.
- setLabel(String) - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
Sets the user friendly text of this refinement.
- setLabel(String) - Method in class com.endeca.infront.cartridge.model.SortOptionConfig
-
Sets the user visible label for this sort.
- setLabel(String) - Method in class com.endeca.infront.navigation.model.SortOption
-
- setLanguageId(String) - Method in class com.endeca.infront.navigation.model.FilterState
-
Sets the language ID that gets passed to the MDEX.
- setLanguageParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the parameter used for specifying the language ID
- setLastRecNum(long) - Method in class com.endeca.infront.cartridge.ResultsList
-
Sets one-based index of the last record in the records list.
- setLatitude(double) - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
Sets the latitude coordinate of this GeoFilterBreadcrumb.
- setLatitude(double) - Method in class com.endeca.infront.navigation.model.GeoFilter
-
- setLessLink(NavigationAction) - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Sets the action for collapsing the RefinementMenu.
- setLessLinkText(String) - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Sets display text for 'less' links.
- setLessLinkText(String) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
When showMoreLink and isShowMore() is true, this text is used in the creation of the 'less' link.
- setLink(Action) - Method in class com.endeca.infront.cartridge.MediaBanner
-
Sets the
Action object used to construct the link
which fires when the media is clicked.
- setLink(LinkBuilder) - Method in class com.endeca.infront.cartridge.MediaBannerConfig
-
Sets the
LinkBuilder object used to construct the link
which fires when the media is clicked.
- setLinkType(LinkBuilder.LinkType) - Method in class com.endeca.infront.cartridge.model.LinkBuilder
-
Sets the type of this link.
- setLocation(String) - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
Sets the result of a reverse geocode lookup.
- setLongitude(double) - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
Sets the longitude coordinate of this GeoFilterBreadcrumb.
- setLongitude(double) - Method in class com.endeca.infront.navigation.model.GeoFilter
-
- setLowerBound(String) - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
Sets the operations lower bound.
- setMatchMode(MatchMode) - Method in class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
Sets the match mode of this SearchBreadcrumb.
- setMatchMode(MatchMode) - Method in class com.endeca.infront.navigation.model.SearchFilter
-
- setMaxNumRecords(int) - Method in class com.endeca.infront.cartridge.RecordSpotlightConfig
-
Sets the maximum number of records to be returned.
- setMaxNumRefinements(int) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
The maximum number of refinements which will be shown when showMore has a value of "true".
- setMaxRecordsPerPage(int) - Method in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
-
Sets the maximum number of records per page that will be returned.
- setMaxResults(int) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
Sets the maximum total number of dimension search results.
- setMaxResultsPerDimension(int) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
Sets the maximum number of dimension search results returned
for each dimension.
- setMdexRequestBroker(MdexRequestBroker) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
-
Sets the MdexRequestBroker used to construct requests.
- setMdexRequestBroker(MdexRequestBroker) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the request Broker used by this class to create record detail
queries.
- setMedia(MediaObject) - Method in class com.endeca.infront.cartridge.MediaBanner
-
Sets the media object to be displayed.
- setMedia(MediaObject) - Method in class com.endeca.infront.cartridge.MediaBannerConfig
-
Sets the media object to be displayed.
- setMediaSourceList(List<MediaSourceConfig>) - Method in class com.endeca.infront.cartridge.MediaBannerHandler
-
- setMoreLink(NavigationAction) - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Sets the action for expanding the RefinementMenu.
- setMoreLinkText(String) - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Sets display text for 'more' links.
- setMoreLinkText(String) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
When showMoreLink is true, and more refinements are available than are included in the RefinementMenu,
this text is used in the link creation.
- setMultiSelect(boolean) - Method in class com.endeca.infront.cartridge.model.Refinement
-
Sets the multi select flag.
- setMultiSelect(boolean) - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
Sets the multi select flag.
- setMultiSelect(boolean) - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Sets the multi-select property.
- setName(String) - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
Sets the localized string for the property.
- setName(String) - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
The localized string for the property.
- setName(String) - Method in class com.endeca.infront.navigation.model.DvalSpec
-
- setName(String) - Method in class com.endeca.infront.navigation.model.PropertyFilter
-
- setNavigation(List<RefinementMenu>) - Method in class com.endeca.infront.cartridge.NavigationContainer
-
Replaces the list of RefinementMenu items in this NavigationContainer with the
specified list.
- setNavigationFilters(List<String>) - Method in class com.endeca.infront.navigation.model.FilterState
-
The List of navigation filters (dimension value IDs).
- setNavigationFiltersParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the dimensionFiltersParam.
- setNavigationState(String) - Method in class com.endeca.infront.cartridge.model.NavigationAction
-
Sets the navigation state for this Action.
- setNavigationState(NavigationState) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
-
Sets the navigation state represented by the current request.
- setNavigationState(NavigationState) - Method in class com.endeca.infront.cartridge.RedirectAwareContentIncludeHandler
-
The navigation state for this request.
- setNavigationStateBuilder(NavigationStateBuilder) - Method in class com.endeca.infront.cartridge.MediaBannerHandler
-
Sets the NavigationStateBuilder
- setNavigationStateId(String) - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
-
- setNavState(DimLocationList) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Sets the navigation state for this UrlState using a DimLocationList.
- setNavState(DimensionList) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Sets the navigation state for this UrlState using a DimensionList.
- setNavState(ERec, DimValList) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Sets the navigation state for this UrlState using an ERec
and a DimValList.
- setNavStateCanonicalizer(NavStateCanonicalizer) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
Specifies the canonicalizer used to sort the navigation state before
rendering an UrlState.
- setNavStateFormatter(NavStateFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
Sets the navStateFormatter property, which is used to render
directory-style (path-encoded) keywords for UrlState objects
containing dimensional navigation state.
- setNavStateParamKey(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
-
Sets the NavStateParamKey.
- setNumRecords(long) - Method in class com.endeca.infront.cartridge.model.Record
-
Sets the number of aggregate records of this record.
- setNumRecords(Long) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setNumRefinements(int) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Sets the maximum number of refinements which will be shown when showMore has a value of "false".
- setNumRefinements(Integer) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setObjectLocator(ObjectLocator) - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
-
- setOffset(long) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets the record offset.
- setOperands(List<Filter>) - Method in class com.endeca.infront.navigation.model.ComboFilter
-
- setOperation(String) - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
Sets the operation to be used to create the range filter.
- setOperation(RangeFilter.Operation) - Method in class com.endeca.infront.navigation.model.RangeFilter
-
- setOriginalTerms(List<String>) - Method in class com.endeca.infront.cartridge.SearchAdjustments
-
Sets the original, unaltered search terms.
- setPagingActionTemplate(NavigationAction) - Method in class com.endeca.infront.cartridge.ResultsList
-
Sets the paging action template.
- setParam(String, String) - Method in class com.endeca.soleng.urlformatter.UrlState
-
Associates the specified value with the specified key in the underlying
parameter map.
- setParamBindings(BasicQueryBuilder.ParamBinding[]) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
Sets the parameters that, if present in the UrlState, will be set in the query.
- setParamKey(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder.ParamBinding
-
Sets the parameter key to be used by the QueryBuilder object, when it constructs
a UrlENEQuery from an UrlState.
- setParamKey(String) - Method in class com.endeca.soleng.urlformatter.seo.UrlParamEncoder
-
Sets the key of the parameter to encode.
- setPath(String) - Method in class com.endeca.infront.cartridge.model.LinkBuilder
-
Sets the path of this Link.
- setPathKeyValueSeparator(char) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
Specifies the character used to separate key/value pairs in the path
parameter section of the URL.
- setPathParamKeys(String[]) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
Specifies the parameter keys that will be appended to the path,
rather than the query string, which is the default setting for any given key.
- setPathSeparatorToken(String) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
Specifies the separator token that is used to separate the misc-path
section of the URL from the path parameter section.
- setPattern(String) - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
-
Specifies a pattern to find and replace with the replacement value.
- setPhraseSuggestionEnabled(boolean) - Method in class com.endeca.infront.cartridge.SearchAdjustmentsConfig
-
If phrase suggestion is enabled, the MDEX may suggest that the user would get
better search results by grouping 2 or more words as a phrase.
- setPort(int) - Method in class com.endeca.infront.navigation.model.MdexResource
-
- setPrecomputedSorts(List<Sort>) - Method in class com.endeca.infront.cartridge.ResultsList
-
Sets the list of precomputed sorts.
- setPrependQuestionMark(boolean) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
-
Determines whether or not question marks will be appended to the Url.
- setProperties(Map<String, String>) - Method in class com.endeca.infront.cartridge.model.Ancestor
-
Sets the properties of this Ancestor.
- setProperties(Map<String, String>) - Method in class com.endeca.infront.cartridge.model.Refinement
-
Sets the properties of this refinement
- setProperties(Map<String, String>) - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
Sets the properties of this refinement.
- setPropertyFormatter(StringFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
-
Specifies a class that implements StringFormatter to format each of the properties included in the propertyKeys.
- setPropertyKeys(String[]) - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
-
Specifies a list of Record Property keys that will be included in the formatted Url.
- setPropertyName(String) - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
Sets the property name for this breadcrumb.
- setPropertyName(String) - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
Sets the property name for this RangeFilterBreadcrumb.
- setPropertyName(String) - Method in class com.endeca.infront.navigation.model.GeoFilter
-
- setPropertyName(String) - Method in class com.endeca.infront.navigation.model.RangeFilter
-
- setQueryEncoding(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
-
Sets the encoding for this Query.
- setQueryString(String) - Method in class com.endeca.infront.cartridge.model.LinkBuilder
-
Sets the query string.
- setRadius(double) - Method in class com.endeca.infront.navigation.model.GeoFilter
-
sets the geo filter radius in kilometers
- setRadiusKM(double) - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
Sets the geo filter radius.
- setRadiusMiles(double) - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
Sets the geo filter radius.
- setRangeFilterCrumbs(List<RangeFilterBreadcrumb>) - Method in class com.endeca.infront.cartridge.Breadcrumbs
-
Sets the list of active range filters.
- setRangeFilters(List<RangeFilter>) - Method in class com.endeca.infront.navigation.model.FilterState
-
The List of range filters.
- setRangeFiltersParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the rangeFiltersParam.
- setRecord(Record) - Method in class com.endeca.infront.cartridge.RecordDetails
-
Sets the Record object.
- setRecordDetailsDimensionNames(List<String>) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the list of dimension values to be retrieved from records and
added to the navigation state on record detail pages.
- setRecordDisplayFieldName(String) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets the name of the field that stores the record's logical name
- setRecordFilterParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the recordFilterParam.
- setRecordFilters(List<String>) - Method in class com.endeca.infront.navigation.model.FilterState
-
The List of record filters.
- setRecordLimit(int) - Method in class com.endeca.infront.cartridge.RecordSpotlightSelection
-
Sets the record limit.
- setRecordNames(List<String>) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setRecords(List<Record>) - Method in class com.endeca.infront.cartridge.model.Record
-
Sets the list containing the children of this record.
- setRecords(List<Record>) - Method in class com.endeca.infront.cartridge.RecordSpotlight
-
Sets the list of records.
- setRecords(List<Record>) - Method in class com.endeca.infront.cartridge.ResultsList
-
Sets the list of records.
- setRecordSelection(RecordSpotlightSelection) - Method in class com.endeca.infront.cartridge.RecordSpotlightConfig
-
Sets the record selection for this cartridge handler.
- setRecordSpec(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setRecordSpecName(String) - Method in class com.endeca.infront.navigation.model.MdexResource
-
- setRecordSpecParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the recordSpecParam.
- setRecordsPerPage(int) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets records displayed per page.
- setRecordState(String) - Method in class com.endeca.infront.cartridge.model.RecordAction
-
Sets the record state for this Action.
- setRecordState(RecordState) - Method in class com.endeca.infront.cartridge.RecordDetailsHandler
-
Sets the record state representing the current request.
- setRecordStateId(String) - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
-
- setRecsPerPage(long) - Method in class com.endeca.infront.cartridge.ResultsList
-
Sets records per page in the rendering code.
- setReferenceLatitude(double) - Method in class com.endeca.infront.navigation.model.GeoSortSpec
-
- setReferenceLongitude(double) - Method in class com.endeca.infront.navigation.model.GeoSortSpec
-
- setRefinementCrumbs(List<RefinementBreadcrumb>) - Method in class com.endeca.infront.cartridge.Breadcrumbs
-
Sets the list of active dimensional refinements.
- setRefinementMenuType(String) - Method in class com.endeca.infront.cartridge.NavigationContainerHandler
-
- setRefinements(List<Refinement>) - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Sets the list of refinements.
- setRefinementsShown(Map<String, String>) - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Sets the map between dimension IDs and the amount of refinements to show.
- setRefinementsShown(String) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Sets the amount of refinements to show.
- setRefinementsShownByDefault(String) - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Sets the amount of refinements to show.
- setRelRank(String) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
- setRelRank(String) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
- setRelRankEffectiveMatchMode(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setRelRankEffectiveSearchKey(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setRelRankEffectiveSearchTerms(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setRelRankKey(String) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets the relevance ranking key to be used with the relevance ranking strategy.
- setRelRankMatchMode(MatchMode) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets the relevance ranking match mode.
- setRelRankStrategy(String) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
Sets the relevance ranking strategy.
- setRelRankStrategy(String) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets the relevance ranking strategy.
- setRelRankStrategy(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setRelRankTerms(String) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets one or more terms that will be used with the relevance ranking strategy to order the records.
- setRemoveAction(NavigationAction) - Method in class com.endeca.infront.cartridge.model.GeoFilterBreadcrumb
-
Sets the remove action of this GeoFilterBreadcrumb.
- setRemoveAction(NavigationAction) - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
Sets the NavigationAction to remove this RangeFilterBreadcrumb.
- setRemoveAction(NavigationAction) - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
-
Sets the remove action of this RefinementBreadcrumb.
- setRemoveAction(NavigationAction) - Method in class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
Sets the remove action of this SearchBreadcrumb.
- setRemoveAllAction(NavigationAction) - Method in class com.endeca.infront.cartridge.Breadcrumbs
-
Sets the action that will clear/remove all breadcrumbs.
- setRemoveAlways(List<String>) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the list of URL parameters that will get removed "always".
- setRemoveOnClearFilterState(List<String>) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
- setRemoveOnUpdateFilterState(List<String>) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the list of URL parameters that will get removed when any method that
updates the filter state is called on NavigationState
(removeSearches, removeFilters, selectNavigationFilter, etc.)
- setReplaceAll(boolean) - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
-
Specifies whether or not all matching patterns will be replaced.
- setReplacement(String) - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
-
Specifies the replacement value.
- setRequestType(RequestType) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setRollupKey(String) - Method in class com.endeca.infront.navigation.model.FilterState
-
If aggregate records are being used, this specifies the MDEX rollup field.
- setRootStringFormatter(StringFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
Specifies the StringFormatter that is used to process the
root DimVal name.
- setSearchCrumbs(List<SearchBreadcrumb>) - Method in class com.endeca.infront.cartridge.Breadcrumbs
-
Sets the list of active search terms.
- setSearchFilters(List<SearchFilter>) - Method in class com.endeca.infront.navigation.model.FilterState
-
The List of search filters.
- setSearchFiltersKeyParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the searchFiltersKeyParam.
- setSearchFiltersMatchModeParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the searchFiltersMatchModeParam.
- setSearchFiltersParam(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the searchFiltersParam.
- setSearchKey(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setSearchMode(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setSearchTerms(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setSecurityFilter(String) - Method in class com.endeca.infront.navigation.model.FilterState
-
Sets a security filter, which is specified using an MDEX record filter string.
- setSeeAllLink(NavigationAction) - Method in class com.endeca.infront.cartridge.RecordSpotlight
-
- setSeeAllLinkText(String) - Method in class com.endeca.infront.cartridge.RecordSpotlightConfig
-
- setSelected(boolean) - Method in class com.endeca.infront.cartridge.model.SortOptionLabel
-
- setSeparator(char) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
-
Specifies the separator character that is used to separate root, ancestor, and
descriptor DimVal names.
- setSeparator(char) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
-
Specifies the separator character that is used to separate fully formatted
DimLocation objects.
- setShowCountsEnabled(boolean) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
-
Enables or disable the calculation of record counts.
- setShowMore(boolean) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Deprecated.
As of release 3.1.1, replaced by RefinementMenuConfig.getRefinementsShown().
Sets whether to "show more" refinements.
When this value is false, the number of menu items generated is limited by numRefinements,
and a more link will be generated. This value is intended to be overridden by request parameters
when a "true" value is required in the link generation for the link generated when showMoreLink is "true".
- setShowMoreIds(List<String>) - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
- setShowMoreLink(boolean) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Enables the generation of a "More..." link as part of the refinement menu
if there are more refinements available than the numRefinements variable and isShowMore() is true.
- setShowSeeAllLink(boolean) - Method in class com.endeca.infront.cartridge.RecordSpotlightConfig
-
- setShowWordInterp(boolean) - Method in class com.endeca.infront.cartridge.SearchAdjustmentsConfig
-
Specifies that the SearchAdjustments cartridge should populate the interpreted terms.
- setSiteManager(SiteManager) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the siteManager
- setSiteRootPath(String) - Method in class com.endeca.infront.cartridge.model.Action
-
Sets the path that identifies the site root associated with this Action.
- setSiteRootPath(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setSiteState(SiteState) - Method in class com.endeca.infront.cartridge.model.Action
-
Sets the site state of this Action
- setSiteState(SiteState) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
-
Sets the site state of the current request.
- setSiteState(SiteState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the siteState
- setSiteStateId(String) - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
-
- setSort(String) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Sets the sort type which governs how the returned refinements
will be ordered in the
RefinementMenu.
- setSortByDimension(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
-
Specifies canonicalization to be done based on Dimension (rather than DimVal).
- setSortByName(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
-
Specifies canonicalization to be done based on the name of the dimension/dimval (rather than ID).
- setSortKeys(List<String>) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setSortOption(SortOption) - Method in class com.endeca.infront.cartridge.RecordSpotlightSelection
-
- setSortOption(SortOption) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets the sort option and also marks it as a default sort.
- setSortOptions(List<SortOptionLabel>) - Method in class com.endeca.infront.cartridge.ResultsList
-
Sets the list of sort options to display.
- setSortOptions(List<SortOptionConfig>) - Method in class com.endeca.infront.cartridge.ResultsListHandler
-
Returns the list of sort options to display to the end user.
- setSortRequestParameter(String) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets the requested sort as a String.
- setSorts(List<SortSpec>) - Method in class com.endeca.infront.navigation.model.SortOption
-
- setSourceName(String) - Method in class com.endeca.infront.cartridge.model.MediaSourceConfig
-
Sets the media source name.
- setSourceValue(String) - Method in class com.endeca.infront.cartridge.model.MediaSourceConfig
-
Sets the media source value.
- setSpellCorrected(boolean) - Method in class com.endeca.infront.cartridge.model.AdjustedSearch
-
Sets the spell correction flag.
- setSpellCorrected(boolean) - Method in class com.endeca.infront.cartridge.model.SuggestedSearch
-
Sets the spell correction flag.
- setSpellSuggestionEnabled(boolean) - Method in class com.endeca.infront.cartridge.SearchAdjustmentsConfig
-
If spell suggestion is enabled, the MDEX may suggest that the user would get
better search results by using an alternate spelling.
- setSpotlights(List<String>) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
-
- setSslEnabled(boolean) - Method in class com.endeca.infront.navigation.model.MdexResource
-
- setStatsPageSerializer(StatsPageTimeEventSerializer) - Method in class com.endeca.infront.cartridge.StatsPageCartridgeHandler
-
Deprecated.
As of release 11.0.
Sets the serializer used to store performance information.
- setStringFormatters(StringFormatter[]) - Method in class com.endeca.soleng.urlformatter.seo.StringFormatterChain
-
Specifies an array of StringFormatters to be applied.
- setSubRecordsPerAggregateRecord(SubRecordsPerAggregateRecord) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
For aggregate records, sets the number of sub records that should be included in the results.
- setSuggestedSearches(Map<String, List<SuggestedSearch>>) - Method in class com.endeca.infront.cartridge.SearchAdjustments
-
Sets the search suggestions.
- setTerms(String) - Method in class com.endeca.infront.cartridge.model.SearchBreadcrumb
-
Sets the term of this SearchBreadcrumb.
- setTerms(String) - Method in class com.endeca.infront.navigation.model.SearchFilter
-
- setTotalNumRecs(long) - Method in class com.endeca.infront.cartridge.ResultsList
-
Sets total number of records.
- setTotalNumResults(Integer) - Method in class com.endeca.infront.cartridge.DimensionSearchResults
-
- setUpperBound(String) - Method in class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
-
Sets the upper bound.
- setUri(String) - Method in class com.endeca.infront.cartridge.model.MediaObject
-
Sets the URI to get this media object.
- setUrl(String) - Method in class com.endeca.infront.cartridge.model.UrlAction
-
Sets the url for this Action.
- setUrlFormatter(UrlFormatter) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
-
Sets the UrlFormatter associated with this class.
- setUrlParamEncoders(UrlParamEncoder[]) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
Specifies the UrlParamEncoder objects used by this SeoUrlFormatter.
- setUseDimensionNameAsKey(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
-
Specifies whether DimLocationFormatter objects should be associated
to this formatter by dimension name or id.
- setUseDimensionNameAsKey(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
-
Specifies whether DimLocationFormatter objects should be associated
to this formatter by dimension name or id.
- setUseNavStateCanonicalizer(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
-
Determines whether or not to use canonicalizers when formatting the URL.
- setUseShowMoreIdsParam(boolean) - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Deprecated.
As of release 3.1.1.
Sets whether the deprecated showMoreIds or the navigation
refinement menu config parameter should be used. If false, the showMoreIds
will be ignored and the expand and collapse action will appear in the RefinementMenu.
- setUseShowMoreIdsParam(boolean) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Deprecated.
As of release 3.1.1.
Sets whether the deprecated showMoreIds or the navigation
refinement menu config parameter should be used. If false, the showMoreIds
will be ignored and the expand and collapse action will appear in the RefinementMenu.
- setValue(String) - Method in class com.endeca.infront.cartridge.model.SortOptionConfig
-
Sets the value to apply this sort.
- setValue(String) - Method in class com.endeca.infront.navigation.model.PropertyFilter
-
- setWhyMatchEnabled(boolean) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets if why match debugging should be enabled.
- setWhyPrecedenceRuleFired(boolean) - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
-
Sets if 'why precedence rule fired' debug information should be enabled.
- setWhyPrecedenceRuleFired(JsonAttribute) - Method in class com.endeca.infront.cartridge.RefinementMenu
-
Sets "why precedence rule fired" debug information.
- setWhyPrecedenceRuleFired(boolean) - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
-
Sets if 'why precedence rule fired' debug information should be enabled.
- setWhyRankEnabled(boolean) - Method in class com.endeca.infront.cartridge.ResultsListConfig
-
Sets if why rank debugging should be enabled.
- shallowCopy() - Method in class com.endeca.infront.navigation.model.FilterState
-
Returns a shallow copy of a this FilterState object.
- SHOW_MORE - Static variable in class com.endeca.infront.cartridge.NavigationContainerRequestParamMarshaller
-
- SHOW_MORE - Static variable in class com.endeca.infront.cartridge.RefinementMenuRequestParamMarshaller
-
- SITE_MANAGER_BEAN_ID_PARAM - Static variable in class com.endeca.infront.assembler.servlet.spring.SpringPreviewLinkServlet
-
The servlet parameter used to specify the Spring bean ID of the
SiteManager to use.
- Sort - Class in com.endeca.infront.cartridge.model
-
Represents a group of actions (both ascending and descending) to sort by a single field
- Sort() - Constructor for class com.endeca.infront.cartridge.model.Sort
-
- SORT_PARAMETER - Static variable in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
-
Name of request parameter that sets the sort options, "Ns".
- SortOption - Class in com.endeca.infront.navigation.model
-
A specification of how a navigation results list should be sorted.
- SortOption() - Constructor for class com.endeca.infront.navigation.model.SortOption
-
- SortOption(String) - Constructor for class com.endeca.infront.navigation.model.SortOption
-
Constructor that supports a String representation.
- SortOptionConfig - Class in com.endeca.infront.cartridge.model
-
This class is the sort option configuration module for ResultList Cartridge.
- SortOptionConfig() - Constructor for class com.endeca.infront.cartridge.model.SortOptionConfig
-
Empty constructor
- SortOptionConfig(String, String) - Constructor for class com.endeca.infront.cartridge.model.SortOptionConfig
-
Constructor
- SortOptionLabel - Class in com.endeca.infront.cartridge.model
-
Represents a button or piece of text that links to an
action and appears within a group of selectable items
- SortOptionLabel() - Constructor for class com.endeca.infront.cartridge.model.SortOptionLabel
-
- SortSpec - Class in com.endeca.infront.navigation.model
-
A way of sorting a list of search/navigation results.
- SortSpec() - Constructor for class com.endeca.infront.navigation.model.SortSpec
-
- SpringPreviewLinkServlet - Class in com.endeca.infront.assembler.servlet.spring
-
- SpringPreviewLinkServlet() - Constructor for class com.endeca.infront.assembler.servlet.spring.SpringPreviewLinkServlet
-
- StatsPageCartridgeHandler - Class in com.endeca.infront.cartridge
-
Deprecated.
As of release 11.0.
An implementation of CartridgeHandler that provides content for the
performance stats page.
- StatsPageCartridgeHandler() - Constructor for class com.endeca.infront.cartridge.StatsPageCartridgeHandler
-
Deprecated.
- StratifySortSpec - Class in com.endeca.infront.navigation.model
-
- StratifySortSpec() - Constructor for class com.endeca.infront.navigation.model.StratifySortSpec
-
- StratifySortSpec(String) - Constructor for class com.endeca.infront.navigation.model.StratifySortSpec
-
Creates a new sort spec, given the relRank module string specified.
- StringAttribute - Class in com.endeca.infront.cartridge.model
-
Class representing single value string attributes.
- StringAttribute() - Constructor for class com.endeca.infront.cartridge.model.StringAttribute
-
- StringFormatter - Interface in com.endeca.soleng.urlformatter.seo
-
An interface for string formatting, implementations of which are
aggregated by SeoDimLocationFormatter, SeoERecFormatter, SeoAggrERecFormatter,
and StringFormatterChain.
- StringFormatterChain - Class in com.endeca.soleng.urlformatter.seo
-
A StringFormatter that aggregates an array of StringFormatter objects,
which it uses to apply a series of operations on a string.
- StringFormatterChain() - Constructor for class com.endeca.soleng.urlformatter.seo.StringFormatterChain
-
- SubRecordsPerAggregateRecord - Enum in com.endeca.infront.navigation.model
-
For aggregate records, the number of sub records that should be included in results.
- SuggestedSearch - Class in com.endeca.infront.cartridge.model
-
SuggestedSearch is the model for a view of suggested search terms a.k.a, "did you mean?".
- SuggestedSearch() - Constructor for class com.endeca.infront.cartridge.model.SuggestedSearch
-
Default constructor.
- SuggestedSearch(String, String, boolean, boolean, long) - Constructor for class com.endeca.infront.cartridge.model.SuggestedSearch
-
Constructs a suggested search with the given navigation state, label, auto phrase, spell correction and count.
- SuggestedSearch(String, String, boolean, boolean) - Constructor for class com.endeca.infront.cartridge.model.SuggestedSearch
-
Constructs a suggested search with the given navigation state, label, auto phrase and spell correction.