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

A

AbstractMDEXStateManager - Class in com.endeca.portal.data

An abstract base class for managing MDEXState changes.

AbstractMDEXStateManager() - Constructor for class com.endeca.portal.data.AbstractMDEXStateManager

default constructor

AbstractMetadata - Class in com.endeca.portal.metadata

Base abstract class for all metadata records.

AbstractMetadata() - Constructor for class com.endeca.portal.metadata.AbstractMetadata

AbstractMetadataManager<T extends MetadataObject> - Class in com.endeca.portal.metadata

Central facade for managing low-level Metadata Objects and Properties.

AbstractMetadataManager() - Constructor for class com.endeca.portal.metadata.AbstractMetadataManager

ACTION_DEEP_LINK - Static variable in class com.endeca.portlet.util.Constants

ACTION_PAGE_TRANSITION - Static variable in class com.endeca.portlet.util.Constants

ACTION_SHOW_DETAIL_VIEW - Static variable in class com.endeca.portlet.util.Constants

ACTION_UPDATE_DATA_SOURCE_BINDING - Static variable in class com.endeca.portlet.util.Constants

addAllAttributes(Map) - Method in class com.endeca.portlet.ModelMap

addAllObjects(Map) - Method in class com.endeca.portlet.ModelAndView

addAttribute(String, Object) - Method in class com.endeca.portlet.ModelMap

addAttributeMapping(String) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Maps an attribute to this set

addAttributeMappings(List<String>) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Maps a list of attributes to this set

addAttributeSet(String, String) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Adds a new attribute set for a given data source

addCachedDataQuery(RequestTracker, String, ENEQuery, ENEQueryResults, long) - Method in interface com.endeca.portal.instrumentation.DataSourceInstrumentor

Tracks a single query to an MDEX DataSource that was satisfied by application cache

addCachedDataQuery(RequestTracker, String, ENEQuery, ENEQueryResults, long) - Method in class com.endeca.portal.instrumentation.DataSourceTracker

addCachedDataQuery(RequestTracker, String, Request, Results, long) - Method in class com.endeca.portal.instrumentation.DataSourceTracker

addCachedDataQuery(RequestTracker, String, ENEQuery, ENEQueryResults, long) - Static method in class com.endeca.portal.instrumentation.MetricsFacade

addCachedDataQuery(RequestTracker, String, Request, Results, long) - Static method in class com.endeca.portal.instrumentation.MetricsFacade

addCachedDataQuery(RequestTracker, String, ENEQuery, ENEQueryResults, long) - Method in class com.endeca.portal.instrumentation.MetricsLogger

addCachedDataQuery(RequestTracker, String, Request, Results, long) - Method in class com.endeca.portal.instrumentation.MetricsLogger

addConfigElement(Request, ContentElementConfig) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

addDataQuery(RequestTracker, String, ENEQuery, ENEQueryResults, long) - Method in interface com.endeca.portal.instrumentation.DataSourceInstrumentor

Tracks a single uncached query to an MDEX DataSource

addDataQuery(RequestTracker, String, ENEQuery, ENEQueryResults, long) - Method in class com.endeca.portal.instrumentation.DataSourceTracker

addDataQuery(RequestTracker, String, Request, Results, long) - Method in class com.endeca.portal.instrumentation.DataSourceTracker

addDataQuery(RequestTracker, String, ENEQuery, ENEQueryResults, long) - Static method in class com.endeca.portal.instrumentation.MetricsFacade

addDataQuery(RequestTracker, String, Request, Results, long) - Static method in class com.endeca.portal.instrumentation.MetricsFacade

addDataQuery(RequestTracker, String, ENEQuery, ENEQueryResults, long) - Method in class com.endeca.portal.instrumentation.MetricsLogger

addDataQuery(RequestTracker, String, Request, Results, long) - Method in class com.endeca.portal.instrumentation.MetricsLogger

addDataSourceConfiguration(MDEXState) - Static method in class com.endeca.portal.data.config.DataSourceConfigHelper

addDataSourceQueryState(String, QueryState) - Method in class com.endeca.portal.model.Bookmark

addDataSourceRequestState(String, Request) - Method in class com.endeca.portal.model.Bookmark

addEndecaPortletState(EndecaPortletState) - Method in class com.endeca.portal.model.Bookmark

addEventTrigger(PortletRequest, MDEXState) - Method in class com.endeca.portal.data.AbstractMDEXStateManager

Use this method to make sure an appropriate change event will be triggered for an altered MDEXState

addFunction(QueryFunction) - Method in class com.endeca.portal.data.QueryState

Add a specified QueryFunction to this QueryState

addFunctions(List<? extends QueryFunction>) - Method in class com.endeca.portal.data.QueryState

Add a list of QueryFunctions to this QueryState

addMDEXState(MDEXState) - Method in class com.endeca.portal.session.UserSession

addMDEXStates(List<MDEXState>) - Method in class com.endeca.portal.session.UserSession

addObject(String, Object) - Method in class com.endeca.portlet.ModelAndView

addPortletExecution(RequestTracker, GenericPortlet, PortletMode, WindowState, long) - Static method in class com.endeca.portal.instrumentation.MetricsFacade

addPortletExecution(RequestTracker, GenericPortlet, PortletMode, WindowState, long) - Method in class com.endeca.portal.instrumentation.MetricsLogger

addPortletExecution(RequestTracker, GenericPortlet, PortletMode, WindowState, long) - Method in interface com.endeca.portal.instrumentation.PortletInstrumentor

Tracks a single portlet execution

addPortletExecution(RequestTracker, GenericPortlet, PortletMode, WindowState, long) - Method in class com.endeca.portal.instrumentation.PortletTracker

addPortletState(long, EndecaPortletState) - Method in interface com.endeca.portal.persistence.bookmarks.BookmarkManager

addPortletState(long, EndecaPortletState) - Method in class com.endeca.portal.persistence.bookmarks.DefaultBookmarkManager

Creates a new portlet state record for an existing bookmark; this allows bookmarks to be updated incrementally by each portlet in the bookmarked page

addProperties(List<? extends MetadataProperty>) - Method in class com.endeca.portal.metadata.MetadataObject

Adds a list of Metadata Properties to this Metadata Object

addProperty(MetadataProperty) - Method in class com.endeca.portal.metadata.MetadataObject

Adds a Metadata Property to this Metadata Object

addQueryTracking(ConversationPort, RequestTracker) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

instrument a MDEX 7 query by setting HTTP headers

addQueryTracking(ENEQuery, RequestTracker) - Static method in class com.endeca.portal.mdex.MDEXUtil

instruments a MDEX 6 query by setting an ENEQueryInfo object on the query

addSingleExecution(long) - Method in class com.endeca.portal.instrumentation.metrics.GenericMetric

adds a single component execution to the count and total time of executions

addSingleExecution(long) - Method in interface com.endeca.portal.instrumentation.metrics.Metric

adds a single component execution to the count and total time of executions

addSingleQuery(ENEQuery, ENEQueryResults, long) - Method in class com.endeca.portal.instrumentation.metrics.QueryMetric

adds a single query execution to the count and total time of queries

addSingleQuery(Request, Results, long) - Method in class com.endeca.portal.instrumentation.metrics.QueryMetric

adds a single discovery service query execution to the count and total time of queries

ALL - Static variable in class com.endeca.portal.util.EndecaPortletCategoryKeys

Represents the list of all categories in the control panel.

AnalyticsQueryConfig - Class in com.endeca.portal.data.functions

Allow an analytics query to be added to the QueryState.

AnalyticsQueryConfig() - Constructor for class com.endeca.portal.data.functions.AnalyticsQueryConfig

AnalyticsQueryConfig(String) - Constructor for class com.endeca.portal.data.functions.AnalyticsQueryConfig

Construct a new AnalyticsQueryConfig with a specified query.

AnalyticsQueryConfig(String, String) - Constructor for class com.endeca.portal.data.functions.AnalyticsQueryConfig

Construct a new AnalyticsQueryConfig with a specified query.

API_VERSION_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

apiErrorJSP - Variable in class com.endeca.portlet.EndecaPortlet

applySecurity(PortletRequest, MDEXState, Query) - Method in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

See MDEXSecurityManager.applySecurity(PortletRequest, MDEXState, Query)

applySecurity(PortletRequest, MDEXState, Query) - Method in interface com.endeca.portal.data.security.MDEXSecurityManager

Applies security filters to a provided Query.

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.AnalyticsQueryConfig

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.BreadcrumbsConfig

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.EQLFilter

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.ExposeRefinement

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.NavConfig

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.QueryFunction

Apply this function to a Request.

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.RangeFilter

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.RecordAggregator

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.RecordFilter

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.RecordSpecListFilter

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.RefinementFilter

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.RemoveNegativeRefinementFilter

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.ResultsConfig

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.ResultsSummaryConfig

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.SearchFilter

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.SearchKeysConfig

applyToDiscoveryServiceQuery(Request) - Method in class com.endeca.portal.data.functions.SortConfig

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.AnalyticsQueryConfig

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.BreadcrumbsConfig

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.EQLFilter

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.ExposeRefinement

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.NavConfig

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.QueryFunction

Apply this function to an ENEQuery.

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.RangeFilter

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.RecordAggregator

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.RecordFilter

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.RecordSpecListFilter

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.RefinementFilter

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.RemoveNegativeRefinementFilter

This filter is unsupported in the presentation API.

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.ResultsConfig

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.ResultsSummaryConfig

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.SearchFilter

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.SearchKeysConfig

applyToENEQuery(ENEQuery) - Method in class com.endeca.portal.data.functions.SortConfig

AttributeDisplayName - Class in com.endeca.portal.metadata.attributes

Specialization of Metadata Object to represent the display name for an attribute

AttributeDisplayName() - Constructor for class com.endeca.portal.metadata.attributes.AttributeDisplayName

Constructor: initializes the object with an ID of -1

AttributeDisplayName(MetadataRecord) - Constructor for class com.endeca.portal.metadata.attributes.AttributeDisplayName

Constructor that initializes the object from a MetadataRecord.

AttributeDisplayName(String, String, String) - Constructor for class com.endeca.portal.metadata.attributes.AttributeDisplayName

Convenience constructor that inits the object and sets a an attribute name, display name for the attribute, and the data source ID

AttributeDisplayNameManager - Class in com.endeca.portal.metadata.attributes

Encapsulates DB-interaction methods specific to display names for attributes

AttributeSet - Class in com.endeca.portal.metadata.attributes

Specialization of Metadata Object to represent an attribute set, which consists of a display name and a list of ordered mappings to individual attributes that are associated with the set.

AttributeSet() - Constructor for class com.endeca.portal.metadata.attributes.AttributeSet

Constructor: initializes the object and sets it immediately to be a DF core type

AttributeSet(MetadataRecord) - Constructor for class com.endeca.portal.metadata.attributes.AttributeSet

Constructor that initializes the object, assigns a given MetadataRecord to its underlying object, and sets its type The underlying object is not persisted to the database; that must be done explicitly if you want it to be persisted.

AttributeSet(String, String, String) - Constructor for class com.endeca.portal.metadata.attributes.AttributeSet

Convenience constructor that inits the object and sets a an locale-specific display name property and the data source ID.

AttributeSetDisplayName - Class in com.endeca.portal.metadata.attributes

Represents a localized display name property of an attribute set.

AttributeSetDisplayName() - Constructor for class com.endeca.portal.metadata.attributes.AttributeSetDisplayName

Constructor: initializes the object with an ID of -1

AttributeSetDisplayName(MetadataPropertyRecord) - Constructor for class com.endeca.portal.metadata.attributes.AttributeSetDisplayName

Constructor that initializes the object from a MetadataRecord.

AttributeSetDisplayName(String, String) - Constructor for class com.endeca.portal.metadata.attributes.AttributeSetDisplayName

Convenience constructor that initializes the object for a specified locale.

AttributeSetManager - Class in com.endeca.portal.metadata.attributes

Encapsulates DB-interaction methods specific to attribute sets

AttributeSetMapping - Class in com.endeca.portal.metadata.attributes

Represents an attribute mapping to an attribute set.

AttributeSetMapping() - Constructor for class com.endeca.portal.metadata.attributes.AttributeSetMapping

Constructor: initializes the object with an ID of -1

AttributeSetMapping(MetadataPropertyRecord) - Constructor for class com.endeca.portal.metadata.attributes.AttributeSetMapping

Constructor that initializes the object from a MetadataRecord.

AttributeSetMapping(String) - Constructor for class com.endeca.portal.metadata.attributes.AttributeSetMapping

Convenience constructor that initializes the object for a specified attribute.

B

BASEFUNCTIONS_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

BASEQUERYOPTIONS_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

Bookmark - Class in com.endeca.portal.model

Bookmark() - Constructor for class com.endeca.portal.model.Bookmark

BookmarkException - Exception in com.endeca.portal.persistence.bookmarks

BookmarkException(String) - Constructor for exception com.endeca.portal.persistence.bookmarks.BookmarkException

one-arg constructor

BookmarkException(String, Throwable) - Constructor for exception com.endeca.portal.persistence.bookmarks.BookmarkException

two-arg constructor

BookmarkHandler - Interface in com.endeca.portal.persistence.bookmarks

BookmarkManager - Interface in com.endeca.portal.persistence.bookmarks

BreadcrumbsConfig - Class in com.endeca.portal.data.functions

Configure how breadcrumbs will be returned on the QueryState's executed results.

BreadcrumbsConfig() - Constructor for class com.endeca.portal.data.functions.BreadcrumbsConfig

BreadcrumbsConfig(boolean) - Constructor for class com.endeca.portal.data.functions.BreadcrumbsConfig

Instantiate the breadcrumbs with the default ID and the given value for the returnFullPath property.

BreadcrumbsConfig(String) - Constructor for class com.endeca.portal.data.functions.BreadcrumbsConfig

Instantiate the breadcrumbs with the specified ID. returnFullPath will be true.

BreadcrumbsConfig(String, boolean) - Constructor for class com.endeca.portal.data.functions.BreadcrumbsConfig

Instantiate the breadcrumbs with the specified ID and the specified value for the returnFullPath property.

C

CA_FILE_PROPERTY - Static variable in class com.endeca.portal.data.SSLConfig

CA_PASS_PROPERTY - Static variable in class com.endeca.portal.data.SSLConfig

cacheResults(HttpENEConnection, ENEQuery, ENEQueryResults) - Method in class com.endeca.portal.mdex.MDEXQueryCacheManager

cacheResults(ConversationPort, Request, Results) - Method in class com.endeca.portal.mdex.MDEXQueryCacheManager

caughtParameters(String) - Static method in class com.endeca.portal.session.UserSession

CERT_FILE_PROPERTY - Static variable in class com.endeca.portal.data.SSLConfig

CERT_PASS_PROPERTY - Static variable in class com.endeca.portal.data.SSLConfig

checkAPICompatibility(MDEXState) - Static method in class com.endeca.portal.mdex.MDEXUtil

checkDataSourceRequired() - Method in class com.endeca.portlet.EndecaPortlet

This method denotes whether or not this portlet requires a binding to a MDEX data source.

CLASS_PROPERTY - Static variable in class com.endeca.portal.data.functions.QueryFunction

clear() - Method in class com.endeca.portlet.ModelAndView

clearViewTransitionParameters(String) - Static method in class com.endeca.portal.session.UserSession

clone() - Method in class com.endeca.portal.data.functions.QueryFunction

clone() - Method in class com.endeca.portal.data.MDEXState

clone() - Method in class com.endeca.portal.data.QueryState

clone() - Method in class com.endeca.portal.instrumentation.DataSourceTracker

clone() - Method in class com.endeca.portal.instrumentation.MetricsLogger

clone() - Method in class com.endeca.portal.instrumentation.PortletTracker

clone(Request) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

cloneFunctionList(List<QueryFunction>) - Static method in class com.endeca.portal.data.QueryState

Clone a List of QueryFunction instances.

cloneRequest(Request) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

com.endeca.portal.data - package com.endeca.portal.data

com.endeca.portal.data.config - package com.endeca.portal.data.config

com.endeca.portal.data.functions - package com.endeca.portal.data.functions

com.endeca.portal.data.functions.util - package com.endeca.portal.data.functions.util

com.endeca.portal.data.security - package com.endeca.portal.data.security

com.endeca.portal.instrumentation - package com.endeca.portal.instrumentation

com.endeca.portal.instrumentation.metrics - package com.endeca.portal.instrumentation.metrics

com.endeca.portal.liferay - package com.endeca.portal.liferay

com.endeca.portal.mdex - package com.endeca.portal.mdex

com.endeca.portal.mdex.ssl - package com.endeca.portal.mdex.ssl

com.endeca.portal.metadata - package com.endeca.portal.metadata

com.endeca.portal.metadata.attributes - package com.endeca.portal.metadata.attributes

com.endeca.portal.metadata.framework - package com.endeca.portal.metadata.framework

com.endeca.portal.metadata.query - package com.endeca.portal.metadata.query

com.endeca.portal.metadata.simple - package com.endeca.portal.metadata.simple

com.endeca.portal.model - package com.endeca.portal.model

com.endeca.portal.persistence - package com.endeca.portal.persistence

com.endeca.portal.persistence.bookmarks - package com.endeca.portal.persistence.bookmarks

com.endeca.portal.session - package com.endeca.portal.session

com.endeca.portal.util - package com.endeca.portal.util

com.endeca.portlet - package com.endeca.portlet

com.endeca.portlet.util - package com.endeca.portlet.util

com.endeca.util - package com.endeca.util

compare(MDEXState, MDEXState) - Method in class com.endeca.portal.data.config.MDEXStateNameComparator

CONFIG_PARAMETER_CONTAINER - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_CORDA_EXTERNAL_URL - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_CORDA_INTERNAL_URL - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_DATA_SOURCE - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_DATA_SOURCE_CHANGED - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_DATA_SOURCE_DEFAULT - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_DATA_SOURCE_DEFAULT_SETTING - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_DATA_SOURCE_HEALTH_CHECK_TIMEOUT - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_DATA_SOURCE_POLLING_INTERVAL - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_DEEP_LINK_PORTLET_NAME - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_MAX_EXPORT_ANALYTIC_RECS - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_MAX_EXPORT_BASE_RECS - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_MDEX_SECURITY_MANAGER - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PARAMETER_MDEX_STATE_MANAGER - Static variable in class com.endeca.portlet.util.Constants

CONFIG_PROPERTY_INHERIT_SECURITY - Static variable in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

JSON key for toggling security filter inheritance from parents on/off

CONFIG_PROPERTY_PARENT_DATA_SOURCE - Static variable in class com.endeca.portal.data.MDEXStateRelationshipUtil

CONFIG_PROPERTY_ROLE_PERMISSIONS - Static variable in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

JSON key for defining available security roles for filters

CONFIG_PROPERTY_SECURITY_ENABLED - Static variable in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

JSON key for toggling security on/off

CONFIG_PROPERTY_SECURITY_FILTERS - Static variable in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

JSON key for security filters

Constants - Class in com.endeca.portlet.util

Container - Enum in com.endeca.portlet.util

containsAttribute(String) - Method in class com.endeca.portlet.ModelMap

convertFromLiferayBookmark(BookmarkRecord) - Method in class com.endeca.portal.persistence.bookmarks.DefaultBookmarkManager

copyQuery(ENEQuery) - Static method in class com.endeca.portal.mdex.MDEXUtil

This method takes an ENEQuery object and makes a copy of it.

createDiscoveryServiceQuery(QueryState, Request) - Method in class com.endeca.portal.data.DataSource

Create a Discovery Service Request instance from a query state, given a request state

createDiscoveryServiceQuery(QueryState) - Method in class com.endeca.portal.data.DataSource

Create a Discovery Service Request instance from a query state, using the current request state.

createElement(Document, String) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

createENEQuery() - Method in class com.endeca.portal.data.DataSource

Create an ENEQuery object from the data source's current state.

createENEQuery(QueryState) - Method in class com.endeca.portal.data.DataSource

Create an ENEQuery object based on the specified query state

createFilterSetFromJSON(JSONArray, JSONObject) - Method in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

Searches a set of JSON object representations of filters identified by name in the provided JSONArray.

createJSONFromDimVal(DimVal) - Static method in class com.endeca.portal.data.functions.RefinementFilter

CURRENTFUNCTIONS_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

CURRENTREQUESTSTATE_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

D

DATA_SOURCE_CONFIG_DIRECTORY - Static variable in class com.endeca.portal.data.config.DataSourceConfigHelper

DataSource - Class in com.endeca.portal.data

DataSource instances encapsulate a connection to an MDEX Engine, a current QueryState on the connection, handles the logic of executing a query on an MDEX to get results, and handles the logic of altering the QueryState.

DataSource(PortletRequest, String) - Constructor for class com.endeca.portal.data.DataSource

Construct a DataSource instance referring to a particular data source.

DataSourceConfigAlreadyExistsException - Exception in com.endeca.portal.data.config

Thrown when writing an MDEX state configuration file to disk if a file of the same name already exists.

DataSourceConfigAlreadyExistsException(String) - Constructor for exception com.endeca.portal.data.config.DataSourceConfigAlreadyExistsException

one-arg constructor

DataSourceConfigAlreadyExistsException(String, Throwable) - Constructor for exception com.endeca.portal.data.config.DataSourceConfigAlreadyExistsException

two-arg constructor

DataSourceConfigHelper - Class in com.endeca.portal.data.config

DataSourceConfigHelper() - Constructor for class com.endeca.portal.data.config.DataSourceConfigHelper

DataSourceConfigNotFoundException - Exception in com.endeca.portal.data.config

Thrown when attempting to add or remove a child datasource from a parent that does not exist.

DataSourceConfigNotFoundException(String) - Constructor for exception com.endeca.portal.data.config.DataSourceConfigNotFoundException

one-arg constructor

DataSourceConfigNotFoundException(String, Throwable) - Constructor for exception com.endeca.portal.data.config.DataSourceConfigNotFoundException

two-arg constructor

DataSourceConfigUpdateException - Exception in com.endeca.portal.data.config

Generic error that represents unexpected errors when updating an MDEX State configuration on disk

DataSourceConfigUpdateException(String) - Constructor for exception com.endeca.portal.data.config.DataSourceConfigUpdateException

one-arg constructor

DataSourceConfigUpdateException(String, Throwable) - Constructor for exception com.endeca.portal.data.config.DataSourceConfigUpdateException

two-arg constructor

dataSourceErrorJSP - Variable in class com.endeca.portlet.EndecaPortlet

DataSourceException - Exception in com.endeca.portal.data

Thrown when attempting to perform an operation on a data source, such as updating an MDEX state or executing a query

DataSourceException(String) - Constructor for exception com.endeca.portal.data.DataSourceException

one-arg constructor

DataSourceException(String, Throwable) - Constructor for exception com.endeca.portal.data.DataSourceException

two-arg constructor

dataSourceExists(String) - Method in class com.endeca.portal.session.UserSession

DataSourceInstrumentor - Interface in com.endeca.portal.instrumentation

Interface representing the ability to track MDEX queries to datasources

dataSourceSelectorJSP - Variable in class com.endeca.portlet.EndecaPortlet

DataSourceTracker - Class in com.endeca.portal.instrumentation

Concrete class to track all query executions, both at a global level and at a per-datasource level

DEFAULT_API_VERSION - Static variable in class com.endeca.portal.data.MDEXState

DEFAULT_CATCHALL_NAME - Static variable in class com.endeca.portal.metadata.attributes.AttributeSetManager

Defines the default name for the "catchall" set

DEFAULT_CONTAINER - Static variable in class com.endeca.util.SettingDefaults

Setting representing the default AJAX/non-AJAX container (see Container)

DEFAULT_DATA_SOURCE_DIRECTORY - Static variable in class com.endeca.util.SettingDefaults

Setting representing the location on disk to store the data source json files (see DataSourceConfigHelper)

DEFAULT_DATA_SOURCE_HEALTH_CHECK_TIMEOUT - Static variable in class com.endeca.util.SettingDefaults

Setting representing the query timeout for ping and API compatibility (see MDEXUtil).

DEFAULT_DATA_SOURCE_ID - Static variable in class com.endeca.util.SettingDefaults

Setting representing the location on disk to store the default data source id (see EndecaPortletUtil)

DEFAULT_DATA_SOURCE_POLLING_INTERVAL - Static variable in class com.endeca.util.SettingDefaults

Setting representing the polling interval to check availability of the underlying data source (see DataSourceConfigHelper). -1 means never poll.

DEFAULT_DEEP_LINK_PORTLET_NAME - Static variable in class com.endeca.util.SettingDefaults

Setting representing the name of the deep link portlet.

DEFAULT_ENGINE_VERSION - Static variable in class com.endeca.portal.data.MDEXState

DEFAULT_ID - Static variable in class com.endeca.portal.data.functions.AnalyticsQueryConfig

DEFAULT_ID - Static variable in class com.endeca.portal.data.functions.BreadcrumbsConfig

DEFAULT_ID - Static variable in class com.endeca.portal.data.functions.DimensionSearchConfig

DEFAULT_ID - Static variable in class com.endeca.portal.data.functions.NavConfig

DEFAULT_ID - Static variable in class com.endeca.portal.data.functions.ResultsConfig

DEFAULT_ID - Static variable in class com.endeca.portal.data.functions.ResultsSummaryConfig

DEFAULT_ID - Static variable in class com.endeca.portal.data.functions.SearchKeysConfig

DEFAULT_MDEX_SECURITY_MANAGER - Static variable in class com.endeca.util.SettingDefaults

Setting representing the default MDEX Security Manager (see DefaultMDEXSecurityManager)

DEFAULT_MDEX_STATE_MANAGER - Static variable in class com.endeca.util.SettingDefaults

Setting representing the default MDEX State Manager (see DefaultMDEXStateManager)

DEFAULT_V7_DIMENSION_ROOT_DVAL_SPEC - Static variable in class com.endeca.portlet.util.Constants

DefaultBookmarkHandler - Class in com.endeca.portal.persistence.bookmarks

Provides default functionality for handling a portlet bookmark.

DefaultBookmarkHandler(PortletStateSerializer) - Constructor for class com.endeca.portal.persistence.bookmarks.DefaultBookmarkHandler

DefaultBookmarkManager - Class in com.endeca.portal.persistence.bookmarks

DefaultBookmarkManager() - Constructor for class com.endeca.portal.persistence.bookmarks.DefaultBookmarkManager

defaultDataSourceId - Variable in class com.endeca.portlet.EndecaPortlet

DefaultMDEXSecurityManager - Class in com.endeca.portal.data.security

This is a simple implementation of MDEXSecurityManager, providing role-based security filters via data source configuration.

DefaultMDEXSecurityManager() - Constructor for class com.endeca.portal.data.security.DefaultMDEXSecurityManager

Default constructor

DefaultMDEXStateManager - Class in com.endeca.portal.data

This is a simple implementation of MDEXStateManager covering a very simple parent-child relationship of data sources.

DefaultMDEXStateManager() - Constructor for class com.endeca.portal.data.DefaultMDEXStateManager

default constructor

deferredLoad(String) - Static method in class com.endeca.portal.session.UserSession

deleteDataSourceConfiguration(MDEXState) - Static method in class com.endeca.portal.data.config.DataSourceConfigHelper

DESCRIPTION_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

deserializePortletState(EndecaPortletState, PortletRequest, StateAwareResponse) - Method in class com.endeca.portlet.EndecaPortlet

Deserializes portlet state (see notes in EndecaPortlet.serializePortletState(PortletRequest, StateAwareResponse) above)

deserializePortletState(EndecaPortletState, PortletRequest, StateAwareResponse) - Method in interface com.endeca.portlet.PortletStateSerializer

DF - Static variable in class com.endeca.portal.util.EndecaPortletCategoryKeys

Represents the "Discovery Framework" category in the control panel

dimensionAttributeIterator() - Method in class com.endeca.portal.mdex.MDEXAttributeList

DimensionSearchConfig - Class in com.endeca.portal.data.functions

DimensionSearchConfig() - Constructor for class com.endeca.portal.data.functions.DimensionSearchConfig

DimensionSearchConfig(String) - Constructor for class com.endeca.portal.data.functions.DimensionSearchConfig

DimensionSearchConfig(String, int) - Constructor for class com.endeca.portal.data.functions.DimensionSearchConfig

DimensionSearchConfig(String, String) - Constructor for class com.endeca.portal.data.functions.DimensionSearchConfig

DimensionSearchConfig(String, String, int) - Constructor for class com.endeca.portal.data.functions.DimensionSearchConfig

DimensionSearchConfig(String, String, String, int) - Constructor for class com.endeca.portal.data.functions.DimensionSearchConfig

dirty - Variable in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

DISCOVERY_SERVICE - Static variable in class com.endeca.portal.mdex.DiscoveryServiceUtil

DiscoveryServiceUtil - Class in com.endeca.portal.mdex

DiscoveryServiceUtil() - Constructor for class com.endeca.portal.mdex.DiscoveryServiceUtil

doEdit(RenderRequest, RenderResponse) - Method in class com.endeca.portlet.EndecaPortlet

doHelp(RenderRequest, RenderResponse) - Method in class com.endeca.portlet.EndecaPortlet

doView(RenderRequest, RenderResponse) - Method in class com.endeca.portlet.EndecaPortlet

E

EDIT_JSP - Static variable in class com.endeca.portlet.EndecaPortlet

editJSP - Variable in class com.endeca.portlet.EndecaPortlet

end(ProfilerType, RequestTracker, GenericPortlet, PortletMode, WindowState, long) - Static method in class com.endeca.portal.instrumentation.Profiler

Convenience method for recording portlet executions only.

end(ProfilerType, RequestTracker, String, ENEQuery, ENEQueryResults, long) - Static method in class com.endeca.portal.instrumentation.Profiler

Method to record MDEX queries, whether cached or uncached.

end(ProfilerType, RequestTracker, String, Request, Results, long) - Static method in class com.endeca.portal.instrumentation.Profiler

Method to record discovery service queries, whether cached or uncached.

ENDECA - Static variable in class com.endeca.portal.util.EndecaPortletCategoryKeys

Represents the "Endeca" category in the control panel

EndecaPortlet - Class in com.endeca.portlet

Base portlet class for portlets that want to make use of Endeca or Discovery Framework functionality.

EndecaPortlet() - Constructor for class com.endeca.portlet.EndecaPortlet

EndecaPortletCategoryKeys - Class in com.endeca.portal.util

Defines control panel categories for Endeca portlets.

EndecaPortletCategoryKeys() - Constructor for class com.endeca.portal.util.EndecaPortletCategoryKeys

EndecaPortletState - Class in com.endeca.portlet

EndecaPortletState() - Constructor for class com.endeca.portlet.EndecaPortletState

EndecaPortletUtil - Class in com.endeca.portlet.util

EndecaPortletUtil() - Constructor for class com.endeca.portlet.util.EndecaPortletUtil

EndecaWindowState - Class in com.endeca.portlet.util

This class wraps the container specific state strings, so we can override if necessary.

EndecaWindowState() - Constructor for class com.endeca.portlet.util.EndecaWindowState

engineVersion - Variable in class com.endeca.portal.data.MDEXState

EQLFilter - Class in com.endeca.portal.data.functions

This class makes it possible to set Endeca Query Language filters on a QueryState This filter is notably different from other implemented filter classes in that it does not merge its specified EQL filter with any other EQL filters that may already be specified on a query: it simply overwrites whatever EQL filter was previously specified.

EQLFilter() - Constructor for class com.endeca.portal.data.functions.EQLFilter

EQLFilter(JSONObject) - Constructor for class com.endeca.portal.data.functions.EQLFilter

EQLFilter(String) - Constructor for class com.endeca.portal.data.functions.EQLFilter

equals(Object) - Method in class com.endeca.portal.data.functions.QueryFunction

equals(QueryFunction) - Method in class com.endeca.portal.data.functions.QueryFunction

Compares two QueryFunction instances by checking class types and using the object's toString() method

equals(Object) - Method in class com.endeca.portal.metadata.attributes.AttributeSetDisplayName

Returns true if the provided display name property object's Metadata Object ID, locale and display name value are the same.

equals(Object) - Method in class com.endeca.portal.metadata.attributes.AttributeSetMapping

Returns true if the provided display name property object's Metadata Object ID and mapping value (the attribute name) are the same.

equals(Object) - Method in class com.endeca.portal.metadata.MetadataObject

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class com.endeca.portal.metadata.MetadataProperty

Indicates whether some other object is "equal to" this one.

equivalent(QueryState) - Method in class com.endeca.portal.data.QueryState

Convenience method to check equivalence of query states A QueryState is equivalent to another if they contain the same non-QueryConfig QueryFunctions, in the same order.

escape(String) - Static method in class com.endeca.portal.data.functions.util.FilterUtils

Escapes special characters in a filter literal.

EVENT_ANALYTICS_DETAIL_VIEW - Static variable in class com.endeca.portlet.util.Constants

EVENT_CREATE_ENDECA_BOOKMARK - Static variable in class com.endeca.portlet.util.Constants

EVENT_DATASOURCE_NAMESPACE - Static variable in class com.endeca.portlet.util.Constants

EVENT_DETAIL_VIEW - Static variable in class com.endeca.portlet.util.Constants

EVENT_LOAD_ENDECA_BOOKMARK - Static variable in class com.endeca.portlet.util.Constants

EVENT_NAMESPACE - Static variable in class com.endeca.portlet.util.Constants

EXCLUSIVE - Static variable in class com.endeca.portlet.util.EndecaWindowState

EXCLUSIVE_WINDOW_STATE - Static variable in class com.endeca.portlet.util.EndecaWindowState

execute() - Method in class com.endeca.portal.data.DataSource

Deprecated.

execute(QueryState, Request) - Method in class com.endeca.portal.data.DataSource

Executes a query represented by a QueryState and a RequestState.

execute(QueryState) - Method in class com.endeca.portal.data.DataSource

Executes a query representing the underlying MDEX State's QueryState and the current RequestState.

execute(ENEQuery) - Method in class com.endeca.portal.data.DataSource

Applies security filters as managed by the MDEX Security Manager and executes query

execute(Request) - Method in class com.endeca.portal.data.DataSource

Applies security and executes query against the current request's FilterState.

execute(MDEXState, Request, RequestTracker) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

execute(MDEXState, ENEQuery, RequestTracker) - Static method in class com.endeca.portal.mdex.MDEXUtil

execute() - Method in class com.endeca.portal.metadata.query.MetadataObjectQuery

Executes the DynamicQuery and returns a list of MetadataRecord objects.

execute() - Method in class com.endeca.portal.metadata.query.MetadataPropertyQuery

Executes the DynamicQuery and returns a list of MetadataPropertyRecord objects.

execute() - Method in class com.endeca.portal.metadata.query.MetadataQuery

Executes the DynamicQuery and return objects that are instances of a class extending Liferay's base record model class BaseModel.

expandLiferayHomeToken(String) - Static method in class com.endeca.portal.data.config.DataSourceConfigHelper

Expands tokens in a path string representing the data source directory.

ExposeRefinement - Class in com.endeca.portal.data.functions

Expose a refinement in a query.

ExposeRefinement() - Constructor for class com.endeca.portal.data.functions.ExposeRefinement

ExposeRefinement(String) - Constructor for class com.endeca.portal.data.functions.ExposeRefinement

ExposeRefinement(String, String) - Constructor for class com.endeca.portal.data.functions.ExposeRefinement

ExposeRefinement(RefinementExposeOperator) - Constructor for class com.endeca.portal.data.functions.ExposeRefinement

F

FALSE_STRING - Static variable in class com.endeca.portlet.util.Constants

Feature - Enum in com.endeca.portal.data

This class contains the mapping of MDEX version to feature support.

FEATURE_CATCHALL - Static variable in class com.endeca.portal.metadata.attributes.AttributeSetManager

Represents the "catchall" feature for attribute sets

FIELD_NAME_DESCRIPTION - Static variable in class com.endeca.portal.metadata.query.MetadataQuery

FIELD_NAME_FEATURE - Static variable in class com.endeca.portal.metadata.query.MetadataQuery

FIELD_NAME_KEY - Static variable in class com.endeca.portal.metadata.query.MetadataQuery

FIELD_NAME_LAST_UPDATED - Static variable in class com.endeca.portal.metadata.query.MetadataQuery

FIELD_NAME_LOCALE - Static variable in class com.endeca.portal.metadata.query.MetadataQuery

FIELD_NAME_OBJECT_ID - Static variable in class com.endeca.portal.metadata.query.MetadataQuery

FIELD_NAME_PROPERTY_ID - Static variable in class com.endeca.portal.metadata.query.MetadataPropertyQuery

FIELD_NAME_REL - Static variable in class com.endeca.portal.metadata.query.MetadataQuery

FIELD_NAME_SOURCE - Static variable in class com.endeca.portal.metadata.query.MetadataQuery

FIELD_NAME_TYPE - Static variable in class com.endeca.portal.metadata.query.MetadataQuery

FIELD_NAME_VALUE - Static variable in class com.endeca.portal.metadata.query.MetadataQuery

FilterUtils - Class in com.endeca.portal.data.functions.util

FrameworkSetting - Class in com.endeca.portal.metadata.framework

Specialization of Metadata Object to represent a Discovery Framework Core setting

FrameworkSetting() - Constructor for class com.endeca.portal.metadata.framework.FrameworkSetting

Constructor: initializes the object with an ID of -1

FrameworkSetting(MetadataRecord) - Constructor for class com.endeca.portal.metadata.framework.FrameworkSetting

Constructor that initializes the object from a MetadataRecord.

FrameworkSetting(String, String, String) - Constructor for class com.endeca.portal.metadata.framework.FrameworkSetting

Convenience constructor that initializes the object and sets a key, value, and description

FrameworkSettingManager - Class in com.endeca.portal.metadata.framework

Encapsulates DB-interaction methods specific to Discovery Framework settings

fromJSONObject(JSONObject) - Static method in class com.endeca.portal.mdex.MDEXUtil

Creates a new ENEQuery object based on the contents of this JSON object.

fromJSONString(String) - Static method in class com.endeca.portal.mdex.MDEXUtil

Creates a new ENEQuery object based on the contents of this JSON packet.

fromXML(String, Class<T>) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

G

GenericMetric - Class in com.endeca.portal.instrumentation.metrics

abstract generic implementation of a metric to be tracked for performance reasons

GenericMetric() - Constructor for class com.endeca.portal.instrumentation.metrics.GenericMetric

getAggCount() - Method in class com.endeca.portal.data.functions.RecordAggregator

Retrieves the number of base records per aggregate.

getAllAnalytics(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getAllAttributeSets() - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Returns all attribute set metadata objects

getAllBreadcrumbs(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getAllContentElementConfigs(Request, Class<T>) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getAllContentElements(Results, Class<T>) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getAllDimensionSearches(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getAllDisplayNames() - Method in class com.endeca.portal.metadata.attributes.AttributeDisplayNameManager

Returns all attribute display names.

getAllFrameworkSettings() - Method in class com.endeca.portal.metadata.framework.FrameworkSettingManager

Returns all Discovery Framework core settings.

getAllNavigationMenus(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getAllPassThroughElements(Results, String) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getAllPortletMessages() - Method in class com.endeca.portlet.util.LanguageUtils

Invokes LanguageUtils.getAllPortletMessages(PortletRequest).

getAllPortletMessages(PortletRequest) - Static method in class com.endeca.portlet.util.LanguageUtils

Retrieves all messages available in a resource bundle for the invoking portlet.

getAllRecordLists(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getAnalytics(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getAnalyticsQuery() - Method in class com.endeca.portal.data.functions.AnalyticsQueryConfig

getAncestors() - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

getAncestors(Results, String, String) - Static method in class com.endeca.portal.data.functions.NegativeRefinementFilter

Returns the ancestors of a specific dimension from a NegativeRefinementFilter returned in a V7 Results object.

getAttribute(String) - Method in class com.endeca.portal.mdex.MDEXAttributeList

getAttributeMappings() - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Gets all attribute mapping Metadata Properties for this attribute set object

getAttributeName() - Method in class com.endeca.portal.metadata.attributes.AttributeSetMapping

Returns the "value" of the attribute mapping, which is the name of the attribute that this mapping represents

getAttributeNames() - Method in class com.endeca.portal.mdex.MDEXAttributeList

getAttributes() - Method in class com.endeca.portal.mdex.MDEXAttributeList

getAttributesByMdexProp(String, String) - Method in class com.endeca.portal.mdex.MDEXAttributeList

getAttributeSetByFeature(String, String) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Returns an attribute set by feature for a specified data source

getAttributeSetById(long) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Returns an attribute set metadata object by ID

getAttributeSetByName(String, String) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Returns an attribute set by name for a specified data source

getAttributeSetsByDataSource(String) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Returns a list of attribute display names associated with a given data source.

getAvailableSearchKeys(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getAverageCachedDataQueryTime() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Returns the dumb average (totalExecutionTime/numExecutions) execution time for cached queries

getAverageDataQueryTime() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Returns the dumb average (totalExecutionTime/numExecutions) execution time for uncached queries

getAverageExecutionTime() - Method in class com.endeca.portal.instrumentation.metrics.GenericMetric

getAverageExecutionTime() - Method in interface com.endeca.portal.instrumentation.metrics.Metric

Returns the dumb average (totalExecutionTime/numExecutions) execution time for this query type.

getBaseUrl() - Method in class com.endeca.portal.model.Bookmark

getBookmarkById(long) - Method in interface com.endeca.portal.persistence.bookmarks.BookmarkManager

getBookmarkById(long) - Method in class com.endeca.portal.persistence.bookmarks.DefaultBookmarkManager

getBookmarksByUserId(long) - Method in interface com.endeca.portal.persistence.bookmarks.BookmarkManager

getBookmarksByUserId(long) - Method in class com.endeca.portal.persistence.bookmarks.DefaultBookmarkManager

getBreadcrumbs(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getCached() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Gets the QueryMetric for queries to this MDEX that were cached

getCachedDataQueryCount() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Returns the total number of cached queries

getCachedDataQueryTime() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Returns the total aggregate execution time for all cached queries

getCachedResults(HttpENEConnection, ENEQuery) - Method in class com.endeca.portal.mdex.MDEXQueryCacheManager

getCachedResults(ConversationPort, Request) - Method in class com.endeca.portal.mdex.MDEXQueryCacheManager

getCAFile() - Method in class com.endeca.portal.data.SSLConfig

getCAPassword() - Method in class com.endeca.portal.data.SSLConfig

getCatchallSet(String) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Returns the "catchall" set for a given data source

getCertFile() - Method in class com.endeca.portal.data.SSLConfig

getCertPassword() - Method in class com.endeca.portal.data.SSLConfig

getColumns() - Method in class com.endeca.portal.data.functions.ResultsConfig

getConfigById(Request, String) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getContainer() - Method in class com.endeca.portlet.EndecaPortlet

getContentElement(Results, Class<T>) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getContentElementConfig(Request, Class<T>) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getCreatedDate() - Method in class com.endeca.portal.model.Bookmark

getDataQueryCacheHitPercentage() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Returns the percentage of queries that were served from the cache

getDataQueryCount() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Returns the total number of uncached queries

getDataQueryTime() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Returns the total aggregate execution time for all uncached queries

getDataSource(PortletRequest) - Method in class com.endeca.portlet.EndecaPortlet

Retrieve the DataSource instance this portlet listens to.

getDataSourceConfigurations() - Static method in class com.endeca.portal.data.config.DataSourceConfigHelper

getDataSourceConfigVersion() - Static method in class com.endeca.portal.data.config.DataSourceConfigHelper

getDataSourceId(PortletRequest) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Retrieve the dataSourceId of the data source that this portlet listens to.

getDataSourceKeys() - Method in class com.endeca.portal.instrumentation.DataSourceTracker

Returns the set of all DataSource keys being tracked

getDataSourceQueryState(String) - Method in class com.endeca.portal.model.Bookmark

getDataSourceQueryStates() - Method in class com.endeca.portal.model.Bookmark

getDataSourceRequestState(String) - Method in class com.endeca.portal.model.Bookmark

getDataSourceRequestStates() - Method in class com.endeca.portal.model.Bookmark

getDataSourceTracker() - Static method in class com.endeca.portal.instrumentation.MetricsFacade

Returns the tracker for MDEX query executions.

getDefaultDataSourceId() - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Retrieves the value of the default data source

getDefaultLocale() - Static method in class com.endeca.portal.liferay.LiferayUtils

Returns the default locale for the container.

getDefaultLocale(Container) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Returns the default locale for the container.

getDescendants(MDEXState, UserSession) - Static method in class com.endeca.portal.data.MDEXStateRelationshipUtil

Gets a list of MDEXState objects that are descendants of the provided MDEXState, determined by the MDEXStateRelationshipUtil.CONFIG_PROPERTY_PARENT_DATA_SOURCE property used in data source configurations.

getDescription() - Method in class com.endeca.portal.data.DataSource

get the DataSource's description

getDescription() - Method in class com.endeca.portal.data.MDEXState

getDescription() - Method in class com.endeca.portal.metadata.AbstractMetadata

get the description

getDescription() - Method in interface com.endeca.portal.metadata.Metadata

get the description

getDescription() - Method in class com.endeca.portal.model.Bookmark

getDimensionId() - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

getDimensionId() - Method in class com.endeca.portal.data.functions.ExposeRefinement

getDimensionId() - Method in class com.endeca.portal.data.functions.RefinementFilter

getDimensionName() - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

getDimensions() - Method in class com.endeca.portal.mdex.MDEXAttributeList

getDimensionSearch(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getDimId() - Method in class com.endeca.portal.mdex.MDEXAttribute

getDimValId() - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

getDimValId() - Method in class com.endeca.portal.data.functions.ExposeRefinement

getDimValId() - Method in class com.endeca.portal.data.functions.RefinementFilter

getDimValName() - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

getDiscoveryServiceQuery() - Method in class com.endeca.portal.data.Query

getDiscoveryServiceResults() - Method in class com.endeca.portal.data.QueryResults

Get the wrapped discovery service results.

getDisplayName(String) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Gets the display name Metadata Property associated with this attribute set object for a specified locale

getDisplayName(PortletRequest, String) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Retrieves the global display name for the specified attribute

getDisplayName(String, String) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Retrieves the global display name for the specified attribute

getDisplayNameByKey(String, String) - Method in class com.endeca.portal.metadata.attributes.AttributeDisplayNameManager

Returns an attribute display name, associated with a given data source, by its key

getDisplayNamesByDataSource(String) - Method in class com.endeca.portal.metadata.attributes.AttributeDisplayNameManager

Returns a list of attribute display names associated with a given data source

getDisplayNameValue(String) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Gets the display name for this attribute set object for a specified locale

getDisplayNameValue(String, String) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Convenience method to return a display name for this attribute set - looks first for a display name for the request locale, then for the container's default locale, then finally uses the key.

getDisplayNameValueByKey(String, String, String) - Method in class com.endeca.portal.metadata.attributes.AttributeDisplayNameManager

Returns the value of an attribute display name, associated with a given data source, by its key.

getEndecaPortletState(String) - Method in class com.endeca.portal.model.Bookmark

getEndecaPortletStates() - Method in class com.endeca.portal.model.Bookmark

getENEQuery() - Method in class com.endeca.portal.data.Query

getENEQueryResults() - Method in class com.endeca.portal.data.QueryResults

Get the wrapped ENEQueryResults.

getEqlFilter() - Method in class com.endeca.portal.data.functions.EQLFilter

getEventName() - Method in class com.endeca.portal.data.DataSource

Retrieve the event name that gets fired/listened for when this data source changes.

getEventName() - Method in class com.endeca.portal.data.MDEXState

getExposeAll() - Method in class com.endeca.portal.data.functions.ExposeRefinement

getExposeAllRefinements() - Method in class com.endeca.portal.data.functions.NavConfig

getFeature() - Method in class com.endeca.portal.metadata.AbstractMetadata

get the feature

getFeature() - Method in interface com.endeca.portal.metadata.Metadata

get the feature

getFileFromPath(String) - Static method in class com.endeca.portal.data.config.DataSourceConfigHelper

getFirstParam(PortletRequest, String) - Method in class com.endeca.portlet.EndecaPortlet

getFrameworkSettingByKey(String) - Method in class com.endeca.portal.metadata.framework.FrameworkSettingManager

Returns a Discovery Framework core setting by its key.

getFrameworkSettingValueByKey(String, String) - Method in class com.endeca.portal.metadata.framework.FrameworkSettingManager

Returns the value of a Discovery Framework core setting by its key.

getFullyQualifiedTransitionContext(PortletRequest, String) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Returns a fully-qualified target page context path.

getFunctions() - Method in class com.endeca.portal.data.QueryState

Get direct access to the QueryFunction list.

getFunctions(Class<T>) - Method in class com.endeca.portal.data.QueryState

Get a list of all query functions of the specified class (determined using .isInstance).

getGetters() - Method in class com.endeca.portal.data.functions.AnalyticsQueryConfig

getGetters() - Method in class com.endeca.portal.data.functions.BreadcrumbsConfig

getGetters() - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

getGetters() - Method in class com.endeca.portal.data.functions.EQLFilter

getGetters() - Method in class com.endeca.portal.data.functions.ExposeRefinement

getGetters() - Method in class com.endeca.portal.data.functions.NavConfig

getGetters() - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

getGetters() - Method in class com.endeca.portal.data.functions.QueryFunction

Return the list of property getters on this function.

getGetters() - Method in class com.endeca.portal.data.functions.RangeFilter

getGetters() - Method in class com.endeca.portal.data.functions.RecordAggregator

getGetters() - Method in class com.endeca.portal.data.functions.RecordFilter

getGetters() - Method in class com.endeca.portal.data.functions.RecordSpecListFilter

getGetters() - Method in class com.endeca.portal.data.functions.RefinementFilter

getGetters() - Method in class com.endeca.portal.data.functions.RemoveNegativeRefinementFilter

getGetters() - Method in class com.endeca.portal.data.functions.ResultsConfig

getGetters() - Method in class com.endeca.portal.data.functions.ResultsSummaryConfig

getGetters() - Method in class com.endeca.portal.data.functions.SearchFilter

getGetters() - Method in class com.endeca.portal.data.functions.SearchKeysConfig

getGetters() - Method in class com.endeca.portal.data.functions.SortConfig

getGetters(Class) - Static method in class com.endeca.util.Reflection

getGetters(Class, List<String>) - Static method in class com.endeca.util.Reflection

getGlobalMetric() - Method in class com.endeca.portal.instrumentation.DataSourceTracker

Returns the metric representing all query executions, lumped together

getGlobalMetric() - Method in class com.endeca.portal.instrumentation.PortletTracker

Returns the metric representing all portlet executions, lumped together

getId() - Method in class com.endeca.portal.data.DataSource

get the DataSource's ID

getId() - Method in class com.endeca.portal.data.functions.QueryConfig

Retrieve this config function's id.

getId() - Method in class com.endeca.portal.data.MDEXState

getId() - Method in class com.endeca.portal.model.Bookmark

getIgnoreSystemRecordsFilter() - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getInitialConfiguration() - Method in class com.endeca.portal.data.MDEXState

getInitialQueryState() - Method in class com.endeca.portal.data.DataSource

Retrieve the initial QueryState on this data source, which is the QueryState defined in the data source's initial JSON configuration

getInitialQueryState() - Method in class com.endeca.portal.data.MDEXState

getInstance(Class<T>, JSONObject) - Static method in class com.endeca.portal.data.functions.QueryFunction

convenience function to instantiate a new function from a JSON configuration.

getInstance(JSONObject) - Static method in class com.endeca.portal.data.functions.QueryFunction

getInstance() - Static method in class com.endeca.portal.instrumentation.DataSourceTracker

getInstance() - Static method in class com.endeca.portal.instrumentation.MetricsLogger

getInstance() - Static method in class com.endeca.portal.instrumentation.PortletTracker

getInstance() - Static method in class com.endeca.portal.mdex.MDEXQueryCacheManager

getInstance() - Static method in class com.endeca.portal.mdex.ssl.SSLKeyStoreManager

getInstance() - Static method in class com.endeca.portal.metadata.attributes.AttributeDisplayNameManager

Gets a AttributeDisplayNameManager instance.

getInstance() - Static method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Gets a AttributeSetManager instance.

getInstance() - Static method in class com.endeca.portal.metadata.framework.FrameworkSettingManager

Gets a FrameworkSettingManager instance.

getInstance() - Static method in class com.endeca.portal.metadata.simple.SimpleMetadataManager

Method to get a FrameworkSettingManager instance.

getInstance(PortletRequest) - Static method in class com.endeca.portal.session.UserSession

TODO: This whole method just seems a little awkward...can it be cleaned up?

getKey() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Returns the key for this metric, typically the DataSource name/description

getKey() - Method in class com.endeca.portal.metadata.AbstractMetadata

get the key

getKey() - Method in interface com.endeca.portal.metadata.Metadata

get the key

getKeyStore(File) - Method in class com.endeca.portal.mdex.ssl.SSLKeyStoreManager

getLastUpdated() - Method in class com.endeca.portal.metadata.AbstractMetadata

get the last-updated date

getLastUpdated() - Method in interface com.endeca.portal.metadata.Metadata

get the last-updated date

getLocale() - Method in class com.endeca.portal.metadata.AbstractMetadata

get the locale

getLocale() - Method in interface com.endeca.portal.metadata.Metadata

get the locale

getMatchMode() - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

getMatchMode() - Method in class com.endeca.portal.data.functions.SearchFilter

getMaxCachedDataQueryTime() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Returns the maximum execution time out of all cached queries

getMaxDataQueryTime() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Returns the maximum execution time out of all uncached queries

getMaxPerDimension() - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

getMaxRefinements() - Method in class com.endeca.portal.data.functions.ExposeRefinement

Returns the maximum number of refinements to return for dimensions and navigable properties.

getMaxTime() - Method in class com.endeca.portal.instrumentation.metrics.GenericMetric

getMaxTime() - Method in interface com.endeca.portal.instrumentation.metrics.Metric

get the maximum time spent on a single query

getMDEXAttributes() - Method in class com.endeca.portal.data.DataSource

Retrieves a list of attributes available in the MDEX engine, by performing a key properties query and wrapping the results for convenience.

getMDEXSecurityManager() - Method in class com.endeca.portal.session.UserSession

getMDEXState() - Method in class com.endeca.portal.data.DataSource

getMDEXState(String) - Method in class com.endeca.portal.session.UserSession

getMDEXStateManager() - Method in class com.endeca.portal.session.UserSession

getMDEXStates() - Method in class com.endeca.portal.session.UserSession

getMessage(String) - Method in class com.endeca.portlet.util.LanguageUtils

Convenience instance-specific wrapper of LanguageUtils.getMessage(PortletRequest, String).

getMessage(String, Object[]) - Method in class com.endeca.portlet.util.LanguageUtils

Convenience instance-specific wrapper of LanguageUtils.getMessage(PortletRequest, String, Object[]).

getMessage(PortletRequest, String) - Static method in class com.endeca.portlet.util.LanguageUtils

Retrieves a message with no parameter subtitution.

getMessage(PortletRequest, String, Object[]) - Static method in class com.endeca.portlet.util.LanguageUtils

Retrieves a message from a resource bundle, substituting the specified parameters for tokens in the message string.

getMetric(String) - Method in class com.endeca.portal.instrumentation.DataSourceTracker

Returns the metric representing only the executions of a specified DataSource

getMetric(String) - Method in class com.endeca.portal.instrumentation.PortletTracker

Returns the metric representing only the executions of a specified portlet

getModel() - Method in class com.endeca.portlet.ModelAndView

getModelInternal() - Method in class com.endeca.portlet.ModelAndView

getModelMap() - Method in class com.endeca.portlet.ModelAndView

getMultiSelect() - Method in class com.endeca.portal.data.functions.RefinementFilter

getName() - Method in class com.endeca.portal.data.DataSource

get the DataSource's name

getName() - Method in class com.endeca.portal.data.functions.QueryFunction

Retrieve the name.

getName() - Method in class com.endeca.portal.data.MDEXState

getName() - Method in class com.endeca.portal.mdex.MDEXAttribute

getName() - Method in class com.endeca.portal.model.Bookmark

getNavigationMenu(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getNegativeRefinements(Results) - Static method in class com.endeca.portal.data.functions.NegativeRefinementFilter

Gets the RecordFilterInfo passthrough element, and finds the NegativeRefinementFilter elements from the V7 results object.

getNegativeRefinements(Request) - Static method in class com.endeca.portal.data.functions.NegativeRefinementFilter

Gets the RecordFilterInfo passthrough element, and finds the NegativeRefinementFilter elements from a request object

getNumArgs() - Method in enum com.endeca.portal.data.functions.RangeFilter.RangeOperator

getNumBulkRecords() - Method in class com.endeca.portal.data.functions.ResultsConfig

getNumericProperties() - Method in class com.endeca.portal.mdex.MDEXAttributeList

getNumRecords(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getObject(MetadataObjectQuery) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Retrieves a Metadata Object from a Metadata Object Query.

getObjectById(long) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Retrieves a Metadata Object by its object ID

getObjectId() - Method in class com.endeca.portal.metadata.AbstractMetadata

get the object ID

getObjectId() - Method in interface com.endeca.portal.metadata.Metadata

get the object ID of the source record.

getObjects(MetadataObjectQuery) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Retrieves a list of Metadata Objects from a Metadata Object Query

getOffset() - Method in class com.endeca.portal.data.functions.ResultsConfig

getOperator() - Method in class com.endeca.portal.data.functions.QueryFunction

Retrieve the Discovery Service API operator on this function

getOrderIndex() - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Returns the ordering index of this set within the list of all sets for this datasource.

getOrSetAttributeSetByFeature(String, String, AttributeSet) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Returns an attribute set associated with a given data source, if it exists and writes (then returns) a specified record to the db otherwise

getOrSetAttributeSetByName(String, String, AttributeSet) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Returns an attribute set associated with a given data source, if it exists and writes (then returns) a specified record to the db otherwise

getOrSetCatchallSet(String) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Returns the "catchall" set for a given datasource, and creates a default one if it does not exist

getOrSetDisplayNameByKey(String, String, AttributeDisplayName) - Method in class com.endeca.portal.metadata.attributes.AttributeDisplayNameManager

Returns an attribute display name, associated with a given data source, if it exists and writes (then returns) a specified record to the db otherwise

getOrSetFrameworkRecordByKey(String, FrameworkSetting) - Method in class com.endeca.portal.metadata.framework.FrameworkSettingManager

Returns a Discovery Framework core setting if it exists and writes (then returns) a specified record to the db otherwise

getOwnerId() - Method in class com.endeca.portal.data.functions.ExposeRefinement

Only relevant to discovery service data sources.

getOwnerId() - Method in class com.endeca.portal.data.functions.SortConfig

getParamValue(PortletRequest, String, String) - Method in class com.endeca.portlet.EndecaPortlet

Retrieves the given parameter from the request, returning the given default value if the value in the request is null or the empty string

getParentMDEXState(MDEXState, UserSession) - Static method in class com.endeca.portal.data.MDEXStateRelationshipUtil

Gets the parent MDEXState object determined by the MDEXStateRelationshipUtil.CONFIG_PROPERTY_PARENT_DATA_SOURCE property used in data source configurations.

getPassThroughElement(Request, String, boolean) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getPassThroughElement(Results, String) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getPort() - Method in class com.endeca.portal.data.MDEXState

getPortalContext() - Static method in class com.endeca.portal.liferay.LiferayUtils

getPortalContext() - Method in class com.endeca.portlet.EndecaPortlet

Retrieves the context path for the root portal web application; typically "/".

getPortletId() - Method in class com.endeca.portal.instrumentation.metrics.PortletMetric

getter for the component ID

getPortletId(PortletRequest) - Method in class com.endeca.portlet.EndecaPortlet

getPortletId() - Method in class com.endeca.portlet.EndecaPortletState

getPortletKeys() - Method in class com.endeca.portal.instrumentation.PortletTracker

Returns the set of all portlet keys being tracked

getPortletName() - Method in class com.endeca.portal.instrumentation.metrics.PortletMetric

getter for component name

getPortletName() - Method in interface com.endeca.portlet.PortletStateSerializer

getPortletTitle() - Method in class com.endeca.portal.instrumentation.metrics.PortletMetric

getter for component title

getPortletTracker() - Static method in class com.endeca.portal.instrumentation.MetricsFacade

Returns the tracker for portlet executions.

getPrecedenceParentDimid() - Method in class com.endeca.portal.mdex.MDEXAttribute

getProperties(MetadataPropertyQuery) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Retrieves a list of Metadata Properties from a Metadata Property Query

getProperties(MetadataPropertyQuery) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

getProperties() - Method in class com.endeca.portal.metadata.MetadataObject

Gets a list of Metadata Properties associated with this Metadata Object

getProperties(Class<T>) - Method in class com.endeca.portal.metadata.MetadataObject

Get a list of all Metadata Properties associated with this Metadata Object of the specified class (determined using .isInstance)

getProperty() - Method in class com.endeca.portal.data.functions.RangeFilter

getProperty() - Method in class com.endeca.portal.data.functions.SortConfig

getProperty(String) - Method in class com.endeca.portal.mdex.MDEXAttribute

getProperty(MetadataPropertyQuery) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Retrieves a Metadata Property from a Metadata Property Query.

getPropertyId() - Method in class com.endeca.portal.metadata.MetadataProperty

Gets the Metadata Property's ID

getPropertyName(String) - Static method in class com.endeca.util.Reflection

getProps() - Method in class com.endeca.portal.mdex.MDEXAttribute

getQueryState() - Method in class com.endeca.portal.data.DataSource

Retrieve the current query state on this data source.

getQueryState() - Method in class com.endeca.portal.data.MDEXState

getQueryTypeName() - Method in class com.endeca.portal.instrumentation.metrics.QueryMetric

Gets the name of the query type this object is tracking

getRangeOperator() - Method in class com.endeca.portal.data.functions.RangeFilter

getRangeType() - Method in class com.endeca.portal.data.functions.RangeFilter

getRawKeyProperties(String) - Method in class com.endeca.portal.mdex.MDEXAttributeList

getRecordCount(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getRecordFilter() - Method in class com.endeca.portal.data.functions.RecordFilter

getRecordFilters(Results) - Static method in class com.endeca.portal.data.functions.RecordFilter

getRecordFilters(Request) - Static method in class com.endeca.portal.data.functions.RecordFilter

getRecordList(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

getRecordsPerPage() - Method in class com.endeca.portal.data.functions.ResultsConfig

getRecSpecs() - Method in class com.endeca.portal.data.functions.RecordSpecListFilter

getRefineAllProperties() - Method in class com.endeca.portal.data.functions.NavConfig

getRel() - Method in class com.endeca.portal.metadata.AbstractMetadata

get the relationship

getRel() - Method in interface com.endeca.portal.metadata.Metadata

get the relationship

getRelevanceRankingStrategy() - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

getRequestId() - Method in class com.endeca.portal.instrumentation.RequestTracker

getRequestLocale(PortletRequest) - Static method in class com.endeca.portal.liferay.LiferayUtils

Returns the locale to be used for the current request.

getRequestLocale(PortletRequest, Container) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Returns the locale to be used for the current request.

getRequestState() - Method in class com.endeca.portal.data.DataSource

This method is only used when your data source and portlet support MDEX 7 and the Discovery Service API.

getRequestState() - Method in class com.endeca.portal.data.MDEXState

getRollupKey() - Method in class com.endeca.portal.data.functions.RecordAggregator

retrieves the aggregate record query rollup key

getRootMDEXState(MDEXState, UserSession) - Static method in class com.endeca.portal.data.MDEXStateRelationshipUtil

Gets the MDEXState object representing the top of the ancestor tree determined by the MDEXStateRelationshipUtil.CONFIG_PROPERTY_PARENT_DATA_SOURCE property used in data source configurations.

getSearchFilterPassThroughs(Results) - Static method in class com.endeca.portal.data.functions.SearchFilter

Gets the SearchFilterInfo passthrough element from the v7 results object, and returns the search filter metadata.

getSearchFilterPassThroughs(Request) - Static method in class com.endeca.portal.data.functions.SearchFilter

Gets the SearchFilterInfo passthrough element from the v7 request object, and returns the search filter metadata.

getSearchInterface() - Method in class com.endeca.portal.data.functions.SearchFilter

getSearchOptions() - Method in class com.endeca.portal.data.functions.SearchFilter

getSearchTerm() - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

getSerializedPortletState() - Method in class com.endeca.portlet.EndecaPortletState

getServer() - Method in class com.endeca.portal.data.MDEXState

getServicePort() - Method in class com.endeca.portal.data.MDEXState

getSessionId() - Method in class com.endeca.portal.instrumentation.RequestTracker

getSetters() - Method in class com.endeca.portal.data.functions.AnalyticsQueryConfig

getSetters() - Method in class com.endeca.portal.data.functions.BreadcrumbsConfig

getSetters() - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

getSetters() - Method in class com.endeca.portal.data.functions.EQLFilter

getSetters() - Method in class com.endeca.portal.data.functions.ExposeRefinement

getSetters() - Method in class com.endeca.portal.data.functions.NavConfig

getSetters() - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

getSetters() - Method in class com.endeca.portal.data.functions.QueryFunction

Return the list of property setters on this function.

getSetters() - Method in class com.endeca.portal.data.functions.RangeFilter

getSetters() - Method in class com.endeca.portal.data.functions.RecordAggregator

getSetters() - Method in class com.endeca.portal.data.functions.RecordFilter

getSetters() - Method in class com.endeca.portal.data.functions.RecordSpecListFilter

getSetters() - Method in class com.endeca.portal.data.functions.RefinementFilter

getSetters() - Method in class com.endeca.portal.data.functions.RemoveNegativeRefinementFilter

getSetters() - Method in class com.endeca.portal.data.functions.ResultsConfig

getSetters() - Method in class com.endeca.portal.data.functions.ResultsSummaryConfig

getSetters() - Method in class com.endeca.portal.data.functions.SearchFilter

getSetters() - Method in class com.endeca.portal.data.functions.SearchKeysConfig

getSetters() - Method in class com.endeca.portal.data.functions.SortConfig

getSetters(Class) - Static method in class com.endeca.util.Reflection

getSetters(Class, List<String>) - Static method in class com.endeca.util.Reflection

getSource() - Method in class com.endeca.portal.metadata.AbstractMetadata

get the source

getSource() - Method in interface com.endeca.portal.metadata.Metadata

get the source

getSourceRecord() - Method in class com.endeca.portal.metadata.MetadataObject

Gets the Liferay source record

getSourceRecord() - Method in class com.endeca.portal.metadata.MetadataProperty

Gets the underlying Liferay source record

getSpec() - Method in class com.endeca.portal.mdex.MDEXAttribute

getSSLConfig() - Method in class com.endeca.portal.data.MDEXState

getSubtractedFilterList(QueryState, QueryState) - Method in class com.endeca.portal.data.DefaultMDEXStateManager

getTerms() - Method in class com.endeca.portal.data.functions.SearchFilter

getTotalCount() - Method in class com.endeca.portal.instrumentation.metrics.GenericMetric

getTotalCount() - Method in interface com.endeca.portal.instrumentation.metrics.Metric

get the total number of times this type of query executed

getTotalTime() - Method in class com.endeca.portal.instrumentation.metrics.GenericMetric

getTotalTime() - Method in interface com.endeca.portal.instrumentation.metrics.Metric

get the total time spent for all queries of this type

getType() - Method in class com.endeca.portal.metadata.AbstractMetadata

Gets the implementation-specific type.

getType() - Method in class com.endeca.portal.metadata.attributes.AttributeDisplayName

Returns

getType() - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Returns "ATTR_SET"

getType() - Method in class com.endeca.portal.metadata.attributes.AttributeSetDisplayName

Returns "ATTR_SET_DISPLAY_NAME"

getType() - Method in class com.endeca.portal.metadata.attributes.AttributeSetMapping

Returns

getType() - Method in class com.endeca.portal.metadata.framework.FrameworkSetting

Returns "Discovery Framework Core"

getType() - Method in interface com.endeca.portal.metadata.Metadata

Gets the domain-specific type of object.

getType() - Method in class com.endeca.portal.metadata.MetadataObject

Gets the implementation-specific type.

getType() - Method in class com.endeca.portal.metadata.MetadataProperty

Gets the implementation-specific type.

getType() - Method in class com.endeca.portal.metadata.simple.SimpleMetadataObject

Returns "SIMPLE"

getUncached() - Method in class com.endeca.portal.instrumentation.metrics.MDEXMetric

Gets the QueryMetric for queries to this MDEX that were not cached

getUserId() - Method in class com.endeca.portal.model.Bookmark

getUserSession() - Method in class com.endeca.portal.data.DataSource

getUserSession(PortletRequest) - Method in class com.endeca.portlet.EndecaPortlet

getValidSessionAttributes() - Method in class com.endeca.portlet.EndecaPortlet

getValue() - Method in class com.endeca.portal.metadata.AbstractMetadata

get the value

getValue() - Method in interface com.endeca.portal.metadata.Metadata

get the value

getValue1() - Method in class com.endeca.portal.data.functions.RangeFilter

getValue2() - Method in class com.endeca.portal.data.functions.RangeFilter

getValue3() - Method in class com.endeca.portal.data.functions.RangeFilter

getVersion() - Method in class com.endeca.portal.data.DataSource

Get what APIVersion this data source supports.

getVersion() - Method in class com.endeca.portal.data.MDEXState

getVersion() - Method in class com.endeca.portal.data.Query

getVersion() - Method in class com.endeca.portal.data.QueryResults

Get what APIVersion this data source supports.

getViewName() - Method in class com.endeca.portlet.ModelAndView

getViewTransitionParameter(String) - Method in class com.endeca.portal.session.UserSession

getViewTransitionParameters() - Method in class com.endeca.portal.session.UserSession

getViewTransitionParameters(PortletRequest) - Method in class com.endeca.portlet.EndecaPortlet

H

handleBookmarkCreation(Bookmark, PortletRequest, StateAwareResponse) - Method in interface com.endeca.portal.persistence.bookmarks.BookmarkHandler

Handles a bookmark's creation for a given portlet request; Default implementation is to store serialized session attributes as a single JSON String

handleBookmarkCreation(Bookmark, PortletRequest, StateAwareResponse) - Method in class com.endeca.portal.persistence.bookmarks.DefaultBookmarkHandler

See BookmarkHandler.handleBookmarkCreation(com.endeca.portal.model.Bookmark, javax.portlet.PortletRequest, javax.portlet.StateAwareResponse)

handleBookmarkCreation(Bookmark, PortletRequest, StateAwareResponse) - Method in class com.endeca.portlet.EndecaPortlet

Handles a bookmark's creation for this particular portlet; Default implementation is to store serialized session attributes as a single JSON String

handleBookmarkLoad(Bookmark, PortletRequest, StateAwareResponse) - Method in interface com.endeca.portal.persistence.bookmarks.BookmarkHandler

Handles a bookmark load for a given portlet request; Default implementation is to load a JSON String representation of this portlet's state by setting session attributes

handleBookmarkLoad(Bookmark, PortletRequest, StateAwareResponse) - Method in class com.endeca.portal.persistence.bookmarks.DefaultBookmarkHandler

See BookmarkHandler.handleBookmarkLoad(com.endeca.portal.model.Bookmark, javax.portlet.PortletRequest, javax.portlet.StateAwareResponse)

handleBookmarkLoad(Bookmark, PortletRequest, StateAwareResponse) - Method in class com.endeca.portlet.EndecaPortlet

Handles a bookmark load for this particular portlet; Default implementation is to load a JSON String representation of this portlet's state by setting session attributes

handleEditRenderRequest(RenderRequest, RenderResponse) - Method in class com.endeca.portlet.EndecaPortlet

Builds a ModelAndView object.

handleHelpRenderRequest(RenderRequest, RenderResponse) - Method in class com.endeca.portlet.EndecaPortlet

Builds a ModelAndView object.

handleObjectPropertyPersistence(T, T) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Processes a Metadata Object's list of Metadata Properties during persistence.

handleObjectPropertyPersistence(AttributeSet, AttributeSet) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Handles persistence processing for all properties associated with this object.

handlePageTransitionParameters(ActionRequest, String, Map<String, String[]>) - Method in class com.endeca.portlet.EndecaPortlet

Stores parameters in user session, to make them available after a page transition.

handlePageTransitionRedirect(ActionResponse, String) - Method in class com.endeca.portlet.EndecaPortlet

Triggers a redirect on the passed in ActionResponse, to the page specified in the viewTransitionPageContext parameter.

handleQueryException(RenderRequest, RenderResponse, Exception) - Method in class com.endeca.portlet.EndecaPortlet

HANDLER_FUNCTION - Static variable in class com.endeca.portal.data.functions.AnalyticsQueryConfig

HANDLER_FUNCTION - Static variable in class com.endeca.portal.data.functions.BreadcrumbsConfig

HANDLER_FUNCTION - Static variable in class com.endeca.portal.data.functions.DimensionSearchConfig

HANDLER_FUNCTION - Static variable in class com.endeca.portal.data.functions.NavConfig

HANDLER_FUNCTION - Static variable in class com.endeca.portal.data.functions.ResultsConfig

HANDLER_FUNCTION - Static variable in class com.endeca.portal.data.functions.ResultsSummaryConfig

HANDLER_FUNCTION - Static variable in class com.endeca.portal.data.functions.SearchKeysConfig

HANDLER_NAMESPACE - Static variable in class com.endeca.portal.mdex.DiscoveryServiceUtil

handleStateMerge(PortletRequest, MDEXState) - Method in class com.endeca.portal.data.AbstractMDEXStateManager

Handle query-time determination of the query a portlet should fire before the portlet requests execution

handleStateMerge(PortletRequest, MDEXState) - Method in class com.endeca.portal.data.DefaultMDEXStateManager

handleStateReset(PortletRequest, MDEXState) - Method in class com.endeca.portal.data.AbstractMDEXStateManager

Handle resetting of the query state to its initial state

handleStateUpdate(PortletRequest, MDEXState, QueryState) - Method in class com.endeca.portal.data.AbstractMDEXStateManager

Encapsulate data source update logic.

handleStateUpdate(PortletRequest, MDEXState, QueryState) - Method in class com.endeca.portal.data.DefaultMDEXStateManager

handleViewRenderRequest(RenderRequest, RenderResponse) - Method in class com.endeca.portlet.EndecaPortlet

Builds a ModelAndView object for a given QueryState.

hashCode() - Method in class com.endeca.portal.data.functions.QueryFunction

hashCode(ENEQuery) - Static method in class com.endeca.portal.mdex.MDEXUtil

Returns a hashcode of the query, used to tersely identify the contents of the query.

hashCode(String) - Static method in class com.endeca.portal.mdex.MDEXUtil

Currently this is just a wrapper of String.hashCode() - this method exists solely so we can override the hashcode implementation if we want to, and to allow calling ENEQueryUtils.hashCode() on a pre-existing jsonString.

hasPrivilege(PortletRequest, String) - Static method in class com.endeca.portal.liferay.LiferayUtils

hasPrivilege(PortletRequest, Container, String) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

hasUpdatePrivileges(PortletRequest) - Static method in class com.endeca.portal.liferay.LiferayUtils

hasUpdatePrivileges(PortletRequest, Container) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

hasView() - Method in class com.endeca.portlet.ModelAndView

hasViewPrivileges(PortletRequest) - Static method in class com.endeca.portal.liferay.LiferayUtils

hasViewPrivileges(PortletRequest, Container) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

HELP_JSP - Static variable in class com.endeca.portlet.EndecaPortlet

helpJSP - Variable in class com.endeca.portlet.EndecaPortlet

I

id - Variable in class com.endeca.portal.data.functions.QueryConfig

The QueryConfig id is used in MDEX7 to identify the returned content element

id - Variable in class com.endeca.portal.data.MDEXState

ID_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

include(String, PortletRequest, PortletResponse) - Method in class com.endeca.portlet.EndecaPortlet

incrementDataSourceConfigVersion() - Static method in class com.endeca.portal.data.config.DataSourceConfigHelper

init(JSONObject) - Method in class com.endeca.portal.data.functions.QueryFunction

Initialize this instance from a JSON configuration.

init(PortletRequest) - Method in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

Initializes an internal map of security filters associated with the user making the request, under any of the following conditions: This is the first time a request is made for the session.

init(MetadataRecord) - Method in class com.endeca.portal.metadata.MetadataObject

Initializes this AbstractMetadataObject from a MetadataRecord

init(MetadataPropertyRecord) - Method in class com.endeca.portal.metadata.MetadataProperty

Initializes this AbstractMetadataObject from a MetadataPropertyRecord

init(PortletConfig) - Method in class com.endeca.portlet.EndecaPortlet

initDynamicQuery() - Method in class com.endeca.portal.metadata.query.MetadataObjectQuery

Initializes the DynamicQuery using the MetadataRecord class.

initDynamicQuery() - Method in class com.endeca.portal.metadata.query.MetadataPropertyQuery

Initializes the DynamicQuery using the MetadataPropertyRecord class.

initDynamicQuery() - Method in class com.endeca.portal.metadata.query.MetadataQuery

Initializes the DynamicQuery with the name of a backing Liferay record class.

initMDEXPermissions(MDEXState, UserSession) - Method in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

Initializes a set of security filters for the provided MDEXState, which is then stored in this security manager's internal map of data source-to-filter mappings for the user.

initRoleBasedSecurityFilters(MDEXState, UserSession) - Method in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

Gets a list of role-based security filters for a specified MDEXState.

isAscending() - Method in class com.endeca.portal.data.functions.SortConfig

isAsync() - Method in class com.endeca.portlet.EndecaPortlet

isAvailable() - Method in class com.endeca.portal.data.DataSource

isAvailable() - Method in class com.endeca.portal.data.MDEXState

isCatchall() - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Indicates whether or not this attribute set is the default "catchall" set.

isDateTimeProperty() - Method in class com.endeca.portal.mdex.MDEXAttribute

isDateTimeProperty(String) - Method in class com.endeca.portal.mdex.MDEXAttributeList

isDimension() - Method in class com.endeca.portal.mdex.MDEXAttribute

isDimension(String) - Method in class com.endeca.portal.mdex.MDEXAttributeList

isDimExposed() - Method in class com.endeca.portal.data.functions.ExposeRefinement

isDiscoveryService() - Method in class com.endeca.portal.data.Query

isDiscoveryService() - Method in class com.endeca.portal.data.QueryResults

isEmpty(String) - Method in class com.endeca.portlet.EndecaPortlet

isEmpty() - Method in class com.endeca.portlet.ModelAndView

isENEQuery() - Method in class com.endeca.portal.data.Query

isENEQuery() - Method in class com.endeca.portal.data.QueryResults

isLiferay(Container) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

isMultiSelectAnd() - Method in class com.endeca.portal.data.functions.RefinementFilter

isMultiSelectAnd() - Method in class com.endeca.portal.mdex.MDEXAttribute

isMultiSelectAnd(String) - Method in class com.endeca.portal.mdex.MDEXAttributeList

isMultiSelectOr() - Method in class com.endeca.portal.data.functions.RefinementFilter

isMultiSelectOr() - Method in class com.endeca.portal.mdex.MDEXAttribute

isMultiSelectOr(String) - Method in class com.endeca.portal.mdex.MDEXAttributeList

isNavigable() - Method in class com.endeca.portal.data.functions.RefinementFilter

isNavigableProp() - Method in class com.endeca.portal.data.functions.ExposeRefinement

isNumericProperty() - Method in class com.endeca.portal.mdex.MDEXAttribute

isNumericProperty(String) - Method in class com.endeca.portal.mdex.MDEXAttributeList

isQueryCached(HttpENEConnection, ENEQuery) - Method in class com.endeca.portal.mdex.MDEXQueryCacheManager

isQueryCached(ConversationPort, Request) - Method in class com.endeca.portal.mdex.MDEXQueryCacheManager

isRecordFilterable() - Method in class com.endeca.portal.mdex.MDEXAttribute

isRequestDeferrable(PortletRequest) - Method in class com.endeca.portlet.EndecaPortlet

This method denotes whether or not this portlet supports deferred rendering.

isReturnFullPath() - Method in class com.endeca.portal.data.functions.BreadcrumbsConfig

isSearchWithin() - Method in class com.endeca.portal.data.functions.SearchFilter

isSSLEnabled() - Method in class com.endeca.portal.data.MDEXState

iterator() - Method in class com.endeca.portal.mdex.MDEXAttributeList

J

JSON_CONFIG_ANCESTORS - Static variable in class com.endeca.portal.data.functions.NegativeRefinementFilter

JSON_CONFIG_DIM_VAL_ID - Static variable in class com.endeca.portal.data.functions.RefinementFilter

JSON_CONFIG_DIM_VAL_NAME - Static variable in class com.endeca.portal.data.functions.NegativeRefinementFilter

JSON_CONFIG_DIMENSION_ID - Static variable in class com.endeca.portal.data.functions.RefinementFilter

JSON_CONFIG_DIMENSION_NAME - Static variable in class com.endeca.portal.data.functions.NegativeRefinementFilter

JSON_CONFIG_MULTI_SELECT - Static variable in class com.endeca.portal.data.functions.RefinementFilter

JSON_CONFIG_NAME - Static variable in class com.endeca.portal.data.functions.NegativeRefinementFilter

JSON_CONFIG_NAVIGABLE - Static variable in class com.endeca.portal.data.functions.RefinementFilter

L

LanguageUtils - Class in com.endeca.portlet.util

This class provides portlet's access to messages stored in resource bundles.

LanguageUtils(PortletRequest) - Constructor for class com.endeca.portlet.util.LanguageUtils

Constructor for using an instance of LanguageUtils without passing the request to each static method call.

LiferayUtils - Class in com.endeca.portal.liferay

LiferayUtils() - Constructor for class com.endeca.portal.liferay.LiferayUtils

logger - Static variable in class com.endeca.portal.data.AbstractMDEXStateManager

M

main(String[]) - Static method in class com.endeca.portal.mdex.MDEXUtil

MAX_ORDER_INDEX - Static variable in class com.endeca.portal.metadata.attributes.AttributeSetManager

the order index (rel) to use if none is found or specified

MDEX_QUERY_REQUEST_TOKEN - Static variable in class com.endeca.portlet.util.Constants

MDEX_QUERY_SESSION_TOKEN - Static variable in class com.endeca.portlet.util.Constants

MDEXAttribute - Class in com.endeca.portal.mdex

Wraps a key properties object, providing easy access to common (default) key properties, including: - Endeca.Type - Endeca.DimensionId - Endeca.MultiSelect - Endeca.RecordFilterable - Endeca.PrecedenceRule

MDEXAttribute(KeyProperties) - Constructor for class com.endeca.portal.mdex.MDEXAttribute

MDEXAttribute(String, String) - Constructor for class com.endeca.portal.mdex.MDEXAttribute

Constructor for a simple attribute, that only contains a name field

MDEXAttributeList - Class in com.endeca.portal.mdex

Wraps a Map of KeyProperties, providing easy access to a list of available attributes in the MDEX, and access to a conveniently wrapped MDEXAttribute object for any attribute requested by name.

MDEXAttributeList(Map<String, KeyProperties>) - Constructor for class com.endeca.portal.mdex.MDEXAttributeList

MDEXAttributeList(List<Refinement>, List<Refinement>, List<Refinement>) - Constructor for class com.endeca.portal.mdex.MDEXAttributeList

MDEXMetric - Class in com.endeca.portal.instrumentation.metrics

Pretty simple bean to represent all queries to a specific MDEX, covering both cached and uncached queries

MDEXMetric(String) - Constructor for class com.endeca.portal.instrumentation.metrics.MDEXMetric

Creates a new instance with the given key

MDEXQueryCacheManager - Class in com.endeca.portal.mdex

MDEXSecurityException - Exception in com.endeca.portal.data.security

Exception class representing an error parsing, processing, or applying record-level security

MDEXSecurityException(String) - Constructor for exception com.endeca.portal.data.security.MDEXSecurityException

Constructor accepting a message

MDEXSecurityException(String, Throwable) - Constructor for exception com.endeca.portal.data.security.MDEXSecurityException

Constructor accepting a message and the root exception cause

mdexSecurityFilterMap - Variable in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

MDEXSecurityManager - Interface in com.endeca.portal.data.security

Interface representing a security manager for the MDEX Engine.

MDEXState - Class in com.endeca.portal.data

Portlet developers should avoid this class.

MDEXState(JSONObject) - Constructor for class com.endeca.portal.data.MDEXState

MDEXState.APIVersion - Enum in com.endeca.portal.data

MDEXStateNameComparator - Class in com.endeca.portal.data.config

Compares two MDEXStates by their human-friendly names, ignoring case

MDEXStateNameComparator() - Constructor for class com.endeca.portal.data.config.MDEXStateNameComparator

MDEXStateRelationshipUtil - Class in com.endeca.portal.data

Utility class providing convenient methods for navigating data source relationships, based on the use of the "parentDataSource" configuration property.

MDEXStateRelationshipUtil() - Constructor for class com.endeca.portal.data.MDEXStateRelationshipUtil

MDEXUtil - Class in com.endeca.portal.mdex

Helper class containing useful methods to execute on an ENEQuery

MDEXUtil() - Constructor for class com.endeca.portal.mdex.MDEXUtil

mergeAttributes(Map) - Method in class com.endeca.portlet.ModelMap

Metadata - Interface in com.endeca.portal.metadata

Interface representing a metadata record that abstracts the basic properties of a Liferay-generated record persisted to the metadata tables.

METADATA_ATTRIBUTE_DISPLAY_NAME - Static variable in class com.endeca.portlet.util.Constants

METADATA_ATTRIBUTE_SET_NAME - Static variable in class com.endeca.portlet.util.Constants

METADATA_ATTRIBUTE_SET_POSITION_SUFFIX - Static variable in class com.endeca.portlet.util.Constants

MetadataException - Exception in com.endeca.portal.metadata

Base Endeca-authored class for Metadata exceptions

MetadataException() - Constructor for exception com.endeca.portal.metadata.MetadataException

no-arg constructor

MetadataException(String, Throwable) - Constructor for exception com.endeca.portal.metadata.MetadataException

constructor accepting a message and root exception

MetadataException(String) - Constructor for exception com.endeca.portal.metadata.MetadataException

constructor accepting a message

MetadataException(Throwable) - Constructor for exception com.endeca.portal.metadata.MetadataException

constructor accepting a root exception

MetadataManager<T extends MetadataObject> - Interface in com.endeca.portal.metadata

Interface for metadata managers - managers are the classes that hold all the logic for retrieving and creating various Metadata Objects.

MetadataObject - Class in com.endeca.portal.metadata

Abstract class representing a Metadata Object.

MetadataObject() - Constructor for class com.endeca.portal.metadata.MetadataObject

Constructor that creates a new Metadata object and its underlying MetadataRecord object.

MetadataObject(MetadataRecord) - Constructor for class com.endeca.portal.metadata.MetadataObject

Constructor that creates a new Metadata object and assigns a given MetadataRecord to its underlying object.

MetadataObjectQuery - Class in com.endeca.portal.metadata.query

Implementation of a metadata query for MetadataRecord instances.

MetadataObjectQuery() - Constructor for class com.endeca.portal.metadata.query.MetadataObjectQuery

Constructs an empty metadata query

MetadataProperty - Class in com.endeca.portal.metadata

Abstract class representing a Metadata Property.

MetadataProperty() - Constructor for class com.endeca.portal.metadata.MetadataProperty

Constructor that creates a new Metadata object property and its underlying MetadataPropertyRecord object.

MetadataProperty(MetadataPropertyRecord) - Constructor for class com.endeca.portal.metadata.MetadataProperty

Constructor that creates a new Metadata object and assigns a given MetadataPropertyRecord to its underlying object.

MetadataPropertyQuery - Class in com.endeca.portal.metadata.query

Implementation of a metadata query for MetadataPropertyRecord instances.

MetadataPropertyQuery() - Constructor for class com.endeca.portal.metadata.query.MetadataPropertyQuery

Constructs an empty metadata query

MetadataQuery<T extends com.liferay.portal.model.BaseModel> - Class in com.endeca.portal.metadata.query

Base abstract class for issuing metadata queries to the portal database.

MetadataQuery() - Constructor for class com.endeca.portal.metadata.query.MetadataQuery

Constructs an empty metadata query

MetadataQueryException - Exception in com.endeca.portal.metadata.query

Thrown when attempting an action against the metadata services through the use of a MetadataQuery.

MetadataQueryException(String) - Constructor for exception com.endeca.portal.metadata.query.MetadataQueryException

one-arg constructor

MetadataQueryException(String, Throwable) - Constructor for exception com.endeca.portal.metadata.query.MetadataQueryException

two-arg constructor

Metric - Interface in com.endeca.portal.instrumentation.metrics

Interface representing a metric to be tracked for performance reasons

MetricsFacade - Class in com.endeca.portal.instrumentation

The central point for external classes to retrieve the metrics being tracked by performance instrumentation code.

MetricsFacade() - Constructor for class com.endeca.portal.instrumentation.MetricsFacade

MetricsLogger - Class in com.endeca.portal.instrumentation

Central point for logging performance-related messages

MIME_TYPE_JSON - Static variable in class com.endeca.portlet.util.Constants

ModelAndView - Class in com.endeca.portlet

ModelAndView() - Constructor for class com.endeca.portlet.ModelAndView

ModelAndView(String) - Constructor for class com.endeca.portlet.ModelAndView

ModelAndView(String, Map) - Constructor for class com.endeca.portlet.ModelAndView

ModelAndView(String, String, Object) - Constructor for class com.endeca.portlet.ModelAndView

ModelMap - Class in com.endeca.portlet

ModelMap() - Constructor for class com.endeca.portlet.ModelMap

ModelMap(String, Object) - Constructor for class com.endeca.portlet.ModelMap

MSG_DATASOURCE_BINDING_CHANGED_SUCCESSFULLY - Static variable in class com.endeca.portlet.EndecaPortlet

MSG_DATASOURCE_BINDING_ERROR - Static variable in class com.endeca.portlet.EndecaPortlet

MSG_DATASOURCE_BINDING_UNCHANGED - Static variable in class com.endeca.portlet.EndecaPortlet

MSG_DATASOURCE_BINDING_UNCHANGED_UNSUPPORTED_API - Static variable in class com.endeca.portlet.EndecaPortlet

MSG_NO_DATASOURCE_SELECTED - Static variable in class com.endeca.portlet.EndecaPortlet

MSG_NO_DATASOURCE_SELECTED_FOR_POWER_USER - Static variable in class com.endeca.portlet.EndecaPortlet

MSG_NO_DATASOURCE_SPECIFIED - Static variable in class com.endeca.portlet.EndecaPortlet

MSG_PORTLET_DOES_NOT_SUPPORT_DATASOURCE_API - Static variable in class com.endeca.portlet.EndecaPortlet

MSG_SAVE_PREFS_ERROR - Static variable in class com.endeca.portlet.EndecaPortlet

MSG_SAVE_PREFS_SUCCESS - Static variable in class com.endeca.portlet.EndecaPortlet

N

name - Variable in class com.endeca.portal.data.MDEXState

NAME_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

NAMESPACE - Static variable in class com.endeca.portal.mdex.DiscoveryServiceUtil

NavConfig - Class in com.endeca.portal.data.functions

Configure the navigation on a query state.

NavConfig() - Constructor for class com.endeca.portal.data.functions.NavConfig

NavConfig(boolean) - Constructor for class com.endeca.portal.data.functions.NavConfig

NavConfig(String) - Constructor for class com.endeca.portal.data.functions.NavConfig

NavConfig(String, boolean) - Constructor for class com.endeca.portal.data.functions.NavConfig

NegativeRefinementFilter - Class in com.endeca.portal.data.functions

NegativeRefinementFilter provides a function for filtering out all records associated with a refinement.

NegativeRefinementFilter() - Constructor for class com.endeca.portal.data.functions.NegativeRefinementFilter

Empty constructor is not public, to nudge users toward one of the more useful constructors.

NegativeRefinementFilter(String, String) - Constructor for class com.endeca.portal.data.functions.NegativeRefinementFilter

NegativeRefinementFilter(Dimension, DimVal) - Constructor for class com.endeca.portal.data.functions.NegativeRefinementFilter

Convenience constructor for creating a NegativeRefinementFilter from Dimension and DimVal objects in the presentation API.

NegativeRefinementFilter(JSONObject) - Constructor for class com.endeca.portal.data.functions.NegativeRefinementFilter

Constructs a NegativeRefinementFilter from its JSON representation.

numericAttributeIterator() - Method in class com.endeca.portal.mdex.MDEXAttributeList

O

objectFromMetadataRecord(MetadataRecord) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Given a base Liferay record, return a Metadata Object; subclasses must implement this method.

objectFromMetadataRecord(MetadataRecord) - Method in class com.endeca.portal.metadata.attributes.AttributeDisplayNameManager

objectFromMetadataRecord(MetadataRecord) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

objectFromMetadataRecord(MetadataRecord) - Method in class com.endeca.portal.metadata.framework.FrameworkSettingManager

Converts a Liferay record to a Framework Setting

objectFromMetadataRecord(MetadataRecord) - Method in interface com.endeca.portal.metadata.MetadataManager

Given a base Liferay record, return a Metadata Object

objectFromMetadataRecord(MetadataRecord) - Method in class com.endeca.portal.metadata.simple.SimpleMetadataManager

Converts a Liferay record to a Simple Metadata Object

objectsFromMetadataRecords(List<MetadataRecord>) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Given a list of base Liferay records, return a list of Metadata Objects in the same order.

operator - Variable in class com.endeca.portal.data.functions.QueryFunction

P

pageTransition(ActionRequest, ActionResponse) - Method in class com.endeca.portlet.EndecaPortlet

Invokes EndecaPortlet.pageTransition(ActionRequest, ActionResponse, String, Map) with the parameter map from the provided request object, and the target page transition context retrieved from request parameter with key Constants.REQUEST_PARAMETER_VIEW_TRANSITION_PAGE_CONTEXT.

pageTransition(ActionRequest, ActionResponse, String, Map<String, String[]>) - Method in class com.endeca.portlet.EndecaPortlet

Triggers a page transition.

parse(String) - Static method in enum com.endeca.portal.data.MDEXState.APIVersion

parseCount(String) - Static method in enum com.endeca.portal.data.functions.RecordAggregator.AggregateCount

Accepts a string and tries to turn it into an AggregateCount

parseOperator(String) - Static method in enum com.endeca.portal.data.functions.RangeFilter.RangeOperator

parseType(String) - Static method in enum com.endeca.portal.data.functions.RangeFilter.RangeType

PASSTHROUGH_NEGATIVE_REFINEMENT_FILTER - Static variable in class com.endeca.portal.data.functions.NegativeRefinementFilter

PASSTHROUGH_RECORD_FILTER_INFO - Static variable in class com.endeca.portal.data.functions.NegativeRefinementFilter

PASSTHROUGH_SEARCH_FILTER - Static variable in class com.endeca.portal.data.functions.SearchFilter

PASSTHROUGH_SEARCH_FILTER_INFO - Static variable in class com.endeca.portal.data.functions.SearchFilter

persist(T) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Persists a Metadata Object to the database

persist(List<T>) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Writes a list of Metadata Objects to the database.

persist(List<AttributeSet>) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Handles persistence processing for the list of attribute sets.

persist(AttributeSet) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Handles persistence processing for a single attribute sets.

persist(Bookmark) - Method in interface com.endeca.portal.persistence.bookmarks.BookmarkManager

persist(Bookmark) - Method in class com.endeca.portal.persistence.bookmarks.DefaultBookmarkManager

PersistenceException - Exception in com.endeca.portal.persistence

PersistenceException(String) - Constructor for exception com.endeca.portal.persistence.PersistenceException

one-arg constructor

PersistenceException(String, Throwable) - Constructor for exception com.endeca.portal.persistence.PersistenceException

two-arg constructor

persistProperties(List<S>) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Writes a list of Metadata Properties to the database.

persistProperties(List<S>) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

persistProperty(S) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Persists a Metadata Property to the database

ping(String, String, SSLConfig) - Static method in class com.endeca.portal.mdex.MDEXUtil

POP_UP - Static variable in class com.endeca.portlet.util.EndecaWindowState

POP_UP_WINDOW_STATE - Static variable in class com.endeca.portlet.util.EndecaWindowState

PORT_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

PORTLET_LIFECYCLE_PROCESS_ACTION - Static variable in class com.endeca.portlet.util.Constants

PORTLET_LIFECYCLE_RENDER - Static variable in class com.endeca.portlet.util.Constants

PortletInstrumentor - Interface in com.endeca.portal.instrumentation

Interface representing the ability to track portlet executions

PortletMetric - Class in com.endeca.portal.instrumentation.metrics

Bean representing the aggregate performance of a component, tracking the component ID and name, the total number of times the component executed, and the total time of all executions.

PortletMetric(String) - Constructor for class com.endeca.portal.instrumentation.metrics.PortletMetric

Create a new PortletMetric for this ID.

PortletStateSerializer - Interface in com.endeca.portlet

portletSupportsAsync() - Method in class com.endeca.portlet.EndecaPortlet

This method denotes whether or not this portlet supports async mode.

portletSupportsDiscoveryService() - Method in class com.endeca.portlet.EndecaPortlet

This method denotes whether or not this portlet supports connections to a MDEX 7 data source via the Endeca Conversation Service, aka the Endeca Discovery Service.

portletSupportsENEQuery() - Method in class com.endeca.portlet.EndecaPortlet

This method denotes whether or not this portlet supports connections to a MDEX 6 data source via the Endeca Presentation API.

PortletTracker - Class in com.endeca.portal.instrumentation

Concrete class to track all portlet executions, both at a global level and at a per-portlet level

postRenderJSP - Variable in class com.endeca.portlet.EndecaPortlet

preRenderJSP - Variable in class com.endeca.portlet.EndecaPortlet

processCreateEndecaBookmarkEvent(EventRequest, EventResponse) - Method in class com.endeca.portlet.EndecaPortlet

Event-processing method for bookmark creation

processEvent(EventRequest, EventResponse) - Method in class com.endeca.portlet.EndecaPortlet

processLoadEndecaBookmarkEvent(EventRequest, EventResponse) - Method in class com.endeca.portlet.EndecaPortlet

Event-processing method for bookmark loading

processRefinementsToAdd(List<QueryFunction>, QueryState) - Method in class com.endeca.portal.data.AbstractMDEXStateManager

This method handles refinement additions for V6 -- specifically, it decides a new refinement is a descendant of an existing one.

ProcessResource - Annotation Type in com.endeca.portlet

Profiler - Class in com.endeca.portal.instrumentation

The Profiler class encapsulates and provides a central point for other classes to hook into performance instrumentation for recording datapoints

ProfilerType - Enum in com.endeca.portal.instrumentation

enum holding the different types of profiling we support

propertiesFromMetadataPropertyRecords(List<MetadataPropertyRecord>) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Given a list of base Liferay records, return a list of Metadata Properties in the same order.

propertyFromMetadataPropertyRecord(MetadataPropertyRecord) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Given a base Liferay record, return a Metadata Property; subclasses must implement this method.

propertyFromMetadataPropertyRecord(MetadataPropertyRecord) - Method in class com.endeca.portal.metadata.attributes.AttributeDisplayNameManager

Returns null; Attribute display names do not have child Metadata Properties

propertyFromMetadataPropertyRecord(MetadataPropertyRecord) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Returns the appropriate type of Metadata Property for the supplied base Liferay record.

propertyFromMetadataPropertyRecord(MetadataPropertyRecord) - Method in class com.endeca.portal.metadata.framework.FrameworkSettingManager

Returns null; Framework settings do not have child Metadata Properties

propertyFromMetadataPropertyRecord(MetadataPropertyRecord) - Method in interface com.endeca.portal.metadata.MetadataManager

Given a base Liferay record, return a Metadata Property

propertyFromMetadataPropertyRecord(MetadataPropertyRecord) - Method in class com.endeca.portal.metadata.simple.SimpleMetadataManager

Returns null; Simple Metadata Objects do not have child Metadata Properties

putKeyStore(File, KeyStore) - Method in class com.endeca.portal.mdex.ssl.SSLKeyStoreManager

Q

Query - Class in com.endeca.portal.data

Query(ENEQuery) - Constructor for class com.endeca.portal.data.Query

Query(Request) - Constructor for class com.endeca.portal.data.Query

query - Variable in class com.endeca.portal.metadata.query.MetadataQuery

QueryConfig - Class in com.endeca.portal.data.functions

A subclass of QueryFunction.

QueryConfig() - Constructor for class com.endeca.portal.data.functions.QueryConfig

QueryFilter - Class in com.endeca.portal.data.functions

A subclass of QueryFunction.

QueryFilter() - Constructor for class com.endeca.portal.data.functions.QueryFilter

QueryFunction - Class in com.endeca.portal.data.functions

The base class of all QueryFunctions.

QueryFunction() - Constructor for class com.endeca.portal.data.functions.QueryFunction

QueryFunctionUnsupportedException - Exception in com.endeca.portal.data.functions

QueryFunctionUnsupportedException(String) - Constructor for exception com.endeca.portal.data.functions.QueryFunctionUnsupportedException

one-arg constructor

QueryFunctionUnsupportedException(String, Throwable) - Constructor for exception com.endeca.portal.data.functions.QueryFunctionUnsupportedException

two-arg constructor

QueryMetric - Class in com.endeca.portal.instrumentation.metrics

Bean representing the aggregate performance of datastore queries, tracking the number of queries, the total time spent querying, and the longest query

QueryMetric(String) - Constructor for class com.endeca.portal.instrumentation.metrics.QueryMetric

Create a new QueryMetric for this query type.

QueryResults - Class in com.endeca.portal.data

An API-agnostic wrapper of query results.

QueryResults(ENEQueryResults) - Constructor for class com.endeca.portal.data.QueryResults

Construct a QueryResults object with results from the ENE presentation API.

QueryResults(Results) - Constructor for class com.endeca.portal.data.QueryResults

Construct a QueryResults object with results from the Discovery Service API.

QueryState - Class in com.endeca.portal.data

QueryState is an API-agnostic representation of a query that can be executed against an MDEX engine to retrieve results.

QueryState() - Constructor for class com.endeca.portal.data.QueryState

Instantiate a QueryState with empty function list.

QueryState(JSONArray) - Constructor for class com.endeca.portal.data.QueryState

Instantiate a QueryState from a serialized representation.

QueryStateException - Exception in com.endeca.portal.data

Thrown when attempting to modify a QueryState

QueryStateException(String) - Constructor for exception com.endeca.portal.data.QueryStateException

one-arg constructor

QueryStateException(String, Throwable) - Constructor for exception com.endeca.portal.data.QueryStateException

two-arg constructor

R

RangeFilter - Class in com.endeca.portal.data.functions

This filter class allows range filters to be added to QueryState instances.

RangeFilter() - Constructor for class com.endeca.portal.data.functions.RangeFilter

RangeFilter(JSONObject) - Constructor for class com.endeca.portal.data.functions.RangeFilter

RangeFilter(String, RangeFilter.RangeType, RangeFilter.RangeOperator, String) - Constructor for class com.endeca.portal.data.functions.RangeFilter

RangeFilter(String, RangeFilter.RangeType, RangeFilter.RangeOperator, String, String) - Constructor for class com.endeca.portal.data.functions.RangeFilter

RangeFilter(String, RangeFilter.RangeType, RangeFilter.RangeOperator, String, String, String) - Constructor for class com.endeca.portal.data.functions.RangeFilter

RangeFilter.RangeFilterCreationException - Exception in com.endeca.portal.data.functions

RangeFilter.RangeFilterCreationException(String) - Constructor for exception com.endeca.portal.data.functions.RangeFilter.RangeFilterCreationException

RangeFilter.RangeOperator - Enum in com.endeca.portal.data.functions

RangeFilter.RangeOperatorNotSupportedException - Exception in com.endeca.portal.data.functions

RangeFilter.RangeOperatorNotSupportedException(String) - Constructor for exception com.endeca.portal.data.functions.RangeFilter.RangeOperatorNotSupportedException

RangeFilter.RangeType - Enum in com.endeca.portal.data.functions

RangeFilter.RangeTypeNotSupportedException - Exception in com.endeca.portal.data.functions

RangeFilter.RangeTypeNotSupportedException(String) - Constructor for exception com.endeca.portal.data.functions.RangeFilter.RangeTypeNotSupportedException

RecordAggregator - Class in com.endeca.portal.data.functions

This class makes it possible to set the rollup key for aggregate record queries on MDEX 6.

RecordAggregator() - Constructor for class com.endeca.portal.data.functions.RecordAggregator

RecordAggregator(JSONObject) - Constructor for class com.endeca.portal.data.functions.RecordAggregator

initializes this query function from JSON.

RecordAggregator(String) - Constructor for class com.endeca.portal.data.functions.RecordAggregator

Convenience constructor to create this query function given a rollup key.

RecordAggregator(String, RecordAggregator.AggregateCount) - Constructor for class com.endeca.portal.data.functions.RecordAggregator

Convenience constructor to create this query function given a rollup key and the number of base records per aggregate

RecordAggregator.AggregateCount - Enum in com.endeca.portal.data.functions

Enum that parallels and abstracts the same constants in ENEQuery.

RecordFilter - Class in com.endeca.portal.data.functions

Permits adding a record filter to a QueryState.

RecordFilter() - Constructor for class com.endeca.portal.data.functions.RecordFilter

RecordFilter(JSONObject) - Constructor for class com.endeca.portal.data.functions.RecordFilter

RecordFilter(String) - Constructor for class com.endeca.portal.data.functions.RecordFilter

RecordFilter(String, String) - Constructor for class com.endeca.portal.data.functions.RecordFilter

recordFilter - Variable in class com.endeca.portal.data.functions.RecordFilter

RecordSpecListFilter - Class in com.endeca.portal.data.functions

Filter your MDEX query by a set of record specs.

RecordSpecListFilter() - Constructor for class com.endeca.portal.data.functions.RecordSpecListFilter

RecordSpecListFilter(List<String>) - Constructor for class com.endeca.portal.data.functions.RecordSpecListFilter

RefinementFilter - Class in com.endeca.portal.data.functions

Defines a single refinement (essentially represents a DimVal and its path) to be added to a QueryState.

RefinementFilter() - Constructor for class com.endeca.portal.data.functions.RefinementFilter

Empty constructor is not public, to nudge users toward one of the more useful constructors.

RefinementFilter(String, String) - Constructor for class com.endeca.portal.data.functions.RefinementFilter

Constructs a refinement filter with the specified dimension value ID and parent dimension ID, defaulting to multiselect "none" and defaulting navigable to "true."

RefinementFilter(String, String, String) - Constructor for class com.endeca.portal.data.functions.RefinementFilter

Constructs a refinement filter with the specified dimension value ID, parent dimension ID, and multiselect value (as parsed by parseMultiSelect method) and defaulting navigable to "true."

RefinementFilter(String, String, RefinementFilter.MultiSelect) - Constructor for class com.endeca.portal.data.functions.RefinementFilter

Constructs a refinement filter with the specified dimension value ID, parent dimension ID, and multiselect value and defaulting navigable to "true."

RefinementFilter(String, String, String, boolean) - Constructor for class com.endeca.portal.data.functions.RefinementFilter

Constructs a refinement filter with the specified dimension value ID, parent dimension ID, multiselect value (as parsed by parseMultiSelect method) and navigable value.

RefinementFilter(String, String, RefinementFilter.MultiSelect, boolean) - Constructor for class com.endeca.portal.data.functions.RefinementFilter

Constructs a refinement filter with the specified dimension value ID, parent dimension ID, multiselect value and navigable value.

RefinementFilter(JSONObject) - Constructor for class com.endeca.portal.data.functions.RefinementFilter

Constructs a refinement filter with values specified in the jsonObject.

RefinementFilter(DimVal) - Constructor for class com.endeca.portal.data.functions.RefinementFilter

RefinementFilter(Operator) - Constructor for class com.endeca.portal.data.functions.RefinementFilter

RefinementFilter.MultiSelect - Enum in com.endeca.portal.data.functions

Reflection - Class in com.endeca.util

Reflection() - Constructor for class com.endeca.util.Reflection

remove(Bookmark) - Method in interface com.endeca.portal.persistence.bookmarks.BookmarkManager

remove(Bookmark) - Method in class com.endeca.portal.persistence.bookmarks.DefaultBookmarkManager

removeAllFunctions() - Method in class com.endeca.portal.data.QueryState

Clear all query functions from this query state

removeAllProperties() - Method in class com.endeca.portal.metadata.MetadataObject

Removes all Metadata Properties from this Metadata Object

removeAttributeMapping(String) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Removes an attribute mapping from this set

removeAttributeMappings(List<String>) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Removes a list of attributes from this set

removeAttributeSetById(long) - Method in class com.endeca.portal.metadata.attributes.AttributeSetManager

Removes an attribute set by its ID

removeFunction(QueryFunction) - Method in class com.endeca.portal.data.QueryState

Remove particular function based on .equals() equality

removeFunctions(List<? extends QueryFunction>) - Method in class com.endeca.portal.data.QueryState

Remove each function in the given list based on .equals() equality

removeFunctions(Class<? extends QueryFunction>) - Method in class com.endeca.portal.data.QueryState

Removes each filter in the list of a given type (determined using .isInstance).

removeInstance(String) - Static method in class com.endeca.portal.session.UserSession

removeMDEXState(String) - Method in class com.endeca.portal.session.UserSession

RemoveNegativeRefinementFilter - Class in com.endeca.portal.data.functions

RemoveNegativeRefinementFilter() - Constructor for class com.endeca.portal.data.functions.RemoveNegativeRefinementFilter

RemoveNegativeRefinementFilter(String) - Constructor for class com.endeca.portal.data.functions.RemoveNegativeRefinementFilter

removeObjectById(long) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Removes an Metadata Object by it's unique identifier, the object ID.

removeProperties(List<? extends MetadataProperty>) - Method in class com.endeca.portal.metadata.MetadataObject

Removes each Metadata Property from this Metadata Object provided in a given list based on .equals() equality

removeProperties(Class<? extends MetadataProperty>) - Method in class com.endeca.portal.metadata.MetadataObject

Removes all Metadata Properties from this Metadata Object that are of a particular class

removeProperty(MetadataProperty) - Method in class com.endeca.portal.metadata.MetadataObject

Removes a Metadata Property from this Metadata Object based on .equals() equality

removePropertyById(long) - Method in class com.endeca.portal.metadata.AbstractMetadataManager

Removes an Metadata Property by it's unique identifier, the property ID

render(RenderRequest, RenderResponse) - Method in class com.endeca.portlet.EndecaPortlet

replaceAttributeMappings(List<String>) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

replaceMessageTokens(String, Object[]) - Static method in class com.endeca.portlet.util.LanguageUtils

Substitutes parameters for tokens in the message string.

REQUEST_ATTRIBUTE_CURRENT_DATA_SOURCE - Static variable in class com.endeca.portlet.util.Constants

REQUEST_ATTRIBUTE_CURRENT_DATA_SOURCE_EVENT_NAME - Static variable in class com.endeca.portlet.util.Constants

REQUEST_ATTRIBUTE_DEFER_RENDERING - Static variable in class com.endeca.portlet.util.Constants

REQUEST_ATTRIBUTE_DEFERRED_EVENTS - Static variable in class com.endeca.portlet.util.Constants

REQUEST_ATTRIBUTE_ENDECA_QUERY - Static variable in class com.endeca.portlet.util.Constants

REQUEST_ATTRIBUTE_ENDECA_QUERY_RESULTS - Static variable in class com.endeca.portlet.util.Constants

REQUEST_ATTRIBUTE_EXISTING_DATA_SOURCE_MAP - Static variable in class com.endeca.portlet.util.Constants

REQUEST_ATTRIBUTE_PORTAL_CONTEXT - Static variable in class com.endeca.portlet.util.Constants

REQUEST_ATTRIBUTE_PORTLET_CONFIG - Static variable in class com.endeca.portlet.util.LanguageUtils

Name of request attribute that holds the PortletConfig class.

REQUEST_ATTRIBUTE_PROCESSING_EVENTS - Static variable in class com.endeca.portlet.util.Constants

REQUEST_ATTRIBUTE_PUBLISHED_EVENTS - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_ATTRIBUTE_NAME - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_ATTRIBUTE_VALUE - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_DATA_SOURCE_BINDING_STATUS - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_DATA_SOURCE_BINDING_STATUS_MSG - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_DATA_SOURCE_STATUS - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_DATA_SOURCE_STATUS_MSG - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_DEEP_LINK - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_PORTLET_RENDER_STATUS - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_PORTLET_RENDER_STATUS_MSG - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_SAVE_PREFERENCES_STATUS - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_SAVE_PREFERENCES_STATUS_MSG - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_SESSION_ATTRIBUTES - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_VIEW_TRANSITION_PAGE_CONTEXT - Static variable in class com.endeca.portlet.util.Constants

REQUEST_PARAMETER_VIEW_TRANSITION_TAB_STATE - Static variable in class com.endeca.portlet.util.Constants

RequestTracker - Class in com.endeca.portal.instrumentation

RequestTracker(String, String) - Constructor for class com.endeca.portal.instrumentation.RequestTracker

REQUIRES_DATA_SOURCE - Static variable in class com.endeca.portlet.EndecaPortlet

Represents the name of the init-param, in portlet.xml, that controls whether or not this portlet requires a binding to a MDEX data source.

requiresDataSource - Variable in class com.endeca.portlet.EndecaPortlet

reservedSessionAttributes - Static variable in class com.endeca.portlet.EndecaPortlet

resetDataSourceStatusPoller() - Static method in class com.endeca.portal.data.config.DataSourceConfigHelper

resetPortletState(PortletRequest, PortletResponse) - Method in class com.endeca.portlet.EndecaPortlet

Children can override this method to reset preferences or variables that are attached to the data source.

resetQueryState() - Method in class com.endeca.portal.data.DataSource

Reset the data source's query state to what it's initial state was.

RESOURCE_BUNDLE_ENDECA_PORTAL_CONFIG - Static variable in class com.endeca.portlet.util.Constants

RESOURCE_SET_SESSION_STATE - Static variable in class com.endeca.portlet.util.Constants

ResultsConfig - Class in com.endeca.portal.data.functions

Configure how results will be returned from the results of an executed QueryState.

ResultsConfig() - Constructor for class com.endeca.portal.data.functions.ResultsConfig

ResultsConfig(int) - Constructor for class com.endeca.portal.data.functions.ResultsConfig

ResultsConfig(String) - Constructor for class com.endeca.portal.data.functions.ResultsConfig

ResultsConfig(String, int) - Constructor for class com.endeca.portal.data.functions.ResultsConfig

ResultsSummaryConfig - Class in com.endeca.portal.data.functions

Configure the summarization of results returned from an executed QueryState.

ResultsSummaryConfig() - Constructor for class com.endeca.portal.data.functions.ResultsSummaryConfig

ResultsSummaryConfig(String) - Constructor for class com.endeca.portal.data.functions.ResultsSummaryConfig

run(HttpSession) - Method in class com.endeca.portal.session.SessionCreateAction

run(HttpSession) - Method in class com.endeca.portal.session.SessionDestroyAction

S

SAVE_PREFERENCES_STATUS_ERROR - Static variable in class com.endeca.portlet.util.Constants

SAVE_PREFERENCES_STATUS_SUCCESS - Static variable in class com.endeca.portlet.util.Constants

SearchFilter - Class in com.endeca.portal.data.functions

Permits adding a keyword search to a QueryState.

SearchFilter() - Constructor for class com.endeca.portal.data.functions.SearchFilter

Empty constructor is not public, to nudge users toward one of the more useful constructors.

SearchFilter(JSONObject) - Constructor for class com.endeca.portal.data.functions.SearchFilter

Constructs a search filter from a JSON object

SearchFilter(String, String) - Constructor for class com.endeca.portal.data.functions.SearchFilter

Constructs a search filter with the specified interface and terms, defaulting to match mode "all" and no additional search options.

SearchFilter(String, String, String) - Constructor for class com.endeca.portal.data.functions.SearchFilter

Constructs a search filter with the specified interface, terms, and match mode (as parsed by parseMatchMode method) and no additional search options.

SearchFilter(String, String, SearchFilter.MatchMode) - Constructor for class com.endeca.portal.data.functions.SearchFilter

Constructs a search filter with the specified interface, terms, and match mode and no additional search options.

SearchFilter(String, String, String, String) - Constructor for class com.endeca.portal.data.functions.SearchFilter

Constructs a search filter with the specified interface, terms, match mode (as parsed by parseMatchMode method) and search options.

SearchFilter(String, String, SearchFilter.MatchMode, String) - Constructor for class com.endeca.portal.data.functions.SearchFilter

Constructs a search filter with the specified interface, terms, match mode and search options.

SearchFilter.MatchMode - Enum in com.endeca.portal.data.functions

SearchKeysConfig - Class in com.endeca.portal.data.functions

SearchKeysConfig() - Constructor for class com.endeca.portal.data.functions.SearchKeysConfig

serializePortletState(PortletRequest, StateAwareResponse) - Method in class com.endeca.portlet.EndecaPortlet

Default implementation of portlet state serialization TODO: Is PortletRequest sufficient here?

serializePortletState(PortletRequest, StateAwareResponse) - Method in interface com.endeca.portlet.PortletStateSerializer

SERVER_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

serveResource(ResourceRequest, ResourceResponse) - Method in class com.endeca.portlet.EndecaPortlet

Called by the portlet container to allow the portlet to serve a resource request.

serveResourceSetSessionState(ResourceRequest, ResourceResponse) - Method in class com.endeca.portlet.EndecaPortlet

Updates arbitrary session attributes in this portlet's session state Request parameters: df.sessionAttributeName: a String that represents the name of the session attribute df.sessionAttributeValue: a String that represents the value of the session attribute df.sessionAttributes: a JSON array of name, value pairs [{"attrName":"attrValue"},...]

SESSION_ATTRIBUTE_DF_DEFERRED_LOGIN - Static variable in class com.endeca.portlet.util.Constants

SESSION_ATTRIBUTE_DF_LOGIN - Static variable in class com.endeca.portlet.util.Constants

SESSION_ATTRIBUTE_LIFERAY_SESSION_ERRORS - Static variable in class com.endeca.portlet.util.Constants

SESSION_ATTRIBUTE_LIFERAY_SESSION_MESSAGES - Static variable in class com.endeca.portlet.util.Constants

SESSION_ATTRIBUTE_PUBLISHED_EVENTS - Static variable in class com.endeca.portlet.util.Constants

SESSION_ATTRIBUTE_QUERY_OPERATORS - Static variable in class com.endeca.portlet.util.Constants

SESSION_ATTRIBUTE_RENDER_PARAMETERS - Static variable in class com.endeca.portlet.util.Constants

SESSION_ATTRIBUTE_USER_SESSION_OBJ - Static variable in class com.endeca.portlet.util.Constants

SessionCreateAction - Class in com.endeca.portal.session

Invoked when a 'session create' event (servlet.session.create.events) is fired by Liferay.

SessionCreateAction() - Constructor for class com.endeca.portal.session.SessionCreateAction

SessionDestroyAction - Class in com.endeca.portal.session

Invoked when a 'session destroy' event (servlet.session.destroy.events) is fired by Liferay.

SessionDestroyAction() - Constructor for class com.endeca.portal.session.SessionDestroyAction

setAggCount(RecordAggregator.AggregateCount) - Method in class com.endeca.portal.data.functions.RecordAggregator

Sets the number of base records per aggregate.

setAggCount(String) - Method in class com.endeca.portal.data.functions.RecordAggregator

Sets the number of base records per aggregate.

setAnalyticsQuery(String) - Method in class com.endeca.portal.data.functions.AnalyticsQueryConfig

setAncestors(List<String>) - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

setAncestors(String) - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

setAscending(boolean) - Method in class com.endeca.portal.data.functions.SortConfig

setAscending(String) - Method in class com.endeca.portal.data.functions.SortConfig

setAttributeMappings(List<AttributeSetMapping>) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

setBaseUrl(String) - Method in class com.endeca.portal.model.Bookmark

setCAFile(File) - Method in class com.endeca.portal.data.SSLConfig

setCAPassword(String) - Method in class com.endeca.portal.data.SSLConfig

setCatchall(boolean) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Sets whether or not this attribute set is the default "catchall" set.

setCertFile(File) - Method in class com.endeca.portal.data.SSLConfig

setCertPassword(String) - Method in class com.endeca.portal.data.SSLConfig

setColumns(String[]) - Method in class com.endeca.portal.data.functions.ResultsConfig

setColumns(String) - Method in class com.endeca.portal.data.functions.ResultsConfig

setCreatedDate(Date) - Method in class com.endeca.portal.model.Bookmark

setDataSourceQueryStates(Map<String, QueryState>) - Method in class com.endeca.portal.model.Bookmark

setDataSourceRequestStates(Map<String, Request>) - Method in class com.endeca.portal.model.Bookmark

setDescription(String) - Method in class com.endeca.portal.metadata.AbstractMetadata

set the description

setDescription(String) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Adds criteria to the query: the value of the "description" field TODO: wildcard/text search possible and useful?

setDescription(String) - Method in class com.endeca.portal.model.Bookmark

setDimensionId(String) - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

setDimensionId(String) - Method in class com.endeca.portal.data.functions.ExposeRefinement

setDimensionId(String) - Method in class com.endeca.portal.data.functions.RefinementFilter

setDimensionName(String) - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

setDimExposed(boolean) - Method in class com.endeca.portal.data.functions.ExposeRefinement

setDimExposed(String) - Method in class com.endeca.portal.data.functions.ExposeRefinement

setDimValId(String) - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

setDimValId(String) - Method in class com.endeca.portal.data.functions.ExposeRefinement

setDimValId(String) - Method in class com.endeca.portal.data.functions.RefinementFilter

setDimValName(String) - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

setDisplayName(String, String) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Sets the display name Metadata Property associated with this attribute set object for a specified locale.

setEndecaPortletStates(Map<String, EndecaPortletState>) - Method in class com.endeca.portal.model.Bookmark

setEqlFilter(String) - Method in class com.endeca.portal.data.functions.EQLFilter

setExposeAll(boolean) - Method in class com.endeca.portal.data.functions.ExposeRefinement

setExposeAll(String) - Method in class com.endeca.portal.data.functions.ExposeRefinement

setExposeAllRefinements(boolean) - Method in class com.endeca.portal.data.functions.NavConfig

setExposeAllRefinements(String) - Method in class com.endeca.portal.data.functions.NavConfig

setFeature(String) - Method in class com.endeca.portal.metadata.AbstractMetadata

set the feature

setFeature(String) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Adds criteria to the query: the value of the "feature" field

setId(String) - Method in class com.endeca.portal.data.functions.QueryConfig

Set this config function's id.

setId(long) - Method in class com.endeca.portal.model.Bookmark

setKey(String) - Method in class com.endeca.portal.metadata.AbstractMetadata

set the key

setKey(String) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Adds criteria to the query: the value of the "key" field

setLastUpdated(Date) - Method in class com.endeca.portal.metadata.AbstractMetadata

set the last-updated date

setLocale(String) - Method in class com.endeca.portal.metadata.AbstractMetadata

set the locale

setLocale(String) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Adds criteria to the query: the value of the "locale" field

setMatchMode(SearchFilter.MatchMode) - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

setMatchMode(String) - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

setMatchMode(SearchFilter.MatchMode) - Method in class com.endeca.portal.data.functions.SearchFilter

setMatchMode(String) - Method in class com.endeca.portal.data.functions.SearchFilter

setMaxPerDimension(int) - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

setMaxPerDimension(String) - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

setMaxRefinements(BigInteger) - Method in class com.endeca.portal.data.functions.ExposeRefinement

Sets the maximum number of refinements to return for dimensions and navigable properties.

setMaxRefinements(int) - Method in class com.endeca.portal.data.functions.ExposeRefinement

Convenience method to set the maximum number of refinements to return for dimensions and navigable properties using an int.

setMaxRefinements(String) - Method in class com.endeca.portal.data.functions.ExposeRefinement

String setter for the maximum number of refinements to return for dimensions and navigable properties for JSON init.

setMultiSelect(RefinementFilter.MultiSelect) - Method in class com.endeca.portal.data.functions.RefinementFilter

setMultiSelect(String) - Method in class com.endeca.portal.data.functions.RefinementFilter

setName(String) - Method in class com.endeca.portal.data.functions.QueryFunction

Set the name.

setName(String) - Method in class com.endeca.portal.data.functions.RecordFilter

setName(String) - Method in class com.endeca.portal.model.Bookmark

setNavigable(boolean) - Method in class com.endeca.portal.data.functions.RefinementFilter

setNavigable(String) - Method in class com.endeca.portal.data.functions.RefinementFilter

setNumBulkRecords(int) - Method in class com.endeca.portal.data.functions.ResultsConfig

Defaults to 0.

setNumBulkRecords(String) - Method in class com.endeca.portal.data.functions.ResultsConfig

setObjectId(long) - Method in class com.endeca.portal.metadata.AbstractMetadata

set the object ID

setObjectId(long) - Method in interface com.endeca.portal.metadata.Metadata

set the object ID of the source record

setObjectId(long) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Adds criteria to the query: the value of the "metadataObjectID" field

setOffset(int) - Method in class com.endeca.portal.data.functions.ResultsConfig

setOffset(String) - Method in class com.endeca.portal.data.functions.ResultsConfig

setOperator(String) - Method in class com.endeca.portal.data.functions.QueryFunction

Required String setter for the Discovery Service API operator on this function.

setOperator(Operator) - Method in class com.endeca.portal.data.functions.QueryFunction

Set the Discovery Service API operator on this function.

setOrderAsc(String) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Orders this query ascending by the specified field; use one of the field constants on this class as the orderField

setOrderDesc(String) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Orders this query descending by the specified field; use one of the field constants on this class as the orderField

setOrderIndex(int) - Method in class com.endeca.portal.metadata.attributes.AttributeSet

Sets the ordering index of this set within the list of all sets for this datasource.

setOwnerId(String) - Method in class com.endeca.portal.data.functions.ExposeRefinement

Set the ownerID of this function.

setOwnerId(String) - Method in class com.endeca.portal.data.functions.SortConfig

setPortletId(String) - Method in class com.endeca.portlet.EndecaPortletState

setPortletName(String) - Method in class com.endeca.portal.instrumentation.metrics.PortletMetric

setter for portlet name

setPortletTitle(String) - Method in class com.endeca.portal.instrumentation.metrics.PortletMetric

setter for component title

setProperty(String) - Method in class com.endeca.portal.data.functions.RangeFilter

setProperty(String) - Method in class com.endeca.portal.data.functions.SortConfig

setPropertyId(long) - Method in class com.endeca.portal.metadata.MetadataProperty

Sets the Metadata Property's ID

setPropertyId(long) - Method in class com.endeca.portal.metadata.query.MetadataPropertyQuery

Adds criteria to the query: the value of the "metadataPropertyId" field

setQueryState(QueryState) - Method in class com.endeca.portal.data.DataSource

Set the state of this data source.

setQueryState(QueryState) - Method in class com.endeca.portal.data.MDEXState

Deprecated.

setRangeOperator(RangeFilter.RangeOperator) - Method in class com.endeca.portal.data.functions.RangeFilter

setRangeOperator(String) - Method in class com.endeca.portal.data.functions.RangeFilter

setRangeType(RangeFilter.RangeType) - Method in class com.endeca.portal.data.functions.RangeFilter

setRangeType(String) - Method in class com.endeca.portal.data.functions.RangeFilter

setRecordFilter(String) - Method in class com.endeca.portal.data.functions.RecordFilter

setRecordsPerPage(int) - Method in class com.endeca.portal.data.functions.ResultsConfig

setRecordsPerPage(String) - Method in class com.endeca.portal.data.functions.ResultsConfig

setRecSpecs(List<String>) - Method in class com.endeca.portal.data.functions.RecordSpecListFilter

setRecSpecs(String) - Method in class com.endeca.portal.data.functions.RecordSpecListFilter

setRefineAllProperties(boolean) - Method in class com.endeca.portal.data.functions.NavConfig

setRefineAllProperties(String) - Method in class com.endeca.portal.data.functions.NavConfig

setRel(String) - Method in class com.endeca.portal.metadata.AbstractMetadata

set the relationship

setRel(String) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Adds criteria to the query: the value of the "rel" field

setRelevanceRankingStrategy(String) - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

setRequestState(Request) - Method in class com.endeca.portal.data.MDEXState

Deprecated.

setReturnFullPath(boolean) - Method in class com.endeca.portal.data.functions.BreadcrumbsConfig

setReturnFullPath(String) - Method in class com.endeca.portal.data.functions.BreadcrumbsConfig

setRollupKey(String) - Method in class com.endeca.portal.data.functions.RecordAggregator

sets the aggregate record query rollup key

setSavePrefsFailureMessage(PortletRequest, String) - Method in class com.endeca.portlet.EndecaPortlet

Sets request attributes indicating that the status of saving preferences was an error/failure, and sets a failure message for display.

setSavePrefsFailureMessage(PortletRequest) - Method in class com.endeca.portlet.EndecaPortlet

Convenience wrapper for EndecaPortlet.setSavePrefsFailureMessage(PortletRequest, String).

setSavePrefsStatusMessage(PortletRequest, String, String) - Method in class com.endeca.portlet.EndecaPortlet

Sets the save preferences status and message as request attributes based on the passed in parameters.

setSavePrefsSuccessMessage(PortletRequest, String) - Method in class com.endeca.portlet.EndecaPortlet

Sets request attributes indicating that the status of saving preferences was successful, and sets a success message for display.

setSavePrefsSuccessMessage(PortletRequest) - Method in class com.endeca.portlet.EndecaPortlet

Convenience wrapper for EndecaPortlet.setSavePrefsSuccessMessage(PortletRequest, String).

setSearchInterface(String) - Method in class com.endeca.portal.data.functions.SearchFilter

setSearchOptions(String) - Method in class com.endeca.portal.data.functions.SearchFilter

setSearchTerm(String) - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

setSearchWithin(boolean) - Method in class com.endeca.portal.data.functions.SearchFilter

setSearchWithin(String) - Method in class com.endeca.portal.data.functions.SearchFilter

setSerializedPortletState(String) - Method in class com.endeca.portlet.EndecaPortletState

setSource(String) - Method in class com.endeca.portal.metadata.AbstractMetadata

set the source

setSource(String) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Adds criteria to the query: the value of the "source" field

setSourceRecord(MetadataRecord) - Method in class com.endeca.portal.metadata.MetadataObject

Sets the Liferay source record

setSourceRecord(MetadataPropertyRecord) - Method in class com.endeca.portal.metadata.MetadataProperty

Sets the underlying Liferay source record

setTerms(String) - Method in class com.endeca.portal.data.functions.SearchFilter

SettingDefaults - Class in com.endeca.util

Utility class that centralizes the default FrameworkSettings within the DF framework.

SettingDefaults() - Constructor for class com.endeca.util.SettingDefaults

setType(String) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Adds criteria to the query: the value of the "type" field

setUserId(long) - Method in class com.endeca.portal.model.Bookmark

setValue(String) - Method in class com.endeca.portal.metadata.AbstractMetadata

set the value

setValue(String) - Method in class com.endeca.portal.metadata.query.MetadataQuery

Adds criteria to the query: the value of the "value" field

setValue1(String) - Method in class com.endeca.portal.data.functions.RangeFilter

setValue2(String) - Method in class com.endeca.portal.data.functions.RangeFilter

setValue3(String) - Method in class com.endeca.portal.data.functions.RangeFilter

setViewName(String) - Method in class com.endeca.portlet.ModelAndView

setViewTransitionDeferred() - Method in class com.endeca.portal.session.UserSession

setViewTransitionParameter(String, String) - Method in class com.endeca.portal.session.UserSession

SimpleMetadataManager - Class in com.endeca.portal.metadata.simple

Central facade for managing simple key-value pair metadata records

SimpleMetadataManager() - Constructor for class com.endeca.portal.metadata.simple.SimpleMetadataManager

SimpleMetadataObject - Class in com.endeca.portal.metadata.simple

Class that represents a simple key-value pair metadata record

SimpleMetadataObject() - Constructor for class com.endeca.portal.metadata.simple.SimpleMetadataObject

Constructor: initializes the object with an ID of -1

SimpleMetadataObject(MetadataRecord) - Constructor for class com.endeca.portal.metadata.simple.SimpleMetadataObject

Constructor that initializes the object from a MetadataRecord.

SortConfig - Class in com.endeca.portal.data.functions

Allow a sort to be applied to records returned from an executed QueryState.

SortConfig() - Constructor for class com.endeca.portal.data.functions.SortConfig

SortConfig(String) - Constructor for class com.endeca.portal.data.functions.SortConfig

SortConfig(String, String) - Constructor for class com.endeca.portal.data.functions.SortConfig

SortConfig(String, boolean) - Constructor for class com.endeca.portal.data.functions.SortConfig

SortConfig(String, String, boolean) - Constructor for class com.endeca.portal.data.functions.SortConfig

SSL_CONFIG_PROPERTY - Static variable in class com.endeca.portal.data.MDEXState

SSLConfig - Class in com.endeca.portal.data

SSLConfig(JSONObject) - Constructor for class com.endeca.portal.data.SSLConfig

SSLHostnameVerifier - Class in com.endeca.portal.mdex.ssl

SSLHostnameVerifier() - Constructor for class com.endeca.portal.mdex.ssl.SSLHostnameVerifier

SSLKeyStoreManager - Class in com.endeca.portal.mdex.ssl

Singleton object that caches CA and client certificates in a map, so they do not need to be read from disk every time

start() - Static method in class com.endeca.portal.instrumentation.Profiler

Call this method just before the code you want to profile.

state - Variable in class com.endeca.portal.data.MDEXState

stats(String, String, SSLConfig) - Static method in class com.endeca.portal.mdex.MDEXUtil

STATUS_ERROR - Static variable in class com.endeca.portlet.util.Constants

STATUS_INFO - Static variable in class com.endeca.portlet.util.Constants

STATUS_SUCCESS - Static variable in class com.endeca.portlet.util.Constants

SUPPORTED_FEATURES_614_MDEX - Static variable in enum com.endeca.portal.data.Feature

SUPPORTED_FEATURES_6_API - Static variable in enum com.endeca.portal.data.Feature

SUPPORTED_FEATURES_701_MDEX - Static variable in enum com.endeca.portal.data.Feature

SUPPORTED_FEATURES_7_API - Static variable in enum com.endeca.portal.data.Feature

SUPPORTED_FEATURES_DEFAULT - Static variable in enum com.endeca.portal.data.Feature

SUPPORTS_DISCOVERY_SERVICE - Static variable in class com.endeca.portlet.EndecaPortlet

Represents the name of the init-param, in portlet.xml, that controls whether or not this portlet supports connections to a MDEX 7 data source via the Endeca Conversation Service, aka the Endeca Discovery Service.

SUPPORTS_ENE_QUERY - Static variable in class com.endeca.portlet.EndecaPortlet

Represents the name of the init-param, in portlet.xml, that controls whether or not this portlet supports connections to a MDEX 6 data source via the Endeca Presentation API.

supportsDiscoveryService() - Method in class com.endeca.portal.data.DataSource

supportsDiscoveryService() - Method in class com.endeca.portal.data.MDEXState

supportsDiscoveryService - Variable in class com.endeca.portlet.EndecaPortlet

supportsENEQuery() - Method in class com.endeca.portal.data.DataSource

supportsENEQuery() - Method in class com.endeca.portal.data.MDEXState

supportsENEQuery - Variable in class com.endeca.portlet.EndecaPortlet

supportsFeature(Feature) - Method in class com.endeca.portal.data.DataSource

supportsFeature(Feature) - Method in class com.endeca.portal.data.MDEXState

SYSTEM_RECORD_FILTER - Static variable in class com.endeca.portal.mdex.DiscoveryServiceUtil

SYSTEM_RECORD_FILTER_NAME - Static variable in class com.endeca.portal.mdex.DiscoveryServiceUtil

T

throwingParameters(String) - Static method in class com.endeca.portal.session.UserSession

tidyNavQuery(ENEQuery) - Static method in class com.endeca.portal.mdex.MDEXUtil

Cleans up and sanitizes a nav query; right now all it does is rewrite the query to include the root if there are otherwise no nav descriptors

toDiscoveryServiceSearchMode() - Method in enum com.endeca.portal.data.functions.SearchFilter.MatchMode

toJSON() - Method in class com.endeca.portal.data.functions.QueryFunction

Construct a JSON representation of this function.

toJSON() - Method in class com.endeca.portal.data.MDEXState

toJSON() - Method in class com.endeca.portal.data.QueryState

Create a JSON representation of this query state and its query functions.

toJSONObject() - Method in interface com.endeca.portal.instrumentation.metrics.Metric

turns the metric information into a JSON object; useful for serialization

toJSONObject() - Method in class com.endeca.portal.instrumentation.metrics.PortletMetric

Serializes this object into a JSON string

toJSONObject() - Method in class com.endeca.portal.instrumentation.metrics.QueryMetric

Serializes this object into a JSON string

toJSONObject(ENEQuery) - Static method in class com.endeca.portal.mdex.MDEXUtil

Returns a JSONObject containing all pertinent query info

toJSONString(ENEQuery) - Static method in class com.endeca.portal.mdex.MDEXUtil

Returns a JSON string containing all pertinent query info

toString() - Method in class com.endeca.portal.data.DataSource

toString() - Method in class com.endeca.portal.data.functions.AnalyticsQueryConfig

toString() - Method in class com.endeca.portal.data.functions.BreadcrumbsConfig

toString() - Method in class com.endeca.portal.data.functions.DimensionSearchConfig

toString() - Method in class com.endeca.portal.data.functions.EQLFilter

toString() - Method in class com.endeca.portal.data.functions.ExposeRefinement

toString() - Method in class com.endeca.portal.data.functions.NavConfig

toString() - Method in class com.endeca.portal.data.functions.NegativeRefinementFilter

toString() - Method in class com.endeca.portal.data.functions.QueryFunction

This class' toString is abstract: all concrete subclasses are expected to provide an implementation. toString is used in comparing QueryFunction instances for equality, so if you implement a QueryFunction subclass it is important that your toString implementation be consistent and deterministic.

toString() - Method in class com.endeca.portal.data.functions.RangeFilter

toString() - Method in class com.endeca.portal.data.functions.RecordAggregator

toString() - Method in class com.endeca.portal.data.functions.RecordFilter

toString() - Method in class com.endeca.portal.data.functions.RecordSpecListFilter

toString() - Method in class com.endeca.portal.data.functions.RefinementFilter

toString() - Method in class com.endeca.portal.data.functions.RemoveNegativeRefinementFilter

toString() - Method in class com.endeca.portal.data.functions.ResultsConfig

toString() - Method in class com.endeca.portal.data.functions.ResultsSummaryConfig

toString() - Method in enum com.endeca.portal.data.functions.SearchFilter.MatchMode

toString() - Method in class com.endeca.portal.data.functions.SearchFilter

toString() - Method in class com.endeca.portal.data.functions.SearchKeysConfig

toString() - Method in class com.endeca.portal.data.functions.SortConfig

toString() - Method in class com.endeca.portal.data.MDEXState

toString() - Method in class com.endeca.portal.data.QueryState

toString(Operator) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

toString() - Method in class com.endeca.portal.metadata.AbstractMetadata

toString() - Method in class com.endeca.portlet.ModelAndView

toString() - Method in enum com.endeca.portlet.util.Container

toXML() - Method in class com.endeca.portal.data.functions.QueryFunction

Convenience method to serialize the Discovery Service API (MDEX7) operator associated with this QueryFunction to XML.

toXML(Request) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

toXML(Results) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

toXML(Operator) - Static method in class com.endeca.portal.mdex.DiscoveryServiceUtil

triggerEvent(PortletRequest, StateAwareResponse, QName, Serializable) - Method in class com.endeca.portlet.EndecaPortlet

This method should be used instead of response.setEvent(QName, Serializable), and provides functionality to store event state in the session if required

triggerEvent(PortletRequest, StateAwareResponse, String, Serializable) - Method in class com.endeca.portlet.EndecaPortlet

This method should be used instead of response.setEvent(String, Serializable), and provides functionality to store event state in the session if required

TRUE_STRING - Static variable in class com.endeca.portlet.util.Constants

TYPE_ATTR_DISPLAY_NAME - Static variable in class com.endeca.portal.metadata.attributes.AttributeDisplayNameManager

Represents the "type" value for an attribute's display name

TYPE_ATTR_SET - Static variable in class com.endeca.portal.metadata.attributes.AttributeSetManager

Represents the "type" value for an attribute set

TYPE_ATTRIBUTE_MAPPING_PROPERTY - Static variable in class com.endeca.portal.metadata.attributes.AttributeSetManager

Represents the "type" value for the attribute mapping property of an attribute set

TYPE_DISPLAY_NAME_PROPERTY - Static variable in class com.endeca.portal.metadata.attributes.AttributeSetManager

Represents the "type" value for the display name property of an attribute set

TYPE_FRAMEWORK - Static variable in class com.endeca.portal.metadata.framework.FrameworkSettingManager

Represents the "type" value for DF-core settings

TYPE_FRAMEWORK_KEYPREFIX - Static variable in class com.endeca.portal.metadata.framework.FrameworkSettingManager

Represents the key prefix for all framework settings

TYPE_SIMPLE_METADATA - Static variable in class com.endeca.portal.metadata.simple.SimpleMetadataManager

Represents the "type" value

U

unsetViewTransitionDeferred(String) - Static method in class com.endeca.portal.session.UserSession

updateDataSourceBinding(ActionRequest, ActionResponse) - Method in class com.endeca.portlet.EndecaPortlet

updateDataSourceConfiguration(MDEXState, boolean, boolean) - Static method in class com.endeca.portal.data.config.DataSourceConfigHelper

updateStatus() - Method in class com.endeca.portal.data.MDEXState

Updates the status of this MDEXState.

userRoles - Variable in class com.endeca.portal.data.security.DefaultMDEXSecurityManager

UserSession - Class in com.endeca.portal.session

UserSessionException - Exception in com.endeca.portal.session

Thrown when attempting to delete a DataSource if that DataSource contains children.

UserSessionException(String) - Constructor for exception com.endeca.portal.session.UserSessionException

one-arg constructor

UserSessionException(String, Throwable) - Constructor for exception com.endeca.portal.session.UserSessionException

two-arg constructor

V

valueOf(String) - Static method in enum com.endeca.portal.data.Feature

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.endeca.portal.data.functions.RangeFilter.RangeOperator

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.endeca.portal.data.functions.RangeFilter.RangeType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.endeca.portal.data.functions.RecordAggregator.AggregateCount

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.endeca.portal.data.functions.RefinementFilter.MultiSelect

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.endeca.portal.data.functions.SearchFilter.MatchMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.endeca.portal.data.MDEXState.APIVersion

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.endeca.portal.instrumentation.ProfilerType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.endeca.portlet.util.Container

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.endeca.portal.data.Feature

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.endeca.portal.data.functions.RangeFilter.RangeOperator

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.endeca.portal.data.functions.RangeFilter.RangeType

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.endeca.portal.data.functions.RecordAggregator.AggregateCount

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.endeca.portal.data.functions.RefinementFilter.MultiSelect

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.endeca.portal.data.functions.SearchFilter.MatchMode

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.endeca.portal.data.MDEXState.APIVersion

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.endeca.portal.instrumentation.ProfilerType

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.endeca.portlet.util.Container

Returns an array containing the constants of this enum type, in the order they're declared.

verify(String, SSLSession) - Method in class com.endeca.portal.mdex.ssl.SSLHostnameVerifier

verifySSLHostname(String, SSLSession) - Static method in class com.endeca.portal.data.SSLConfig

VIEW_JSP - Static variable in class com.endeca.portlet.EndecaPortlet

VIEW_TRANSITION_DEFAULT_CONTEXT - Static variable in class com.endeca.portlet.util.Constants

viewJSP - Variable in class com.endeca.portlet.EndecaPortlet

W

wasCleared() - Method in class com.endeca.portlet.ModelAndView

writeJSONArrayResponse(JSONArray, ResourceResponse) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Convenience method for outputting a JSONArray to a resource response.

writeJSONResponse(JSONObject, RenderResponse) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

writeJSONResponse(JSONObject, RenderResponse, String) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Convenience method for outputting a JSONObject to a render response, with the name of a JavaScript callback function to be appended to the JSON response.

writeJSONResponse(JSONObject, ResourceResponse) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Convenience method for outputting a JSONObject to a resource response.

writeJSONResponse(JSONObject, ResourceResponse, String) - Static method in class com.endeca.portlet.util.EndecaPortletUtil

Convenience method for outputting a JSONObject to a resource response, with the name of a JavaScript callback function to be appended to the JSON response.

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