A B C D E F G H I J K L M N O P Q R S T U V W X Z

A

AbstractAssemblerServlet - Class in com.endeca.infront.assembler.servlet
Servlet used to invoke the Assembler and process its results.
AbstractAssemblerServlet() - Constructor for class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet
 
AbstractCartridgeHandler - Class in com.endeca.infront.assembler
An abstract implementation of CartridgeHandler that provides no-op implementations of CartridgeHandler.initialize(ContentItem) and CartridgeHandler.preprocess(ContentItem).
AbstractCartridgeHandler() - Constructor for class com.endeca.infront.assembler.AbstractCartridgeHandler
 
AbstractContentSource - Class in com.endeca.infront.content.source
Base implementation of the ContentSource interface.
AbstractContentSource(String) - Constructor for class com.endeca.infront.content.source.AbstractContentSource
Deprecated. 
AbstractContentSource() - Constructor for class com.endeca.infront.content.source.AbstractContentSource
Constructs a content source.
AbstractPreviewLinkServlet - Class in com.endeca.infront.assembler.servlet
Link service for Workbench Preview functionality.
AbstractPreviewLinkServlet() - Constructor for class com.endeca.infront.assembler.servlet.AbstractPreviewLinkServlet
 
Action - Class in com.endeca.infront.cartridge.model
An Action represents a decision that an end user might choose to make when interacting with an Assembler application.
Action() - Constructor for class com.endeca.infront.cartridge.model.Action
Default constructor.
Action(String) - Constructor for class com.endeca.infront.cartridge.model.Action
Constructs an Action with the specified label.
Action(String, String, String) - Constructor for class com.endeca.infront.cartridge.model.Action
Constructs an Action with the specified label, site root path and content path.
ActionPathProvider - Interface in com.endeca.infront.navigation.url
Cartridge handlers use an implementation of the ActionPathProvider interface to determine the site root paths and content paths for the Action objects that they create.
addAssemblerEventListener(AssemblerEventListener) - Method in interface com.endeca.infront.assembler.Assembler
Adds a listener to all activity within the context of this request.
addAutoPhraseEnabled(NavigationState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState, adding the autophraseParam if the current value of FilterState.isAutoPhraseEnabled() is different from the defaultFilterState.
addDefaults(ContentItem, ContentItem) - Static method in class com.endeca.infront.cartridge.ConfigInitializer
Helper method for adding defaults "below" the values present in a given ContentItem.
addDidYouMeanTo(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
Convenience method to add a single "did-you-mean" suggestion
addDimension(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
Convenience method to add a single dimension
addDimensionValue(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
Convenience method to add a single dimension value
addEqlFilter(NavigationState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState, adding the eqlparam if the current value of FilterState.getEqlFilter() is different from the defaultFilterState.
addEventSerializer(EventSerializer) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils
Registers a serializer with the system.
addFeaturedRecords(NavigationState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState by adding featured records from the given NavigationState.
addGeoFilter(NavigationState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState by adding a geo filter from the given NavigationState.
addLanguageId(NavigationState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState, adding the languageParam if the current value of FilterState.getLanguageId() is different from the defaultFilterState.
addListItem(String, Object) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
Add a list item to this map.
addNavigationFilters(NavigationState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState by adding navigation filters from the NavigationState.
addParamBinding(BasicQueryBuilder.ParamBinding) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
 
addParameters(NavigationState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState by adding URL parameters from the given NavigationState.
addParameters(RecordState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState by adding URL parameters from the given RecordState
addRangeFilters(NavigationState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState by adding range filters from the given NavigationState.
addRecordFilters(NavigationState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState by adding record filters from the given NavigationState
addRecordName(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
Convenience method to add a single record name
addRecordSpec(RecordState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState by adding the record spec from the given RecordState.
addSearchFilters(NavigationState, UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Updates the UrlState by adding search filters from the given NavigationState.
addSortKey(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
Convenience method to add a single sort key
addSpotlight(String) - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
Convenience method to add a single spotlight
addUserSegments(String) - Method in class com.endeca.infront.navigation.UserState
Convenience method to add a user segments to the currently active set of user segments.
AdjustedSearch - Class in com.endeca.infront.cartridge.model
Represents a search input that was automatically adjusted.
AdjustedSearch() - Constructor for class com.endeca.infront.cartridge.model.AdjustedSearch
Default constructor.
AdjustedSearch(String, boolean, boolean) - Constructor for class com.endeca.infront.cartridge.model.AdjustedSearch
Constructs an AdjustedSearch with the specified terms, auto phrase and spell corrected values.
AggrERecFormatter - Interface in com.endeca.soleng.urlformatter.seo
Interface that specifies the formatting of a UrlState associated with an aggregate record, used by SeoUrlFormatter.
AggrERecUrlParam - Interface in com.endeca.soleng.urlformatter
An interface used internally by an UrlState to store an AggrERec for aggregate record detail page links.
all - Variable in class com.endeca.infront.assembler.perf.TimeSummary
All the inclusive (descendant and self) time recorded
Ancestor - Class in com.endeca.infront.cartridge.model
Represents an ancestor in a dimension hierarchy.
Ancestor() - Constructor for class com.endeca.infront.cartridge.model.Ancestor
 
AndFilter - Class in com.endeca.infront.navigation.model
A logical conjunction of some number of filters.
AndFilter() - Constructor for class com.endeca.infront.navigation.model.AndFilter
Create an AndFilter.
AndFilter(List<Filter>) - Constructor for class com.endeca.infront.navigation.model.AndFilter
 
assemble(ContentItem) - Method in interface com.endeca.infront.assembler.Assembler
Invokes the assembly process and returns the assembled results.
Assembler - Interface in com.endeca.infront.assembler
Used to invoke a single assembly process.
ASSEMBLER_FACTORY_ID_PARAM - Static variable in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet
The servlet parameter used to specify the Spring bean ID of the AssemblerFactory to use.
AssemblerEvent - Class in com.endeca.infront.assembler.event
Event type that transmits information about activity within the Assembler.
AssemblerEvent(Assembler, ContentItem, CartridgeHandler<?>, Throwable) - Constructor for class com.endeca.infront.assembler.event.AssemblerEvent
Constructor.
AssemblerEventAdapter - Class in com.endeca.infront.assembler.event
Contains an empty implementation of each method on the AssemblerEventListener interface.
AssemblerEventAdapter() - Constructor for class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
AssemblerEventListener - Interface in com.endeca.infront.assembler.event
Listener for assembler events.
AssemblerException - Exception in com.endeca.infront.assembler
Indicates that an exception occurred while creating or processing an assembler request.
AssemblerException() - Constructor for exception com.endeca.infront.assembler.AssemblerException
Constructs a new AssemblerException with null as its detail message.
AssemblerException(String) - Constructor for exception com.endeca.infront.assembler.AssemblerException
Constructs a new AssemblerException with the specified detail message.
AssemblerException(Throwable) - Constructor for exception com.endeca.infront.assembler.AssemblerException
Constructs a new AssemblerException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
AssemblerException(String, Throwable) - Constructor for exception com.endeca.infront.assembler.AssemblerException
Constructs a new AssemblerException with the specified detail message and cause.
AssemblerFactory - Interface in com.endeca.infront.assembler
Interface for assembler factory implementations.
AssemblerPerfUtils - Class in com.endeca.infront.assembler.perf
A static interface to ease use of Assembler performance timing primitives.
AssemblerSettings - Class in com.endeca.infront.assembler
Used to configure an Assembler.
AssemblerSettings() - Constructor for class com.endeca.infront.assembler.AssemblerSettings
 
assemblyComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
assemblyComplete(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener
An evaluation process has completed.
assemblyComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.request.RequestEventListener
Performs final updates to the RequestEvent for the current request and invokes the RequestEventListener.handleAssemblerRequestEvent(com.endeca.infront.assembler.event.request.RequestEvent, com.endeca.infront.assembler.ContentItem) method on it.
assemblyError(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
assemblyError(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener
An assembly has been aborted due to an unrecoverable error.
assemblyError(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.request.RequestEventListener
Cleans up the RequestEvent for the current request
assemblyStarting(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
assemblyStarting(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener
A new assembly is about to start.
assemblyStarting(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.request.RequestEventListener
Initializes the RequestEvent for the current request
Attribute<T> - Class in com.endeca.infront.cartridge.model
An ordered list of values that represents a record attribute that could be single valued or multi-valued.
Attribute() - Constructor for class com.endeca.infront.cartridge.model.Attribute
 
AUDIT_CONTENTS - Static variable in class com.endeca.infront.cartridge.ContentSlotHandler
Key for the list of audit content items.
augment(FilterState) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, augmented with the specified FilterState object.
AuthoringContentSource - Class in com.endeca.infront.content.source
Deprecated. 
AuthoringContentSource(String, String, String, int, String, String, boolean) - Constructor for class com.endeca.infront.content.source.AuthoringContentSource
Deprecated. 

B

BasicContentItem - Class in com.endeca.infront.assembler
Convenience class to extend when implementing ContentItem
BasicContentItem() - Constructor for class com.endeca.infront.assembler.BasicContentItem
Creates a new BasicContentItem without a type.
BasicContentItem(String) - Constructor for class com.endeca.infront.assembler.BasicContentItem
Creates a new BasicContentItem without the specified type.
BasicContentItem(ContentItem) - Constructor for class com.endeca.infront.assembler.BasicContentItem
Copy constructor.
BasicQueryBuilder - Class in com.endeca.soleng.urlformatter.basic
A QueryBuilder, used to create an UrlENEQuery from a UrlState object.
BasicQueryBuilder() - Constructor for class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
 
BasicQueryBuilder.ParamBinding - Class in com.endeca.soleng.urlformatter.basic
Used by the BasicQueryBuilder class to bind parameters to the UrlENEQuery.
BasicQueryBuilder.ParamBinding() - Constructor for class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder.ParamBinding
 
BasicUrlFormatter - Class in com.endeca.soleng.urlformatter.basic
An UrlFormatter that formats traditional Endeca URLs.
BasicUrlFormatter() - Constructor for class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
 
bind(UrlParam, UrlState, UrlENEQuery) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder.ParamBinding
 
Breadcrumb - Interface in com.endeca.infront.cartridge.model
The cartridge output model interface for a single breadcrumb.
Breadcrumbs - Class in com.endeca.infront.cartridge
BreadcrumbsHandler output model.
Breadcrumbs(BreadcrumbsConfig) - Constructor for class com.endeca.infront.cartridge.Breadcrumbs
Creates the BreadcrumbsHandler output model, using the type and data present in the input BreadcrumbsConfig.
BreadcrumbsConfig - Class in com.endeca.infront.cartridge
BreadcrumbsHandler configuration model.
BreadcrumbsConfig() - Constructor for class com.endeca.infront.cartridge.BreadcrumbsConfig
Creates a BreadcrumbsConfig with no specified type.
BreadcrumbsConfig(String) - Constructor for class com.endeca.infront.cartridge.BreadcrumbsConfig
Creates a BreadcrumbsConfig with the input argument set as the type.
BreadcrumbsConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.BreadcrumbsConfig
Creates a BreadcrumbsConfig and copies the configuration present in the input ContentItem.
BreadcrumbsHandler - Class in com.endeca.infront.cartridge
Cartridge handler that creates Breadcrumbs model objects.
BreadcrumbsHandler() - Constructor for class com.endeca.infront.cartridge.BreadcrumbsHandler
 
buildQuery(UrlState) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
 
buildQuery(UrlState) - Method in interface com.endeca.soleng.urlformatter.QueryBuilder
Marshals the specified UrlState into an ENEQuery.
buildUrlState(NavigationState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
 
buildUrlState(RecordState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
 

C

canonicalize(NavStateUrlParam) - Method in interface com.endeca.soleng.urlformatter.seo.NavStateCanonicalizer
 
canonicalize(NavStateUrlParam) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
CanonicalLinkBuilder - Class in com.endeca.infront.navigation.url.event
Appends the canonical link to the root content item.
CanonicalLinkBuilder() - Constructor for class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
 
cartridgeError(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
cartridgeError(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener
Processing of a cartridge has failed due to a local error.
CartridgeHandler<T extends ContentItem> - Interface in com.endeca.infront.assembler
An interface for inserting custom cartridge logic into the assembler.
CartridgeHandlerException - Exception in com.endeca.infront.assembler
Indicates that an exception occurred while invoking a single cartridge handler.
CartridgeHandlerException() - Constructor for exception com.endeca.infront.assembler.CartridgeHandlerException
Constructs a new CartridgeHandlerException with null as its detail message.
CartridgeHandlerException(String) - Constructor for exception com.endeca.infront.assembler.CartridgeHandlerException
Constructs a new CartridgeHandlerException with the specified detail message.
CartridgeHandlerException(Throwable) - Constructor for exception com.endeca.infront.assembler.CartridgeHandlerException
Constructs a new CartridgeHandlerException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
CartridgeHandlerException(String, Throwable) - Constructor for exception com.endeca.infront.assembler.CartridgeHandlerException
Constructs a new CartridgeHandlerException with the specified detail message and cause.
cartridgeInitializeComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
cartridgeInitializeComplete(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener
A cartridge handler has finished its CartridgeHandler.initialize(ContentItem) method.
cartridgeInitializeStarting(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
cartridgeInitializeStarting(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener
A cartridge handler is about to start its CartridgeHandler.initialize(ContentItem) method.
cartridgePreprocessComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
cartridgePreprocessComplete(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener
A cartridge handler has finished its CartridgeHandler.preprocess(ContentItem) method.
cartridgePreprocessStarting(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
cartridgePreprocessStarting(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener
A cartridge handler is about to start its CartridgeHandler.preprocess(ContentItem) method.
cartridgeProcessComplete(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
cartridgeProcessComplete(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener
A cartridge handler has finished its CartridgeHandler.process(ContentItem) method.
cartridgeProcessStarting(AssemblerEvent) - Method in class com.endeca.infront.assembler.event.AssemblerEventAdapter
 
cartridgeProcessStarting(AssemblerEvent) - Method in interface com.endeca.infront.assembler.event.AssemblerEventListener
A cartridge handler is about to start its CartridgeHandler.process(ContentItem) method.
clearFilterState() - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, clearing the FilterState object of the following: FilterState.getSearchFilters() - clears to an empty list FilterState.getNavigationFilters() - clears to an empty list FilterState.getRangeFilters() - clears to an empty list FilterState.getRecordFilters() - clears to an empty list FilterState.getFeaturedRecords() - clears to an empty list FilterState.getGeoFilter() - clears to null
clearGeoFilter() - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, removing the geo filter.
clearNavigationFilters() - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, clearing the navigation filters.
clearNavState() - Method in class com.endeca.soleng.urlformatter.UrlState
Clears any existing navigation state from this UrlState.
clearParameters() - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, clearing the parameters map.
clearParameters() - Method in interface com.endeca.infront.navigation.RecordState
Create a new RecordState relative to this one, clearing the parameters map.
clearRangeFilters() - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, removing the range filters.
clearRecordFilters() - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, removing the record filters.
clearSearchFilters() - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, removing the searches.
client - Variable in class com.endeca.infront.content.source.WorkbenchContentSource
 
clone() - Method in class com.endeca.infront.navigation.model.AndFilter
 
clone() - Method in class com.endeca.infront.navigation.model.CollectionFilter
 
clone() - Method in class com.endeca.infront.navigation.model.ComboFilter
 
clone() - Method in class com.endeca.infront.navigation.model.DimensionFilter
 
clone() - Method in class com.endeca.infront.navigation.model.EqlFilter
 
clone() - Method in class com.endeca.infront.navigation.model.Filter
 
clone() - Method in class com.endeca.infront.navigation.model.FilterState
Returns a deep copy of this FilterState object.
clone() - Method in class com.endeca.infront.navigation.model.GeoFilter
 
clone() - Method in class com.endeca.infront.navigation.model.OrFilter
 
clone() - Method in class com.endeca.infront.navigation.model.PropertyFilter
 
clone() - Method in class com.endeca.infront.navigation.model.RangeFilter
 
clone() - Method in class com.endeca.infront.navigation.model.SearchFilter
 
clone() - Method in interface com.endeca.soleng.urlformatter.UrlParam
Creates a cloned instance of the parameter.
clone() - Method in class com.endeca.soleng.urlformatter.UrlState
Returns a cloned instance of this UrlState object.
CollectionFilter - Class in com.endeca.infront.navigation.model
Utility class to create record stratum
CollectionFilter() - Constructor for class com.endeca.infront.navigation.model.CollectionFilter
Create a CollectionFilter.
CollectionFilter(Filter) - Constructor for class com.endeca.infront.navigation.model.CollectionFilter
 
com.endeca.infront.assembler - package com.endeca.infront.assembler
Contains the core interfaces for the Assembler.
com.endeca.infront.assembler.event - package com.endeca.infront.assembler.event
The Assembler Event listening interface.
com.endeca.infront.assembler.event.request - package com.endeca.infront.assembler.event.request
Interface for tracking information related to individual Assembler.assemble() calls.
com.endeca.infront.assembler.perf - package com.endeca.infront.assembler.perf
The performance package contains utility classes and interfaces to monitor timing and performance events in an application.
com.endeca.infront.assembler.perf.config - package com.endeca.infront.assembler.perf.config
A set of configuration beans used for configuring the Assembler Perf monitoring system.
com.endeca.infront.assembler.perf.serializers - package com.endeca.infront.assembler.perf.serializers
Contains serializers to be used with the Assembler performance monitoring package.
com.endeca.infront.assembler.servlet - package com.endeca.infront.assembler.servlet
This package provides an HttpServlet interface over an Assembler to serve Assembler clients over the wire and a servlet for generating links for preview.
com.endeca.infront.assembler.servlet.spring - package com.endeca.infront.assembler.servlet.spring
Contains implementations of the Assembler Servlet and Preview Link Servlet powered by Spring for bean resolution.
com.endeca.infront.assembler.spring - package com.endeca.infront.assembler.spring
Contains an implementation of the Assembler that uses Spring for managing configuration and resolving it.
com.endeca.infront.assembler.util - package com.endeca.infront.assembler.util
 
com.endeca.infront.cartridge - package com.endeca.infront.cartridge
Contains the built-in Assembler cartridge handlers and their configuration classes.
com.endeca.infront.cartridge.model - package com.endeca.infront.cartridge.model
Contains model objects for use in the built-in Assembler cartridge handlers.
com.endeca.infront.content - package com.endeca.infront.content
Contains all interfaces for accessing and representing content in an Assembler Application.
com.endeca.infront.content.source - package com.endeca.infront.content.source
Contains interfaces for content sources in an Assembler Application.
com.endeca.infront.navigation - package com.endeca.infront.navigation
Contains classes and interfaces for making requests to an MDEX server.
com.endeca.infront.navigation.event - package com.endeca.infront.navigation.event
The interface to create navigation related RequestEvent objects and log them to an Oracle Endeca log server
com.endeca.infront.navigation.model - package com.endeca.infront.navigation.model
Contains model objects for use in making requests to an MDEX server.
com.endeca.infront.navigation.url - package com.endeca.infront.navigation.url
Contains URL-based implementations of the interfaces in com.endeca.infront.navigation for making requests to an MDEX server.
com.endeca.infront.navigation.url.event - package com.endeca.infront.navigation.url.event
 
com.endeca.infront.serialization - package com.endeca.infront.serialization
Contains serializers that may be used to serialize java beans to XML or JSON.
com.endeca.infront.web.spring - package com.endeca.infront.web.spring
Contains Spring-powered utilities to get an Assembler app working.
com.endeca.infront.web.tags - package com.endeca.infront.web.tags
Contains tags to use when building an Assembler-powered application.
com.endeca.soleng.urlformatter - package com.endeca.soleng.urlformatter
The core of the URL Optimization API containing the fundamental components required for URL manipulation and generation - including the primary UrlState class and its related UrlFormatter and QueryBuilder interfaces.
com.endeca.soleng.urlformatter.basic - package com.endeca.soleng.urlformatter.basic
Contains the BasicUrlFormatter and BasicQueryBuilder classes.
com.endeca.soleng.urlformatter.seo - package com.endeca.soleng.urlformatter.seo
Contains the SeoUrlFormatter and its associated classes for configuring and tuning the behavior of this SEO-friendly implementation of the core UrlFormatter interface.
combineWith(EventSummary) - Method in interface com.endeca.infront.assembler.perf.EventSummary
Aggregate this summary with another.
combineWith(EventSummary) - Method in class com.endeca.infront.assembler.perf.TimeSummary
 
ComboFilter - Class in com.endeca.infront.navigation.model
Base class for AndFilter and OrFilter.
ComboFilter() - Constructor for class com.endeca.infront.navigation.model.ComboFilter
 
ComboFilter(List<Filter>) - Constructor for class com.endeca.infront.navigation.model.ComboFilter
 
compare(Object, Object) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
ConfigInitializer - Class in com.endeca.infront.cartridge
Helper class for implementing CartridgeHandler.initialize(ContentItem).
ConfigInitializer() - Constructor for class com.endeca.infront.cartridge.ConfigInitializer
 
configName() - Static method in enum com.endeca.infront.cartridge.RefinementMenuConfig.RefinementsShown
The parameter name of the configuration.
containsAggrERec() - Method in class com.endeca.soleng.urlformatter.UrlState
Returns true if this UrlState contains an AggrERec parameter.
containsERec() - Method in class com.endeca.soleng.urlformatter.UrlState
Returns true if this UrlState contains an ERec parameter.
containsNavState() - Method in class com.endeca.soleng.urlformatter.UrlState
Returns true if this UrlState contains a navigation state parameter.
containsRollupKey() - Method in class com.endeca.infront.navigation.model.FilterState
 
CONTENT_SLOT_LIST - Static variable in class com.endeca.infront.cartridge.ContentSlotListConfig
 
CONTENT_SOURCE_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 ContentSource to use.
contentBroker - Variable in class com.endeca.infront.cartridge.ContentSlotHandler
The broker for querying the MDEX.
ContentException - Exception in com.endeca.infront.content
Indicates that an exception occurred while creating or processing a content request.
ContentException() - Constructor for exception com.endeca.infront.content.ContentException
 
ContentException(String) - Constructor for exception com.endeca.infront.content.ContentException
 
ContentException(Throwable) - Constructor for exception com.endeca.infront.content.ContentException
 
ContentException(String, Throwable) - Constructor for exception com.endeca.infront.content.ContentException
 
ContentInclude - Class in com.endeca.infront.cartridge
Contains a set of parameters used to make a request for content from the assembler.
ContentInclude(String) - Constructor for class com.endeca.infront.cartridge.ContentInclude
Constructor that requires a URI to get the desired content.
ContentInclude(ContentItem) - Constructor for class com.endeca.infront.cartridge.ContentInclude
Constructor that requires a ContentItem to describe the requested content.
ContentIncludeHandler - Class in com.endeca.infront.cartridge
Cartridge handler that handles content from a URI.
ContentIncludeHandler() - Constructor for class com.endeca.infront.cartridge.ContentIncludeHandler
 
ContentItem - Interface in com.endeca.infront.assembler
The interface that defines the data object (model) in the assembly process.
ContentItemAugmentAdapter - Class in com.endeca.infront.assembler.event.request
Implementation of RequestEventListener that attaches Assembler request information to the content item returned by the Assembler.
ContentItemAugmentAdapter(SessionIdProvider) - Constructor for class com.endeca.infront.assembler.event.request.ContentItemAugmentAdapter
Constructor
ContentItemInitializer - Interface in com.endeca.infront.assembler
An interface for initializing a ContentItem with configuration properties.
ContentLocator - Interface in com.endeca.infront.content.source
Implementations of the ContentLocator interface provide information about the location of a specific ContentItem as well as a means to retrieve that item.
CONTENTS - Static variable in class com.endeca.infront.cartridge.ContentSlotHandler
The key for the list of content items to be added to the content slot
ContentSlotConfig - Class in com.endeca.infront.cartridge
ContentSlotHandler configuration model.
ContentSlotConfig(String, int) - Constructor for class com.endeca.infront.cartridge.ContentSlotConfig
Creates a ContentSlotConfig with type "ContentSlot" and specified content collection and rule limit.
ContentSlotConfig(String, String, int) - Constructor for class com.endeca.infront.cartridge.ContentSlotConfig
Creates a ContentSlotConfig.
ContentSlotConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.ContentSlotConfig
Creates a ContentSlotConfig and copies the configuration present in the input ContentItem.
ContentSlotConfig() - Constructor for class com.endeca.infront.cartridge.ContentSlotConfig
Constructor that sets the type to "ContentSlot".
ContentSlotHandler - Class in com.endeca.infront.cartridge
This CartridgeHandler handles content slot invocations.
ContentSlotHandler() - Constructor for class com.endeca.infront.cartridge.ContentSlotHandler
 
ContentSlotListConfig - Class in com.endeca.infront.cartridge
ContentSlotListHandler configuration model.
ContentSlotListConfig() - Constructor for class com.endeca.infront.cartridge.ContentSlotListConfig
Creates a new ContentSlotListConfig, with type = "ContentSlotList".
ContentSlotListConfig(List<ContentItem>) - Constructor for class com.endeca.infront.cartridge.ContentSlotListConfig
Creates a new ContentSlotListConfig wrapping the specified list, with type = "ContentSlotList".
ContentSlotListConfig(String, List<ContentItem>) - Constructor for class com.endeca.infront.cartridge.ContentSlotListConfig
Creates a new ContentSlotListConfig wrapping the specified list, with the specified type string.
ContentSlotListConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.ContentSlotListConfig
Wraps the specified ContentItem with the ContentSlotListConfig type.
ContentSlotListHandler - Class in com.endeca.infront.cartridge
Cartridge handler that provides a pass through for ContentSlotListConfig objects.
ContentSlotListHandler() - Constructor for class com.endeca.infront.cartridge.ContentSlotListHandler
 
ContentSource - Interface in com.endeca.infront.content.source
Defines a source to retrieve content for the application.
convertToBoolean(ContentItem, String) - Static method in class com.endeca.infront.cartridge.RequestParamMarshaller
Helper method for converting the String value associated with a key to a boolean.
convertToInt(ContentItem, String) - Static method in class com.endeca.infront.cartridge.RequestParamMarshaller
Helper method for converting the String value associated with a key to an integer.
convertToList(ContentItem, String) - Static method in class com.endeca.infront.cartridge.RequestParamMarshaller
Helper method for converting a pipe delimited String value associated with a key to a list of strings.
convertToLong(ContentItem, String) - Static method in class com.endeca.infront.cartridge.RequestParamMarshaller
Helper method for converting the String value associated with a key to a long.
count - Variable in class com.endeca.infront.assembler.perf.TimeSummary
The number of invocations recorded for this summary
createAction(NavigationStateBuilder, ContentSource, ActionPathProvider) - Method in class com.endeca.infront.cartridge.model.LinkBuilder
Returns an action created from the path, link type and query string of this LinkBuilder.
createAggrERecUrlParam(UrlState, AggrERec) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
 
createAggrERecUrlParam(UrlState, AggrERec) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
createAggrERecUrlParam(UrlState, AggrERec) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
Creates an URL parameter containing an AggrERec.
createAssembler() - Method in interface com.endeca.infront.assembler.AssemblerFactory
Creates and returns a new assembler.
createAssembler() - Method in class com.endeca.infront.assembler.spring.SpringAssemblerFactory
 
createAssemblerInput(HttpServletRequest) - Method in class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet
Creates and returns the appropriate input for the the Assembler using the given request object.
createDimensionSearchNavigationState(NavigationState) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsHandler
Takes the global NavigationState and returns the NavigationState that gets used to submit the dimension search query.
createERecUrlParam(UrlState, ERec) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
 
createERecUrlParam(UrlState, ERec) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
createERecUrlParam(UrlState, ERec) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
Creates an URL parameter containing an ERec.
createEvent(String) - Method in interface com.endeca.infront.assembler.perf.EventFactory
Create an event to represent the given id
createEvent(String) - Method in class com.endeca.infront.assembler.perf.TimeEventFactory
 
createHeaderForEventSummary(StringBuilder, String) - Method in class com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer
Appends header text describing the event formatting and time units.
createMdexRequest(FilterState, MdexQuery) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
Convenience method that wraps the MdexRequestBroker.createMdexRequest(FilterState, MdexQuery) method, throwing a CartridgeHandlerException if a NavigationException is caught.
createMdexRequest(FilterState, MdexQuery) - Method in class com.endeca.infront.navigation.MdexRequestBroker
This method is for internal Oracle use only and should never be called.
If the request specified by the given query and filter state has already been constructed, then return a reference to it.
createNavStateUrlParam(UrlState) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
 
createNavStateUrlParam(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
createNavStateUrlParam(UrlState) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
Creates an URL parameter containing an empty NavState.
createSpotlightNavigationState(NavigationState, RecordSpotlightConfig) - Method in class com.endeca.infront.cartridge.RecordSpotlightHandler
This method is responsible for merging the global NavigationState passed in with the RecordSpotlightConfig's navigation selection.
createUrlParam(UrlState, String, String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
 
createUrlParam(UrlState, String, String) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
createUrlParam(UrlState, String, String) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
Creates an URL parameter for the specified UrlState.
createUserState(HttpServletRequest) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder
Returns a UserState object by parsing the information present in the HttpServletRequest.

D

decodeValue(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateEncoder
 
decodeValue(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.UrlParamEncoder
 
DEFAULT_CLIENT_PORT - Static variable in class com.endeca.infront.content.source.WorkbenchContentSource
 
DEFAULT_MESSAGE_TIMEOUT - Static variable in class com.endeca.infront.content.source.WorkbenchContentSource
 
DEFAULT_SERVER_PORT - Static variable in class com.endeca.infront.content.source.WorkbenchContentSource
 
deriveRequestType(NavigationState) - Static method in enum com.endeca.infront.navigation.event.RequestType
Attempt to infer the type of page request from a given navigation state.
destroy() - Method in class com.endeca.infront.assembler.perf.PerfEventFilter
Empty implementation of Filter.destroy().
destroy() - Method in class com.endeca.infront.content.source.AbstractContentSource
 
destroy() - Method in interface com.endeca.infront.content.source.ContentSource
Performs any actions needed to clean up after the content source.
destroy() - Method in class com.endeca.infront.content.source.WorkbenchContentSource
Calls the destroy method of the content source
DIM_SEARCH_ENABLED - Static variable in class com.endeca.infront.cartridge.DimensionSearchResultsRequestParamMarshaller
Url parameter, "Dy", which is used to turn on processing of dimension search results Set to 1 to turn it on, set to 0 to turn it off.
DimensionFilter - Class in com.endeca.infront.navigation.model
A dimension value filter.
DimensionFilter() - Constructor for class com.endeca.infront.navigation.model.DimensionFilter
Creates a dimension value filter.
DimensionFilter(String, String) - Constructor for class com.endeca.infront.navigation.model.DimensionFilter
 
DimensionSearchGroup - Class in com.endeca.infront.cartridge.model
Result of a dimension search grouped by the same dimension.
DimensionSearchGroup() - Constructor for class com.endeca.infront.cartridge.model.DimensionSearchGroup
 
DimensionSearchResults - Class in com.endeca.infront.cartridge
DimensionSearchResultsHandler output model.
DimensionSearchResults(DimensionSearchResultsConfig) - Constructor for class com.endeca.infront.cartridge.DimensionSearchResults
Creates the DimensionSearchResults output model, using the type and data present in the input DimensionSearchResultsConfig.
DimensionSearchResultsConfig - Class in com.endeca.infront.cartridge
DimensionSearchResultsHandler configuration model.
DimensionSearchResultsConfig() - Constructor for class com.endeca.infront.cartridge.DimensionSearchResultsConfig
Creates a DimensionSearchResultsConfig with the following default settings: enabled = false showCountsEnabled = false relRankEnabled = false maxResults = 100 maxResultsPerDimension = 10 dimensionList = null
DimensionSearchResultsConfig(String) - Constructor for class com.endeca.infront.cartridge.DimensionSearchResultsConfig
Creates a DimensionSearchResultsConfig with the following default settings: enabled = false showCountsEnabled = false relRankEnabled = false maxResults = 100 maxResultsPerDimension = 10 dimensionList = null
DimensionSearchResultsConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.DimensionSearchResultsConfig
Creates a DimensionSearchResultsConfig with the following default settings: enabled = false showCountsEnabled = false relRankEnabled = false maxResults = 100 maxResultsPerDimension = 10 dimensionList = null
DimensionSearchResultsHandler - Class in com.endeca.infront.cartridge
Cartridge handler that creates DimensionSearchResults model objects.
DimensionSearchResultsHandler() - Constructor for class com.endeca.infront.cartridge.DimensionSearchResultsHandler
 
DimensionSearchResultsRequestParamMarshaller - Class in com.endeca.infront.cartridge
Creates DimensionSearchResultsHandler configuration from the parameters present in a request URL.
DimensionSearchResultsRequestParamMarshaller() - Constructor for class com.endeca.infront.cartridge.DimensionSearchResultsRequestParamMarshaller
Creates the marshaller for reading request parameters related to DimensionSearchResultsConfig.
DimensionSearchValue - Class in com.endeca.infront.cartridge.model
A model class that represents a single search result within a DimensionSearchGroup.
DimensionSearchValue() - Constructor for class com.endeca.infront.cartridge.model.DimensionSearchValue
 
DimLocationFormatter - Interface in com.endeca.soleng.urlformatter.seo
An extension point used by various SEO URL formatting classes to control the rendering of DimLocation objects into path-encoded keyword strings.
dispatchNavigationEventInformation(ENEQueryResults) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
Tracks all Navigation State related information
dispatchNavigationEventInformation(ResultsListConfig, ResultsList) - Method in class com.endeca.infront.cartridge.ResultsListHandler
Tracks all Navigation State related information.
doAfterBody() - Method in class com.endeca.infront.web.tags.IncludeSlot
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class com.endeca.infront.assembler.perf.PerfEventFilter
Starts performance monitoring on invocation, and stops it once the filter chain returns.
doGet(HttpServletRequest, HttpServletResponse) - Method in class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet
Creates an Assembler, passes it input based on the request, and processes the results.
doGet(HttpServletRequest, HttpServletResponse) - Method in class com.endeca.infront.assembler.servlet.AbstractPreviewLinkServlet
Creates and returns a link to the page specified using request parameters.
doTag() - Method in class com.endeca.infront.web.tags.PageHead
DvalSpec - Class in com.endeca.infront.navigation.model
 
DvalSpec() - Constructor for class com.endeca.infront.navigation.model.DvalSpec
 
DYM_ENABLED_PARAMETER - Static variable in class com.endeca.infront.cartridge.SearchAdjustmentsRequestParamMarshaller
Name of request parameter, "Nty", that enables/disables search suggestions.

E

emptySummary(StringBuilder) - Method in class com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer
 
enableKeywordRedirects() - Method in class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet
A method to obtain whether or not keyword redirects should be supported.
enableKeywordRedirects() - Method in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet
 
encodeValue(UrlState, UrlParam) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateEncoder
 
encodeValue(UrlState, UrlParam) - Method in class com.endeca.soleng.urlformatter.seo.UrlParamEncoder
 
ENDECA_CONTENT_PATH - Static variable in class com.endeca.infront.cartridge.ContentIncludeHandler
The key for the content root value.
ENDECA_SITE_ROOT_PATH - Static variable in class com.endeca.infront.cartridge.ContentIncludeHandler
The key for the site root value.
EqlFilter - Class in com.endeca.infront.navigation.model
The EqlFilter contains an EQL expression, which is used to filter the results of a search.
EqlFilter() - Constructor for class com.endeca.infront.navigation.model.EqlFilter
Creates an empty EQL filter.
EqlFilter(String) - Constructor for class com.endeca.infront.navigation.model.EqlFilter
Creates an EQL filter.
equals(Object) - Method in class com.endeca.infront.navigation.model.AndFilter
 
equals(Object) - Method in class com.endeca.infront.navigation.model.CollectionFilter
 
equals(Object) - Method in class com.endeca.infront.navigation.model.ComboFilter
 
equals(Object) - Method in class com.endeca.infront.navigation.model.DimensionFilter
 
equals(Object) - Method in class com.endeca.infront.navigation.model.DvalSpec
Returns true if the given object is equal to this DvalSpec, false otherwise.
equals(Object) - Method in class com.endeca.infront.navigation.model.EqlFilter
equals(Object) - Method in class com.endeca.infront.navigation.model.FilterState
Returns true if the given object is equal to this filter state, false otherwise.
equals(Object) - Method in class com.endeca.infront.navigation.model.GeoFilter
equals(Object) - Method in class com.endeca.infront.navigation.model.GeoSortSpec
 
equals(Object) - Method in class com.endeca.infront.navigation.model.OrFilter
 
equals(Object) - Method in class com.endeca.infront.navigation.model.PropertyFilter
 
equals(Object) - Method in class com.endeca.infront.navigation.model.RangeFilter
equals(Object) - Method in class com.endeca.infront.navigation.model.SearchFilter
equals(Object) - Method in class com.endeca.infront.navigation.model.SortOption
Equality check.
equals(Object) - Method in class com.endeca.infront.navigation.model.SortSpec
 
equals(Object) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
ERecFormatter - Interface in com.endeca.soleng.urlformatter.seo
Interface that specifies the formatting of a UrlState associated with an Endeca record, aggregated by an SeoUrlFormatter.
ERecUrlParam - Interface in com.endeca.soleng.urlformatter
An interface used internally by an UrlState to store an ERec for record detail page links.
Event - Interface in com.endeca.infront.assembler.perf
An abstract interface that represents a performance event.
EVENT_EXECUTE - Static variable in class com.endeca.infront.content.MdexContentRequestBroker
 
EventFactory - Interface in com.endeca.infront.assembler.perf
An interface to produce Events for an EventSerializer.
EventSerializer - Interface in com.endeca.infront.assembler.perf
An interface that serializes EventSummary instances.
EventSummary - Interface in com.endeca.infront.assembler.perf
An interface which represents the summary of multiple Events.
executeMdexRequest(MdexRequest) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
Convenience method that wraps the MdexRequest.execute(), throwing a CartridgeHandlerException if a NavigationException is caught.

F

Filter - Class in com.endeca.infront.navigation.model
Abstract base class for various types of Endeca filter.
Filter() - Constructor for class com.endeca.infront.navigation.model.Filter
 
FilterState - Class in com.endeca.infront.navigation.model
A class that contains the filters applied to an Endeca data set.
FilterState() - Constructor for class com.endeca.infront.navigation.model.FilterState
Creates a new empty FilterState object.
FilterState(List<String>, List<SearchFilter>, List<RangeFilter>, GeoFilter, List<String>, List<String>, String, String, String, boolean) - Constructor for class com.endeca.infront.navigation.model.FilterState
Deprecated. use the empty constructor FilterState.FilterState() and the requisite setter methods instead.
finished() - Method in interface com.endeca.infront.assembler.perf.Event
Produce a summary of this event, for storage and further summarization.
finished() - Method in class com.endeca.infront.assembler.perf.TimeEvent
 
format(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.LowerCaseStringFormatter
 
format(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
 
format(UrlState, String) - Method in interface com.endeca.soleng.urlformatter.seo.StringFormatter
 
format(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.StringFormatterChain
 
format(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.UpperCaseStringFormatter
 
format(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.UrlEncodedStringFormatter
 
formatAggrERec(UrlState, AggrERec) - Method in interface com.endeca.soleng.urlformatter.seo.AggrERecFormatter
 
formatAggrERec(UrlState, AggrERec) - Method in class com.endeca.soleng.urlformatter.seo.SeoAggrERecFormatter
 
formatAggrERec(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatCanonicalUrl(UrlState) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
 
formatCanonicalUrl(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatCanonicalUrl(UrlState) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
Formats a canonical url.
formatDimLocation(UrlState, DimLocation) - Method in interface com.endeca.soleng.urlformatter.seo.DimLocationFormatter
Formats the specified DimLocation for the specified UrlState.
formatDimLocation(UrlState, DimLocation) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
 
formatERec(UrlState, ERec) - Method in interface com.endeca.soleng.urlformatter.seo.ERecFormatter
 
formatERec(UrlState, ERec) - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
 
formatERec(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatNavState(UrlState, DimLocationList) - Method in interface com.endeca.soleng.urlformatter.seo.NavStateFormatter
 
formatNavState(UrlState, DimLocationList) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
 
formatNavState(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatPathKeywords(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatPathParams(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatQueryString(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatUrl(UrlState) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
 
formatUrl(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatUrl(UrlState) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
Formats the specified UrlState into an URL string.

G

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.
getApplicationName() - Method in interface com.endeca.infront.content.source.ContentLocator
The name of the application to which this locator's content item belongs.
getAppName() - Method in class com.endeca.infront.content.source.WorkbenchContentSource
 
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"
getAssembler() - Method in class com.endeca.infront.assembler.event.AssemblerEvent
 
getAssemblerFactory() - Method in class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet
A method to retrieve an AssemblerFactory.
getAssemblerFactory() - Method in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet
Retrieves an AssemblerFactory using the Spring Framework.
getAssemblerResponseDecorators() - Method in class com.endeca.infront.assembler.AssemblerSettings
 
getAssemblyFinishTime() - Method in class com.endeca.infront.assembler.event.request.RequestEvent
 
getAssemblyStartTime() - Method in class com.endeca.infront.assembler.event.request.RequestEvent
 
getAttributes() - Method in class com.endeca.infront.cartridge.model.Record
Record attribute (property and dimension) values, indexed by name string.
getAuditContents(String) - 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
 
getBooleanProperty(String, boolean) - Method in class com.endeca.infront.assembler.BasicContentItem
Convenience method for getting a boolean property value.
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.
getCartridgeHandler() - Method in class com.endeca.infront.assembler.event.AssemblerEvent
 
getClassName() - Method in class com.endeca.infront.assembler.perf.config.LoggableEventConfiguration
Get the class name for this event configuration.
getClientPort() - Method in class com.endeca.infront.content.source.WorkbenchContentSource
 
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.ContentIncludeHandler
A method that allows subclasses to control the content returned by the ContentIncludeHandler.preprocess(com.endeca.infront.assembler.ContentItem) method.
getContent(ContentLocator) - Method in class com.endeca.infront.cartridge.RedirectAwareContentIncludeHandler
Adds keyword redirect information, if a redirect was triggered.
getContent() - Method in interface com.endeca.infront.content.source.ContentLocator
Retrieves this locator's content item.
getContentBytes() - Method in class com.endeca.infront.cartridge.model.MediaObject
 
getContentCollection() - Method in class com.endeca.infront.cartridge.ContentSlotConfig
Returns the content collection name.
getContentHeight() - Method in class com.endeca.infront.cartridge.model.MediaObject
 
getContentItem() - Method in class com.endeca.infront.assembler.event.AssemblerEvent
 
getContentItemInitializer() - Method in class com.endeca.infront.cartridge.ContentSlotListHandler
Returns the ContentItemInitializer used to create the full cartridge configuration.
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 interface com.endeca.infront.content.source.ContentLocator
The path within the site that refers to this locator's content item.
getContentPath() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
 
getContents(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 from a specified content collection.
getContentSlotList() - Method in class com.endeca.infront.cartridge.ContentSlotListConfig
Gets the ContentSlotConfig list contained in this ContentSlotListConfig.
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.ContentIncludeHandler
Gets the content source used by this handler.
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
 
getContentUri() - Method in class com.endeca.infront.cartridge.ContentInclude
The URI to retrieve content from a configured ContentSource.
getContentUri() - Method in interface com.endeca.infront.content.source.ContentLocator
Convenience method for getting the full content URI.
getContentWidth() - Method in class com.endeca.infront.cartridge.model.MediaObject
 
getContextPath() - Method in class com.endeca.infront.web.spring.SpringUtility
Retrieves the context path from the ServletContext via the Spring WebApplicationContext.
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.
getDate() - Method in class com.endeca.infront.navigation.UserState
 
getDateAsString() - Method in class com.endeca.infront.navigation.UserState
 
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
 
getDefaultSiteRootPath() - Method in class com.endeca.infront.content.source.AbstractContentSource
If a valid content URI cannot be extracted from the request in the AbstractContentSource.resolveContent(HttpServletRequest) method, it will attempt to resolve the content URI using this default site root path.
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".
getError() - Method in class com.endeca.infront.assembler.event.AssemblerEvent
 
getEvent() - Static method in class com.endeca.infront.assembler.event.request.RequestEventFactory
 
getEventFactory() - Method in interface com.endeca.infront.assembler.perf.EventSerializer
Get the factory which is responsible for creating events for this serializer.
getEventFactory() - Method in class com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer
Get the factory which is responsible for creating events for this serializer.
getEventFactory() - Method in class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer
 
getEvents() - Method in class com.endeca.infront.assembler.perf.config.LoggableEventConfiguration
Get the events to be recorded for this class.
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
 
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.content.source.WorkbenchContentSource
 
getHost() - Method in class com.endeca.infront.navigation.model.MdexResource
 
getHttpServletRequest() - Method in class com.endeca.infront.web.spring.SpringUtility
Uses org.springframework.web to retrieve the current servlet request
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.
getIntProperty(String, int) - Method in class com.endeca.infront.assembler.BasicContentItem
Convenience method for getting an int property value.
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
 
getLongProperty(String, long) - Method in class com.endeca.infront.assembler.BasicContentItem
Convenience method for getting a long property value.
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
Returns the list of MediaSourceConfig objects.
getMessageTimeout() - Method in class com.endeca.infront.content.source.WorkbenchContentSource
 
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
A method to retrieve a NavigationStateBuilder to use for creating links.
getNavigationStateBuilder() - Method in class com.endeca.infront.assembler.servlet.spring.SpringPreviewLinkServlet
Retrieves a NavigationStateBuilder using the Spring Framework.
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
 
getPreviewModuleUrl() - Method in class com.endeca.infront.assembler.AssemblerSettings
Returns the preview module URL, for use when preview is enabled.
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
 
getRealPath() - Method in class com.endeca.infront.web.spring.SpringUtility
Retrieves the real path from the ServletContext via the Spring WebApplicationContext.
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
getRecordedEvents() - Method in class com.endeca.infront.assembler.perf.config.RecordedEventsConfiguration
Returns the list of events to 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.
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
Returns the RefinementMenu type.
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
Deprecated. use DimensionSearchResultsConfig.getRelRankStrategy() instead.
getRelRank() - Method in class com.endeca.infront.cartridge.ResultsListConfig
Deprecated. use ResultsListConfig.getRelRankStrategy() instead.
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
Gets the list of URL parameters that will get removed when NavigationState.clearFilterState() is called.
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
 
getResponseWriter() - Method in class com.endeca.infront.assembler.servlet.AbstractAssemblerServlet
A method to retrieve a ResponseWriter.
getResponseWriter() - Method in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet
Retrieves a ResponseWriter using the Spring Framework.
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.
getRuleLimit() - Method in class com.endeca.infront.cartridge.ContentSlotConfig
Returns the maximum number of rules that can fire for this slot.
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
Gets the text to display for the See All Action returned by RecordSpotlight.getSeeAllLink().
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.
getServerPort() - Method in class com.endeca.infront.content.source.WorkbenchContentSource
 
getSessionId() - Method in class com.endeca.infront.assembler.event.request.RequestEvent
 
getSessionId() - Method in interface com.endeca.infront.assembler.event.request.SessionIdProvider
 
getSessionId() - Method in class com.endeca.infront.web.spring.SpringUtility
Uses org.springframework.web to retrieve the current servlet request's session id
getShowMoreIds() - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
Deprecated. As of release 3.1.1, replaced by NavigationContainerConfig.getRefinementsShown().
Returns dimension IDs for which 'More' refinement expansion should happen.
getShowSeeAllLink() - Method in class com.endeca.infront.cartridge.RecordSpotlightConfig
Gets whether to display the See All Action returned by RecordSpotlight.getSeeAllLink().
getSiteRootPath() - Method in class com.endeca.infront.cartridge.model.Action
 
getSiteRootPath() - Method in interface com.endeca.infront.content.source.ContentLocator
The path of the site to which this locator's content item belongs.
getSiteRootPath() - Method in class com.endeca.infront.navigation.event.NavigationEventWrapper
 
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
Returns the SortOption.
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
The number of DimensionSearchValues in this result.
getType() - Method in class com.endeca.infront.assembler.BasicContentItem
Returns the type of this content item.
getType() - Method in interface com.endeca.infront.assembler.ContentItem
 
getTypedProperty(String) - Method in class com.endeca.infront.assembler.BasicContentItem
Convenience method for returning a property value without having to cast the return value to the desired type.
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
 
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.
getUserAgent() - Method in class com.endeca.infront.navigation.UserState
 
getUserSegments() - Method in class com.endeca.infront.navigation.UserState
 
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
Returns the RefinementMenuConfig.RefinementsShown whose RefinementMenuConfig.RefinementsShown.toString() method matches the input argument.
getValue(String) - Static method in enum com.endeca.infront.navigation.model.MatchMode
Returns the MatchMode whose name or MatchMode.toString() method matches the input argument.
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.

H

handleAssemblerRequestEvent(RequestEvent, ContentItem) - Method in class com.endeca.infront.assembler.event.request.ContentItemAugmentAdapter
Attaches Assembler request information to the given Assembler output ContentItem.
handleAssemblerRequestEvent(RequestEvent, ContentItem) - Method in class com.endeca.infront.assembler.event.request.RequestEventListener
This method is invoked when an Assembler invocation is complete and the corresponding RequestEvent is fully populated.
handleAssemblerRequestEvent(RequestEvent, ContentItem) - Method in class com.endeca.infront.navigation.event.LogServerAdapter
Send information about the Assembler request to an Oracle Endeca Log Server.
handleAssemblerRequestEvent(RequestEvent, ContentItem) - Method in class com.endeca.infront.navigation.url.event.CanonicalLinkBuilder
 
handledParams - Variable in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
A list of the parameters that are parsed by the methods in this class.
hashCode() - Method in class com.endeca.infront.navigation.model.CollectionFilter
 
hashCode() - Method in class com.endeca.infront.navigation.model.ComboFilter
 
hashCode() - Method in class com.endeca.infront.navigation.model.DimensionFilter
 
hashCode() - Method in class com.endeca.infront.navigation.model.DvalSpec
 
hashCode() - Method in class com.endeca.infront.navigation.model.EqlFilter
 
hashCode() - Method in class com.endeca.infront.navigation.model.FilterState
 
hashCode() - Method in class com.endeca.infront.navigation.model.GeoFilter
 
hashCode() - Method in class com.endeca.infront.navigation.model.GeoSortSpec
 
hashCode() - Method in class com.endeca.infront.navigation.model.PropertyFilter
 
hashCode() - Method in class com.endeca.infront.navigation.model.RangeFilter
 
hashCode() - Method in class com.endeca.infront.navigation.model.SearchFilter
 
hashCode() - Method in class com.endeca.infront.navigation.model.SortOption
 
hashCode() - Method in class com.endeca.infront.navigation.model.SortSpec
 

I

IGNORE_STATS_EVENT_ID - Static variable in class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer
Signals that the following events should not be included in the performance statistics.
IncludeSlot - Class in com.endeca.infront.web.tags
Tag for enabling Workbench preview functionality; all slot JSP files must include an IncludeSlot tag.
IncludeSlot() - Constructor for class com.endeca.infront.web.tags.IncludeSlot
 
inform(ENEQueryResults) - Method in interface com.endeca.infront.navigation.NavigationState
This method is for internal Oracle use only and should never be called.

Informs this class of important meta-information.
inform(DimLocation) - Method in interface com.endeca.infront.navigation.NavigationState
This method is for internal Oracle use only and should never be called.

Informs this class of important meta-information.
inform(DimLocationList) - Method in interface com.endeca.infront.navigation.NavigationState
This method is for internal Oracle use only and should never be called.

Informs this class of important meta-information.
inform(ENEQueryResults) - Method in interface com.endeca.infront.navigation.RecordState
Informs this class of important meta-information.
inform(ENEQueryResults) - Method in class com.endeca.soleng.urlformatter.UrlState
Initializes this UrlState using state from the specified ENEQueryResults.
init(FilterConfig) - Method in class com.endeca.infront.assembler.perf.PerfEventFilter
Empty implementation of Filter.init(javax.servlet.FilterConfig).
init(ServletConfig) - Method in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet
 
init(ServletConfig) - Method in class com.endeca.infront.assembler.servlet.spring.SpringPreviewLinkServlet
 
init() - Method in class com.endeca.infront.content.source.WorkbenchContentSource
Validates all configuration parameters are set on the WorkbenchContentSource and establishes a connection to the Workbench Server to receive content.
initEvent() - Static method in class com.endeca.infront.assembler.event.request.RequestEventFactory
Initialize the RequestEvent for the current request.
initialize(ContentItem) - Method in class com.endeca.infront.assembler.AbstractCartridgeHandler
This implementation simply returns the input ContentItem without modification.
initialize(ContentItem) - Method in interface com.endeca.infront.assembler.CartridgeHandler
Called by the assembler once for each cartridge instance, immediately before CartridgeHandler.preprocess(ContentItem) is called.
initialize(ContentItem) - Method in interface com.endeca.infront.assembler.ContentItemInitializer
Initialize the input ContentItem.
initialize(ContentItem) - Method in class com.endeca.infront.cartridge.ConfigInitializer
Subclasses can extend this method to add layers or re-order layers.
initialize(ContentItem) - Method in class com.endeca.infront.cartridge.ContentSlotListHandler
Uses the ContentItemInitializer, if one has been set, to create the full configuration for this cartridge.
initialize(ContentItem) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
Uses the ContentItemInitializer, if one has been set, to create the full configuration for this cartridge.
initialize(ContentItem) - Method in class com.endeca.infront.cartridge.ResultsListHandler
Creates a ResultsListConfig representing the full configuration for this cartridge.
isAggregateRecord() - Method in interface com.endeca.infront.navigation.RecordState
 
isAuditEnabled() - Method in class com.endeca.infront.assembler.AssemblerSettings
Returns whether or not audit contents should be retrieved.
isAuditEnabled() - Method in class com.endeca.infront.content.MdexContentRequestBroker
This method is for internal Oracle use only and should never be called.
Returns a value indicating whether audit is enabled.
isAugment() - Method in class com.endeca.infront.cartridge.RecordSpotlightSelection
Indicates whether current record selection should be augmented by the current navigation state.
isAuthoring() - Method in class com.endeca.infront.content.source.WorkbenchContentSource
 
isAutoPhrased() - Method in class com.endeca.infront.cartridge.model.AdjustedSearch
 
isAutoPhrased() - Method in class com.endeca.infront.cartridge.model.SuggestedSearch
 
isAutoPhraseEnabled() - Method in class com.endeca.infront.navigation.model.FilterState
 
isDefault() - Method in class com.endeca.infront.navigation.model.SortOption
Returns whether or not this sort was applied as a default sort, or as a user-requested sort Used to control the application of Boost / Bury
isDescending() - Method in class com.endeca.infront.navigation.model.SortSpec
The sort direction.
isEmpty() - Method in class com.endeca.infront.cartridge.RecordSpotlightSelection
Return if this selection is empty.
isEmpty() - Method in class com.endeca.infront.navigation.model.FilterState
Returns true if this FilterState has no filters, false otherwise.
isEnabled() - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
Returns whether or not the dimension search cartridge is enabled.
isIncludePrecomputedSorts() - Method in class com.endeca.infront.cartridge.ResultsListConfig
 
isLoggingEnabled() - Static method in class com.endeca.infront.assembler.event.request.RequestEventFactory
 
isMultiSelect() - Method in class com.endeca.infront.cartridge.model.Refinement
 
isMultiSelect() - Method in class com.endeca.infront.cartridge.model.RefinementBreadcrumb
 
isMultiSelect() - Method in class com.endeca.infront.cartridge.RefinementMenu
Whether this RefinementMenu allows multiple Refinements to be selected at the same time.
isPhraseSuggestionEnabled() - Method in class com.endeca.infront.cartridge.SearchAdjustmentsConfig
 
isPreviewEnabled() - Method in class com.endeca.infront.assembler.AssemblerSettings
 
isSelected() - Method in class com.endeca.infront.cartridge.model.SortOptionLabel
True if this label represents the current selection.
isShowCountsEnabled() - Method in class com.endeca.infront.cartridge.DimensionSearchResultsConfig
Returns whether or not record counts are calculated for each result item.
isShowMore() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
Deprecated. As of release 3.1.1, replaced by RefinementMenuConfig.getRefinementsShown().
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". The default value for this property is false.
isShowMoreLink() - 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.
isShowWordInterp() - Method in class com.endeca.infront.cartridge.SearchAdjustmentsConfig
 
isSpellCorrected() - Method in class com.endeca.infront.cartridge.model.AdjustedSearch
 
isSpellCorrected() - Method in class com.endeca.infront.cartridge.model.SuggestedSearch
 
isSpellSuggestionEnabled() - Method in class com.endeca.infront.cartridge.SearchAdjustmentsConfig
 
isTimingPerformance() - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils
Returns whether performance is being monitored on the current request/thread.
isWhyMatchEnabled() - Method in class com.endeca.infront.cartridge.ResultsListConfig
Returns if why match debugging should be enabled.
isWhyPrecedenceRuleFired() - Method in class com.endeca.infront.cartridge.NavigationContainerConfig
When true, enables the reporting of 'why precedence rule fired' debug information.
isWhyPrecedenceRuleFired() - Method in class com.endeca.infront.cartridge.RefinementMenuConfig
When true, enables the reporting of 'why precedence rule fired' debug information.
isWhyRankEnabled() - Method in class com.endeca.infront.cartridge.ResultsListConfig
Returns if why rank debugging should be enabled.

J

JsonAttribute - Class in com.endeca.infront.cartridge.model
An attribute that stores JSON formatted property values in a Record.
JsonAttribute(Object) - Constructor for class com.endeca.infront.cartridge.model.JsonAttribute
Constructs an attribute with a JSON object (a List or any other object) If object is a List, adds all elements to this attribute.
JsonResponseWriter - Class in com.endeca.infront.assembler.servlet
Serializes the Assembler output as JSON and writes it to the response.
JsonResponseWriter() - Constructor for class com.endeca.infront.assembler.servlet.JsonResponseWriter
 
JsonSerializer - Class in com.endeca.infront.serialization
A class for serializing java objects to JSON.
JsonSerializer(Writer) - Constructor for class com.endeca.infront.serialization.JsonSerializer
Create a JsonSerializer with the given Writer.

K

KEYWORD_REDIRECTS_PARAM - Static variable in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet
The servlet parameter used to enable keyword redirects.

L

LinkBuilder - Class in com.endeca.infront.cartridge.model
A class that represents links as created by the LinkBuilder editor in Experience Manager and transforms them into Action objects.
LinkBuilder() - Constructor for class com.endeca.infront.cartridge.model.LinkBuilder
Default constructor.
LinkBuilder(String) - Constructor for class com.endeca.infront.cartridge.model.LinkBuilder
Constructs a LinkBuilder model with the specified path.
LinkBuilder(String, LinkBuilder.LinkType) - Constructor for class com.endeca.infront.cartridge.model.LinkBuilder
Constructs a LinkBuilder model with the specified path and link type.
LinkBuilder(String, LinkBuilder.LinkType, String) - Constructor for class com.endeca.infront.cartridge.model.LinkBuilder
Constructs a LinkBuilder model with the specified path, link type and queryString.
LinkBuilder.LinkType - Enum in com.endeca.infront.cartridge.model
The types of links that the LinkBuilder supports.
LiveContentSource - Class in com.endeca.infront.content.source
Deprecated. 
LiveContentSource(String, String, String, int, int, String, String) - Constructor for class com.endeca.infront.content.source.LiveContentSource
Deprecated. 
local - Variable in class com.endeca.infront.assembler.perf.TimeSummary
All the local (non-descendant) time recorded
locate(String) - Method in interface com.endeca.infront.assembler.util.ObjectLocator
Retrieves the requested resource by name.
locate(String) - Method in class com.endeca.infront.web.spring.SpringUtility
Retrieves a bean from the application context.
LoggableEventConfiguration - Class in com.endeca.infront.assembler.perf.config
A bean to configure what performance events are loggable with PerfLogTimeEventSerializer.
LoggableEventConfiguration() - Constructor for class com.endeca.infront.assembler.perf.config.LoggableEventConfiguration
 
LogServerAdapter - Class in com.endeca.infront.navigation.event
Sends Assembler request event to an Oracle Endeca Log Server
LogServerAdapter(SessionIdProvider, String, Integer) - Constructor for class com.endeca.infront.navigation.event.LogServerAdapter
Constructs a new LogServerAdapter
LowerCaseStringFormatter - Class in com.endeca.soleng.urlformatter.seo
A StringFormatter that formats strings to lower case.
LowerCaseStringFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.LowerCaseStringFormatter
 

M

makeConnection() - Method in class com.endeca.infront.navigation.model.MdexResource
 
marshall() - Method in class com.endeca.infront.cartridge.DimensionSearchResultsRequestParamMarshaller
 
marshall() - Method in class com.endeca.infront.cartridge.NavigationContainerRequestParamMarshaller
 
marshall() - Method in class com.endeca.infront.cartridge.RefinementMenuRequestParamMarshaller
 
marshall() - Method in class com.endeca.infront.cartridge.RequestParamMarshaller
Creates a new ContentItem and populates it with information from the HttpServletRequest.
marshall() - Method in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
 
marshall() - Method in class com.endeca.infront.cartridge.SearchAdjustmentsRequestParamMarshaller
 
MatchMode - Enum in com.endeca.infront.navigation.model
 
mAuditEnabled - Variable in class com.endeca.infront.content.MdexContentRequestBroker
 
max - Variable in class com.endeca.infront.assembler.perf.TimeSummary.MinMaxTotalSummary
The maximum time observed across all invocations of this event.
mDateParam - Variable in class com.endeca.infront.content.RequestParamUserStateBuilder
 
MdexContentRequestBroker - Class in com.endeca.infront.content
Internal class used by Endeca cartridge handlers used to retrieve content using the MDEX-based rules engine -- Should not be used directly outside of Endeca content cartridge handlers.
MdexContentRequestBroker(MdexResource, NavigationState, UserState, boolean) - Constructor for class com.endeca.infront.content.MdexContentRequestBroker
Builds an MDEX Content Request Broker
MdexRequestBroker - Class in com.endeca.infront.navigation
Internal class used by Endeca cartridge handlers to query the MDEX engine -- Should not be used directly outside of Endeca navigation cartridge handlers.
MdexRequestBroker(MdexResource, boolean) - Constructor for class com.endeca.infront.navigation.MdexRequestBroker
Creates an MDEX request broker.
MdexResource - Class in com.endeca.infront.navigation.model
Allows a connection to an MDEX server to be created.
MdexResource() - Constructor for class com.endeca.infront.navigation.model.MdexResource
 
MediaBanner - Class in com.endeca.infront.cartridge
MediaBanner output model.
MediaBanner(ContentItem) - Constructor for class com.endeca.infront.cartridge.MediaBanner
Creates the MediaBanner output model, using the type and data present in the input ContentItem.
MediaBannerConfig - Class in com.endeca.infront.cartridge
MediaBannerConfig configuration model.
MediaBannerConfig() - Constructor for class com.endeca.infront.cartridge.MediaBannerConfig
Creates an empty MediaBannerConfig.
MediaBannerConfig(String) - Constructor for class com.endeca.infront.cartridge.MediaBannerConfig
Creates an empty MediaBannerConfig with the specified type.
MediaBannerConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.MediaBannerConfig
Creates a copy of the specified ContentItem, and returns it as an instance of MediaBannerConfig.
MediaBannerHandler - Class in com.endeca.infront.cartridge
Cartridge handler that creates MediaObject model objects.
MediaBannerHandler() - Constructor for class com.endeca.infront.cartridge.MediaBannerHandler
 
MediaObject - Class in com.endeca.infront.cartridge.model
A generic media object that could represent an image or a video.
MediaObject() - Constructor for class com.endeca.infront.cartridge.model.MediaObject
 
MediaSourceConfig - Class in com.endeca.infront.cartridge.model
MediaObject configuration model.
MediaSourceConfig() - Constructor for class com.endeca.infront.cartridge.model.MediaSourceConfig
 
min - Variable in class com.endeca.infront.assembler.perf.TimeSummary.MinMaxTotalSummary
The minimum time observed across all invocations of this event.
mMdexResource - Variable in class com.endeca.infront.content.MdexContentRequestBroker
 
mNavigationState - Variable in class com.endeca.infront.content.MdexContentRequestBroker
 
mRecordState - Variable in class com.endeca.infront.cartridge.RecordDetailsHandler
 
mRequest - Variable in class com.endeca.infront.cartridge.RequestParamMarshaller
 
mRequestMap - Variable in class com.endeca.infront.cartridge.RequestParamMarshaller
 
mUrlParamEncoders() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
The UrlParamEncoder objects used by this SeoUrlFormatter.
mUserAgentParam - Variable in class com.endeca.infront.content.RequestParamUserStateBuilder
 
mUserSegmentParam - Variable in class com.endeca.infront.content.RequestParamUserStateBuilder
 
mUserState - Variable in class com.endeca.infront.content.MdexContentRequestBroker
 

N

NAV_REFINEMENT_MENU_CONFIG - Static variable in class com.endeca.infront.cartridge.NavigationContainerRequestParamMarshaller
Name of request parameter that sets the navigation refinement menu configuration.
NAV_REFINEMENT_MENU_CONFIG - Static variable in class com.endeca.infront.cartridge.RefinementMenuRequestParamMarshaller
Name of request parameter that sets the navigation refinement menu configuration.
NAVIGATION_STATE_BUILDER_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 NavigationStateBuilder to use.
NavigationAction - Class in com.endeca.infront.cartridge.model
An Action which represents a change to the current navigation state (e.g., selecting a refinement, performing a search, or paging through results).
NavigationAction() - Constructor for class com.endeca.infront.cartridge.model.NavigationAction
Default constructor.
NavigationAction(String) - Constructor for class com.endeca.infront.cartridge.model.NavigationAction
Constructs a NavigationAction with the give navigation state.
NavigationAction(String, String) - Constructor for class com.endeca.infront.cartridge.model.NavigationAction
Constructs a NavigationAction with the give navigation state and label.
NavigationAction(String, String, String, String) - Constructor for class com.endeca.infront.cartridge.model.NavigationAction
Constructs a navigation action with the given navigation state, label, site root path and content path.
NavigationCartridgeHandler<ConfigType extends ContentItem,ModelType extends ContentItem> - Class in com.endeca.infront.cartridge
Base class for Endeca navigation cartridge handlers.
NavigationCartridgeHandler() - Constructor for class com.endeca.infront.cartridge.NavigationCartridgeHandler
 
NavigationContainer - Class in com.endeca.infront.cartridge
NavigationContainerHandler output model.
NavigationContainer(NavigationContainerConfig) - Constructor for class com.endeca.infront.cartridge.NavigationContainer
Creates the NavigationContainer output model, using the type and data present in the input NavigationContainerConfig.
NavigationContainerConfig - Class in com.endeca.infront.cartridge
NavigationContainerHandler configuration model.
NavigationContainerConfig() - Constructor for class com.endeca.infront.cartridge.NavigationContainerConfig
Creates a NavigationContainerConfig with the following default setting: whyPrecedenceRuleFired = false
NavigationContainerConfig(String) - Constructor for class com.endeca.infront.cartridge.NavigationContainerConfig
Creates a NavigationContainerConfig with the specified type and the following default setting: whyPrecedenceRuleFired = false
NavigationContainerHandler - Class in com.endeca.infront.cartridge
Class that shows all available navigation refinements.
NavigationContainerHandler() - Constructor for class com.endeca.infront.cartridge.NavigationContainerHandler
 
NavigationContainerRequestParamMarshaller - Class in com.endeca.infront.cartridge
Creates NavigationContainerHandler configuration from the parameters present in a request URL.
NavigationContainerRequestParamMarshaller() - Constructor for class com.endeca.infront.cartridge.NavigationContainerRequestParamMarshaller
Creates the marshaller for reading request parameters related to NavigationContainerConfig.
NavigationEventWrapper - Class in com.endeca.infront.navigation.event
Provides a navigation specific schema to a request event.
NavigationEventWrapper(RequestEvent) - Constructor for class com.endeca.infront.navigation.event.NavigationEventWrapper
Create a new NavigationEventWrapper object based on the given RequestEvent
NavigationException - Exception in com.endeca.infront.navigation
Indicates that an exception occurred while creating or processing a navigation request.
NavigationException() - Constructor for exception com.endeca.infront.navigation.NavigationException
Constructs a new NavigationException with null as its detail message.
NavigationException(String) - Constructor for exception com.endeca.infront.navigation.NavigationException
Constructs a new NavigationException with the specified detail message.
NavigationException(Throwable) - Constructor for exception com.endeca.infront.navigation.NavigationException
Constructs a new NavigationException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
NavigationException(String, Throwable) - Constructor for exception com.endeca.infront.navigation.NavigationException
Constructs a new NavigationException with the specified detail message and cause.
NavigationState - Interface in com.endeca.infront.navigation
The NavigationState interface represents a request state that consists of a FilterState and a collection of URL parameters.
NavigationStateBuilder - Interface in com.endeca.infront.navigation
A builder used by the core cartridge handlers to create NavigationState and RecordState objects.
NavStateCanonicalizer - Interface in com.endeca.soleng.urlformatter.seo
An interface that specifies canonicalization of a NavStateUrlParam, aggregated by an SeoUrlFormatter.
NavStateFormatter - Interface in com.endeca.soleng.urlformatter.seo
An interface that specifies the formatting of an UrlState associated with a Navigation State, aggregated by an SeoUrlFormatter.
NavStateUrlParam - Interface in com.endeca.soleng.urlformatter
An interface used internally by an UrlState to manage state for navigation pages.

O

ObjectLocator - Interface in com.endeca.infront.assembler.util
ObjectLocator allows the retrieval of services without explicit injection.
OFFSET_PARAMETER - Static variable in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
Name of request parameter that sets the offset, in terms of number of records from the start of the results, of the first record of the ResultsList, "No".
OrFilter - Class in com.endeca.infront.navigation.model
A logical disjunction of some number of filters.
OrFilter() - Constructor for class com.endeca.infront.navigation.model.OrFilter
Create an OrFilter.
OrFilter(List<Filter>) - Constructor for class com.endeca.infront.navigation.model.OrFilter
 
override(ContentItem) - Method in class com.endeca.infront.cartridge.RefinementMenuRequestParamMarshaller
 
override(ContentItem) - Method in class com.endeca.infront.cartridge.RequestParamMarshaller
Helper method for layering a ContentItem on top of another ContentItem.

P

PageBody - Class in com.endeca.infront.web.tags
Tag for enabling Workbench preview functionality; each <body> tag must contain a reference to the PageBody tag.
PageBody() - Constructor for class com.endeca.infront.web.tags.PageBody
 
PageHead - Class in com.endeca.infront.web.tags
Tag for enabling Workbench preview functionality; each <head> tag must contain a reference to the PageHead tag.
PageHead() - Constructor for class com.endeca.infront.web.tags.PageHead
 
parseDate(HttpServletRequest) - Method in class com.endeca.infront.content.PreviewUserStateBuilder
 
parseDate(HttpServletRequest) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder
Returns the date parameter value, using the parameter name set by RequestParamUserStateBuilder.setDateParam(String).
parseFeaturedRecords(UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Parses a List of featured records from the given UrlState.
parseFilterState(UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Creates a new FilterState (or a clone of the FilterState specified by UrlNavigationStateBuilder.getDefaultFilterState()) and parses the filter state parameters on the given UrlState onto it.
parseGeoFilter(UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Parses a GeoFilter off of the UrlState.
parseNavigationFilters(UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Parses a List of navigation filters (dimension value IDs) off of the UrlState.
parseNavigationState(String, String, String) - Method in interface com.endeca.infront.navigation.NavigationStateBuilder
Create a NavigationState parsed from a query string, a path info, and a character encoding.
parseNavigationState(HttpServletRequest) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Creates a NavigationState using the query string, path info, and character encoding from the given request object.
parseNavigationState(String, String, String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
 
parseParameters(UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Parses parameters from the UrlState and returns them as a map.
parsePathInfo(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
parseQueryString(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
parseRangeFilters(UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Parses a List of RangeFilter off of the UrlState.
parseRecordFilters(UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Returns a List of record filters parsed from the UrlState.
parseRecordSpec(UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Parses a record spec String off of the UrlState.
parseRecordState(String, String, String) - Method in interface com.endeca.infront.navigation.NavigationStateBuilder
Create a RecordState parsed from a path info, a query string, and a character encoding.
parseRecordState(HttpServletRequest) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Creates a RecordState using the query string, path info, and character encoding from the given request object.
parseRecordState(String, String, String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
 
parseRequest(HttpServletRequest) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
 
parseRequest(String, String, String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
 
parseRequest(String, String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
 
parseRequest(HttpServletRequest) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
parseRequest(String, String, String) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
parseRequest(HttpServletRequest) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
Parses the specified request into an UrlState.
parseRequest(String, String, String) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter
 
parseSearchFilters(UrlState) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Parses a List of SearchFilter objects off of the UrlState.
parseUserAgent(HttpServletRequest) - Method in class com.endeca.infront.content.PreviewUserStateBuilder
 
parseUserAgent(HttpServletRequest) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder
Returns the user agent parameter value, using the parameter name set by RequestParamUserStateBuilder.setUserAgentParam(String).
parseUserSegments(HttpServletRequest) - Method in class com.endeca.infront.content.PreviewUserStateBuilder
 
parseUserSegments(HttpServletRequest) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder
Returns the user segment parameter value, using the parameter name set by RequestParamUserStateBuilder.setUserSegmentsParam(String).
PATH_SEPARATOR - Static variable in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
PerfEventFilter - Class in com.endeca.infront.assembler.perf
An implementation of Filter that starts performance monitoring when a request comes in.
PerfEventFilter() - Constructor for class com.endeca.infront.assembler.perf.PerfEventFilter
 
PerfLogTimeEventSerializer - Class in com.endeca.infront.assembler.perf.serializers
An implementation of EventSerializer that logs time taken, per request, into the assembler performance log.
PerfLogTimeEventSerializer(String, RecordedEventsConfiguration) - Constructor for class com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer
Constructs a PerfLogTimeEventSerializer with a log file count of 5 and a log file limit of 1000 (that is, 1000 megabytes).
PerfLogTimeEventSerializer(String, RecordedEventsConfiguration, int, int) - Constructor for class com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer
Constructs a PerfLogTimeEventSerializer.
populateNavigationPathDefaults(Action) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
Convenience method to populate the site root path and content path of the given action using the configured ActionPathProvider.
preprocess(ContentItem) - Method in class com.endeca.infront.assembler.AbstractCartridgeHandler
This implementation does nothing and does not modify the input ContentItem.
preprocess(T) - Method in interface com.endeca.infront.assembler.CartridgeHandler
Called by the assembler once for each cartridge instance in a response model.
preprocess(BreadcrumbsConfig) - Method in class com.endeca.infront.cartridge.BreadcrumbsHandler
Creates a breadcrumbs MDEX query.
preprocess(ContentItem) - Method in class com.endeca.infront.cartridge.ContentIncludeHandler
Gets content from the ContentSource and stores it in the input ContentItem.
preprocess(ContentItem) - Method in class com.endeca.infront.cartridge.ContentSlotHandler
Adds the List of ContentItem objects returned by the ContentManager to the input content item using the key, ContentSlotHandler.CONTENTS.
preprocess(ContentSlotListConfig) - Method in class com.endeca.infront.cartridge.ContentSlotListHandler
Does nothing.
preprocess(DimensionSearchResultsConfig) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsHandler
Creates a dimension search query if DimensionSearchResultsConfig.isEnabled() returns true.
preprocess(MediaBannerConfig) - Method in class com.endeca.infront.cartridge.MediaBannerHandler
Verifies the configuration for this handler.
preprocess(ConfigType) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
The default implementation does nothing.
preprocess(NavigationContainerConfig) - Method in class com.endeca.infront.cartridge.NavigationContainerHandler
Initializes the showAll fields and sets NavigationContainerHandler.mMdexRequest.
preprocess(RecordDetailsConfig) - Method in class com.endeca.infront.cartridge.RecordDetailsHandler
Creates a record details MDEX query.
preprocess(RecordSpotlightConfig) - Method in class com.endeca.infront.cartridge.RecordSpotlightHandler
This method ensures the configuration's recordSelection is valid (i.e.
preprocess(RefinementMenuConfig) - Method in class com.endeca.infront.cartridge.RefinementMenuHandler
Creates a query to the MDEX for the refinements of the Dimension specified by RefinementMenuConfig.getDimensionId().
preprocess(ResultsListConfig) - Method in class com.endeca.infront.cartridge.ResultsListHandler
Creates a record list MDEX query.
preprocess(SearchAdjustmentsConfig) - Method in class com.endeca.infront.cartridge.SearchAdjustmentsHandler
Creates an MDEX query with spell and phrase Did You Mean enabled.
PREVIEW_MODULE_URL - Static variable in class com.endeca.infront.assembler.AssemblerSettings
Key for storing preview URL on content items output by the Assembler.
PreviewUserStateBuilder - Class in com.endeca.infront.content
Builds UserState objects for use with Experience Manager preview.
PreviewUserStateBuilder() - Constructor for class com.endeca.infront.content.PreviewUserStateBuilder
Constructor.
process(T) - Method in interface com.endeca.infront.assembler.CartridgeHandler
Called by the assembler after the preprocess method has been called for all cartridges in a complete response model.
process(BreadcrumbsConfig) - Method in class com.endeca.infront.cartridge.BreadcrumbsHandler
Creates a simple Breadcrumbs model.
process(ContentItem) - Method in class com.endeca.infront.cartridge.ContentIncludeHandler
Returns the content obtained from the ContentSource (retrieved in ContentIncludeHandler.preprocess(com.endeca.infront.assembler.ContentItem)).
process(ContentItem) - Method in class com.endeca.infront.cartridge.ContentSlotHandler
 
process(ContentSlotListConfig) - Method in class com.endeca.infront.cartridge.ContentSlotListHandler
Returns the input ContentSlotListConfig.
process(DimensionSearchResultsConfig) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsHandler
Returns a DimensionSearchResults if DimensionSearchResultsConfig.isEnabled() is true, and there is at least 1 search term in the NavigationState else returns null.
process(MediaBannerConfig) - Method in class com.endeca.infront.cartridge.MediaBannerHandler
Creates a response model of the form:
process(ConfigType) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
The default implementation does nothing and returns null.
process(NavigationContainerConfig) - Method in class com.endeca.infront.cartridge.NavigationContainerHandler
Builds the RefinementMenus and creates the output NavigationContainer model.
process(RecordDetailsConfig) - Method in class com.endeca.infront.cartridge.RecordDetailsHandler
Creates a RecordDetails model object.
process(RecordSpotlightConfig) - Method in class com.endeca.infront.cartridge.RecordSpotlightHandler
This method processes the global query results in order to obtain information about the current navigation state dimensions, such as whether they are multi-or, and what their ancestors are.
process(RefinementMenuConfig) - Method in class com.endeca.infront.cartridge.RefinementMenuHandler
Returns null if no dimension id is specified in the config, or if the MDEX doesn't return any refinements.
process(ResultsListConfig) - Method in class com.endeca.infront.cartridge.ResultsListHandler
Creates a basic RecordList model.
process(SearchAdjustmentsConfig) - Method in class com.endeca.infront.cartridge.SearchAdjustmentsHandler
Always returns a SearchAdjustments object, even if no search adjustments have been suggested.
process(ContentItem) - Method in class com.endeca.infront.cartridge.StatsPageCartridgeHandler
If a StatsPageTimeEventSerializer has been set, stores performance information in the supplied ContentItem.
processSpotlightMdexResponse(NavigationState, RecordSpotlightConfig, ENEQueryResults) - Method in class com.endeca.infront.cartridge.RecordSpotlightHandler
Protected method allows this to be overridden by subclasses of the CartridgeHandler.
PropertyFilter - Class in com.endeca.infront.navigation.model
A filter for a single record.
PropertyFilter() - Constructor for class com.endeca.infront.navigation.model.PropertyFilter
Creates a filter for a single record.
PropertyFilter(String, String) - Constructor for class com.endeca.infront.navigation.model.PropertyFilter
 
putAllParameters(Map<String, String>) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, updating all of the specified parameters.
putAllParameters(Map<String, String>) - Method in interface com.endeca.infront.navigation.RecordState
Create a new RecordState relative to this one, updating all of the specified parameters.
putParameter(String, String) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, updating the specified parameter.
putParameter(String, String) - Method in interface com.endeca.infront.navigation.RecordState
Create a new RecordState relative to this one, updating the specified parameter.
putStatsIntoContentItem(ContentItem) - Method in class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer
Adds performance statistics to the supplied content item.

Q

QueryBuilder - Interface in com.endeca.soleng.urlformatter
An interface that is responsible for marshaling UrlState objects into ENEQuery objects.
QueryBuildException - Exception in com.endeca.soleng.urlformatter
Indicates that an error occurred while marshaling an UrlState into an ENEQuery object.
QueryBuildException() - Constructor for exception com.endeca.soleng.urlformatter.QueryBuildException
Constructs a QueryBuildException with no message or cause.
QueryBuildException(String) - Constructor for exception com.endeca.soleng.urlformatter.QueryBuildException
Constructs a QueryBuildException with the specified message.
QueryBuildException(String, Throwable) - Constructor for exception com.endeca.soleng.urlformatter.QueryBuildException
Constructs a QueryBuildException with the specified message and cause.
QueryBuildException(Throwable) - Constructor for exception com.endeca.soleng.urlformatter.QueryBuildException
Constructs a QueryBuildException with the specified cause.

R

RangeFilter - Class in com.endeca.infront.navigation.model
A range filter.
RangeFilter() - Constructor for class com.endeca.infront.navigation.model.RangeFilter
Creates a range filter.
RangeFilter(String, double, RangeFilter.Operation) - Constructor for class com.endeca.infront.navigation.model.RangeFilter
Creates a range filter.
RangeFilter(String, double, double) - Constructor for class com.endeca.infront.navigation.model.RangeFilter
Constructs a new range filter with the between operation (Operation.BTWN).
RangeFilter.Operation - Enum in com.endeca.infront.navigation.model
 
RangeFilterBreadcrumb - Class in com.endeca.infront.cartridge.model
RangeFilterBreadcrumb is the model for a view of a selected range filter a.k.a., a breadcrumb.
RangeFilterBreadcrumb() - Constructor for class com.endeca.infront.cartridge.model.RangeFilterBreadcrumb
 
Record - Class in com.endeca.infront.cartridge.model
A generic data record that could represent a single record or an aggregate record.
Record() - Constructor for class com.endeca.infront.cartridge.model.Record
 
RecordAction - Class in com.endeca.infront.cartridge.model
An Action which represents the selection of a particular record or aggregate record.
RecordAction() - Constructor for class com.endeca.infront.cartridge.model.RecordAction
Default constructor.
RecordAction(String) - Constructor for class com.endeca.infront.cartridge.model.RecordAction
Constructs a record action with the given record state.
RecordAction(String, String) - Constructor for class com.endeca.infront.cartridge.model.RecordAction
Constructs a record action with the given record state and label.
RecordAction(String, String, String, String) - Constructor for class com.endeca.infront.cartridge.model.RecordAction
Constructs a record action with the given record state, label, site root path and content path.
RecordDetails - Class in com.endeca.infront.cartridge
RecordDetailsHandler output model.
RecordDetails(RecordDetailsConfig) - Constructor for class com.endeca.infront.cartridge.RecordDetails
Creates the RecordDetails output model, using the type and data present in the input RecordDetailsConfig.
RecordDetailsConfig - Class in com.endeca.infront.cartridge
RecordDetailsHandler configuration model.
RecordDetailsConfig() - Constructor for class com.endeca.infront.cartridge.RecordDetailsConfig
Creates an empty RecordDetailsConfig.
RecordDetailsConfig(String) - Constructor for class com.endeca.infront.cartridge.RecordDetailsConfig
Creates an empty RecordDetailsConfig with the specified type.
RecordDetailsConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.RecordDetailsConfig
Creates a copy of the specified ContentItem, and returns it as an instance of RecordDetailsConfig.
RecordDetailsHandler - Class in com.endeca.infront.cartridge
Cartridge handler that creates RecordDetails model objects.
RecordDetailsHandler() - Constructor for class com.endeca.infront.cartridge.RecordDetailsHandler
 
RecordedEventsConfiguration - Class in com.endeca.infront.assembler.perf.config
A bean for listing all performance events that are desired for monitoring in an application.
RecordedEventsConfiguration() - Constructor for class com.endeca.infront.assembler.perf.config.RecordedEventsConfiguration
 
RECORDS_PER_PAGE_PARAMETER - Static variable in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
Name of request parameter that sets the maximum number of records that the ResultsList may contain, "Nrpp".
RecordSpotlight - Class in com.endeca.infront.cartridge
RecordSpotlightHandler output model.
RecordSpotlight(RecordSpotlightConfig) - Constructor for class com.endeca.infront.cartridge.RecordSpotlight
Creates the RecordSpotlight output model, using the type and data present in the input RecordSpotlightConfig.
RecordSpotlightConfig - Class in com.endeca.infront.cartridge
RecordSpotlightHandler configuration model.
RecordSpotlightConfig() - Constructor for class com.endeca.infront.cartridge.RecordSpotlightConfig
Creates a RecordSpotlightConfig with the following default settings: maxNumRecords = 10 showSeeAllLink = false
RecordSpotlightConfig(String) - Constructor for class com.endeca.infront.cartridge.RecordSpotlightConfig
Creates a RecordSpotlightConfig with the following default settings: maxNumRecords = 10 showSeeAllLink = false
RecordSpotlightConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.RecordSpotlightConfig
Creates a copy of the specified ContentItem, and returns it as an instance of RecordSpotlightConfig.
RecordSpotlightHandler - Class in com.endeca.infront.cartridge
Cartridge handler that creates RecordSpotlight model objects.
RecordSpotlightHandler() - Constructor for class com.endeca.infront.cartridge.RecordSpotlightHandler
 
RecordSpotlightSelection - Class in com.endeca.infront.cartridge
Represents a record selection from content XML.
RecordSpotlightSelection() - Constructor for class com.endeca.infront.cartridge.RecordSpotlightSelection
 
RecordState - Interface in com.endeca.infront.navigation
The RecordState interface represents a request state that consists of a record spec and a collection of URL parameters.
RedirectAwareContentInclude - Class in com.endeca.infront.cartridge
Contains a set of parameters used to make a request for content from the assembler.
RedirectAwareContentInclude(String) - Constructor for class com.endeca.infront.cartridge.RedirectAwareContentInclude
Constructor that requires a URI to get the desired content.
RedirectAwareContentInclude(ContentItem) - Constructor for class com.endeca.infront.cartridge.RedirectAwareContentInclude
Constructor that requires a ContentItem to describe the requested content.
RedirectAwareContentIncludeHandler - Class in com.endeca.infront.cartridge
A handler for obtaining content from a URI, when keyword redirect support is desired.
RedirectAwareContentIncludeHandler() - Constructor for class com.endeca.infront.cartridge.RedirectAwareContentIncludeHandler
 
Refinement - Class in com.endeca.infront.cartridge.model
A view model that provides an action to perform dimension filtering with information about the resulting dataset when applied.
Refinement() - Constructor for class com.endeca.infront.cartridge.model.Refinement
 
RefinementBreadcrumb - Class in com.endeca.infront.cartridge.model
RefinementBreadcrumb is the model for a view of a selected refinement.
RefinementBreadcrumb() - Constructor for class com.endeca.infront.cartridge.model.RefinementBreadcrumb
 
RefinementMenu - Class in com.endeca.infront.cartridge
RefinementMenuHandler output model.
RefinementMenu(RefinementMenuConfig) - Constructor for class com.endeca.infront.cartridge.RefinementMenu
Creates the RefinementMenu output model, using the type and data present in the input RefinementMenuConfig.
RefinementMenuConfig - Class in com.endeca.infront.cartridge
RefinementMenuHandler configuration model.
RefinementMenuConfig() - Constructor for class com.endeca.infront.cartridge.RefinementMenuConfig
Creates a ResultsListConfig with the following default settings: showMoreLink = false numRefinements = 10 maxNumRefinements = 1000 showMore = false whyPrecedenceRuleFired = false
RefinementMenuConfig(String) - Constructor for class com.endeca.infront.cartridge.RefinementMenuConfig
Creates a ResultsListConfig with the following default settings: showMoreLink = false numRefinements = 10 maxNumRefinements = 1000 showMore = false whyPrecedenceRuleFired = false
RefinementMenuConfig(ContentItem) - Constructor for class com.endeca.infront.cartridge.RefinementMenuConfig
Creates a ResultsListConfig with the following default settings: showMoreLink = false numRefinements = 10 maxNumRefinements = 1000 showMore = false whyPrecedenceRuleFired = false
RefinementMenuConfig.RefinementsShown - Enum in com.endeca.infront.cartridge
An enumeration of valid values for RefinementMenuConfig.getRefinementsShown()
RefinementMenuHandler - Class in com.endeca.infront.cartridge
Cartridge handler that creates RefinementMenu model objects.
RefinementMenuHandler() - Constructor for class com.endeca.infront.cartridge.RefinementMenuHandler
 
RefinementMenuRequestParamMarshaller - Class in com.endeca.infront.cartridge
Creates RefinementMenuHandler configuration from the parameters present in a request URL.
RefinementMenuRequestParamMarshaller() - Constructor for class com.endeca.infront.cartridge.RefinementMenuRequestParamMarshaller
Creates the marshaller for reading request parameters related to RefinementMenuConfig.
RegexStringFormatter - Class in com.endeca.soleng.urlformatter.seo
A StringFormatter that specifies a regular expression for find/replace manipulations on strings.
RegexStringFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
 
RELRANK_KEY_PARAMETER - Static variable in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
Name of request parameter that sets the relevance ranking search key.
RELRANK_MATCHMODE_PARAMETER - Static variable in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
Name of request parameter that sets the relevance ranking match mode.
RELRANK_TERMS_PARAMETER - Static variable in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
Name of request parameter that sets the relevance ranking search terms.
removeAssemblerEventListener(AssemblerEventListener) - Method in interface com.endeca.infront.assembler.Assembler
Removes a listener previously added by Assembler.addAssemblerEventListener(AssemblerEventListener)
removeDescriptor(DimVal) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam
Internal method delegated from an UrlState.
removeDescriptor(DimVal, boolean) - Method in class com.endeca.soleng.urlformatter.UrlState
Removes the specifed descriptor DimVal from the current navigation state.
removeNavigationFilter(String) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, removing the specified navigation filter.
removeNavState() - Method in class com.endeca.soleng.urlformatter.UrlState
Fully removes any navigation state from this UrlState.
removeParam(String) - Method in class com.endeca.soleng.urlformatter.UrlState
Removes any value associated with the specified key from the underlying parameter map.
removeParameter(String) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, removing the specified parameter.
removeParameter(String) - Method in interface com.endeca.infront.navigation.RecordState
Create a new RecordState relative to this one, removing the specified parameter.
RequestEvent - Class in com.endeca.infront.assembler.event.request
Tracks information about a single Assembler invocation.
RequestEvent() - Constructor for class com.endeca.infront.assembler.event.request.RequestEvent
Constructs a new RequestEvent
RequestEventFactory - Class in com.endeca.infront.assembler.event.request
Used to get the RequestEvent for the current Assembler request.
RequestEventFactory() - Constructor for class com.endeca.infront.assembler.event.request.RequestEventFactory
 
RequestEventListener - Class in com.endeca.infront.assembler.event.request
Consolidates Assembler request event information and fires a method with the request information.
RequestEventListener() - Constructor for class com.endeca.infront.assembler.event.request.RequestEventListener
Creates a new RequestEventListener without a SessionIdProvider.
RequestEventListener(SessionIdProvider) - Constructor for class com.endeca.infront.assembler.event.request.RequestEventListener
Creates a new RequestEventListener with the given SessionIdProvider.
RequestParamMarshaller - Class in com.endeca.infront.cartridge
A class that transforms request parameter values into a ContentItem.
RequestParamMarshaller() - Constructor for class com.endeca.infront.cartridge.RequestParamMarshaller
 
RequestParamUserStateBuilder - Class in com.endeca.infront.content
Builds UserState objects from parameter values present in the HttpServletRequest.
RequestParamUserStateBuilder() - Constructor for class com.endeca.infront.content.RequestParamUserStateBuilder
 
RequestType - Enum in com.endeca.infront.navigation.event
Navigation request types
RESET_STATS_EVENT_ID - Static variable in class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer
Resets the collection of performance statistics.
resetEvent() - Static method in class com.endeca.infront.assembler.event.request.RequestEventFactory
Reset the RequestEvent.
resolveContent(HttpServletRequest) - Method in class com.endeca.infront.content.source.AbstractContentSource
Attempts to resolve content based on the given request.
resolveContent(String) - Method in interface com.endeca.infront.content.source.ContentSource
Returns a ContentLocator which can be used to provide information about the location of the content represented by the given URI or retrieve the actual content.
resolveContent(HttpServletRequest) - Method in interface com.endeca.infront.content.source.ContentSource
Similar to ContentSource.resolveContent(String), but attempts to infer the content URI from the path info of the given servlet request.
resolveContent(String) - Method in class com.endeca.infront.content.source.WorkbenchContentSource
Calls the resolveContent method of the content source
resolveContent(HttpServletRequest) - Method in class com.endeca.infront.content.source.WorkbenchContentSource
Calls the resolveContent method of the content source
RESPONSE_WRITER_ID_PARAM - Static variable in class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet
The servlet parameter used to specify the Spring bean ID of the ResponseWriter to use.
ResponseWriter - Interface in com.endeca.infront.assembler.servlet
A ResponseWriter is responsible for writing the servlet response based on the Assembler output.
ResultsList - Class in com.endeca.infront.cartridge
ResultsListHandler output model.
ResultsList(ResultsListConfig) - Constructor for class com.endeca.infront.cartridge.ResultsList
Creates the ResultsList output model, using the type and data present in the input ResultsListConfig.
ResultsListConfig - Class in com.endeca.infront.cartridge
ResultsListHandler configuration model.
ResultsListConfig() - Constructor for class com.endeca.infront.cartridge.ResultsListConfig
Creates a ResultsListConfig with the following default settings: offset = 0 recordsPerPage = 10 whyMatchEnabled = false whyRankEnabled = false
ResultsListConfig(String) - Constructor for class com.endeca.infront.cartridge.ResultsListConfig
Creates a ResultsListConfig with the specified type and the following default settings: offset = 0 recordsPerPage = 10 whyMatchEnabled = false whyRankEnabled = false
ResultsListHandler - Class in com.endeca.infront.cartridge
Handler for the ResultsList cartridge.
ResultsListHandler() - Constructor for class com.endeca.infront.cartridge.ResultsListHandler
 
ResultsListRequestParamMarshaller - Class in com.endeca.infront.cartridge
Creates ResultsListHandler configuration from the parameters present in a request URL.
ResultsListRequestParamMarshaller() - Constructor for class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
Creates the marshaller for reading request parameters related to ResultsListConfig.
resume(Event) - Method in interface com.endeca.infront.assembler.perf.Event
Resume this event; the old event is passed for reference.
resume(Event) - Method in class com.endeca.infront.assembler.perf.TimeEvent
 
retainFields(Map<String, Attribute>, FieldNamesConfig, boolean) - Method in class com.endeca.infront.cartridge.ResultsListHandler
 

S

SearchAdjustments - Class in com.endeca.infront.cartridge
SearchAdjustmentsHandler output model.
SearchAdjustments(SearchAdjustmentsConfig) - Constructor for class com.endeca.infront.cartridge.SearchAdjustments
Creates the SearchAdjustments output model, using the type and data present in the input SearchAdjustmentsConfig.
SearchAdjustmentsConfig - Class in com.endeca.infront.cartridge
SearchAdjustmentsHandler configuration model.
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
Cartridge handler that creates SearchAdjustments model objects.
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
Creates the marshaller for reading request parameters related to SearchAdjustmentsConfig.
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
Create a new NavigationState relative to this one, selecting the specified navigation filter.
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.
serialize(Map<String, EventSummary>, HttpServletRequest) - Method in interface com.endeca.infront.assembler.perf.EventSerializer
Record performance events with this serializer.
serialize(StringBuilder) - Method in interface com.endeca.infront.assembler.perf.EventSummary
Serializes this summary into a human-readable string.
serialize(Map<String, EventSummary>, HttpServletRequest) - Method in class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer
 
serialize(StringBuilder) - Method in class com.endeca.infront.assembler.perf.TimeSummary
 
SessionIdProvider - Interface in com.endeca.infront.assembler.event.request
Provides the ID for the current user session
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.
setApplicationContext(ApplicationContext) - Method in class com.endeca.infront.assembler.spring.SpringAssemblerFactory
Sets the Spring Framework bean factory used by this assembler for resolving cartridge handlers and other services within an assembler request context.
setApplicationContext(ApplicationContext) - Method in class com.endeca.infront.web.spring.SpringUtility
Implementation of the Spring ApplicationContextAware interface.
setAppName(String) - Method in class com.endeca.infront.content.source.WorkbenchContentSource
 
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
 
setAssemblyFinishTime(Long) - Method in class com.endeca.infront.assembler.event.request.RequestEvent
Sets the time (in milliseconds from Epoch) that the assembly finished
setAssemblyStartTime(Long) - Method in class com.endeca.infront.assembler.event.request.RequestEvent
Sets the time (in milliseconds from Epoch) that the assembly started
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.
setClassName(String) - Method in class com.endeca.infront.assembler.perf.config.LoggableEventConfiguration
Sets the class name for this event configuration
setClientPort(int) - Method in class com.endeca.infront.content.source.WorkbenchContentSource
 
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.ContentSlotHandler
Provider of essential services to dynamic content handlers.
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.
setContentCollection(String) - Method in class com.endeca.infront.cartridge.ContentSlotConfig
Sets the content collection name.
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.ContentSlotListHandler
Sets the ContentItemInitializer used to create the full cartridge configuration in the ContentSlotListHandler.initialize(com.endeca.infront.assembler.ContentItem) method.
setContentItemInitializer(ContentItemInitializer) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
Sets the ContentItemInitializer used to create the full cartridge configuration in the NavigationCartridgeHandler.initialize(com.endeca.infront.assembler.ContentItem) method.
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
 
setContentSlotList(List<ContentItem>) - Method in class com.endeca.infront.cartridge.ContentSlotListConfig
Sets the ContentSlotConfig list contained in this ContentSlotListConfig.
setContentSource(ContentSource) - Method in class com.endeca.infront.cartridge.ContentIncludeHandler
Sets the content source used by this handler.
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.
setContentUri(String) - Method in class com.endeca.infront.cartridge.ContentInclude
Sets the URI to retrieve content from a configured ContentSource.
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.
setDate(Date) - Method in class com.endeca.infront.navigation.UserState
Sets the date; this is useful for previewing what a site looks like on a particular date.
setDateAsString(String) - Method in class com.endeca.infront.navigation.UserState
Convenience method to set the date from a String of the format "yyyy-MM-dd'T'HH:mm".
setDateParam(String) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder
Sets the name of the parameter used for obtaining the date information from the HttpServletRequest.
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
Sets the default match mode that will be set when a SearchFilter is parsed and a match mode is not specified in the URL parameter specified by UrlNavigationStateBuilder.getSearchFiltersMatchModeParam()
setDefaultRedirectCollection(String) - Method in class com.endeca.infront.cartridge.RedirectAwareContentIncludeHandler
Sets the default redirect collection name.
setDefaults(ContentItem) - Method in class com.endeca.infront.cartridge.ConfigInitializer
Set the default configuration for a given CartridgeHandler.
setDefaultSearchKey(String) - Method in class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
Sets the default search key that will be set when a SearchFilter is parsed and a search key is not specified in the URL parameter specified by UrlNavigationStateBuilder.getSearchFiltersKeyParam().
setDefaultSiteRootPath(String) - Method in class com.endeca.infront.content.source.AbstractContentSource
 
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
Controls whether or not records per page can be set via ResultsListRequestParamMarshaller.RECORDS_PER_PAGE_PARAMETER.
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.
setEvents(List<String>) - Method in class com.endeca.infront.assembler.perf.config.LoggableEventConfiguration
Set the event names to be recorded that are related to this class.
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.content.source.WorkbenchContentSource
 
setHost(String) - Method in class com.endeca.infront.navigation.model.MdexResource
 
setHttpServletRequest(HttpServletRequest) - Method in class com.endeca.infront.cartridge.RequestParamMarshaller
Sets the current servlet request.
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.
setIsAuthoring(boolean) - Method in class com.endeca.infront.content.source.WorkbenchContentSource
 
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
Sets the list of MediaSourceConfig objects.
setMessageTimeout(long) - Method in class com.endeca.infront.content.source.WorkbenchContentSource
 
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.
setPreviewEnabled(boolean) - Method in class com.endeca.infront.assembler.AssemblerSettings
Sets whether or not preview should be enabled.
setPreviewModuleUrl(String) - Method in class com.endeca.infront.assembler.AssemblerSettings
Sets the preview module 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
setRecordedEvents(List<LoggableEventConfiguration>) - Method in class com.endeca.infront.assembler.perf.config.RecordedEventsConfiguration
Sets the list of events to record.
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
Sets the type for RefinementMenus created by this class.
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
Deprecated. use DimensionSearchResultsConfig.setRelRankStrategy(String) instead.
setRelRank(String) - Method in class com.endeca.infront.cartridge.ResultsListConfig
Deprecated. use ResultsListConfig.setRelRankStrategy(String) instead.
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
Sets the list of URL parameters that will get removed when NavigationState.clearFilterState() is called.
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.
setRequestMap(Map<String, String>) - Method in class com.endeca.infront.cartridge.RequestParamMarshaller
Sets the mapping of request parameters to ContentItem keys.
setRequestParamMarshaller(RequestParamMarshaller) - Method in class com.endeca.infront.cartridge.ConfigInitializer
Set the RequestParamMarshaller that can create request-based configuration for a given CartridgeHandler.
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.
setRootContentItem(ContentItem) - Method in class com.endeca.infront.web.tags.PageBody
Sets the root content item for obtaining the configuration information.
setRootContentItem(ContentItem) - Method in class com.endeca.infront.web.tags.PageHead
Sets the root content item for obtaining the configuration information.
setRootStringFormatter(StringFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Specifies the StringFormatter that is used to process the root DimVal name.
setRuleLimit(int) - Method in class com.endeca.infront.cartridge.ContentSlotConfig
Sets the maximum number of rules that can fire for this slot.
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
Sets the See All NavigationAction.
setSeeAllLinkText(String) - Method in class com.endeca.infront.cartridge.RecordSpotlightConfig
Sets the text for display in the See All Action returned by RecordSpotlight.getSeeAllLink().
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.
setServerPort(int) - Method in class com.endeca.infront.content.source.WorkbenchContentSource
 
setSessionId(String) - Method in class com.endeca.infront.assembler.event.request.RequestEvent
Sets the unique identifier for a user browser session
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
Deprecated. As of release 3.1.1, replaced by NavigationContainerConfig.getRefinementsShown().
Sets dimension IDs for which 'More' refinement expansion should happen.
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
Sets whether to display the See All Action returned by RecordSpotlight.getSeeAllLink().
setShowWordInterp(boolean) - Method in class com.endeca.infront.cartridge.SearchAdjustmentsConfig
Specifies that the SearchAdjustments cartridge should populate the interpreted terms.
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
 
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
Sets the SortOption.
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
 
setStatsPageSerializer(StatsPageTimeEventSerializer) - Method in class com.endeca.infront.cartridge.StatsPageCartridgeHandler
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
Sets the number of DimensionSearchValues in this result.
setType(String) - Method in class com.endeca.infront.assembler.BasicContentItem
Sets the type for this content item.
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.
setUserAgent(String) - Method in class com.endeca.infront.navigation.UserState
Sets the user-agent; this is useful for previewing what a site looks like with a particular user-agent.
setUserAgentParam(String) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder
Sets the name of the parameter used for obtaining the user agent information from the HttpServletRequest.
setUserSegments(Set<String>) - Method in class com.endeca.infront.navigation.UserState
Sets the set of user segments.
setUserSegmentsParam(String) - Method in class com.endeca.infront.content.RequestParamUserStateBuilder
Sets the name of the parameter used for obtaining the user segment information from the HttpServletRequest.
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
Deprecated. As of release 3.1.1, replaced by NavigationContainerRequestParamMarshaller.NAV_REFINEMENT_MENU_CONFIG.
Name of request parameter that sets the list of Dimension IDs for which ALL dimension values will be shown. The value can be pipe delimited to expand multiple refinement menus. e.g. /N-83092?showMoreIds=10021|1000482
SHOW_MORE - Static variable in class com.endeca.infront.cartridge.RefinementMenuRequestParamMarshaller
Deprecated. As of release 3.1.1, replaced by RefinementMenuRequestParamMarshaller.NAV_REFINEMENT_MENU_CONFIG.
Name of request parameter that sets the list of Dimension IDs for which ALL dimension values will be shown. The value can be pipe delimited to expand multiple refinement menus. e.g. /N-83092?showMoreIds=10021|1000482
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
 
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
 
SpringAssemblerFactory - Class in com.endeca.infront.assembler.spring
An assembler factory implementation that uses a Spring Framework bean factory to resolve cartridge handlers and other services.
SpringAssemblerFactory(AssemblerSettings) - Constructor for class com.endeca.infront.assembler.spring.SpringAssemblerFactory
Constructor to use when configuring and instantiating instances of this assembler from Spring.
SpringAssemblerFactory(AssemblerSettings, List<AssemblerEventListener>) - Constructor for class com.endeca.infront.assembler.spring.SpringAssemblerFactory
Constructor to use when configuring and instantiating instances of this assembler from Spring.
SpringAssemblerFactory(AssemblerSettings, List<AssemblerEventListener>, ApplicationContext) - Constructor for class com.endeca.infront.assembler.spring.SpringAssemblerFactory
Convenience constructor to use when instantiating a Spring-based assembler programmatically.
SpringAssemblerServlet - Class in com.endeca.infront.assembler.servlet.spring
Extends the AbstractAssemblerServlet to provide the needed AssemblerFactory and ResponseWriter using the Spring Framework.
SpringAssemblerServlet() - Constructor for class com.endeca.infront.assembler.servlet.spring.SpringAssemblerServlet
 
SpringPreviewLinkServlet - Class in com.endeca.infront.assembler.servlet.spring
Extends the AbstractPreviewLinkServlet to provide the needed NavigationStateBuilder and ContentSource using the Spring Framework.
SpringPreviewLinkServlet() - Constructor for class com.endeca.infront.assembler.servlet.spring.SpringPreviewLinkServlet
 
SpringUtility - Class in com.endeca.infront.web.spring
Utility for interacting with the Spring Framework.
SpringUtility() - Constructor for class com.endeca.infront.web.spring.SpringUtility
 
startEvent(Object, String) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils
Called to start a new performance event.
startEvent(String) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils
Called to start a new performance event.
startPerformanceTiming(HttpServletRequest) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils
Starts performance timing on the current request/thread.
StatsPageCartridgeHandler - Class in com.endeca.infront.cartridge
An implementation of CartridgeHandler that provides content for the performance stats page.
StatsPageCartridgeHandler() - Constructor for class com.endeca.infront.cartridge.StatsPageCartridgeHandler
 
StatsPageTimeEventSerializer - Class in com.endeca.infront.assembler.perf.serializers
An implementation of EventSerializer that stores information for the performance stats page.
StatsPageTimeEventSerializer(RecordedEventsConfiguration) - Constructor for class com.endeca.infront.assembler.perf.serializers.StatsPageTimeEventSerializer
Creates a StatsPageTimeEventSerializer.
stopEvent(Object, String) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils
Called to stop an event that was previously started.
stopEvent(String) - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils
Called to stop an event that was previously started.
stopPerformanceTiming() - Static method in class com.endeca.infront.assembler.perf.AssemblerPerfUtils
Stops performance timing on the current request/thread.
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.
suspend(Event) - Method in interface com.endeca.infront.assembler.perf.Event
Suspend this event; the new event is passed for reference.
suspend(Event) - Method in class com.endeca.infront.assembler.perf.TimeEvent
 

T

TimeEvent - Class in com.endeca.infront.assembler.perf
An implementation of the Event interface that tracks the time spent in performing an event.
TimeEvent() - Constructor for class com.endeca.infront.assembler.perf.TimeEvent
Constructs a TimeEvent.
TimeEventFactory - Class in com.endeca.infront.assembler.perf
An EventFactory implementation that produces TimeEvents.
TimeEventFactory() - Constructor for class com.endeca.infront.assembler.perf.TimeEventFactory
 
TimeSummary - Class in com.endeca.infront.assembler.perf
An implementation of EventSummary that aggregates the time recorded by one or more TimeEvents.
TimeSummary(long, long) - Constructor for class com.endeca.infront.assembler.perf.TimeSummary
Constructs a summary over a single invocation.
TimeSummary(long, long, int) - Constructor for class com.endeca.infront.assembler.perf.TimeSummary
Constructs a summary over a single invocation.
TimeSummary.MinMaxTotalSummary - Class in com.endeca.infront.assembler.perf
A convenience wrapper class to store the total, min, and max time.
toString() - Method in class com.endeca.infront.assembler.perf.TimeSummary.MinMaxTotalSummary
 
toString() - Method in class com.endeca.infront.assembler.perf.TimeSummary
Returns a human-readable representation of this summary.
toString() - Method in class com.endeca.infront.cartridge.model.Attribute
 
toString(String) - Method in class com.endeca.infront.cartridge.model.Attribute
Uses the argument delimiter to separate multiple values in the list.
toString() - Method in enum com.endeca.infront.cartridge.model.LinkBuilder.LinkType
 
toString() - Method in enum com.endeca.infront.cartridge.RefinementMenuConfig.RefinementsShown
 
toString() - Method in enum com.endeca.infront.navigation.event.RequestType
 
toString() - Method in class com.endeca.infront.navigation.model.DimensionFilter
For debugging.
toString() - Method in class com.endeca.infront.navigation.model.EqlFilter
For debugging.
toString() - Method in class com.endeca.infront.navigation.model.GeoFilter
For debugging.
toString() - Method in enum com.endeca.infront.navigation.model.MatchMode
 
toString() - Method in class com.endeca.infront.navigation.model.RangeFilter
For debugging.
toString() - Method in class com.endeca.infront.navigation.model.SearchFilter
For debugging.
toString() - Method in class com.endeca.infront.navigation.model.SortOption
 
toString() - Method in class com.endeca.soleng.urlformatter.UrlState
Returns an encoded string representation of this UrlState.
total - Variable in class com.endeca.infront.assembler.perf.TimeSummary.MinMaxTotalSummary
The total time observed across all invocations of this event.

U

updateFilterState(FilterState) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, replacing the existing FilterState object with the given one.
updateGeoFilter(GeoFilter) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, with the existing GeoFilter (if any) replaced by the given one.
updateParameters(Map<String, String>) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, replacing the entire existing parameter map with the given one.
updateParameters(Map<String, String>) - Method in interface com.endeca.infront.navigation.RecordState
Create a new RecordState relative to this one, replacing the entire existing parameter map with the given one.
updateRangeFilters(List<RangeFilter>) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, with any existing range filters replaced by those in the given list.
updateRecordFilters(List<String>) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, with any existing record filters replaced by those in the given list.
updateRecordSpec(String, boolean) - Method in interface com.endeca.infront.navigation.RecordState
Create a new RecordState relative to this one, updating just the record spec and the aggregate record property.
updateSearchFilters(List<SearchFilter>) - Method in interface com.endeca.infront.navigation.NavigationState
Create a new NavigationState relative to this one, with any existing search filters replaced by those in the given list.
UpperCaseStringFormatter - Class in com.endeca.soleng.urlformatter.seo
A StringFormatter that formats strings to upper case.
UpperCaseStringFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.UpperCaseStringFormatter
 
UrlAction - Class in com.endeca.infront.cartridge.model
An Action which involves following some arbitrary URL.
UrlAction() - Constructor for class com.endeca.infront.cartridge.model.UrlAction
Default constructor.
UrlAction(String) - Constructor for class com.endeca.infront.cartridge.model.UrlAction
Constructor.
UrlEncodedStringFormatter - Class in com.endeca.soleng.urlformatter.seo
A StringFormatter that URL encodes strings.
UrlEncodedStringFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.UrlEncodedStringFormatter
 
UrlFormatException - Exception in com.endeca.soleng.urlformatter
Indicates that an error occurred while formatting an UrlState object into an URL string - or while parsing a request into an UrlState.
UrlFormatException() - Constructor for exception com.endeca.soleng.urlformatter.UrlFormatException
Constructs a UrlFormatException with no message or cause.
UrlFormatException(String) - Constructor for exception com.endeca.soleng.urlformatter.UrlFormatException
Constructs a UrlFormatException with the specified message.
UrlFormatException(String, Throwable) - Constructor for exception com.endeca.soleng.urlformatter.UrlFormatException
Constructs a UrlFormatException with the specified message and cause.
UrlFormatException(Throwable) - Constructor for exception com.endeca.soleng.urlformatter.UrlFormatException
Constructs a UrlFormatException with the specified cause.
UrlFormatter - Interface in com.endeca.soleng.urlformatter
An interface that is responsible for formatting UrlState objects into URL strings.
UrlNavigationStateBuilder - Class in com.endeca.infront.navigation.url
An implementation of NavigationStateBuilder that uses the UrlFormatter.
UrlNavigationStateBuilder() - Constructor for class com.endeca.infront.navigation.url.UrlNavigationStateBuilder
 
UrlParam - Interface in com.endeca.soleng.urlformatter
An interface used internally by an UrlState to store a single URL parameter.
UrlParamEncoder - Class in com.endeca.soleng.urlformatter.seo
Specifies the encoding of a URL parameter, aggregated by an SeoUrlFormatter in an UrlParamEncoder[] array.
UrlParamEncoder() - Constructor for class com.endeca.soleng.urlformatter.seo.UrlParamEncoder
 
UrlState - Class in com.endeca.soleng.urlformatter
An object that represents URL state for a web application request - a central component for this API.
UrlState(UrlFormatter, String) - Constructor for class com.endeca.soleng.urlformatter.UrlState
Constructs an empty UrlState object.
useNavStateCanonicalizer() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
The useNavStateCanonicalizer property used determine whether to use any canonicalizers associated with this formatter.
UserState - Class in com.endeca.infront.navigation
An object that contains user segments and date state information.
UserState() - Constructor for class com.endeca.infront.navigation.UserState
 

V

validator - Variable in class com.endeca.infront.content.source.WorkbenchContentSource
 
valueOf(String) - Static method in enum com.endeca.infront.cartridge.model.LinkBuilder.LinkType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.endeca.infront.cartridge.RefinementMenuConfig.RefinementsShown
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.endeca.infront.navigation.event.RequestType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.endeca.infront.navigation.model.MatchMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.endeca.infront.navigation.model.RangeFilter.Operation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.endeca.infront.navigation.model.SubRecordsPerAggregateRecord
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.endeca.infront.cartridge.model.LinkBuilder.LinkType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.endeca.infront.cartridge.RefinementMenuConfig.RefinementsShown
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.endeca.infront.navigation.event.RequestType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.endeca.infront.navigation.model.MatchMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.endeca.infront.navigation.model.RangeFilter.Operation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.endeca.infront.navigation.model.SubRecordsPerAggregateRecord
Returns an array containing the constants of this enum type, in the order they are declared.
verifyNotNull(String, Object) - Static method in class com.endeca.infront.navigation.model.Filter
 

W

WHY_MATCH - Static variable in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
Query parameter name for turning on debug information about why a record is included in a text search result, "whymatch".
WHY_PRECEDENCE_RULE_FIRED - Static variable in class com.endeca.infront.cartridge.NavigationContainerRequestParamMarshaller
Query parameter name for turning on debug information about what triggered precedence rules to fire for dimensions which are not always displayed, "whyprecedencerulefired".
WHY_PRECEDENCE_RULE_FIRED - Static variable in class com.endeca.infront.cartridge.RefinementMenuRequestParamMarshaller
Query parameter name for turning on debug information about what triggered precedence rules to fire for dimensions which are not always displayed, "whyprecedencerulefired".
WHY_RANK - Static variable in class com.endeca.infront.cartridge.ResultsListRequestParamMarshaller
Query parameter name for turning on debug information about why a record is ordered higher or lower than another in the result list, "whyrank".
WorkbenchContentSource - Class in com.endeca.infront.content.source
The WorkbenchContentSource allows the retrieval of content from a Workbench Server.
WorkbenchContentSource(boolean, String, String, String, int, String, String, boolean, int, int, String, String) - Constructor for class com.endeca.infront.content.source.WorkbenchContentSource
Deprecated. 
WorkbenchContentSource() - Constructor for class com.endeca.infront.content.source.WorkbenchContentSource
Constructs a new content source.
wrapConfig(ContentItem) - Method in class com.endeca.infront.cartridge.BreadcrumbsHandler
 
wrapConfig(ContentItem) - Method in class com.endeca.infront.cartridge.DimensionSearchResultsHandler
 
wrapConfig(ContentItem) - Method in class com.endeca.infront.cartridge.MediaBannerHandler
 
wrapConfig(ContentItem) - Method in class com.endeca.infront.cartridge.NavigationCartridgeHandler
Wraps the input ContentItem as a typed config object.
wrapConfig(ContentItem) - Method in class com.endeca.infront.cartridge.NavigationContainerHandler
 
wrapConfig(ContentItem) - Method in class com.endeca.infront.cartridge.RecordDetailsHandler
 
wrapConfig(ContentItem) - Method in class com.endeca.infront.cartridge.RecordSpotlightHandler
Creates a RecordSpotlightConfig.
wrapConfig(ContentItem) - Method in class com.endeca.infront.cartridge.RefinementMenuHandler
 
wrapConfig(ContentItem) - Method in class com.endeca.infront.cartridge.ResultsListHandler
 
wrapConfig(ContentItem) - Method in class com.endeca.infront.cartridge.SearchAdjustmentsHandler
 
write(HttpServletRequest, HttpServletResponse, ContentItem) - Method in class com.endeca.infront.assembler.servlet.JsonResponseWriter
Serializes the Assembler output as JSON and writes it to the response.
write(HttpServletRequest, HttpServletResponse, ContentItem) - Method in interface com.endeca.infront.assembler.servlet.ResponseWriter
Writes the servlet response based on the given Assembler output.
write(HttpServletRequest, HttpServletResponse, ContentItem) - Method in class com.endeca.infront.assembler.servlet.XmlResponseWriter
Serializes the Assembler output as XML and writes it to the response.
write(Object) - Method in class com.endeca.infront.serialization.JsonSerializer
Serialize the given object.
write(Object) - Method in class com.endeca.infront.serialization.XmlSerializer
Serialize the given object.

X

XmlResponseWriter - Class in com.endeca.infront.assembler.servlet
Serializes the Assembler output as XML and writes it to the response.
XmlResponseWriter() - Constructor for class com.endeca.infront.assembler.servlet.XmlResponseWriter
 
XmlSerializer - Class in com.endeca.infront.serialization
A class for serializing java objects to XML.
XmlSerializer(Writer) - Constructor for class com.endeca.infront.serialization.XmlSerializer
Create a XmlSerializer with the given Writer.

Z

ZONE_KEY - Static variable in class com.endeca.infront.content.MdexContentRequestBroker
Name of zone property in supplemental property map.

A B C D E F G H I J K L M N O P Q R S T U V W X Z

Copyright © 2012, Oracle and/or its affiliates. All rights reserved.