A B C D E F G H I J K L M N O P Q R S T U V W X _
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ACCESSIBILITY_AUDITOR - com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
- ACCESSIBILITY_AUDITOR_ACKNOWLEDGEMENT_COUNTS - com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
- ACCESSIBILITY_AUDITOR_GET_ALL_RESULTS - com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
- ACCESSIBILITY_REPORTING - com.funnelback.plugin.docs.model.ProductSubtopic.AnalyticsReporting
- action - Variable in class com.funnelback.plugin.index.model.querycompletion.AutoCompletionEntry
-
Action that will be performed when the user selects this suggestion.
- ACTUAL_SUFFIX - Static variable in interface com.funnelback.common.filter.jsoup.IJSoupFilter
- addedDate - Variable in class com.funnelback.publicui.search.model.transaction.session.CartResult
-
Date when the result was added to the cart
- addExternalMetadataLine(String) - Method in interface com.funnelback.plugin.index.consumers.ExternalMetadataConsumer
-
Deprecated.
- addExtraSearch(String, SearchQuestion) - Method in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Adds an
SearchQuestionto be processed as an extra search. - additionalData - Variable in class com.funnelback.publicui.search.model.transaction.SearchError
-
The original
Exceptionthat occurred, if available. - additionalParameters - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Additional parameters to pass as-is to PADRE.
- additionalProperties - Variable in class com.funnelback.publicui.search.model.curator.data.Message
-
Any additional properties associated with the message (for example CSS styling related information).
- additionalProperties - Variable in class com.funnelback.publicui.search.model.curator.data.UrlAdvert
-
Any additional properties associated with the advert (for example CSS styling related information).
- addMetadataToPrefix(String, ListMultimap<String, String>) - Method in interface com.funnelback.plugin.index.consumers.ExternalMetadataConsumer
-
Adds an external metadata mapping.
- addOption(String, String) - Method in class com.funnelback.publicui.search.model.transaction.PriorityQueryProcessorOptions
-
Adds an option to the map of query processor options that are guaranteed to apply.
- Admin - com.funnelback.publicui.search.model.transaction.ExecutionContext
-
Deployed on Admin port
- ADMINISTRATION_DASHBOARD - com.funnelback.plugin.docs.model.ProductSubtopic.ApplicationAdministration
- ADMINISTRATOR - com.funnelback.plugin.docs.model.Audience
- adminMsg - Variable in class com.funnelback.publicui.search.model.padre.Error
-
Technical message for the administrator.
- AllowedType() - Constructor for enum com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue.AllowedType
- allowedValue - Variable in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- allowedValue - Variable in class com.funnelback.plugin.details.model.PluginConfigKey
-
Defines range of allowed plugin configuration key values, for details see
PluginConfigKeyAllowedValue - allSummaryText - Variable in class com.funnelback.publicui.search.model.padre.Result
-
All texts available for generating summary text
- allValues - Variable in class com.funnelback.publicui.search.model.transaction.Facet
-
List of all facet values both selected and unselected.
- alpha - Variable in class com.funnelback.plugin.search.model.SuggestionQuery
-
alpha value
- ANALYTICS_REPORTING - com.funnelback.plugin.docs.model.ProductTopic
- ANALYTICS_USAGE - com.funnelback.plugin.docs.model.ProductSubtopic.AnalyticsReporting
- AnalyticsReporting() - Constructor for enum com.funnelback.plugin.docs.model.ProductSubtopic.AnalyticsReporting
- AnchorDescription - Class in com.funnelback.publicui.search.model.anchors
- AnchorDescription(String) - Constructor for class com.funnelback.publicui.search.model.anchors.AnchorDescription
- AnchorDetail - Class in com.funnelback.publicui.search.model.anchors
- AnchorDetail(String) - Constructor for class com.funnelback.publicui.search.model.anchors.AnchorDetail
- AnchorModel - Class in com.funnelback.publicui.search.model.anchors
- AnchorModel() - Constructor for class com.funnelback.publicui.search.model.anchors.AnchorModel
- anchors - Variable in class com.funnelback.publicui.search.model.anchors.AnchorModel
- anchortext - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDetail
- anchorText - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- AND - com.funnelback.common.facetednavigation.models.FacetConstraintJoin
-
Requires that all selected constraints are met.
- anyExtraSearchesIncomplete - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Set true when at least one extra search was unable to complete.
- anyUrlsPromoted - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Are any URLs promoted (includes URLs that may have been later removed or collapsed).
- API - com.funnelback.plugin.docs.model.ProductSubtopic.IntegrationDevelopment
- APPLICATION_ADMINISTRATION - com.funnelback.plugin.docs.model.ProductTopic
- APPLICATION_JSON_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType
-
Deprecated.
- ApplicationAdministration() - Constructor for enum com.funnelback.plugin.docs.model.ProductSubtopic.ApplicationAdministration
- applyAutoCompletionEntryToProfiles(AutoCompletionEntry, Set<String>) - Method in interface com.funnelback.plugin.index.consumers.AutoCompletionConsumer
-
A plugin may call this to supply autocompletion entries and the profiles for which they should be applied.
- applyGscopeWhenQueryMatches(String, String) - Method in interface com.funnelback.plugin.index.consumers.GscopeByQueryConsumer
-
A plugin may call this to supply a gscope which should be set for all documents that match the query.
- applyGscopeWhenRegexMatches(String, String) - Method in interface com.funnelback.plugin.index.consumers.GscopeByRegexConsumer
-
A plugin may call this to supply a gscope which should be set when the regular expression matches the URL.
- applyQieWhenQueryMatches(double, String) - Method in interface com.funnelback.plugin.index.consumers.QieByQueryConsumer
-
A plugin may call this to supply a QIE which should be set for all documents that match the query.
- applyQieWhenUrlMatches(double, String) - Method in interface com.funnelback.plugin.index.consumers.QieByUrlConsumer
-
A plugin may call this to supply a qie which should be set to the given URL(s).
- ARRAY - com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- ASCENDING - com.funnelback.publicui.search.model.transaction.facet.order.Order
- AscendingAlphabetic - com.funnelback.plugin.search.model.Sort
-
Sort by ascending alphabetic order
- AscendingLength - com.funnelback.plugin.search.model.Sort
-
Sort by ascending length
- asContentType() - Method in class com.funnelback.filter.api.DocumentType._DocumentType
- asContentType() - Method in interface com.funnelback.filter.api.DocumentType
-
Gets the document type as a Content-Type header value.
- AsIsComparator() - Constructor for class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparatorProvider.AsIsComparator
- associatedKeyId - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyConditional
-
Plugin configuration key
- associatedKeyValues - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyConditional
-
List of values
- ATTEMPT_FILTER - com.funnelback.filter.api.filters.PreFilterCheck
-
Returned when the pre filter check decides that an attempt to filter the document should be made.
- Audience - Enum in com.funnelback.plugin.docs.model
-
Source documentation meta tag "hc-audience"
- Audience() - Constructor for enum com.funnelback.plugin.docs.model.Audience
- AUTH - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click
-
Authorisation token used to prevent spoofed redirects
- AUTH - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Serve
-
Authentication token
- AUTO_COMPLETION - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- AutoCompletionAction - Interface in com.funnelback.plugin.index.model.querycompletion.action
-
This interface groups the options for what action occurs when an auto completion suggestion is selected.
- AutoCompletionConsumer - Interface in com.funnelback.plugin.index.consumers
- AutoCompletionDisplay - Interface in com.funnelback.plugin.index.model.querycompletion.display
-
This interface groups the options for how auto completion suggestions are displayed.
- AutoCompletionEntry - Class in com.funnelback.plugin.index.model.querycompletion
-
Represents an entry to be provided as additional data for auto-completion.
- AutoCompletionEntry() - Constructor for class com.funnelback.plugin.index.model.querycompletion.AutoCompletionEntry
- AutoConvertingMap<K,V> - Class in com.funnelback.publicui.search.model.util.map
-
A map that can auto convert the key from one type to the expected type.
- AutoConvertingMap(AutoConvertingMap.Converter<K>, String, Map<K, V>) - Constructor for class com.funnelback.publicui.search.model.util.map.AutoConvertingMap
- AutoConvertingMap.Converter<T> - Interface in com.funnelback.publicui.search.model.util.map
-
Converter to convert from some other type to the expected type.
- AutoConvertingMapXStreamConverter - Class in com.funnelback.publicui.xml
- AutoConvertingMapXStreamConverter() - Constructor for class com.funnelback.publicui.xml.AutoConvertingMapXStreamConverter
B
- BACKUP - com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- BEST_BETS - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- BOOLEAN - com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- boundingBoxes - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Bounding boxes for Geospatial metadata classes
- by - Variable in class com.funnelback.publicui.search.model.padre.SumByGroup
-
The metadata class sums are grouped by.
- by - Variable in class com.funnelback.publicui.search.model.padre.UniqueByGroup
-
The metadata class counts are grouped by.
- BY_COUNT_ASCENDING - Static variable in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparators
- BY_COUNT_DESCENDING - Static variable in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparators
- BY_LABEL_AS_NUMBER_ASCENDING - Static variable in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparators
- BY_LABEL_AS_NUMBER_DESCENDING - Static variable in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparators
- BY_LABEL_ASCENDING - Static variable in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparators
- BY_LABEL_DESCENDING - Static variable in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparators
- ByDateComparator - Class in com.funnelback.publicui.search.model.transaction.facet.order
-
Compare
Facet.CategoryValuecontaining date-based facet values and sort them in reverse chronological order. - ByDateComparator(boolean) - Constructor for class com.funnelback.publicui.search.model.transaction.facet.order.ByDateComparator
- BySelectedFirst - Class in com.funnelback.publicui.search.model.transaction.facet.order
- BySelectedFirst() - Constructor for class com.funnelback.publicui.search.model.transaction.facet.order.BySelectedFirst
- ByStringAsNumberComparator - Class in com.funnelback.publicui.search.model.transaction.facet.order
- ByStringAsNumberComparator() - Constructor for class com.funnelback.publicui.search.model.transaction.facet.order.ByStringAsNumberComparator
- BytesDocument - Interface in com.funnelback.filter.api.documents
-
A raw byte document.
- BytesDocumentFilter - Interface in com.funnelback.filter.api.filters
-
Filters a document where the content is converted to a byte[].
C
- Cache() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Cache
- CACHED_RESULTS - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- CacheQuestion - Class in com.funnelback.publicui.search.model.transaction.cache
-
This class contains all the input parameters for a cache request
- CacheQuestion() - Constructor for class com.funnelback.publicui.search.model.transaction.cache.CacheQuestion
- cacheUrl - Variable in class com.funnelback.publicui.search.model.padre.Result
-
URL to access the cached version of the result.
- caculateWin(float, float) - Method in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- caculateWin(float, float) - Method in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureMaxOther
- caculateWin(float, float) - Method in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureMaxPossible
- caculateWin(float, float) - Method in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureMaxPossibleMultiWordOnly
- callbackCode - Variable in class com.funnelback.plugin.index.model.querycompletion.action.JavaScriptCallbackAction
- callbackCode - Variable in class com.funnelback.plugin.index.model.querycompletion.display.JavaScriptCallbackDisplay
- canConvert(Class) - Method in class com.funnelback.publicui.xml.AutoConvertingMapXStreamConverter
- canConvert(Class) - Method in class com.funnelback.publicui.xml.FacetConverter
- canFilter(NoContentDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.BytesDocumentFilter
-
Checks if the document can be filtered.
- canFilter(NoContentDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.StringDocumentFilter
-
Checks if the document can be filtered.
- canonicaliseQueryStringToBeHashed(String) - Static method in class com.funnelback.publicui.utils.URLSignature
-
Converts a query string into a canonical form that can be used for hashing.
- carriedOverFtd - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Number of events continued from the day when using event search.
- Cart() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Cart
- cartContains(String) - Method in class com.funnelback.publicui.search.model.transaction.session.SearchSession
-
Check if the cart contains a specific result
- CartResult - Class in com.funnelback.publicui.search.model.transaction.session
-
A Cart result presented to the user.
- CartResult() - Constructor for class com.funnelback.publicui.search.model.transaction.session.CartResult
- CartResult(String, String, String, String, String, Date, Map<String, String>) - Constructor for class com.funnelback.publicui.search.model.transaction.session.CartResult
- categories - Variable in class com.funnelback.publicui.search.model.padre.ContextualNavigation
-
List of categories (type, topic, site).
- category - Variable in class com.funnelback.plugin.index.model.querycompletion.AutoCompletionEntry
-
The category of the suggestion.
- category - Variable in class com.funnelback.plugin.search.model.SuggestionQuery
-
Category to scope suggestions
- category - Variable in class com.funnelback.publicui.search.model.curator.data.Message
-
A category for the message which may be used by an FreeMarker template to display different types of messages in different ways.
- category - Variable in class com.funnelback.publicui.search.model.curator.data.Properties
-
A category for the properties which may be used by a FreeMarker template to display different types of properties in different ways.
- category - Variable in class com.funnelback.publicui.search.model.curator.data.UrlAdvert
-
A category for the advert which may be used by an ftl file to display different types of adverts in different ways.
- category - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- Category - Class in com.funnelback.publicui.search.model.padre
-
A contextual navigation category (type, topic, site).
- Category(String, Integer) - Constructor for class com.funnelback.publicui.search.model.padre.Category
- CATEGORY_DEFINITION_ORDER - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Values should be in the same order as the category definitions are in the facet configuration.
- categoryDefinitionIndex - Variable in class com.funnelback.publicui.search.model.transaction.Facet.CategoryValue
-
The category definition index, used for sorting by category definition.
- CategoryValue(String, String, Integer, boolean, String, String, int) - Constructor for class com.funnelback.publicui.search.model.transaction.Facet.CategoryValue
- categoryValueDepth - Variable in class com.funnelback.publicui.search.model.transaction.Facet.CategoryValue
-
The depth of the category value, used for sorting.
- CF_CONNECTING_IP - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Header
-
Header used to provide the cloudflare IP address , which may differ from the normal remote address if the request is forwarded by a proxy or wrapped by a CMS.
- ChainComparator() - Constructor for class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparatorProvider.ChainComparator
- CHECKBOX - com.funnelback.publicui.search.model.transaction.facet.FacetDisplayType
- checkbytes(byte[]) - Method in interface com.funnelback.plugin.gatherer.FileScanner
- city - Variable in class com.funnelback.publicui.search.model.geolocation.Location
-
The city name of the represented location if it can be determined, otherwise null.
- cleanAnchorText(String) - Static method in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- clear() - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- clear() - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- clear() - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- Click() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click
- clickDate - Variable in class com.funnelback.publicui.search.model.transaction.session.ClickHistory
-
Date when the click was performed
- clickHistory - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchSession
-
Click history of the user for the current collection.
- ClickHistory - Class in com.funnelback.publicui.search.model.transaction.session
-
A single entry in the user's click history
- ClickHistory() - Constructor for class com.funnelback.publicui.search.model.transaction.session.ClickHistory
- clickTrackingUrl - Variable in class com.funnelback.publicui.search.model.padre.Result
-
URL for click tracking.
- clive - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Specific component of a meta-collection to query
- CLIVE - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Meta components restriction
- cloneWithContent(DocumentType, Optional<Charset>, byte[]) - Method in interface com.funnelback.filter.api.documents.BytesDocument
-
Creates a clone of the document with the given content.
- cloneWithDocumentType(DocumentType) - Method in interface com.funnelback.filter.api.documents.FilterableDocument
-
Creates a clone of the document with the given document type.
- cloneWithMetadata(ListMultimap<String, String>) - Method in interface com.funnelback.filter.api.documents.BytesDocument
-
Gets a clone of the document with the given metadata.
- cloneWithMetadata(ListMultimap<String, String>) - Method in interface com.funnelback.filter.api.documents.FilterableDocument
-
Gets a clone of the document with the given metadata.
- cloneWithMetadata(ListMultimap<String, String>) - Method in interface com.funnelback.filter.api.documents.StringDocument
- cloneWithStringContent(DocumentType, String) - Method in interface com.funnelback.filter.api.documents.StringDocument
-
Creates a clone of the document with the given content and document type.
- cloneWithURI(URI) - Method in interface com.funnelback.filter.api.documents.BytesDocument
-
Gets a clone of the document with a different URI.
- cloneWithURI(URI) - Method in interface com.funnelback.filter.api.documents.FilterableDocument
-
Gets a clone of the document with a different URI.
- cloneWithURI(URI) - Method in interface com.funnelback.filter.api.documents.StringDocument
- Cluster - Class in com.funnelback.publicui.search.model.padre
-
A contextual navigation cluster (belongs to a
Category). - Cluster(String, Integer, String) - Constructor for class com.funnelback.publicui.search.model.padre.Cluster
- clusterNav - Variable in class com.funnelback.publicui.search.model.padre.ContextualNavigation
-
Navigation items
- ClusterNav - Class in com.funnelback.publicui.search.model.padre
-
Contextual navigation details to navigate through results and clusters.
- ClusterNav() - Constructor for class com.funnelback.publicui.search.model.padre.ClusterNav
- clusters - Variable in class com.funnelback.publicui.search.model.padre.Category
-
List of clusters (suggestions) for this category.
- CN_CLICKED - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.ContextualNavigation
-
Name of the last clicked suggestion
- CN_PREV_PATTERN - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.ContextualNavigation
-
Pattern to use to find previously clicked suggestion parameters.
- CN_PREV_PREFIX - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.ContextualNavigation
-
Prefix for the previously clicked suggestions (cluster0, cluster1, etc.).
- cnClickedCluster - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Contextual Navigation: last clicked cluster
- cnPreviousClusters - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Contextual Navigation: Previous clicked clusters
- code - Variable in enum com.funnelback.plugin.search.model.Sort
-
Sort code for
libqs - collapsed - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Result collapsing information for this result.
- collapsed - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Number of collapsed results
- Collapsed - Class in com.funnelback.publicui.search.model.padre
-
Information about collapsed results, for a given
Result - Collapsed() - Constructor for class com.funnelback.publicui.search.model.padre.Collapsed
- COLLAPSING - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Controls whether result collapsing is performed
- COLLAPSING_SIGNATURE - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Controls the field used for collapsing
- collection - Variable in class com.funnelback.publicui.search.model.anchors.AnchorModel
- collection - Variable in class com.funnelback.publicui.search.model.padre.Result
-
ID of the collection to which this result belongs.
- collection - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
ID of the collection being searched.
- collection - Variable in class com.funnelback.publicui.search.model.transaction.cache.CacheQuestion
-
Collectionto get the cached document from - collection - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Searched
Collection. - collection - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
Collection identifier for this search event
- collection - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistoryPK
- collection - Variable in class com.funnelback.publicui.search.model.transaction.session.SessionResult
- collection - Variable in class com.funnelback.publicui.search.model.transaction.session.SessionResultPK
- COLLECTION - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Collection ID
- collectionSize - Variable in class com.funnelback.publicui.search.model.padre.Details
-
Size of the index.
- collectionUpdated - Variable in class com.funnelback.publicui.search.model.padre.Details
-
Last updated date of the index.
- column - Variable in class com.funnelback.publicui.search.model.padre.Collapsed
-
Column from the signature file on which the result was collapsed
- com.funnelback.common.facetednavigation.models - package com.funnelback.common.facetednavigation.models
- com.funnelback.common.filter.jsoup - package com.funnelback.common.filter.jsoup
- com.funnelback.common.utils - package com.funnelback.common.utils
- com.funnelback.filter.api - package com.funnelback.filter.api
-
This holds the public API which clients are expected to use for filtering.
- com.funnelback.filter.api.documents - package com.funnelback.filter.api.documents
- com.funnelback.filter.api.filters - package com.funnelback.filter.api.filters
- com.funnelback.plugin - package com.funnelback.plugin
- com.funnelback.plugin.details - package com.funnelback.plugin.details
- com.funnelback.plugin.details.model - package com.funnelback.plugin.details.model
- com.funnelback.plugin.details.model.deserializer - package com.funnelback.plugin.details.model.deserializer
- com.funnelback.plugin.docs - package com.funnelback.plugin.docs
- com.funnelback.plugin.docs.model - package com.funnelback.plugin.docs.model
- com.funnelback.plugin.facets - package com.funnelback.plugin.facets
- com.funnelback.plugin.gatherer - package com.funnelback.plugin.gatherer
- com.funnelback.plugin.index - package com.funnelback.plugin.index
- com.funnelback.plugin.index.consumers - package com.funnelback.plugin.index.consumers
- com.funnelback.plugin.index.model.indexingconfig - package com.funnelback.plugin.index.model.indexingconfig
- com.funnelback.plugin.index.model.metadatamapping - package com.funnelback.plugin.index.model.metadatamapping
- com.funnelback.plugin.index.model.querycompletion - package com.funnelback.plugin.index.model.querycompletion
- com.funnelback.plugin.index.model.querycompletion.action - package com.funnelback.plugin.index.model.querycompletion.action
- com.funnelback.plugin.index.model.querycompletion.display - package com.funnelback.plugin.index.model.querycompletion.display
- com.funnelback.plugin.search - package com.funnelback.plugin.search
- com.funnelback.plugin.search.model - package com.funnelback.plugin.search.model
- com.funnelback.plugin.servlet.filter - package com.funnelback.plugin.servlet.filter
- com.funnelback.plugin.starturl - package com.funnelback.plugin.starturl
- com.funnelback.publicui.search.model.anchors - package com.funnelback.publicui.search.model.anchors
- com.funnelback.publicui.search.model.collection - package com.funnelback.publicui.search.model.collection
-
Provides classes representing collections to search on.
- com.funnelback.publicui.search.model.curator - package com.funnelback.publicui.search.model.curator
-
Provides classes representing the Curator system's data model.
- com.funnelback.publicui.search.model.curator.data - package com.funnelback.publicui.search.model.curator.data
-
Provides classes representing information for inclusion in the search results page generated by the Curator system.
- com.funnelback.publicui.search.model.facetednavigation - package com.funnelback.publicui.search.model.facetednavigation
-
Provides classes modeling faceted navigation requests.
- com.funnelback.publicui.search.model.geolocation - package com.funnelback.publicui.search.model.geolocation
-
Provides classes representing request location information.
- com.funnelback.publicui.search.model.padre - package com.funnelback.publicui.search.model.padre
-
Provides classes corresponding to the XML result packet returned by PADRE.
- com.funnelback.publicui.search.model.related - package com.funnelback.publicui.search.model.related
- com.funnelback.publicui.search.model.transaction - package com.funnelback.publicui.search.model.transaction
-
Provides classes used for a search transaction, from the input parameters to the search results.
- com.funnelback.publicui.search.model.transaction.cache - package com.funnelback.publicui.search.model.transaction.cache
- com.funnelback.publicui.search.model.transaction.contentoptimiser - package com.funnelback.publicui.search.model.transaction.contentoptimiser
-
Provides classes related to the Content Optimiser.
- com.funnelback.publicui.search.model.transaction.extrasearch - package com.funnelback.publicui.search.model.transaction.extrasearch
- com.funnelback.publicui.search.model.transaction.facet - package com.funnelback.publicui.search.model.transaction.facet
- com.funnelback.publicui.search.model.transaction.facet.order - package com.funnelback.publicui.search.model.transaction.facet.order
- com.funnelback.publicui.search.model.transaction.padrecmd - package com.funnelback.publicui.search.model.transaction.padrecmd
- com.funnelback.publicui.search.model.transaction.session - package com.funnelback.publicui.search.model.transaction.session
-
Provides classes related to session features (search user, search/click history, results shopping cart).
- com.funnelback.publicui.search.model.util.map - package com.funnelback.publicui.search.model.util.map
- com.funnelback.publicui.utils - package com.funnelback.publicui.utils
- com.funnelback.publicui.xml - package com.funnelback.publicui.xml
- commonWords - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.DocumentContentModel
- comparator - Variable in class com.funnelback.publicui.search.model.transaction.facet.order.ByDateComparator
- comparatorList - Variable in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparatorProvider.ChainComparator
- compare(Facet.CategoryValue, Facet.CategoryValue) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.ByDateComparator
- compare(Facet.CategoryValue, Facet.CategoryValue) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.BySelectedFirst
- compare(Facet.CategoryValue, Facet.CategoryValue) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparatorProvider.AsIsComparator
- compare(Facet.CategoryValue, Facet.CategoryValue) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.FacetConfigOrder
- compare(String, String) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.ByStringAsNumberComparator
- compare(T, T) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparatorProvider.ChainComparator
- compareByteArraysIgnoringLineEndings(byte[], byte[]) - Static method in interface com.funnelback.common.filter.jsoup.IJSoupFilter
-
Compare two byte arrays, ignoring the difference between different line endings (\n, \r\n, \r).
- compareTo(AnchorDescription) - Method in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- compareTo(RankingFeature) - Method in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- compareTo(RankingFeatureCategory) - Method in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureCategory
- component - Variable in class com.funnelback.publicui.search.model.padre.Result
-
For meta collections, it's the internal component number of the subcollection this result is coming from.
- computeQueryStringSignature(String) - Static method in class com.funnelback.publicui.utils.URLSignature
-
Computes a signature for a query string which is independent of the way parameters are encoded, or from their order.
- consat - Variable in class com.funnelback.publicui.search.model.padre.Explain
-
The number of constraints this result satisfied
- CONSAT - Static variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- constraintJoin - Variable in class com.funnelback.publicui.search.model.transaction.Facet
- constructAllowedValue(PluginConfigKeyAllowedValue) - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- constructDefaultValue(T) - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- constructDescription(String) - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- constructId(String) - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- constructKey(String) - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- constructLabel(String) - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- constructLongDescription(String) - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- constructRequired(boolean) - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- constructShowIfKeyHasValue(PluginConfigKeyConditional) - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- constructType(PluginConfigKeyType) - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- containsKey(Object) - Method in class com.funnelback.publicui.search.model.util.map.AutoConvertingMap
- containsKey(Object) - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- containsKey(Object) - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- containsKey(Object) - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- containsValue(Object) - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- containsValue(Object) - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
-
Warning - This check is not efficient on this map wrapper because we must calculate all the values.
- containsValue(Object) - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- content - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.ContentOptimiserModel
- CONTENT_AUDITOR - com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
- CONTENT_AUDITOR_DUPLICATES - com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
- CONTENT_EDITOR - com.funnelback.plugin.docs.model.Audience
- CONTENT_OPTIMISER_ADVANCED - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Content Optimiser: Advanced mode toggle.
- CONTENT_OPTIMISER_SELECT_DOCUMENT - com.funnelback.publicui.search.model.transaction.SearchTransaction.ExtraSearches
-
Extra search for the content optimiser when it selects a single document
- CONTENT_OPTIMISER_URL - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Content Optimiser: URL of the document to optimise.
- CONTENT_REPORTING - com.funnelback.plugin.docs.model.ProductSubtopic.AnalyticsReporting
- contentAsInputStream() - Method in interface com.funnelback.filter.api.documents.BytesDocument
-
Gets the contents of the document as an input stream.
- ContentOptimiserModel - Class in com.funnelback.publicui.search.model.transaction.contentoptimiser
- ContentOptimiserModel() - Constructor for class com.funnelback.publicui.search.model.transaction.contentoptimiser.ContentOptimiserModel
- ContentPath - Class in com.funnelback.plugin.index.model.indexingconfig
- ContentPath() - Constructor for class com.funnelback.plugin.index.model.indexingconfig.ContentPath
- contentPaths - Variable in class com.funnelback.plugin.index.model.indexingconfig.XmlIndexingConfig
-
When empty the field 'whenNoContentPaths' describes what is indexed, when non empty only the text within the given paths are indexed.
- contentType - Variable in class com.funnelback.filter.api.DocumentType._DocumentType
- CONTEXTUAL_NAVIGATION - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- contextualNavigation - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Contextual navigation suggestions.
- ContextualNavigation - Class in com.funnelback.publicui.search.model.padre
-
Contextual navigation parent class.
- ContextualNavigation() - Constructor for class com.funnelback.publicui.search.model.padre.ContextualNavigation
- ContextualNavigation() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.ContextualNavigation
- convert(Object) - Method in interface com.funnelback.publicui.search.model.util.map.AutoConvertingMap.Converter
-
If the object is a type we support but not the expected type this should take care of converting that.
- Converters - Class in com.funnelback.publicui.search.model.util.map
- Converters() - Constructor for class com.funnelback.publicui.search.model.util.map.Converters
- convertKey(K) - Method in class com.funnelback.publicui.search.model.util.map.AutoConvertingMap
- convertMapArray(Map<String, List<String>>) - Static method in class com.funnelback.publicui.utils.MapUtils
- convertMapList(Map<String, String[]>) - Static method in class com.funnelback.publicui.utils.MapUtils
- coolerNames - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
A
Mapof long names for cooler ranking variables, keyed by the cooler variable short names + id. - CoolerWeighting - Class in com.funnelback.publicui.search.model.padre
-
Ranking weighting, defined using
-coolcommand line flags on the query processor. - CoolerWeighting() - Constructor for class com.funnelback.publicui.search.model.padre.CoolerWeighting
- coolerWeights - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
A
Mapof floats that describe the cooler ranking weights. - count - Variable in class com.funnelback.plugin.search.model.SuggestionQuery
-
How many suggestions to get
- count - Variable in class com.funnelback.publicui.search.model.padre.Cluster
-
Number of results for this suggestion
- count - Variable in class com.funnelback.publicui.search.model.padre.Collapsed
-
Number of collapsed documents
- count - Variable in class com.funnelback.publicui.search.model.padre.DateCount
-
Number of documents for this date.
- count - Variable in class com.funnelback.publicui.search.model.transaction.Facet.CategoryValue
-
Count of occurrences for this value
- COUNT_ASCENDING - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Values should be sorted by the count of documents returned when the category value is selected.
- COUNT_DESCENDING - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Values should be sorted by the count of documents returned when the category value is selected.
- countryCode - Variable in class com.funnelback.publicui.search.model.geolocation.Location
-
The two-letter country code (ISO 3166-1 alpha code) of the represented location if it can be determined, otherwise null.
- countryGeoNameId - Variable in class com.funnelback.publicui.search.model.geolocation.Location
-
The GeoName ID of the country.
- countryName - Variable in class com.funnelback.publicui.search.model.geolocation.Location
-
The full country name of the represented location if it can be determined, otherwise null.
- create(String) - Static method in class com.funnelback.common.utils.URIHandlingUtils
-
create URI based on the incoming URL string
- createBean() - Method in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
-
The createBean method is executed after the Json object has been deserialized into the above properties.
- curator - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
Curator: Curated result packet data data.
- Curator - Class in com.funnelback.publicui.search.model.curator
-
A Curator will contain and additional information (exhibits) which has been added to the result packet by curator actions.
- Curator() - Constructor for class com.funnelback.publicui.search.model.curator.Curator
- CURATOR - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- CURATOR - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Parameter for enabling/disabling curator
- currEnd - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Current offset of the last result returned.
- currentProfile - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
The profile which will be used for the request.
- currStart - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Current offset of the first result returned.
- currStart - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
Starting page offset
- CUSTOM - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- CUSTOM_COMPARATOR - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Uses a custom comparator that can be set on the Facet.
- customComparator - Variable in class com.funnelback.publicui.search.model.transaction.Facet
-
If non-null this comparator will be used to sort values returned by the
Facet#getAllValues(),Facet.getSelectedValues()andFacet#getUnselectAllUrl()methods. - customData - Variable in class com.funnelback.publicui.search.model.padre.ContextualNavigation
-
Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
- customData - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
- customData - Variable in class com.funnelback.publicui.search.model.transaction.Facet
-
Custom data placeholder allowing any arbitrary data to be stored for this facet by hook scripts.
- customData - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
- customData - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
- customData - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
D
- DAAT - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Parameter for controlling the number of documents considered in document at a time mode
- data - Variable in class com.funnelback.publicui.search.model.transaction.Facet.CategoryValue
-
Actual value of the category (Ex: "Sydney").
- DATA_MODEL_MANIPULATION - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- DATA_MODEL_SEARCH - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- DATA_REPORTING - com.funnelback.plugin.docs.model.ProductSubtopic.AnalyticsReporting
- DATA_SOURCE - com.funnelback.plugin.details.model.PluginTarget
- DATA_SOURCES - com.funnelback.plugin.docs.model.ProductTopic
- DATABASE - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- DataFetchError - com.funnelback.publicui.search.model.transaction.SearchError.Reason
- DataSources() - Constructor for enum com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- date - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Date of the search result
- DATE - com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- DATE - com.funnelback.plugin.index.model.metadatamapping.MetadataType
-
Currently can only be set to metadata class "d".
- DATE_ASCENDING - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Sort values produced by the Date facet category in ascending order.
- DATE_DESCENDING - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Sort values produced by the Date facet category in descending order.
- DATE_LABELS_VALUES - Static variable in class com.funnelback.publicui.search.model.transaction.facet.order.ByDateComparator
- DateCount - Class in com.funnelback.publicui.search.model.padre
-
A date count (Used in faceted navigation).
- DateCount() - Constructor for class com.funnelback.publicui.search.model.padre.DateCount
- dateCounts - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Date counts (Used in faceted navigation)
- DEBUG - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
PADRE debug mode
- defaultValue - Variable in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- defaultValue - Variable in class com.funnelback.plugin.details.model.PluginConfigKey
-
Defines the default value of plugin configuration key
- definedMetadataSeparators - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Map containing the separators defined for each metadata class.
- definedSeparators - Variable in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- DelegateMap<K,V> - Class in com.funnelback.publicui.search.model.util.map
- DelegateMap() - Constructor for class com.funnelback.publicui.search.model.util.map.DelegateMap
- delete() - Static method in class com.funnelback.filter.api.FilterResult
-
Returned by a filter when it wants to delete the given document.
- DELIMITED_TEXT - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- DeprecatedSearchLifeCyclePlugin - Interface in com.funnelback.plugin
-
Deprecated.replaced by
SearchLifeCyclePluginThis interface is only used for backwards compatability purpose. Dev should only implement methods fromSearchLifeCyclePlugin. And must not implement both the old and new methods with the same name. - DESCENDING - com.funnelback.publicui.search.model.transaction.facet.order.Order
- DescendingWeight - com.funnelback.plugin.search.model.Sort
-
Sort by descending weight
- DescendingWeightedComboScore - com.funnelback.plugin.search.model.Sort
-
Sort by weighted combo of weight and length score = alpha * weight + (1 - alpha) * length_score
- description - Variable in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- description - Variable in class com.funnelback.plugin.details.model.PluginConfigFile
-
Description of plugin configuration file to display in plugin configuration admin UI and in auto-generated documentation
- description - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyBase
-
Short description of plugin configuration key to display in plugin configuration admin UI and in auto-generated documentation
- descriptionHtml - Variable in class com.funnelback.publicui.search.model.curator.data.UrlAdvert
-
The description (in HTML) body of the advert.
- detail - Variable in class com.funnelback.publicui.search.model.anchors.AnchorModel
- details - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Details about the index and PADRE version.
- Details - Class in com.funnelback.publicui.search.model.padre
-
Details (header) of a PADRE result packet
- Details() - Constructor for class com.funnelback.publicui.search.model.padre.Details
- DEVELOPER - com.funnelback.plugin.docs.model.Audience
- DIRECTORY - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- display - Variable in class com.funnelback.plugin.index.model.querycompletion.AutoCompletionEntry
-
This is what will be displayed to the user for this suggestion.
- DisplayTrigger - Class in com.funnelback.plugin.index.model.querycompletion.display
-
An auto-completion display type which simply displays the trigger string as the auto-completion suggestion.
- DisplayTrigger() - Constructor for class com.funnelback.plugin.index.model.querycompletion.display.DisplayTrigger
- displayUrl - Variable in class com.funnelback.publicui.search.model.curator.data.UrlAdvert
-
The URL to be displayed for the advert.
- displayUrl - Variable in class com.funnelback.publicui.search.model.padre.Result
-
URL to display for the result.
- distilledFileName - Variable in class com.funnelback.publicui.search.model.anchors.AnchorModel
- diversified - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Set true if the URL was downweighted by result diversification.
- DLS - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- DO_NOTHING - Static variable in class com.funnelback.publicui.search.model.util.map.Converters
- doc - Variable in class com.funnelback.publicui.search.model.transaction.cache.CacheQuestion
-
Relative path of the document in the collection storage to access the document.
- DOC - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Cache
-
Document path
- DOC - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Serve
-
Location of the file on disk
- docNum - Variable in class com.funnelback.publicui.search.model.anchors.AnchorModel
- docNum - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Internal document number of the result in the index.
- DOCUMENT_FILTERS - com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
- documentBuilder() - Static method in class com.funnelback.common.utils.SharedXMLUtils
- DocumentContentModel - Class in com.funnelback.publicui.search.model.transaction.contentoptimiser
- DocumentContentModel() - Constructor for class com.funnelback.publicui.search.model.transaction.contentoptimiser.DocumentContentModel
- DocumentPath - Class in com.funnelback.plugin.index.model.indexingconfig
- DocumentPath() - Constructor for class com.funnelback.plugin.index.model.indexingconfig.DocumentPath
- documentPaths - Variable in class com.funnelback.plugin.index.model.indexingconfig.XmlIndexingConfig
-
Defines where the documents are within the XML, this can be used to split XML documents.
- documentsPerCollection - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
A map containing the number of documents each collection contributed to the result set.
- DocumentType - Interface in com.funnelback.filter.api
-
Holds the information describing the type of the document.
- DocumentType._DocumentType - Class in com.funnelback.filter.api
- DocumentTypeFactory - Interface in com.funnelback.filter.api
- documentURI - Variable in exception com.funnelback.filter.api.filters.FilterException
- documentVisibleToUser - Variable in class com.funnelback.publicui.search.model.padre.Result
- domain - Variable in class com.funnelback.publicui.search.model.padre.QuickLinks
-
Domain of the quick links.
- doNothingConverter() - Static method in class com.funnelback.publicui.search.model.util.map.Converters
- DONT_INDEX_UNMAPPED_AS_CONTENT - com.funnelback.plugin.index.model.indexingconfig.WhenNoContentPathsAreSet
- DOUBLE - com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- dynamicQueryProcessorOptions - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Dynamic query processor options for PADRE, in addition to the one set in
collection.cfg.
E
- ENC - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Encoding of the input parameters (query ...)
- end - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDetail
- entityList - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
List of prominent entities.
- entrySet() - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- entrySet() - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- entrySet() - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- environmentVariables - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
List of environment variables to pass to PADRE.
- equals(Object) - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- error - Variable in class com.funnelback.publicui.search.model.anchors.AnchorModel
- error - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Error occurred during the search, if any.
- error - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Any error if the search wasn't successful.
- Error - Class in com.funnelback.publicui.search.model.padre
-
PADRE error data.
- Error() - Constructor for class com.funnelback.publicui.search.model.padre.Error
- estimatedCounts - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Whether the counts within this summary have been estimated.
- EVENT_SEARCH - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- eventDate - Variable in class com.funnelback.publicui.search.model.padre.TierBar
-
Date of the events for this tier bar when the
-eventsquery processor option is set. - excludeScopes - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Scopes (URL prefixes, not Gscopes) excluded via the
scopequery processor option. - executionContext - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Execution context of the Search UI.
- ExecutionContext - Enum in com.funnelback.publicui.search.model.transaction
-
Context where the Modern UI is being executed
- ExecutionContext() - Constructor for enum com.funnelback.publicui.search.model.transaction.ExecutionContext
- Exhibit - Interface in com.funnelback.publicui.search.model.curator
-
Exhibits are individual 'blocks' of information made available for display within search results by the curator system.
- exhibits - Variable in class com.funnelback.publicui.search.model.curator.Curator
-
Contains the list of additional elements (exhibits) which curator actions have caused to be available for display within the search result page.
- EXP - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Explore: Number of query terms
- EXPECTED_SUFFIX - Static variable in interface com.funnelback.common.filter.jsoup.IJSoupFilter
- explain - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Explain data used in the Content Optimiser.
- Explain - Class in com.funnelback.publicui.search.model.padre
-
Search explain plan used in the Content Optimiser.
- Explain() - Constructor for class com.funnelback.publicui.search.model.padre.Explain
- EXPLAIN - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Content Optimiser: Activate explain mode on PADRE.
- explainTypes - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
A
Mapof Strings that describes how to calculate the potential improvement for ranking on each feature when the content optimiser is used. - exploreLink - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Link to the also of interest CGI.
- externalLinkCount - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- externalMetadata(IndexConfigProviderContext, ExternalMetadataConsumer) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Allows supplying external metadata.
- ExternalMetadataConsumer - Interface in com.funnelback.plugin.index.consumers
- EXTRA_SEARCH - com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
- EXTRA_SEARCHES - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- extractFirstNumber(String) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.ByStringAsNumberComparator
-
Extracts the first decimal number in the given string or returns null.
- extraFacetedNavigation(IndexConfigProviderContext) - Method in interface com.funnelback.plugin.facets.FacetProvider
-
Supply additional faceted navigation configuration.
- extraParameter - Variable in class com.funnelback.publicui.search.model.facetednavigation.FacetParameter
-
Additional parameter information specific to the selected facet.
- extraParameter - Variable in class com.funnelback.publicui.search.model.facetednavigation.FacetSelectedDetails
- extraSearch - Variable in enum com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
-
Is the search type an extra search one
- extraSearches - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Any additional extra search transactions performed during this transaction.
- ExtraSearches() - Constructor for enum com.funnelback.publicui.search.model.transaction.SearchTransaction.ExtraSearches
- extraSearchesAproxTimeSpent - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
How much time (ms) has been spent in executing extra searches.
- extraSearchesQuestions - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Internal use: Additional
SearchQuestions to process as extra searches. - extraSearchesTasks - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Internal use: Holds the extra searches tasks being executed.
- ExtraSearchFuture - Interface in com.funnelback.publicui.search.model.transaction.extrasearch
-
Internal use see DefaultExtraSearchFuture
- extraSearchName - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Holds the extra search name
- extraStartUrls(StartUrlProviderContext) - Method in interface com.funnelback.plugin.starturl.StartUrlProvider
F
- Facet - Class in com.funnelback.publicui.search.model.transaction
-
Facets, generated from the result data (Metadata counts, GScope counts, URL counts).
- Facet(String) - Constructor for class com.funnelback.publicui.search.model.transaction.Facet
-
Deprecated.
- Facet(String, FacetSelectionType, FacetConstraintJoin, FacetValues, List<FacetValuesOrder>) - Constructor for class com.funnelback.publicui.search.model.transaction.Facet
- FACET_ORDER_TO_COMPARATOR - Variable in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparatorProvider
- FACET_PARAM_PATTERN - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Pattern to use to find faceted navigation parameters.
- FACET_PREFIX - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Prefix used on faceted navigation parameters (Ex:
f.Location|X=... - FACET_SCOPE - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Checkbox used to preserve the facet scope when running a query.
- Facet.CategoryValue - Class in com.funnelback.publicui.search.model.transaction
-
Value of a facet category, such as "Location = Sydney".
- facetCollectionConstraints - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
The collections to restrict search to for faceted navigation.
- FacetComparatorProvider - Class in com.funnelback.publicui.search.model.transaction.facet.order
- FacetComparatorProvider() - Constructor for class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparatorProvider
- FacetComparatorProvider.AsIsComparator - Class in com.funnelback.publicui.search.model.transaction.facet.order
- FacetComparatorProvider.ChainComparator<T> - Class in com.funnelback.publicui.search.model.transaction.facet.order
- FacetComparators - Class in com.funnelback.publicui.search.model.transaction.facet.order
- FacetComparators() - Constructor for class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparators
- FacetConfigOrder - Class in com.funnelback.publicui.search.model.transaction.facet.order
-
Leaves the order of categories as they are, which should be the order in which they appear in the facet config.
- FacetConfigOrder() - Constructor for class com.funnelback.publicui.search.model.transaction.facet.order.FacetConfigOrder
- FacetConstraintJoin - Enum in com.funnelback.common.facetednavigation.models
-
Defines how selected constraints within a facet are applied.
- FacetConstraintJoin() - Constructor for enum com.funnelback.common.facetednavigation.models.FacetConstraintJoin
- FacetConverter - Class in com.funnelback.publicui.xml
- FacetConverter() - Constructor for class com.funnelback.publicui.xml.FacetConverter
- FacetConverter.FacetWithFields - Class in com.funnelback.publicui.xml
-
XStream will only serialise fields so this is a Facet with selected and unselected fields for values
- FacetDisplayType - Enum in com.funnelback.publicui.search.model.transaction.facet
- FacetDisplayType() - Constructor for enum com.funnelback.publicui.search.model.transaction.facet.FacetDisplayType
- FACETED_NAVIGATION - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- FACETED_NAVIGATION - com.funnelback.publicui.search.model.transaction.SearchTransaction.ExtraSearches
-
Faceted navigation extra search when the full facets list mode is enabled.
- FACETED_NAVIGATION_EXTRA_SEARCH - com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
-
These extra searches are created for use in faceted navigation.
- FACETED_NAVIGATION_SORT - com.funnelback.plugin.docs.model.MarketplaceSubtype
- facetExtras - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
Information about facets that is not available from
SearchResponse.facets - FacetExtras - Class in com.funnelback.publicui.search.model.transaction
-
Holds extra information on faceted navigation.
- FacetExtras() - Constructor for class com.funnelback.publicui.search.model.transaction.FacetExtras
- facetName - Variable in class com.funnelback.publicui.search.model.facetednavigation.FacetSelectedDetails
- FacetParameter - Class in com.funnelback.publicui.search.model.facetednavigation
-
Representation of a parameter for selecting a particular facet category (or categories) within the faceted navigation system.
- FacetParameter() - Constructor for class com.funnelback.publicui.search.model.facetednavigation.FacetParameter
- FacetProvider - Interface in com.funnelback.plugin.facets
-
Provide extra faceted navigation to use during query processing.
- facets - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
Computed facets based on the PADRE result packet and collection configuration.
- FacetSelectedDetails - Class in com.funnelback.publicui.search.model.facetednavigation
- FacetSelectedDetails() - Constructor for class com.funnelback.publicui.search.model.facetednavigation.FacetSelectedDetails
- FacetSelectionType - Enum in com.funnelback.common.facetednavigation.models
-
Defines how facet selection works.
- FacetSelectionType() - Constructor for enum com.funnelback.common.facetednavigation.models.FacetSelectionType
- facetsGScopeConstraints - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
GScope constraints to apply for faceted navigation (In addition to existing gscope constraints).
- facetsQueryConstraints - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Query constraints to apply for faceted navigation (In addition to other query expressions).
- facetValues - Variable in class com.funnelback.publicui.search.model.transaction.Facet
- FacetValues - Enum in com.funnelback.common.facetednavigation.models
-
Defines where the (category) values to display in facet come from.
- FacetValues() - Constructor for enum com.funnelback.common.facetednavigation.models.FacetValues
- FacetValuesOrder - Enum in com.funnelback.common.facetednavigation.models
- FacetValuesOrder() - Constructor for enum com.funnelback.common.facetednavigation.models.FacetValuesOrder
- FacetWithFields(Facet) - Constructor for class com.funnelback.publicui.xml.FacetConverter.FacetWithFields
- featureScores - Variable in class com.funnelback.publicui.search.model.padre.Explain
-
Map of float scores for each ranking feature.
- fewerLink - Variable in class com.funnelback.publicui.search.model.padre.Category
-
Link to get fewer values for this category.
- FILE_SYSTEM - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- FileScanner - Interface in com.funnelback.plugin.gatherer
- fileSize - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Size of the file corresponding to the search results, in bytes.
- fileType - Variable in class com.funnelback.publicui.search.model.padre.Result
-
File type of the result, usually the file extension ("pdf", "xls", "html", ...)
- FileTypePath - Class in com.funnelback.plugin.index.model.indexingconfig
- FileTypePath() - Constructor for class com.funnelback.plugin.index.model.indexingconfig.FileTypePath
- fileTypePaths - Variable in class com.funnelback.plugin.index.model.indexingconfig.XmlIndexingConfig
-
The type at this path (e.g.
- filter(FilterableDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.BytesDocumentFilter
-
Filter method responsible for calling
BytesDocumentFilter.canFilter(NoContentDocument, FilterContext)andBytesDocumentFilter.filterAsBytesDocument(BytesDocument, FilterContext) - filter(FilterableDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.Filter
-
Filter a document.
- filter(FilterableDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.StringDocumentFilter
-
Filter method responsible for calling
StringDocumentFilter.canFilter(NoContentDocument, FilterContext)andStringDocumentFilter.filterAsStringDocument(StringDocument, FilterContext) - filter(String) - Method in class com.funnelback.publicui.utils.MapKeyFilter
- filter(Pattern) - Method in class com.funnelback.publicui.utils.MapKeyFilter
- Filter - Interface in com.funnelback.filter.api.filters
-
Filters a document.
- FILTER - com.funnelback.plugin.docs.model.MarketplaceSubtype
- FilterableDocument - Interface in com.funnelback.filter.api.documents
-
A Document which can be filtered by the filter framework.
- filterAsBytesDocument(BytesDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.BytesDocumentFilter
-
Filters the
BytesDocument - filterAsStringDocument(StringDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.StringDocumentFilter
-
Filters the
StringDocument - filterConfigurationFile(String) - Method in interface com.funnelback.filter.api.InternalFilterContext
-
Reads a configuration file for the currently running filter as a UTF-8 String.
- filterConfigurationFileAsBytes(String) - Method in interface com.funnelback.filter.api.InternalFilterContext
-
Reads a configuration file for the currently running filter.
- FilterContext - Interface in com.funnelback.common.filter.jsoup
-
A Jsoup filter context.
- FilterContext - Interface in com.funnelback.filter.api
-
An immutable context supplied to the filters.
- FilterDocumentFactory - Interface in com.funnelback.filter.api
- filteredDocuments - Variable in class com.funnelback.filter.api.FilterResult
- FilterException - Exception in com.funnelback.filter.api.filters
-
Thrown when an error occurs during filtering of a document and filtering of that document should not proceed.
- FilterException(FilterableDocument, String) - Constructor for exception com.funnelback.filter.api.filters.FilterException
- FilterException(FilterableDocument, String, Throwable) - Constructor for exception com.funnelback.filter.api.filters.FilterException
- FilterResult - Class in com.funnelback.filter.api
-
The result of filtering a document.
- FilterResult() - Constructor for class com.funnelback.filter.api.FilterResult
- FilterResult(boolean, List<FilterableDocument>) - Constructor for class com.funnelback.filter.api.FilterResult
- FilterResult(FilterableDocument) - Constructor for class com.funnelback.filter.api.FilterResult
- FilterResult(Collection<? extends FilterableDocument>) - Constructor for class com.funnelback.filter.api.FilterResult
- finalScore - Variable in class com.funnelback.publicui.search.model.padre.Explain
-
The final score for this result
- firstRank - Variable in class com.funnelback.publicui.search.model.padre.TierBar
-
Rank of the first search result contained within this tier bar
- FIXED_LIST - com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue.AllowedType
- form - Variable in class com.funnelback.publicui.search.model.transaction.cache.CacheQuestion
-
Form (template) to use to render the cached copy
- form - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Display form (template)
- FORM - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Name of the form (template) to use to display results
- format - Variable in class com.funnelback.plugin.details.model.PluginConfigFile
-
Expected format of plugin configuration file For example: json, xml, txt
- Format() - Constructor for enum com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- FROM_SCOPED_QUERY - com.funnelback.common.facetednavigation.models.FacetValues
-
Values are from the query which may have facets applied.
- FROM_SCOPED_QUERY_HIDE_UNSELECTED_PARENT_VALUES - com.funnelback.common.facetednavigation.models.FacetValues
-
Values come from the scoped query however if a value is selected all other non selected values at the same category level are not shown.
- FROM_SCOPED_QUERY_WITH_FACET_UNSELECTED - com.funnelback.common.facetednavigation.models.FacetValues
-
Values are from the query which may have facets applied, except the 'current' facet is not selected.
- FROM_UNSCOPED_ALL_QUERY - com.funnelback.common.facetednavigation.models.FacetValues
-
Values are from running the all (padre null) query where no facets are selected.
- FROM_UNSCOPED_QUERY - com.funnelback.common.facetednavigation.models.FacetValues
-
Values are from the unscoped query, that is the user's query without any facets selected.
- fromBytes(byte[]) - Static method in class com.funnelback.common.utils.SharedXMLUtils
-
Parse a Document from a given byte[].
- fromContentTypeHeader(String) - Method in interface com.funnelback.filter.api.DocumentTypeFactory
-
Creates a DocumentType from HTTP header Content-Type.
- fromFile(File) - Static method in class com.funnelback.common.utils.SharedXMLUtils
-
Parse a Document from a given File path.
- fromInputSource(InputSource) - Static method in class com.funnelback.common.utils.SharedXMLUtils
-
Parse a Document from an inputSource.
- fromInputStream(InputStream) - Static method in class com.funnelback.common.utils.SharedXMLUtils
-
Parse a Document from an inputStream.
- fromJSON(String) - Static method in class com.funnelback.publicui.search.model.padre.CoolerWeighting
-
Used to deserialize a
CoolerWeightingfrom a JSON value, as represented byCoolerWeighting.toString(). - fromProperties(Properties) - Static method in class com.funnelback.publicui.utils.MapUtils
-
Converts a
Propertiesto aMap - fromString(String) - Static method in class com.funnelback.common.utils.SharedXMLUtils
-
Parse a Document from a given String.
- FULL_MATCHES_ONLY - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Parameter indicating only fully matching documents should be returned
- fullyMatching - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Number of documents that fully matched the query terms.
- funnelbackVersion - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Funnelback version
- FunnelbackVersionI - Interface in com.funnelback.publicui.search.model.transaction
G
- gather(PluginGatherContext, PluginStore) - Method in interface com.funnelback.plugin.gatherer.PluginGatherer
- gather(PluginGatherContext, PluginStore, FileScanner) - Method in interface com.funnelback.plugin.gatherer.PluginGatherer
- GATHERER - com.funnelback.plugin.docs.model.MarketplaceSubtype
- GeoBoundingBox - Class in com.funnelback.publicui.search.model.padre
-
The smallest bounding box the coordinates of all result within the daat limit.
- GeoBoundingBox() - Constructor for class com.funnelback.publicui.search.model.padre.GeoBoundingBox
- GeoBoundingBox.LatLong - Class in com.funnelback.publicui.search.model.padre
- geoNameId - Variable in class com.funnelback.publicui.search.model.geolocation.Location.Subdivision
-
The GeoName id of this subdivision.
- GEOSPATIAL - com.funnelback.plugin.index.model.metadatamapping.MetadataType
- GEOSPATIAL_SEARCH - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- get(Object) - Method in class com.funnelback.publicui.search.model.util.map.AutoConvertingMap
- get(Object) - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- get(Object) - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- get(Object) - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- get(String) - Method in interface com.funnelback.publicui.search.model.collection.ServiceConfig
- getAdditionalMetadata() - Method in interface com.funnelback.common.filter.jsoup.FilterContext
-
Metadata to be added to the document being filtered as a result of filtering.
- getAllowedValue() - Method in interface com.funnelback.plugin.details.model.PluginConfigKeyDetails
- getAudience() - Method in interface com.funnelback.plugin.docs.PluginDocsDetails
-
Define a list of tags to display in documentation as meta tag "hc-audience"
- getCharset() - Method in interface com.funnelback.filter.api.documents.NoContentDocument
-
Returns the possible charset of the document.
- getCharset() - Method in interface com.funnelback.filter.api.documents.StringDocument
-
Charset of a StringDocument are always UTF-8, if the document contains any indication of charset it must be UTF-8
- getClickHistory(String) - Method in class com.funnelback.publicui.search.model.transaction.session.SearchSession
-
Retrieve the clich history for a specific result
- getCollection() - Method in class com.funnelback.publicui.search.model.transaction.session.CartResult
-
Since 15.18 this is set to the collection the result came from rather than the collection the search ran on.
- getCollectionConfigFile(String) - Method in interface com.funnelback.common.filter.jsoup.SetupContext
-
Provides access to configuration files inside the collection configuration folder.
- getCollectionConfigFile(String) - Method in interface com.funnelback.filter.api.InternalFilterContext
-
Provides access to configuration files inside the collection configuration folder.
- getCollectionName() - Method in interface com.funnelback.filter.api.FilterContext
-
Gets the name of the collection under which the filter is run.
- getCollectionName() - Method in interface com.funnelback.plugin.PluginBaseContext
-
The name of the funnelback collection for which filtering is being performed
- getComparator(FacetValuesOrder, Optional<Comparator<Facet.CategoryValue>>) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparatorProvider
- getComparatorWhenSortingAllValues(List<FacetValuesOrder>, Optional<Comparator<Facet.CategoryValue>>) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparatorProvider
-
Gets the comparator to use when we are sorting on ALL category values.
- getConfigFiles() - Method in interface com.funnelback.plugin.details.PluginDetails
-
Define a list of all plugin configuration files to display in plugin configuration admin UI and in auto-generated documentation
- getConfigKeys() - Method in interface com.funnelback.filter.api.FilterContext
-
Gets the set of all configuration keys for collection the filter is running under.
- getConfigKeys() - Method in interface com.funnelback.plugin.details.PluginDetails
-
Define a list of all plugin configuration keys to display in plugin configuration admin UI and in auto-generated documentation
- getConfigKeysMatchingPattern(String) - Method in interface com.funnelback.filter.api.FilterContext
-
Provides config settings which match the given key pattern.
- getConfigKeysMatchingPattern(String) - Method in interface com.funnelback.plugin.PluginBaseConfigContext
-
Provides config settings which match the given key pattern.
- getConfigKeysMatchingPattern(String) - Method in interface com.funnelback.publicui.search.model.collection.ServiceConfig
-
Provides config settings which match the given key pattern.
- getConfigKeysWithPrefix(String) - Method in interface com.funnelback.filter.api.FilterContext
-
Provides a list of config setting keys which have some prefix.
- getConfigKeysWithPrefix(String) - Method in interface com.funnelback.plugin.PluginBaseConfigContext
-
Provides a list of config setting keys which have some prefix.
- getConfigKeysWithPrefix(String) - Method in interface com.funnelback.publicui.search.model.collection.ServiceConfig
-
Provides a list of config setting keys which have some prefix.
- getConfigSetting(String) - Method in interface com.funnelback.plugin.PluginBaseConfigContext
-
Provides access to config settings from the current funnelback installation and collection.
- getConfigValue(String) - Method in interface com.funnelback.filter.api.FilterContext
-
Gets the value of the configuration setting for the collection the filter is running under.
- getContentAsString() - Method in interface com.funnelback.filter.api.documents.StringDocument
-
Gets the document content as a string.
- getCopyOfContents() - Method in interface com.funnelback.filter.api.documents.FilterableDocument
-
Returns a copy of the documents content as bytes.
- getCopyOfMetadata() - Method in interface com.funnelback.filter.api.documents.NoContentDocument
-
Gets a mutable copy of the documents metadata.
- getCurrentProfileConfig() - Method in interface com.funnelback.plugin.servlet.filter.SearchServletFilterHookContext
-
Returns the (modern) config of the currentProfile for the search request.
- getCurrentProfileConfig() - Method in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Returns the (modern) config of the currentProfile
- getCurrentProjectVersion() - Static method in class com.funnelback.plugin.PluginUtil
-
Reads the pom.xml file for the current project, and returns the value of the version node.
- getCustomData() - Method in interface com.funnelback.common.filter.jsoup.FilterContext
-
A map of custom data which may be used to communicate between filters in the chain.
- getDefaultValue() - Method in interface com.funnelback.plugin.details.model.PluginConfigKeyDetails
- getDocument() - Method in interface com.funnelback.common.filter.jsoup.FilterContext
-
The document being filtered.
- getDocumentType() - Method in interface com.funnelback.filter.api.documents.NoContentDocument
-
Returns the document type of this filterable document, this may not be the original document type.
- getDocumentTypeFactory() - Method in interface com.funnelback.filter.api.FilterContext
-
Provides a DocumentTypeFactory, may be used to construct
- getEffectiveExtraSearchName() - Method in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Gets the name of the extra search this search should be considered to be under.
- getFacetByName(String) - Method in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
Returns the first facet with the given name
- getFilterClass() - Method in interface com.funnelback.plugin.details.PluginDetails
-
Define fully-qualified class name of filter to display in plugin configuration admin UI and in auto-generated documentation
- getFilterDocumentFactory() - Method in interface com.funnelback.filter.api.FilterContext
-
Provides a DocumentTypeConverter, used to convert between filterable document types.
- getFilterName() - Method in interface com.funnelback.filter.api.filters.NamedFilter
-
Gets the filters name.
- getFirstString(ListMultimap<String, String>, String, String) - Static method in class com.funnelback.publicui.utils.MapUtils
- getFirstString(Map<String, String[]>, Object, String) - Static method in class com.funnelback.publicui.utils.MapUtils
-
Gets a value for a given key, or a default value if the key is not found.
- getIndexUrl() - Method in class com.funnelback.publicui.search.model.transaction.session.SessionResult
- getInputParametersCopy() - Method in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Returns a copy of the
#getInputParameters()map - getIntegerFromCategory(Facet.CategoryValue) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.ByDateComparator
- getJsoupFilterClass() - Method in interface com.funnelback.plugin.details.PluginDetails
-
Define fully-qualified class name of jsoup filter to display in plugin configuration admin UI and in auto-generated documentation
- getKey() - Method in class com.funnelback.plugin.details.model.PluginConfigKeyBase
-
Create a plugin key based on provided key ID If ID was defined with wildcard, this method will return key in wildcard form.
- getKey(String...) - Method in class com.funnelback.plugin.details.model.PluginConfigKeyBase
-
Create a plugin key based on provided key ID with resolving wildcards to provided values For example: - for ID `foo.*`, `getKey("something")` returns `plugin.pluginID.config.foo.something` - for ID `*.foo.*.bar`, `getKey("something", "more")` returns `plugin.pluginID.config.something.foo.more.bar`
- getKeyPrefix() - Method in class com.funnelback.plugin.details.model.PluginConfigKeyEncrypted
- getKeyPrefix() - Method in interface com.funnelback.plugin.details.model.PluginDetailsBase
- getKeyType() - Method in interface com.funnelback.publicui.search.model.util.map.AutoConvertingMap.Converter
- getKeyWithWildcard(String, List<String>) - Static method in class com.funnelback.common.utils.SharedConfigKeyUtils
-
Substitutes the wildcards into the key.
- getMajor() - Method in interface com.funnelback.publicui.search.model.transaction.FunnelbackVersionI
- getMarketplaceSubtype() - Method in interface com.funnelback.plugin.docs.PluginDocsDetails
-
Define a list of tags to display in documentation as meta tag "marketplace-subtype"
- getMessage() - Method in exception com.funnelback.filter.api.filters.FilterException
- getMetaComponents() - Method in interface com.funnelback.publicui.search.model.collection.SearchPackageConfig
-
Returns the list of component collections for the current collection
- getMetadata() - Method in interface com.funnelback.filter.api.documents.NoContentDocument
-
Metadata of the document.
- getMetadataTags() - Method in interface com.funnelback.plugin.details.PluginDetails
-
Define a list of metadata tags describing purpose of plugin See
ProductSubtopic - getMetadataTags() - Method in interface com.funnelback.plugin.PluginUtilsBase
- getMinor() - Method in interface com.funnelback.publicui.search.model.transaction.FunnelbackVersionI
- getOptions() - Method in class com.funnelback.publicui.search.model.transaction.PriorityQueryProcessorOptions
- getPluginDescription() - Method in interface com.funnelback.plugin.details.PluginDetails
-
Define plugin short description or summary with purpose of usage to display in plugin configuration admin UI and in auto-generated documentation
- getPluginId() - Method in interface com.funnelback.plugin.details.model.PluginDetailsBase
- getPluginName() - Method in interface com.funnelback.plugin.details.PluginDetails
-
Define human-readable plugin name to display in plugin configuration admin UI and in auto-generated documentation
- getPluginTarget() - Method in interface com.funnelback.plugin.details.PluginDetails
-
Define target for which plugin is executed and source meta tag "plugin-scope" in auto-generated documentation
- getProductSubtopic() - Method in interface com.funnelback.plugin.docs.PluginDocsDetails
-
Define a list of tags to display in documentation as meta tag "product-subtopic" and source metadata tags about plugin
- getProductTopic() - Method in interface com.funnelback.plugin.docs.PluginDocsDetails
-
Define a list of tags to display in documentation as meta tag "product-topic"
- getProfile() - Method in interface com.funnelback.plugin.index.IndexConfigProviderContext
- getProfileWithView() - Method in interface com.funnelback.plugin.index.IndexConfigProviderContext
-
When the plugin is called for a profile, this will be set to the profile and view value which is used in the profile parameter in the modern UI.
- getQueryStringMapCopy() - Method in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Query string parameters as a Map
- getRawKeys() - Method in interface com.funnelback.publicui.search.model.collection.ServiceConfig
- getResultsWithTierBars() - Method in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Get the results and the tier bars mixed together.
- getRevision() - Method in interface com.funnelback.publicui.search.model.transaction.FunnelbackVersionI
- getSearchHome() - Method in interface com.funnelback.plugin.PluginBaseContext
-
The home of the Funnelback installation currently being used to perform filtering.
- getSearchParams() - Method in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
- getSelectedValues() - Method in class com.funnelback.publicui.search.model.transaction.Facet
- getSetup() - Method in interface com.funnelback.common.filter.jsoup.FilterContext
-
A representation of the setup details for this filter.
- getShowIfKeyHasValue() - Method in interface com.funnelback.plugin.details.model.PluginConfigKeyDetails
- getString(Map<String, String>, Object, String) - Static method in class com.funnelback.publicui.utils.MapUtils
- getSuggestionQueryResult(SuggestionQuery) - Method in interface com.funnelback.plugin.search.SearchLifeCycleContext
-
To query PADRE to get a query suggestion for query completion
- getTarget() - Method in enum com.funnelback.plugin.details.model.PluginTarget
- getTopic() - Method in enum com.funnelback.plugin.docs.model.ProductSubtopic.AnalyticsReporting
- getTopic() - Method in enum com.funnelback.plugin.docs.model.ProductSubtopic.ApplicationAdministration
- getTopic() - Method in enum com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- getTopic() - Method in enum com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
- getTopic() - Method in enum com.funnelback.plugin.docs.model.ProductSubtopic.IntegrationDevelopment
- getTopic() - Method in enum com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- getTopic() - Method in enum com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- getTopic() - Method in interface com.funnelback.plugin.docs.model.ProductSubtopicCategory
- getTotalLinkCount() - Method in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- getTransformer(String) - Static method in class com.funnelback.common.utils.SharedXMLUtils
-
Get a transformer that can be used for transforming a Document back out into an output stream.
- getType(FacetSelectionType, FacetConstraintJoin, FacetValues) - Static method in enum com.funnelback.publicui.search.model.transaction.facet.FacetDisplayType
- getURI() - Method in interface com.funnelback.filter.api.documents.NoContentDocument
-
The URI of the document.
- getWin() - Method in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureCategory
- GLOBAL_CONFIGURATION - com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- groupAndCounts - Variable in class com.funnelback.publicui.search.model.padre.UniqueByGroup
-
Holds the count of distinct values in a group.
- groupAndSums - Variable in class com.funnelback.publicui.search.model.padre.SumByGroup
-
Holds the sum of numeric values in a group
- GSCOPE1 - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Gscope constraint
- GscopeByQueryConsumer - Interface in com.funnelback.plugin.index.consumers
- GscopeByRegexConsumer - Interface in com.funnelback.plugin.index.consumers
- gScopeCounts - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
GScope counts (Used in faceted navigation)
- gscopesSet - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Set of GScope Numbers that this result has.
- guessedDisplayType - Variable in class com.funnelback.publicui.search.model.transaction.Facet
-
The guessed type of the facet based on its configuration.
H
- hashCode() - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- hasNonTabFacets - Variable in class com.funnelback.publicui.search.model.transaction.FacetExtras
-
true if
SearchResponse#getFacets()has facets which do not have a guessed display type ofFacetDisplayType.TAB - hasResultPacket() - Method in class com.funnelback.publicui.search.model.transaction.SearchResponse
- hasResults() - Method in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Test if the packet contains results.
- hasSelectedNonTabFacets - Variable in class com.funnelback.publicui.search.model.transaction.FacetExtras
-
true if
SearchResponse#getFacets()has selected facets which do not have a guessed display type ofFacetDisplayType.TAB - hasValues() - Method in class com.funnelback.publicui.search.model.transaction.Facet
-
Recursively check if this facet has any value at all.
- Header() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Header
- hintCollections - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.ContentOptimiserModel
- hintCollectionsByName - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.ContentOptimiserModel
- hints - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureCategory
- hintsByName - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.ContentOptimiserModel
- hintsByWin - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.ContentOptimiserModel
- hintTexts - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- HOST - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Header
-
Header used to provide the server hostname which was requested.
- hostname - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Name of the host where PADRE executed the query.
- href - Variable in class com.funnelback.publicui.search.model.padre.Cluster
-
Link to run a query using this cluster as query terms.
- html - Variable in class com.funnelback.plugin.index.model.querycompletion.display.HTMLFragment
- HTML - Variable in class com.funnelback.filter.api.DocumentType._DocumentType
- HTML_OR_HTTP_HEADERS - com.funnelback.plugin.index.model.metadatamapping.MetadataSourceType
-
Used when the metadata can come from either HTTP headers or from HTML metadata.
- HTMLFragment - Class in com.funnelback.plugin.index.model.querycompletion.display
-
An auto-completion display type which displays an HTML fragment as the suggestion.
- HTMLFragment() - Constructor for class com.funnelback.plugin.index.model.querycompletion.display.HTMLFragment
I
- id - Variable in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- id - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyBase
-
ID of a key to create a plugin configuration key For example, to create - key `plugin.pluginID.config.foo` provide `id="foo"` - key `plugin.pluginID.config.foo.bar` provide `id="foo.bar"` - key with wildcard `plugin.pluginID.config.foo.*` provide `id="foo.*"` - key with wildcard `plugin.pluginID.config.foo.*.baz` provide `id="foo.*.baz"` - key with wildcard `plugin.pluginID.config.foo.*.baz.*` provide `id="foo.*.baz
- id - Variable in class com.funnelback.publicui.search.model.padre.CoolerWeighting
-
Identifier
- id - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchUser
-
Unique identifier of the user
- IJSoupFilter - Interface in com.funnelback.common.filter.jsoup
-
Interface for filtering steps applied by JSoupProcessingFilterProvider.
- impersonated - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Whether the request is impersonated (Document Level Security)
- includeScopes - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Scopes (URL prefixes, not Gscope) included via the
scopequery processor option. - INDEX_ALL_UNMAPPED_AS_CONTENT - com.funnelback.plugin.index.model.indexingconfig.WhenNoContentPathsAreSet
- INDEX_MANIPULATION - com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
- INDEX_URL - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click
-
URL of the target in the index (maybe different to the redirect URL).
- INDEX_URL - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click.Result
-
URL of the result in the index
- IndexConfigProviderContext - Interface in com.funnelback.plugin.index
- indexedTermCounts - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
A list containing the counts of term occurrences in a metadata class.
- IndexedTermCounts - Class in com.funnelback.publicui.search.model.padre
-
Holds the count of each indexed term for a metadata class 'metadataClass'.
- IndexedTermCounts() - Constructor for class com.funnelback.publicui.search.model.padre.IndexedTermCounts
- Indexing() - Constructor for enum com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
- INDEXING - com.funnelback.plugin.docs.model.MarketplaceSubtype
- INDEXING - com.funnelback.plugin.docs.model.ProductTopic
- IndexingConfigProvider - Interface in com.funnelback.plugin.index
-
An interface that may be implemented in a plugin to control indexing.
- indexUrl - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Original URL from the index, taken from indexUrl before any transformation.
- indexUrl - Variable in class com.funnelback.publicui.search.model.transaction.session.SessionResult
-
URI of the result in the index
- indexUrl - Variable in class com.funnelback.publicui.search.model.transaction.session.SessionResultPK
- InnerDocumentPath - Class in com.funnelback.plugin.index.model.indexingconfig
- InnerDocumentPath() - Constructor for class com.funnelback.plugin.index.model.indexingconfig.InnerDocumentPath
- innerDocumentPaths - Variable in class com.funnelback.plugin.index.model.indexingconfig.XmlIndexingConfig
-
Maps an element withing an XML document which contains a (XML escaped) document that may itself be HTML/XML/text. e.g.
- inputParameters - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Raw input parameters
- InputProcessorError - com.funnelback.publicui.search.model.transaction.SearchError.Reason
- INSTALLATION - com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- INTEGER - com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- INTEGER_TO_STRING - Static variable in class com.funnelback.publicui.search.model.util.map.Converters
- INTEGRATION_DEVELOPMENT - com.funnelback.plugin.docs.model.ProductTopic
- IntegrationDevelopment() - Constructor for enum com.funnelback.plugin.docs.model.ProductSubtopic.IntegrationDevelopment
- InternalFilterContext - Interface in com.funnelback.filter.api
-
An immutable context supplied to the product filters and contains tools to read collection configuration files This interface is only used for product build-in filters Dev should only implement methods from
FilterContextAnd must not implement methods with the same name as methods declared in this interface - internalLinkCount - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- InvalidCollection - com.funnelback.publicui.search.model.transaction.SearchError.Reason
- isDecimalPoint(char) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.ByStringAsNumberComparator
- isDigit(char) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.ByStringAsNumberComparator
- isEmpty() - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- isEmpty() - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- isEmpty() - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- isExtraSearch() - Method in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Deprecated.As of release 14.2, replaced by
SearchQuestion.questionType - isHTML() - Method in interface com.funnelback.filter.api.DocumentType
- isInteresting() - Method in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- isJSON() - Method in interface com.funnelback.filter.api.DocumentType
- isNumberSeparator(char) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.ByStringAsNumberComparator
- isoCode - Variable in class com.funnelback.publicui.search.model.geolocation.Location.Subdivision
-
The ISO-3166-2 code of the subdivision.
- isSelected() - Method in class com.funnelback.publicui.search.model.transaction.Facet
- isXML() - Method in interface com.funnelback.filter.api.DocumentType
J
- JavaScriptCallbackAction - Class in com.funnelback.plugin.index.model.querycompletion.action
-
An auto-completion action type which executes the given JavaScript code when the completion is selected.
- JavaScriptCallbackAction() - Constructor for class com.funnelback.plugin.index.model.querycompletion.action.JavaScriptCallbackAction
- JavaScriptCallbackDisplay - Class in com.funnelback.plugin.index.model.querycompletion.display
-
An auto-completion display type which invokes a JavaScript callback which is expected to return HTML, which is then used as the display.
- JavaScriptCallbackDisplay() - Constructor for class com.funnelback.plugin.index.model.querycompletion.display.JavaScriptCallbackDisplay
- json - Variable in class com.funnelback.plugin.index.model.querycompletion.display.JSONData
- JSON - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- JSON - Variable in class com.funnelback.filter.api.DocumentType._DocumentType
- JSONData - Class in com.funnelback.plugin.index.model.querycompletion.display
-
An auto-completion display type which provides JSON data which can be templated within the auto-completion's javascript code as required.
- JSONData() - Constructor for class com.funnelback.plugin.index.model.querycompletion.display.JSONData
K
- key - Variable in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- keyConverter - Variable in class com.funnelback.publicui.search.model.util.map.AutoConvertingMap
- keys - Variable in class com.funnelback.publicui.utils.MapKeyFilter
- keySet() - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- keySet() - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- keySet() - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- killByExactMatch(IndexConfigProviderContext, KillByExactMatchConsumer) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Supply URLs to kill by exact match.
- killByExactMatch(String) - Method in interface com.funnelback.plugin.index.consumers.KillByExactMatchConsumer
- KillByExactMatchConsumer - Interface in com.funnelback.plugin.index.consumers
- killByPartialMatch(IndexConfigProviderContext, KillByPartialMatchConsumer) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Supply URLs to kill by partial match.
- killByPartialMatch(String) - Method in interface com.funnelback.plugin.index.consumers.KillByPartialMatchConsumer
- KillByPartialMatchConsumer - Interface in com.funnelback.plugin.index.consumers
- killByQueryMatch(IndexConfigProviderContext, KillByQueryMatchConsumer) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Supply queries to return a list of URLs to kill For example, to kill all documents matching query 'example' call:
- killByQueryMatch(String) - Method in interface com.funnelback.plugin.index.consumers.KillByQueryMatchConsumer
-
A plugin may call this to kill the URL(s) returned by a given query.
- KillByQueryMatchConsumer - Interface in com.funnelback.plugin.index.consumers
- kmFromOrigin - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Distance in kilometres of this search result from the origin set when the query is run.
- KNOWLEDGE_GRAPH - com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
- knownNumberSpaces() - Static method in class com.funnelback.publicui.search.model.transaction.facet.order.ByStringAsNumberComparator
L
- label - Variable in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- label - Variable in class com.funnelback.plugin.details.model.PluginConfigFile
-
Label for plugin configuration file to display in plugin configuration admin UI
- label - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyBase
-
Label for plugin configuration key to display in plugin configuration admin UI
- label - Variable in class com.funnelback.publicui.search.model.padre.Cluster
-
Label of this suggestion (Ex: "...
- label - Variable in class com.funnelback.publicui.search.model.padre.ClusterNav
-
Label for this navigation item, such as "King Richard".
- label - Variable in class com.funnelback.publicui.search.model.transaction.Facet.CategoryValue
-
Label of the value, usually the same as the data.
- LABEL_AS_NUMBER_ASCENDING - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Values are sorted by the first number found in the label, in increasing value.
- LABEL_AS_NUMBER_DESCENDING - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Values are sorted by the first number found in the label, in decreasing value.
- LABEL_ASCENDING - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Sort the values by lexicographically comparing the lowercase equivalent of the label, with lower values first e.g. a before b.
- LABEL_DESCENDING - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Sort the values by lexicographically comparing the lowercase equivalent of the label, with higher values first e.g. b before a.
- LANG - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Parameter to specify the locale of the search query
- LANG_UI - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Parameter to specify the locale of the UI only
- lastRank - Variable in class com.funnelback.publicui.search.model.padre.TierBar
-
Rank of the last search result contained within this tier bar
- latitude - Variable in class com.funnelback.publicui.search.model.geolocation.Location
-
The latitude of the represented location.
- latitude - Variable in class com.funnelback.publicui.search.model.padre.GeoBoundingBox.LatLong
- LatLong() - Constructor for class com.funnelback.publicui.search.model.padre.GeoBoundingBox.LatLong
- LEGACY - com.funnelback.common.facetednavigation.models.FacetConstraintJoin
-
Constraints are joined in the same way as version 15.10 and before did.
- len - Variable in class com.funnelback.publicui.search.model.transaction.cache.CacheQuestion
-
Length of the document in the WARC file
- LENGTH - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Cache
-
Length of the file to read
- lenratio - Variable in class com.funnelback.publicui.search.model.padre.Explain
-
The length ratio of this document relative to the average document, measured in content words
- level - Variable in class com.funnelback.publicui.search.model.padre.ClusterNav
-
Level of this navigation item.
- linkAnchortext - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDetail
- linkAnchorText - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- linksTo - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- linkTo(String) - Method in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- linkType - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- linkTypePattern - Static variable in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- linkUrl - Variable in class com.funnelback.publicui.search.model.curator.data.UrlAdvert
-
The URL to which the user should be taken if the advert is clicked.
- listMetadata - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Multi-Map containing the list of metadata values for each metadata field for each result.
- listMetadataSeparators - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Multi-Map containing the separators originally used by the metadata values within in newMetadata.
- LIVE_URL - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click.Result
-
Live URL to access the result
- liveUrl - Variable in class com.funnelback.publicui.search.model.padre.Result
-
URL to access the search result.
- liveUrl - Variable in class com.funnelback.publicui.search.model.padre.RMCItemResult
-
URL to access the search result.
- locale - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Localeto use for the search. - LOCALIZATION - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- location - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Locationinformation detected for the remote user based on information from their request. - Location - Class in com.funnelback.publicui.search.model.geolocation
-
This class represents a location along with a range of 'names' which apply to it, such as countries, cities, postalCodes etc.
- Location() - Constructor for class com.funnelback.publicui.search.model.geolocation.Location
- Location.Subdivision - Class in com.funnelback.publicui.search.model.geolocation
- logger - Static variable in interface com.funnelback.filter.api.documents.StringDocument
- LOGGING - com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- logQuery - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Defines if the query should be logged or not, or if it should fall back to default.
- LONG - com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- longDescription - Variable in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- longDescription - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyBase
-
Longer description of plugin configuration key to display in plugin auto-generated documentation
- longitude - Variable in class com.funnelback.publicui.search.model.geolocation.Location
-
The longitude of the represented location.
- longitude - Variable in class com.funnelback.publicui.search.model.padre.GeoBoundingBox.LatLong
- longName - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- lowerLeft - Variable in class com.funnelback.publicui.search.model.padre.GeoBoundingBox
M
- makeComparatorChain(List<FacetValuesOrder>, Optional<Comparator<Facet.CategoryValue>>) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.FacetComparatorProvider
-
Creates a comparator by chaining the wanted comparators.
- map - Variable in class com.funnelback.publicui.utils.SingleValueMapWrapper
- map(String, MetadataType, MetadataSourceType, String) - Method in interface com.funnelback.plugin.index.consumers.MetadataMappingConsumer
- MapKeyFilter - Class in com.funnelback.publicui.utils
-
Filters the keys of a Map depending of a regex.
- MapKeyFilter(ListMultimap<String, ?>) - Constructor for class com.funnelback.publicui.utils.MapKeyFilter
- MapKeyFilter(Map<String, ?>) - Constructor for class com.funnelback.publicui.utils.MapKeyFilter
- MapUtils - Class in com.funnelback.publicui.utils
- MapUtils() - Constructor for class com.funnelback.publicui.utils.MapUtils
- MarketplaceSubtype - Enum in com.funnelback.plugin.docs.model
-
Source documentation meta tag "marketplace-subtype"
- MarketplaceSubtype() - Constructor for enum com.funnelback.plugin.docs.model.MarketplaceSubtype
- marshal(Object, HierarchicalStreamWriter, MarshallingContext) - Method in class com.funnelback.publicui.xml.AutoConvertingMapXStreamConverter
- marshal(Object, HierarchicalStreamWriter, MarshallingContext) - Method in class com.funnelback.publicui.xml.FacetConverter
- matched - Variable in class com.funnelback.publicui.search.model.padre.TierBar
-
Number of query terms matched by this tier bar
- matchesSemver(String) - Static method in class com.funnelback.plugin.PluginUtil
- MAX_LEN_METADATA - Static variable in class com.funnelback.publicui.search.model.transaction.session.SessionResult
-
Size of the column holding metadata fields
- MAX_LEN_SUMMARY - Static variable in class com.funnelback.publicui.search.model.transaction.session.SessionResult
-
Size of the column holding the summary
- MAX_QUERY_LENGTH - Static variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
- MAX_URLS_PER_PAGE - Static variable in class com.funnelback.publicui.search.model.anchors.AnchorDetail
- maximum - Variable in class com.funnelback.publicui.search.model.padre.Range
-
The maximum value in the range
- maxPadrePacketSize - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
An optional maxPadrePacketSize which may be overridden to set the max Padre packet size that will be permitted.
- maxScore - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- maybeMultiword - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureMaxPossibleMultiWordOnly
- Message - Class in com.funnelback.publicui.search.model.curator.data
-
Message represents a 'message' added by curator to be displayed within the search results.
- Message() - Constructor for class com.funnelback.publicui.search.model.curator.data.Message
- messageHtml - Variable in class com.funnelback.publicui.search.model.curator.data.Message
-
The HTML content of the message to display.
- messages - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.ContentOptimiserModel
- metadata - Variable in class com.funnelback.publicui.search.model.related.RelatedDocument
- metaData - Variable in class com.funnelback.publicui.search.model.transaction.session.CartResult
-
Metadata values for the result
- metaData - Variable in class com.funnelback.publicui.search.model.transaction.session.ClickHistory
-
Metadata values for the result at the time the result was first clicked by the user.
- METADATA - com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- METADATA - com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
- METADATA_BUFFER_LENGTH - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Maximum bytes of metadata to return per result
- metadataClass - Variable in class com.funnelback.publicui.search.model.padre.IndexedTermCounts
-
The metadata class the terms are indexed under.
- MetadataMappingConsumer - Interface in com.funnelback.plugin.index.consumers
- metadataMappings(IndexConfigProviderContext, MetadataMappingConsumer) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Supply additional metadata mappings from the plugin.
- metadataRanges - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Metadata ranges.
- MetadataSourceType - Enum in com.funnelback.plugin.index.model.metadatamapping
- MetadataSourceType() - Constructor for enum com.funnelback.plugin.index.model.metadatamapping.MetadataSourceType
- metadataSums - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
A map of the numeric metadata to total of that numeric metadata in the result set
- MetadataType - Enum in com.funnelback.plugin.index.model.metadatamapping
- MetadataType() - Constructor for enum com.funnelback.plugin.index.model.metadatamapping.MetadataType
- metaParameters - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
meta_*/query_*input parameters, transformed in query expressions. - metroCode - Variable in class com.funnelback.publicui.search.model.geolocation.Location
-
The metro code of the represented location if it can be determined, otherwise zero.
- MIME_APPLICATION_JSON_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType
-
Simple json MIME type which should be used when a filter converts a document to json.
- MIME_CSV_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType
-
Standard CSV MIME type which should be used when a filter converts a document to CSV
- MIME_HTML_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType
-
Simple html MIME type which should be used when a filter converts a document to html.
- MIME_TEXT_PLAIN - Static variable in interface com.funnelback.filter.api.DocumentType
-
A document type for plain text documents.
- MIME_UNKNOWN - Static variable in interface com.funnelback.filter.api.DocumentType
-
A mime type that is unknown.
- MIME_XHTML_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType
-
Deprecated.
- MIME_XHTML_XML - Static variable in interface com.funnelback.filter.api.DocumentType
-
Simple xhtml MIME type which should be used when a filter converts a document to xhtml.
- MIME_XML_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType
-
Simple xml MIME type which should be used when a filter converts a document to xml.
- minimum - Variable in class com.funnelback.publicui.search.model.padre.Range
-
The minimum value in the range
- minScore - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- MissingParameter - com.funnelback.publicui.search.model.transaction.SearchError.Reason
- MONITORING - com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- more - Variable in class com.funnelback.publicui.search.model.padre.Category
-
Number of additional values of this categories, if any.
- moreLink - Variable in class com.funnelback.publicui.search.model.padre.Category
-
Link to get more values for this category.
- MULTI_SERVER_CONFIGURATION - com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- MultimapToSingleStringMapWrapper - Class in com.funnelback.publicui.utils
- MultimapToSingleStringMapWrapper(ListMultimap<String, String>, ListMultimap<String, String>, ListMultimap<String, String>) - Constructor for class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- MULTIPLE - com.funnelback.common.facetednavigation.models.FacetSelectionType
-
When a category value is selected other category values are left selected.
N
- name - Variable in class com.funnelback.plugin.details.model.PluginConfigFile
-
Plugin configuration file name For example: rules.json, properties.cfg
- name - Variable in class com.funnelback.publicui.search.model.collection.QueryProcessorOption
-
QPO name
- name - Variable in class com.funnelback.publicui.search.model.facetednavigation.FacetParameter
-
The name of the facet to which this selection applies.
- name - Variable in class com.funnelback.publicui.search.model.geolocation.Location.Subdivision
-
The name of the subdivision.
- name - Variable in class com.funnelback.publicui.search.model.padre.Category
-
Name of the category ("type", "topic" or "site").
- name - Variable in class com.funnelback.publicui.search.model.padre.CoolerWeighting
-
Short name, e.g.
- name - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- name - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureCategory
- name - Variable in class com.funnelback.publicui.search.model.transaction.Facet
-
Facet name, for example "Location"
- NamedFilter - Interface in com.funnelback.filter.api.filters
-
Gives a name to filters for clearer logging.
- nextStart - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Offset of the first result of the next page of results.
- NOATTACHMENT - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click
-
Used in automated tests, in click tracking, to return directly the content of a file instead of redirecting to it.
- NoContentDocument - Interface in com.funnelback.filter.api.documents
-
A document which may have its non-content parts inspected.
- NOOP_ENTITY_RESOLVER - Static variable in class com.funnelback.common.utils.SharedXMLUtils
- NoOpEntityResolver() - Constructor for class com.funnelback.common.utils.SharedXMLUtils.NoOpEntityResolver
- note - Variable in class com.funnelback.publicui.search.model.util.map.AutoConvertingMap
- NUM_RANKS - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Number of results per page
- NUMERICAL - com.funnelback.plugin.index.model.metadatamapping.MetadataType
- numRanks - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Number of results returned.
- numRanks - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
Number of results per page
O
- of(FilterableDocument) - Static method in class com.funnelback.filter.api.FilterResult
-
Returned by a filter when it has filtered a document returning a single document.
- of(Collection<? extends FilterableDocument>) - Static method in class com.funnelback.filter.api.FilterResult
-
Returned by a filter when it has filtered a document into many documents.
- off - Variable in class com.funnelback.publicui.search.model.transaction.cache.CacheQuestion
-
Offset of the document in the WARC file
- OFFSET - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Cache
-
Offset where to read the file from
- ofNullableSingle(T) - Static method in class com.funnelback.publicui.search.model.transaction.Facet
-
Clone from com.funnelback.common.function.StreamUtils.ofNullableSingle(T)
- on - Variable in class com.funnelback.publicui.search.model.padre.SumByGroup
-
The numeric metadata class being summed.
- on - Variable in class com.funnelback.publicui.search.model.padre.UniqueByGroup
-
The metadata class being counted.
- ONESHOT - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Special parameter to redirect directly to the first result
- OpenUrl - Class in com.funnelback.plugin.index.model.querycompletion.action
-
An auto-completion action type which directly opens the given URL rather than changing the search page.
- OpenUrl(String) - Constructor for class com.funnelback.plugin.index.model.querycompletion.action.OpenUrl
-
Convenience constructor which converts the given string to a URI.
- optimiserModel - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
Content Optimiser: URL comparison data.
- OR - com.funnelback.common.facetednavigation.models.FacetConstraintJoin
-
Requires that at least one of the selected constraints are met.
- order - Variable in class com.funnelback.publicui.search.model.transaction.Facet
- Order - Enum in com.funnelback.publicui.search.model.transaction.facet.order
- Order() - Constructor for enum com.funnelback.publicui.search.model.transaction.facet.order.Order
- origin - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Origin of the search, for geographical searches.
- ORIGIN - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Parameter specifying the origin point for the search request
- originalQuery - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Original query, as entered by the user.
- originalQuery - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
Original query as entered by the user
- outOf - Variable in class com.funnelback.publicui.search.model.padre.TierBar
-
Total number of query terms, including the one matched by this tier bar.
- OutputProcessorError - com.funnelback.publicui.search.model.transaction.SearchError.Reason
P
- PADRE - com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- padreElapsedTime - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Time spent by PADRE processing the query, in milliseconds
- padreSwCmd - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
The padre-sw command run to execute the query used to generate this search response.
- PadreSwCmd - Interface in com.funnelback.publicui.search.model.transaction.padrecmd
-
The search transaction only knows about this.
- padreTimeout - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
An optional timeout which when set overrides the value of collection.cfg option ui.modern.padre_fork_timeout_ms, which controls how long the main padre forking may take.
- padreVersion - Variable in class com.funnelback.publicui.search.model.padre.Details
-
Version of the PADRE query processor.
- paragraph - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Number of paragraphs in the document
- parentTransaction - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Holds the parent search transaction from which this search transaction was created under.
- partiallyMatching - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Number of documents that partially matched the query terms.
- partialQuery - Variable in class com.funnelback.plugin.search.model.SuggestionQuery
-
Initial query term for requesting suggestion
- PASSWORD - com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- PATCHING - com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- path - Variable in class com.funnelback.plugin.index.model.indexingconfig.ContentPath
- path - Variable in class com.funnelback.plugin.index.model.indexingconfig.DocumentPath
- path - Variable in class com.funnelback.plugin.index.model.indexingconfig.FileTypePath
- path - Variable in class com.funnelback.plugin.index.model.indexingconfig.InnerDocumentPath
- path - Variable in class com.funnelback.plugin.index.model.indexingconfig.UrlPath
- PERFORMANCE - com.funnelback.plugin.docs.model.ProductSubtopic.IntegrationDevelopment
- performanceMetrics - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
Performance metrics of each phase of the transaction lifecycle
- PERSONALIZATION - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- phlusterElapsedTime - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Time spent by PADRE processing contextual navigation, in seconds.
- PlainText - Class in com.funnelback.plugin.index.model.querycompletion.display
-
An auto-completion display type which provides some plain text which will be displayed as the auto-completion suggestion.
- PlainText() - Constructor for class com.funnelback.plugin.index.model.querycompletion.display.PlainText
- PLUGIN - com.funnelback.plugin.docs.model.ProductSubtopic.IntegrationDevelopment
- PLUGIN_CONFIG_QUALIFIER - Static variable in interface com.funnelback.plugin.details.model.PluginDetailsBase
- PLUGIN_ENCRYPTED_QUALIFIER - Static variable in interface com.funnelback.plugin.details.model.PluginDetailsBase
- PLUGIN_PREFIX - Static variable in interface com.funnelback.plugin.details.model.PluginDetailsBase
- PluginBaseConfigContext - Interface in com.funnelback.plugin
- PluginBaseConfigFileContext - Interface in com.funnelback.plugin
- PluginBaseContext - Interface in com.funnelback.plugin
- PluginConfigFile - Class in com.funnelback.plugin.details.model
-
Defines plugin configuration file properties For example, to define JSON file
- PluginConfigFile() - Constructor for class com.funnelback.plugin.details.model.PluginConfigFile
- PluginConfigKey<T> - Class in com.funnelback.plugin.details.model
-
Defines plugin configuration key properties For example, to define configuration key 'plugin.pluginID.config.foo.*'
- PluginConfigKey(String, String, String, String, boolean, PluginConfigKeyType, T, PluginConfigKeyAllowedValue<T>, PluginConfigKeyConditional) - Constructor for class com.funnelback.plugin.details.model.PluginConfigKey
- PluginConfigKey(String, String, String, String, String, boolean, PluginConfigKeyType, T, PluginConfigKeyAllowedValue<T>, PluginConfigKeyConditional) - Constructor for class com.funnelback.plugin.details.model.PluginConfigKey
- PluginConfigKeyAllowedValue<T> - Class in com.funnelback.plugin.details.model
-
Define plugin configuration key allowed value To define fixed list of allowed values, set `values`
PluginConfigKeyAllowedValue.values. - PluginConfigKeyAllowedValue() - Constructor for class com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue
-
This private constructor is required for JSOM deserializer
- PluginConfigKeyAllowedValue(List<T>) - Constructor for class com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue
- PluginConfigKeyAllowedValue(Pattern) - Constructor for class com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue
- PluginConfigKeyAllowedValue.AllowedType - Enum in com.funnelback.plugin.details.model
- PluginConfigKeyBase - Class in com.funnelback.plugin.details.model
- PluginConfigKeyBase(String, String, String, String, boolean, PluginConfigKeyType) - Constructor for class com.funnelback.plugin.details.model.PluginConfigKeyBase
- PluginConfigKeyBase(String, String, String, String, String, boolean, PluginConfigKeyType) - Constructor for class com.funnelback.plugin.details.model.PluginConfigKeyBase
- PluginConfigKeyConditional<T> - Class in com.funnelback.plugin.details.model
-
Define plugin configuration keys' dependency on each other to display it in plugin configuration admin UI and in auto-generated documentation.
- PluginConfigKeyConditional() - Constructor for class com.funnelback.plugin.details.model.PluginConfigKeyConditional
- PluginConfigKeyDetails<T> - Interface in com.funnelback.plugin.details.model
- PluginConfigKeyDetailsDeserializer<T> - Class in com.funnelback.plugin.details.model.deserializer
-
This class is used to deserialize objects which implement the PluginConfigKeyDetails class It is required because during the serialization process a pluginId and id are converted to the "key" JsonProperty
- PluginConfigKeyDetailsDeserializer() - Constructor for class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- PluginConfigKeyEncrypted - Class in com.funnelback.plugin.details.model
-
Defines plugin configuration key properties for storing secret information (like passwords) For example, to define configuration key 'plugin.pluginID.encrypted.token'
- PluginConfigKeyEncrypted(String, String, String, String, boolean) - Constructor for class com.funnelback.plugin.details.model.PluginConfigKeyEncrypted
- PluginConfigKeyEncrypted(String, String, String, String, String, boolean) - Constructor for class com.funnelback.plugin.details.model.PluginConfigKeyEncrypted
- PluginConfigKeyType - Class in com.funnelback.plugin.details.model
-
Define a type of plugin configuration key For example, if key value is expected to be `true` or `false`
- PluginConfigKeyType(PluginConfigKeyType.Format) - Constructor for class com.funnelback.plugin.details.model.PluginConfigKeyType
- PluginConfigKeyType(PluginConfigKeyType.Format, PluginConfigKeyType.Format) - Constructor for class com.funnelback.plugin.details.model.PluginConfigKeyType
- PluginConfigKeyType.Format - Enum in com.funnelback.plugin.details.model
-
Allowed types of plugin configuration key
- pluginConfigurationFile(String) - Method in interface com.funnelback.filter.api.FilterContext
-
Reads a configuration file for the currently running plugin as a UTF-8 String.
- pluginConfigurationFile(String) - Method in interface com.funnelback.plugin.PluginBaseConfigFileContext
-
Reads a configuration file for the currently running plugin as a UTF-8 String.
- pluginConfigurationFileAsBytes(String) - Method in interface com.funnelback.filter.api.FilterContext
-
Reads a configuration file for the currently running plugin.
- pluginConfigurationFileAsBytes(String) - Method in interface com.funnelback.plugin.PluginBaseConfigFileContext
-
Reads a configuration file for the currently running plugin.
- PluginDetails - Interface in com.funnelback.plugin.details
- PluginDetailsBase - Interface in com.funnelback.plugin.details.model
- PluginDocsDetails - Interface in com.funnelback.plugin.docs
- PluginGatherContext - Interface in com.funnelback.plugin.gatherer
- PluginGatherer - Interface in com.funnelback.plugin.gatherer
-
A plugin may implement this if the plugin is to support gathering of documents.
- pluginId - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyBase
-
ID of a current plugin
- PluginStore - Interface in com.funnelback.plugin.gatherer
- PluginTarget - Enum in com.funnelback.plugin.details.model
- PluginTarget() - Constructor for enum com.funnelback.plugin.details.model.PluginTarget
- PluginUtil - Class in com.funnelback.plugin
- PluginUtil() - Constructor for class com.funnelback.plugin.PluginUtil
- PluginUtilsBase - Interface in com.funnelback.plugin
- postalCode - Variable in class com.funnelback.publicui.search.model.geolocation.Location
-
The postal code of the represented location if it can be determined, otherwise null.
- postDatafetch(SearchLifeCycleContext, SearchTransaction) - Method in interface com.funnelback.plugin.SearchLifeCyclePlugin
-
Runs just after the
hook_post_datafetch.groovyhook which is just after the response object is populated based on the raw XML return, but before other response elements are built. - postDatafetch(SearchTransaction) - Method in interface com.funnelback.plugin.DeprecatedSearchLifeCyclePlugin
-
Deprecated.
- postFilterResponse(SearchServletFilterHookContext, ServletRequest, ServletResponse) - Method in interface com.funnelback.plugin.servlet.filter.SearchServletFilterHook
-
Allows the ServletFilterHook implementation to perform actions after Funnelback has processed the request.
- postProcess(SearchLifeCycleContext, SearchTransaction) - Method in interface com.funnelback.plugin.SearchLifeCyclePlugin
-
Runs just after the
hook_post_process.groovyhook. - postProcess(SearchTransaction) - Method in interface com.funnelback.plugin.DeprecatedSearchLifeCyclePlugin
-
Deprecated.
- preDatafetch(SearchLifeCycleContext, SearchTransaction) - Method in interface com.funnelback.plugin.SearchLifeCyclePlugin
-
Runs just after the
hook_pre_datafetch.groovyhook and after all of the input processing is complete, but just before the query is submitted. - preDatafetch(SearchTransaction) - Method in interface com.funnelback.plugin.DeprecatedSearchLifeCyclePlugin
-
Deprecated.
- preExtraSearchExecution(SearchLifeCycleContext, SearchTransaction) - Method in interface com.funnelback.plugin.SearchLifeCyclePlugin
-
Runs just after the search life cycle section
extraSearchesInputProcessorwhich adds configured extra searches fromui.modern.extra_searchesto the main search transaction. - preExtraSearchExecution(SearchTransaction) - Method in interface com.funnelback.plugin.DeprecatedSearchLifeCyclePlugin
-
Deprecated.
- PreFilterCheck - Enum in com.funnelback.filter.api.filters
- PreFilterCheck() - Constructor for enum com.funnelback.filter.api.filters.PreFilterCheck
- preFilterRequest(SearchServletFilterHookContext, ServletRequest) - Method in interface com.funnelback.plugin.servlet.filter.SearchServletFilterHook
-
Allows the ServletFilterHook implementation to perform actions on the request before it is populated by Funnelback.
- preFilterResponse(SearchServletFilterHookContext, ServletRequest, ServletResponse) - Method in interface com.funnelback.plugin.servlet.filter.SearchServletFilterHook
-
Allows the ServletFilterHook implementation to perform actions on the response before it is populated by Funnelback, or prevent further processing (by returning null).
- prePersist() - Method in class com.funnelback.publicui.search.model.transaction.session.ClickHistory
-
Truncate metadata to maximum size allowed in the database before saving to database
- prePersist() - Method in class com.funnelback.publicui.search.model.transaction.session.SessionResult
-
Truncate summary to maximum size allowed in the database before saving to database
- preProcess(SearchLifeCycleContext, SearchTransaction) - Method in interface com.funnelback.plugin.SearchLifeCyclePlugin
-
Runs just after the
hook_pre_process.groovyhook and before any input processing occurs. - preProcess(SearchTransaction) - Method in interface com.funnelback.plugin.DeprecatedSearchLifeCyclePlugin
-
Deprecated.
- prevStart - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Offset of the first result of the previous page of results.
- principal - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Principal representing the remote user for the current request.
- priorityQueryProcessorOptions - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Query processor options that are guaranteed to apply.
- PriorityQueryProcessorOptions - Class in com.funnelback.publicui.search.model.transaction
- PriorityQueryProcessorOptions() - Constructor for class com.funnelback.publicui.search.model.transaction.PriorityQueryProcessorOptions
- privateLinksTo - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDescription
- processDocument(FilterContext) - Method in interface com.funnelback.common.filter.jsoup.IJSoupFilter
-
Implement this method to perform any desired processing on the filterContext.getDocument() object before it is stored in the collection.
- ProductSubtopic - Class in com.funnelback.plugin.docs.model
-
List of subtopic types, see
ProductSubtopicCategory - ProductSubtopic() - Constructor for class com.funnelback.plugin.docs.model.ProductSubtopic
- ProductSubtopic.AnalyticsReporting - Enum in com.funnelback.plugin.docs.model
-
"Analytics and reporting" product topic
- ProductSubtopic.ApplicationAdministration - Enum in com.funnelback.plugin.docs.model
-
"Application administration" product topic
- ProductSubtopic.DataSources - Enum in com.funnelback.plugin.docs.model
-
"Search data sources" product topic
- ProductSubtopic.Indexing - Enum in com.funnelback.plugin.docs.model
-
"Search indexing" product topic
- ProductSubtopic.IntegrationDevelopment - Enum in com.funnelback.plugin.docs.model
-
"Integration and development" product topic
- ProductSubtopic.RankingSorting - Enum in com.funnelback.plugin.docs.model
-
"Search ranking and sorting" product topic
- ProductSubtopic.ResultsPage - Enum in com.funnelback.plugin.docs.model
-
"Search results pages" product topic
- ProductSubtopic.SystemAdministration - Enum in com.funnelback.plugin.docs.model
-
"System administration" product topic
- ProductSubtopicCategory - Interface in com.funnelback.plugin.docs.model
-
Source documentation meta tag "product-subtopic"
- ProductTopic - Enum in com.funnelback.plugin.docs.model
-
Source documentation meta tag "product-topic"
- ProductTopic() - Constructor for enum com.funnelback.plugin.docs.model.ProductTopic
- profile - Variable in class com.funnelback.publicui.search.model.transaction.cache.CacheQuestion
-
Profile where to lookup the cached copies template to use
- profile - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
The profile to search with, defaulting to "_default".
- PROFILE - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Search profile
- PROMOTE_URLS - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Parameter for promoting individual URLs
- promoted - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Set true if the URL was promoted using -promote_urls.
- properties - Variable in class com.funnelback.publicui.search.model.curator.data.Properties
-
The data for the Properties object.
- Properties - Class in com.funnelback.publicui.search.model.curator.data
-
Properties represents arbitrary structured data added by the curator system to be displayed within the search results.
- Properties() - Constructor for class com.funnelback.publicui.search.model.curator.data.Properties
- Public - com.funnelback.publicui.search.model.transaction.ExecutionContext
-
Deployed on Public port
- PUSH_INDEXES - com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
- put(String, String) - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- put(String, String) - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- put(K, V) - Method in class com.funnelback.publicui.search.model.util.map.AutoConvertingMap
- put(K, V) - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- putAll(Map<? extends String, ? extends String>) - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- putAll(Map<? extends String, ? extends String>) - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- putAll(Map<? extends K, ? extends V>) - Method in class com.funnelback.publicui.search.model.util.map.AutoConvertingMap
- putAll(Map<? extends K, ? extends V>) - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- putAsStringArrayIfNotNull(Map<String, String[]>, String, String) - Static method in class com.funnelback.publicui.utils.MapUtils
-
Put a String value in a map, transforming it into a 1-slot String array, and only if it's not null.
- putIfNotNull(ListMultimap<String, String>, String, String) - Static method in class com.funnelback.publicui.utils.MapUtils
- putIfNotNull(Map<String, String>, String, String) - Static method in class com.funnelback.publicui.utils.MapUtils
Q
- QIE - com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- QieByQueryConsumer - Interface in com.funnelback.plugin.index.consumers
- QieByUrlConsumer - Interface in com.funnelback.plugin.index.consumers
- QSup - Class in com.funnelback.publicui.search.model.padre
-
A supplementary query, in the query blending mechanism.
- QSup() - Constructor for class com.funnelback.publicui.search.model.padre.QSup
- QSup.Source - Enum in com.funnelback.publicui.search.model.padre
-
Query blending sources
- qSups - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
List of additional queries for the Query Blending system.
- QUERIES_LOG_ERROR - Static variable in class com.funnelback.publicui.search.model.padre.ReturnCodes
-
Error writing to
queries.log - query - Variable in class com.funnelback.publicui.search.model.padre.Cluster
-
Query term for this suggestion (Ex: "King Richard" for the query "King").
- query - Variable in class com.funnelback.publicui.search.model.padre.QSup
-
Query terms
- query - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Original query terms
- query - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Query terms.
- query - Variable in class com.funnelback.publicui.search.model.transaction.session.ClickHistory
-
Query that returned this result
- QUERY - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Query terms
- QUERY_BLENDING - com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- QUERY_LANGUAGE - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- QUERY_OPTIMIZATION - com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- QUERY_PATTERN - Static variable in class com.funnelback.publicui.search.model.padre.Cluster
-
Pattern used to find the query for this cluster from the query string.
- queryAsProcessed - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Query terms as processed by PADRE.
- queryAsProcessed - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
Query as processed by the query processor
- queryCleaned - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
The query, cleaned from any operator or constraint that was automatically added by the faceted navigation system.
- queryHighlightRegex - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Regular expression to use to highlight query terms in titles, summaries or metadata.
- queryProcessorCodes - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Indicates how the query was internally processed by PADRE.
- QueryProcessorOption<T> - Class in com.funnelback.publicui.search.model.collection
-
A PADRE query processor option, with a name and a value
- QueryProcessorOption() - Constructor for class com.funnelback.publicui.search.model.collection.QueryProcessorOption
- queryProcessorOptions - Variable in class com.funnelback.publicui.search.model.transaction.PriorityQueryProcessorOptions
- queryRaw - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Query terms as provided to PADRE by the user.
- queryStringMap - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Sets the query string parameter map.
- queryStringParamName - Variable in class com.funnelback.publicui.search.model.transaction.Facet.CategoryValue
-
Name of the query string parameter for this value (e.g.
- queryStringParamValue - Variable in class com.funnelback.publicui.search.model.transaction.Facet.CategoryValue
-
Value of the query string parameter for this value (e.g.
- querySystemRaw - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
System-generated query terms as provided to PADRE.
- queryTerm - Variable in class com.funnelback.publicui.search.model.padre.DateCount
-
Date constraint to apply to select documents for this date count, e.g.
- queryToRun - Variable in class com.funnelback.plugin.index.model.querycompletion.action.RunQuery
- question - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
The question containing the input parameters.
- questionType - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Indicates the 'type' of question, which may trigger special processing in the search lifecycle.
- QuickLink() - Constructor for class com.funnelback.publicui.search.model.padre.QuickLinks.QuickLink
- quickLinks - Variable in class com.funnelback.publicui.search.model.padre.QuickLinks
-
List of quick links
- quickLinks - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Quick links associated with the result.
- QuickLinks - Class in com.funnelback.publicui.search.model.padre
-
Quick links, associated to a
Result. - QuickLinks() - Constructor for class com.funnelback.publicui.search.model.padre.QuickLinks
- QuickLinks.QuickLink - Class in com.funnelback.publicui.search.model.padre
-
A single quick link.
R
- RADIO_BUTTON - com.funnelback.publicui.search.model.transaction.facet.FacetDisplayType
- Range - Class in com.funnelback.publicui.search.model.padre
-
A range of values (used for numeric metadata ranges)
- Range() - Constructor for class com.funnelback.publicui.search.model.padre.Range
- rank - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Rank of the result (From 1 to n)
- RANKING_SORTING - com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- RANKING_SORTING - com.funnelback.plugin.docs.model.ProductTopic
- RankingFeature - Class in com.funnelback.publicui.search.model.transaction.contentoptimiser
- RankingFeature(String, String, String) - Constructor for class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- RankingFeatureCategory - Class in com.funnelback.publicui.search.model.transaction.contentoptimiser
- RankingFeatureCategory() - Constructor for class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureCategory
- RankingFeatureMaxOther - Class in com.funnelback.publicui.search.model.transaction.contentoptimiser
- RankingFeatureMaxOther(String, String, ResultPacket) - Constructor for class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureMaxOther
- RankingFeatureMaxPossible - Class in com.funnelback.publicui.search.model.transaction.contentoptimiser
- RankingFeatureMaxPossible(String, String, ResultPacket) - Constructor for class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureMaxPossible
- RankingFeatureMaxPossibleMultiWordOnly - Class in com.funnelback.publicui.search.model.transaction.contentoptimiser
- RankingFeatureMaxPossibleMultiWordOnly(String, String, ResultPacket) - Constructor for class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeatureMaxPossibleMultiWordOnly
- RankingSorting() - Constructor for enum com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- rawPacket - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
Raw XML packet as return by PADRE, for debugging purposes.
- readCollectionConfigFile(String...) - Method in interface com.funnelback.plugin.index.IndexConfigProviderContext
-
May be used to read a file from the current collection's configuration directory.
- reason - Variable in class com.funnelback.publicui.search.model.transaction.SearchError
-
Reason for this error.
- Reason() - Constructor for enum com.funnelback.publicui.search.model.transaction.SearchError.Reason
- REFERRER - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Header
-
Header used to provide the URL of the web page from which the user accessed the search service.
- regex - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue
-
Define regular expression to run against provided plugin configuration key value to determine if a value is allowed to display in plugin configuration admin UI
- REGEX_LIST - com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue.AllowedType
- RelatedDocument - Class in com.funnelback.publicui.search.model.related
- RelatedDocument() - Constructor for class com.funnelback.publicui.search.model.related.RelatedDocument
- relatedDocuments - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Documents related to this result which have been fetched by RelatedDocumentFetcher.
- rememberScore(float, String) - Method in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- remove(Object) - Method in class com.funnelback.publicui.search.model.util.map.AutoConvertingMap
- remove(Object) - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- remove(Object) - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- remove(Object) - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- REMOVE_URLS - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Parameter for removing individual URLs
- requestHeaders - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Headers provided with the incoming search request
- requestId - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Request identifier to log for this transaction.
- RequestParameters() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
- required - Variable in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- required - Variable in class com.funnelback.plugin.details.model.PluginConfigFile
-
Mark plugin configuration file as required or optional in plugin configuration admin UI and in auto-generated documentation
- required - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyBase
-
Mark plugin configuration key as required or optional in plugin configuration admin UI and in auto-generated documentation
- resolveEntity(String, String) - Method in class com.funnelback.common.utils.SharedXMLUtils.NoOpEntityResolver
- response - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
The response containing result data.
- Result - Class in com.funnelback.publicui.search.model.padre
-
A single search result.
- Result() - Constructor for class com.funnelback.publicui.search.model.padre.Result
- Result() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click.Result
- RESULT_COLLAPSING - com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- RESULT_DIVERSIFICATION - com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- resultDiversificationApplied - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Was any result affected by result diversification.
- resultPacket - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
The result packet coming from PADRE
- ResultPacket - Class in com.funnelback.publicui.search.model.padre
-
A PADRE result packet, containing search results.
- ResultPacket() - Constructor for class com.funnelback.publicui.search.model.padre.ResultPacket
- results - Variable in class com.funnelback.publicui.search.model.padre.Collapsed
-
List of collapsed results
- results - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
List of results.
- RESULTS_PAGE - com.funnelback.plugin.details.model.PluginTarget
- RESULTS_PAGE - com.funnelback.plugin.docs.model.ProductTopic
- RESULTS_TEMPLATES - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- resultsCart - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchSession
-
Results cart of the user for the current collection
- ResultsPage() - Constructor for enum com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- resultsSummary - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Summary counts and data about the results (How many documents matched, which page is currently returned, etc.).
- ResultsSummary - Class in com.funnelback.publicui.search.model.padre
-
Search result summary, with document counts and information about the current page returned.
- ResultsSummary() - Constructor for class com.funnelback.publicui.search.model.padre.ResultsSummary
- ResultType - Interface in com.funnelback.publicui.search.model.padre
- returnCode - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
PADRE return code (0 = success)
- ReturnCodes - Class in com.funnelback.publicui.search.model.padre
-
PADRE return codes.
- ReturnCodes() - Constructor for class com.funnelback.publicui.search.model.padre.ReturnCodes
- RMCItemResult - Class in com.funnelback.publicui.search.model.padre
-
Top n results for an RMC item count (Results that would be returned is the RMC constraint is applied)
- RMCItemResult() - Constructor for class com.funnelback.publicui.search.model.padre.RMCItemResult
- rmcItemResults - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Metadata counts (Used in faceted navigation) including top n results for each count.
- rmcs - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Metadata counts (Used in faceted navigation).
- run() - Method in interface com.funnelback.common.filter.jsoup.IJSoupFilter
-
We provide a default run method, which is run when a groovy script is executed.
- RunQuery - Class in com.funnelback.plugin.index.model.querycompletion.action
-
An auto-completion action type which replaces the user's current query with the supplied one, causing a search results page with the supplied query to be shown.
- RunQuery() - Constructor for class com.funnelback.plugin.index.model.querycompletion.action.RunQuery
- RunTriggerAsQuery - Class in com.funnelback.plugin.index.model.querycompletion.action
-
An auto-completion action type which replaces the user's current query with the entry's trigger, causing a search results page for the trigger to be shown.
- RunTriggerAsQuery() - Constructor for class com.funnelback.plugin.index.model.querycompletion.action.RunTriggerAsQuery
S
- S - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
System generated query
- score - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Score of the result (From 1000 to 0)
- scores - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- SEARCH - com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
- SEARCH_GET_ALL_RESULTS - com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
- SEARCH_LIFECYCLE - com.funnelback.plugin.docs.model.MarketplaceSubtype
- SEARCH_PACKAGES - com.funnelback.plugin.docs.model.ProductTopic
- SEARCH_REFERER - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click
-
Search referrer
- SEARCH_TRENDS - com.funnelback.plugin.docs.model.ProductSubtopic.AnalyticsReporting
- searchDate - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
Date when the search was performed
- SearchError - Class in com.funnelback.publicui.search.model.transaction
-
Errors occurring during a
SearchTransaction. - SearchError() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchError
- SearchError.Reason - Enum in com.funnelback.publicui.search.model.transaction
-
Generic reasons of errors.
- searchHistory - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchSession
-
Search history of the user for the current collection.
- SearchHistory - Class in com.funnelback.publicui.search.model.transaction.session
-
A single entry in the
SearchUsersearch history - SearchHistory() - Constructor for class com.funnelback.publicui.search.model.transaction.session.SearchHistory
- SearchHistoryPK - Class in com.funnelback.publicui.search.model.transaction.session
-
Internal Primary Key class for
SearchHistory - SearchHistoryPK() - Constructor for class com.funnelback.publicui.search.model.transaction.session.SearchHistoryPK
- SearchLifeCycleContext - Interface in com.funnelback.plugin.search
-
Context for search life cycle plugin
- SearchLifeCyclePlugin - Interface in com.funnelback.plugin
-
Plugins can implement this to add logic to a search life cycle.
- SearchPackageConfig - Interface in com.funnelback.publicui.search.model.collection
- searchParams - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
URL parameters used to perform the search
- searchParamsSignature - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
Signature identifying the search URL parameters regardless of the order of the parameters or their encoding
- searchParamsSignature - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistoryPK
- SearchQuestion - Class in com.funnelback.publicui.search.model.transaction
-
This class contains all the input data related to a search.
- SearchQuestion() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchQuestion
- SearchQuestion.RequestParameters - Class in com.funnelback.publicui.search.model.transaction
-
Common query string parameters names.
- SearchQuestion.RequestParameters.Cache - Class in com.funnelback.publicui.search.model.transaction
-
Common request parameter names used in the cache controller.
- SearchQuestion.RequestParameters.Cart - Class in com.funnelback.publicui.search.model.transaction
-
Common request parameters used in the ResultsCartController
- SearchQuestion.RequestParameters.Click - Class in com.funnelback.publicui.search.model.transaction
-
Common request parameter names used in the click controller.
- SearchQuestion.RequestParameters.Click.Result - Class in com.funnelback.publicui.search.model.transaction
-
Parameter names matching the field names of the
SearchQuestion.RequestParameters.Click.Resultclass - SearchQuestion.RequestParameters.ContextualNavigation - Class in com.funnelback.publicui.search.model.transaction
-
Common request parameter names used in contextual navigation.
- SearchQuestion.RequestParameters.Header - Class in com.funnelback.publicui.search.model.transaction
-
Common request header names
- SearchQuestion.RequestParameters.Serve - Class in com.funnelback.publicui.search.model.transaction
-
Common request parameter names used in the
serve-*controllers - SearchQuestion.SearchQuestionType - Enum in com.funnelback.publicui.search.model.transaction
-
Enum for identifying special types of search requests requiring special processing
- SearchQuestionType() - Constructor for enum com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
- SearchResponse - Class in com.funnelback.publicui.search.model.transaction
-
This class contains all the output data related to a search.
- SearchResponse() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchResponse
- SearchServletFilterHook - Interface in com.funnelback.plugin.servlet.filter
-
Base class for servlet filter hooks within Funnelback's Public UI, allowing code to audit log or manipulate the request/response before it is processed/returned to the user.
- SearchServletFilterHookContext - Interface in com.funnelback.plugin.servlet.filter
- SearchSession - Class in com.funnelback.publicui.search.model.transaction.session
-
Contains data associated with the current user and search session.
- SearchSession() - Constructor for class com.funnelback.publicui.search.model.transaction.session.SearchSession
- searchTerm - Variable in class com.funnelback.publicui.search.model.padre.ContextualNavigation
-
Terms used within this contextual navigation object
- SearchTransaction - Class in com.funnelback.publicui.search.model.transaction
-
Represents a full search transaction consisting of a question, a response and possible error.
- SearchTransaction() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Build a new transaction
- SearchTransaction(SearchQuestion, SearchResponse) - Constructor for class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
Build a new transaction
- SearchTransaction.ExtraSearches - Enum in com.funnelback.publicui.search.model.transaction
-
Internal use: Keys for internal extra searches.
- searchUser - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchSession
-
User performing the search.
- SearchUser - Class in com.funnelback.publicui.search.model.transaction.session
-
User performing the search.
- SearchUser() - Constructor for class com.funnelback.publicui.search.model.transaction.session.SearchUser
- SECURITY - com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- SECURITY - com.funnelback.plugin.index.model.metadatamapping.MetadataType
- selected - Variable in class com.funnelback.publicui.search.model.transaction.Facet.CategoryValue
-
Indicates if this value is currently selected
- SELECTED_FIRST - com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Values that have been selected are sorted before those that have not been selected.
- selectedCategoryValues - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
List of selected facets categories.
- selectedDocument - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.ContentOptimiserModel
- selectedFacets - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
List of selected facets.
- selectedValues - Variable in class com.funnelback.publicui.xml.FacetConverter.FacetWithFields
- selectionType - Variable in class com.funnelback.publicui.search.model.transaction.Facet
- semverPattern - Static variable in class com.funnelback.plugin.PluginUtil
- SEO_TUNING - com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- SEP - Static variable in class com.funnelback.publicui.search.model.padre.CoolerWeighting
-
Separator between the id and the name
- separators - Variable in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- serialVersionUID - Static variable in exception com.funnelback.filter.api.filters.FilterException
- serialVersionUID - Static variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistoryPK
- serialVersionUID - Static variable in class com.funnelback.publicui.search.model.transaction.session.SearchUser
- serialVersionUID - Static variable in class com.funnelback.publicui.search.model.transaction.session.SessionResultPK
- Serve() - Constructor for class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Serve
- ServiceConfig - Interface in com.funnelback.publicui.search.model.collection
- serviceConfigProvider - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
- SERVLET_FILTER - com.funnelback.plugin.docs.model.MarketplaceSubtype
- session - Variable in class com.funnelback.publicui.search.model.transaction.SearchTransaction
-
User session data, might be null if not enabled.
- SessionResult - Class in com.funnelback.publicui.search.model.transaction.session
-
Search result base class when used in a session context
- SessionResult() - Constructor for class com.funnelback.publicui.search.model.transaction.session.SessionResult
- SessionResultPK - Class in com.funnelback.publicui.search.model.transaction.session
-
Internal Primary Key class for
SessionResult - SessionResultPK() - Constructor for class com.funnelback.publicui.search.model.transaction.session.SessionResultPK
- SESSIONS_HISTORY - com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- setConfigSetting(String, String) - Method in interface com.funnelback.common.filter.jsoup.SetupContext
-
Set the config settings for the current collection.
- setConfigSetting(String, String) - Method in interface com.funnelback.plugin.gatherer.PluginGatherContext
-
Set the config settings for the current collection.
- setExtraSearch(boolean) - Method in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
Deprecated.As of release 14.2, replaced by
SearchQuestion.questionType - setExtraSearchNameAndParentTransaction(Optional<String>, Optional<SearchTransaction>) - Method in class com.funnelback.publicui.search.model.transaction.SearchTransaction
- setHref(String) - Method in class com.funnelback.publicui.search.model.padre.Cluster
-
Sets the
Cluster.hrefof this suggestion and extracts the query terms intoCluster.query. - setIndexUrl(URI) - Method in class com.funnelback.publicui.search.model.transaction.session.SessionResult
- setOriginalQuery(String) - Method in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
- setQueryAsProcessed(String) - Method in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
- setSearchParams(String) - Method in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
Set the search parameters
- setup(SetupContext) - Method in interface com.funnelback.common.filter.jsoup.IJSoupFilter
-
Perform any setup the filter may need before process is first called.
- SetupContext - Interface in com.funnelback.common.filter.jsoup
-
Represents the 'setup' of a filter, which includes information about the Funnelback installation and collection for which documents will be filtered.
- SharedConfigKeyUtils - Class in com.funnelback.common.utils
- SharedConfigKeyUtils() - Constructor for class com.funnelback.common.utils.SharedConfigKeyUtils
- SharedQueryStringUtils - Class in com.funnelback.publicui.utils
-
Utilities for manipulating query strings.
- SharedQueryStringUtils() - Constructor for class com.funnelback.publicui.utils.SharedQueryStringUtils
- SharedXMLUtils - Class in com.funnelback.common.utils
-
Shared XML Utilities that can help parse documents and transform them in a safe way that aims to avoid common OWASP vulnerabilities.
- SharedXMLUtils() - Constructor for class com.funnelback.common.utils.SharedXMLUtils
- SharedXMLUtils.NoOpEntityResolver - Class in com.funnelback.common.utils
- showIfKeyHasValue - Variable in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- showIfKeyHasValue - Variable in class com.funnelback.plugin.details.model.PluginConfigKey
-
Defines conditional usage of plugin configuration key based on other key's value, for details see
PluginConfigKeyConditional - signature - Variable in class com.funnelback.publicui.search.model.padre.Collapsed
-
Common signature for all collapsed documents
- SINGLE - com.funnelback.common.facetednavigation.models.FacetSelectionType
-
When a category value is selected other category values of equal or lower depth are unselected.
- SINGLE_AND_UNSELECT_OTHER_FACETS - com.funnelback.common.facetednavigation.models.FacetSelectionType
-
Unselects other facets when selected, useful for tab type facets.
- SINGLE_DRILL_DOWN - com.funnelback.publicui.search.model.transaction.facet.FacetDisplayType
- SingleValueMapWrapper - Class in com.funnelback.publicui.utils
- SingleValueMapWrapper(Map<String, String[]>) - Constructor for class com.funnelback.publicui.utils.SingleValueMapWrapper
- SITE_BUILDER - com.funnelback.plugin.docs.model.Audience
- size - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDetail
- size() - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- size() - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- size() - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- SKIP_FILTER - com.funnelback.filter.api.filters.PreFilterCheck
-
Returned when the pre filter check decides that the filter can not filter the given document and so the filter should be skipped.
- skipped - Variable in class com.funnelback.filter.api.FilterResult
- skipped() - Static method in class com.funnelback.filter.api.FilterResult
-
Marks a filter as being skipped.
- SKIPPED - Static variable in class com.funnelback.filter.api.FilterResult
- SOCIAL_MEDIA - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- sort - Variable in class com.funnelback.plugin.search.model.SuggestionQuery
-
Sort options for returned suggestions
- Sort - Enum in com.funnelback.plugin.search.model
-
Sort options for returned suggestions
- Sort() - Constructor for enum com.funnelback.plugin.search.model.Sort
- Source() - Constructor for enum com.funnelback.publicui.search.model.padre.QSup.Source
- SPACE_CHARS_ALLOWED_IN_NUMBERS - Static variable in class com.funnelback.publicui.search.model.transaction.facet.order.ByStringAsNumberComparator
- SPEL - com.funnelback.publicui.search.model.padre.QSup.Source
-
Spelling suggestions
- spell - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Spelling suggestions.
- Spell - Class in com.funnelback.publicui.search.model.padre
-
A spelling suggestion
- Spell() - Constructor for class com.funnelback.publicui.search.model.padre.Spell
- SPELLING_SUGGESTIONS - com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
- SQUIZ_CONNECT - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- SQUIZ_MATRIX - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- src - Variable in class com.funnelback.publicui.search.model.padre.QSup
-
Source of this additional query
- start - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDetail
- START_RANK - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Rank of the first result to display
- StartUrlProvider - Interface in com.funnelback.plugin.starturl
-
Provide extra start URLs to use during crawling
- StartUrlProviderContext - Interface in com.funnelback.plugin.starturl
- STEM - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Controls the type/level of stemming which should be used
- stemmedEquivs - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
A
SetMultimapof Strings that describes the results of stemming on the query. - STEMMING - com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- stopWords - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
A
Listof stop words used by the query processor. - store(URI, byte[], ListMultimap<String, String>) - Method in interface com.funnelback.plugin.gatherer.PluginStore
-
Store content under a URI.
- STRING - com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- StringDocument - Interface in com.funnelback.filter.api.documents
-
A filterable String Document
- StringDocumentFilter - Interface in com.funnelback.filter.api.filters
-
Filter a document where the content is converted to a String.
- Subdivision() - Constructor for class com.funnelback.publicui.search.model.geolocation.Location.Subdivision
- subdivisions - Variable in class com.funnelback.publicui.search.model.geolocation.Location
-
The subdivisions of the location.
- subtype - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyType
-
If the type of plugin configuration key value is `FORMAT.ARRAY`, define a type of item in an array
- SUCCESS - Static variable in class com.funnelback.publicui.search.model.padre.ReturnCodes
-
Success
- SuggestionQuery - Class in com.funnelback.plugin.search.model
-
To build the suggestion query which will query PADRE to a suggestion
- SuggestionQuery() - Constructor for class com.funnelback.plugin.search.model.SuggestionQuery
- SumByGroup - Class in com.funnelback.publicui.search.model.padre
-
Holds the sum of numeric metadata class 'on' grouped by the values in metadata class 'by'.
- SumByGroup() - Constructor for class com.funnelback.publicui.search.model.padre.SumByGroup
- sumByGroups - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
A list containing the sum of a numeric metadata class grouped by another metadata class
- summary - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Query-biased summary
- summary - Variable in class com.funnelback.publicui.search.model.padre.RMCItemResult
-
Snippet (non query-biased)
- summary - Variable in class com.funnelback.publicui.search.model.transaction.session.SessionResult
-
Summary of the results biased towards the query that generated this result
- SUMMARY - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click.Result
-
Summary of the result
- SUMMARY_FIELDS - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Metadata field list to be used in producing result metadata summaries
- SUMMARY_MODE - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters
-
Type of result summaries padre should return
- supplyAutoCompletionEntriesForProfiles(List<IndexConfigProviderContext>, AutoCompletionConsumer) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Supply auto completion entries to use on profiles.
- supplyGscopesByQuery(IndexConfigProviderContext, GscopeByQueryConsumer) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Supply gscopes that must be set on a document when a query matches the document.
- supplyGscopesByRegex(IndexConfigProviderContext, GscopeByRegexConsumer) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Supply gscopes that must be set on a document when a regular expression matches the URL.
- supplyQieByQuery(IndexConfigProviderContext, QieByQueryConsumer) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Supply QIE weight that must be set on a document when the URL matches a query.
- supplyQieByURL(IndexConfigProviderContext, QieByUrlConsumer) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Supply the QIE weight to a given URL.
- svgs - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
Contains SVG data returned by PADRE, for example an SVG representation of the syntax tree.
- SYNONYMS - com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- SYNS - com.funnelback.publicui.search.model.padre.QSup.Source
-
Synonyms
- SYSTEM_ADMINISTRATION - com.funnelback.plugin.docs.model.ProductTopic
- SYSTEM_SERVICES - com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- SystemAdministration() - Constructor for enum com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- systemMetaParameters - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
smeta_*/squery_*input parameters, transformed in query expressions.
T
- TAB - com.funnelback.publicui.search.model.transaction.facet.FacetDisplayType
- tags - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Tags associated with a result.
- target - Variable in enum com.funnelback.plugin.details.model.PluginTarget
- termAndOccurrences - Variable in class com.funnelback.publicui.search.model.padre.IndexedTermCounts
-
Holds the count of occurrences of each term in the metadata class in the result set.
- termsToStemEquivs - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.DocumentContentModel
- TEST_SUFFIX - Static variable in interface com.funnelback.common.filter.jsoup.IJSoupFilter
- text - Variable in class com.funnelback.plugin.index.model.querycompletion.display.PlainText
- text - Variable in class com.funnelback.publicui.search.model.padre.QuickLinks.QuickLink
- text - Variable in class com.funnelback.publicui.search.model.padre.Spell
- TEXT_INDEXED_AS_DOCUMENT_CONTENT - com.funnelback.plugin.index.model.metadatamapping.MetadataType
-
Metadata of this type will also have its value recorded in document content.
- TEXT_NOT_INDEXED_AS_DOCUMENT_CONTENT - com.funnelback.plugin.index.model.metadatamapping.MetadataType
- tf - Static variable in class com.funnelback.common.utils.SharedXMLUtils
- tier - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Tier number to which this search results belongs.
- TierBar - Class in com.funnelback.publicui.search.model.padre
-
A tier bar
- TierBar(int, int, Date) - Constructor for class com.funnelback.publicui.search.model.padre.TierBar
- tierBars - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
List of tier bars
- title - Variable in class com.funnelback.publicui.search.model.padre.Result
-
Title of the result
- title - Variable in class com.funnelback.publicui.search.model.padre.RMCItemResult
-
Title of the result
- title - Variable in class com.funnelback.publicui.search.model.transaction.session.SessionResult
-
Title of the result
- TITLE - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click.Result
-
Title of the result
- titleHtml - Variable in class com.funnelback.publicui.search.model.curator.data.UrlAdvert
-
The title (in HTML) of the advert.
- toBytes(Document, String) - Static method in class com.funnelback.common.utils.SharedXMLUtils
-
Converts a given Document back out to a byte array.
- toBytesDocument(FilterableDocument) - Method in interface com.funnelback.filter.api.FilterDocumentFactory
-
Converts a FilterableDocument into a RawFilterableDocument
- toggleUrl - Variable in class com.funnelback.publicui.search.model.transaction.Facet.CategoryValue
-
URL to use to toggle the select status of the facet value.
- toMap(String) - Static method in class com.funnelback.publicui.utils.SharedQueryStringUtils
-
Convert a query string to a ListMultimap
- topic - Variable in enum com.funnelback.plugin.docs.model.ProductSubtopic.AnalyticsReporting
- topic - Variable in enum com.funnelback.plugin.docs.model.ProductSubtopic.ApplicationAdministration
- topic - Variable in enum com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- topic - Variable in enum com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
- topic - Variable in enum com.funnelback.plugin.docs.model.ProductSubtopic.IntegrationDevelopment
- topic - Variable in enum com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
- topic - Variable in enum com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
- topic - Variable in enum com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- topic - Variable in enum com.funnelback.plugin.docs.model.ProductTopic
- topResults - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.ContentOptimiserModel
- toString() - Method in class com.funnelback.publicui.search.model.collection.QueryProcessorOption
-
Used for debugging display, not suitable to use to generate the CLI string representation.
- toString() - Method in class com.funnelback.publicui.search.model.padre.CoolerWeighting
- toString() - Method in class com.funnelback.publicui.search.model.transaction.Facet
- toString() - Method in interface com.funnelback.publicui.search.model.transaction.FunnelbackVersionI
-
Version in human readable form.
- toString() - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- toString(String) - Static method in class com.funnelback.common.utils.SharedXMLUtils
-
Round trip conversion of a given XML string back into XML with the secure transformations applied.
- toString(Document) - Static method in class com.funnelback.common.utils.SharedXMLUtils
-
Converts a given Document back out to a String.
- toStringDocument(FilterableDocument) - Method in interface com.funnelback.filter.api.FilterDocumentFactory
-
Attempts to create a StingDocument from the given document.
- toStringDocument(FilterableDocument, DocumentType, String) - Method in interface com.funnelback.filter.api.FilterDocumentFactory
-
Constructs a StringDocument from a FilterableDocument, with the given mimeType and content.
- totalDistinctMatchingUrls - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Number of distinct URLs when using event search.
- totalLinks - Variable in class com.funnelback.publicui.search.model.anchors.AnchorModel
- totalMatching - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
Total number of documents matching the query terms, fully or partially.
- totalMatching - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
Total number of results returned
- totalSecurityObscuredUrls - Variable in class com.funnelback.publicui.search.model.padre.ResultsSummary
-
The number of results which are not viewable to the user
- totalWords - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.DocumentContentModel
- translations - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
Contains translation messages for the UI, for the locale given in the
SearchQuestion. - triggers - Variable in class com.funnelback.plugin.index.model.querycompletion.AutoCompletionEntry
-
Contains the text against which the partial query entered by the user is matched.
- tryParseInt(String) - Method in class com.funnelback.publicui.search.model.transaction.facet.order.ByDateComparator
- type - Variable in class com.funnelback.plugin.details.model.deserializer.PluginConfigKeyDetailsDeserializer
- type - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue
-
Type of allowed values
- type - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyBase
-
Type of plugin configuration key, for details see
PluginConfigKeyType - type - Variable in enum com.funnelback.plugin.details.model.PluginConfigKeyType.Format
- type - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyType
-
Type of plugin configuration key value
- type - Variable in enum com.funnelback.plugin.docs.model.Audience
- type - Variable in enum com.funnelback.plugin.docs.model.MarketplaceSubtype
- TYPE - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click
-
Type of click for logging purposes
- TYPE_FP - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click
-
Feature page click type
U
- underlyingMap - Variable in class com.funnelback.publicui.search.model.util.map.DelegateMap
- underlyingMetadata - Variable in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- UniqueByGroup - Class in com.funnelback.publicui.search.model.padre
-
Holds the count of unique values for a metadata class 'on' grouped by the values in metadata class 'by'.
- UniqueByGroup() - Constructor for class com.funnelback.publicui.search.model.padre.UniqueByGroup
- uniqueCountsByGroups - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
A list containing the count of unique values for a metadata class grouped by another metadata class.
- uniqueWords - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.DocumentContentModel
- UNIVERSAL_IP - Static variable in class com.funnelback.common.utils.URIHandlingUtils
- Unknown - com.funnelback.publicui.search.model.padre.QSup.Source
-
Unknown
- Unknown - com.funnelback.publicui.search.model.transaction.ExecutionContext
-
Context may be unknown, usually when running under an IDE / Tomcat
- Unknown - com.funnelback.publicui.search.model.transaction.SearchError.Reason
- UNKNOWN - com.funnelback.publicui.search.model.transaction.facet.FacetDisplayType
- unmarshal(HierarchicalStreamReader, UnmarshallingContext) - Method in class com.funnelback.publicui.xml.AutoConvertingMapXStreamConverter
- unmarshal(HierarchicalStreamReader, UnmarshallingContext) - Method in class com.funnelback.publicui.xml.FacetConverter
- unselectAllFacetsUrl - Variable in class com.funnelback.publicui.search.model.transaction.FacetExtras
-
The URL required to unselect all selected facets.
- unselectAllUrl - Variable in class com.funnelback.publicui.search.model.transaction.Facet
-
URL to use to unselect all possible values of this facet, built from the current URL
- untruncatedPadreOutputSize - Variable in class com.funnelback.publicui.search.model.transaction.SearchResponse
-
Amount of output produced by PADRE responding to the query, in bytes.
- UPGRADES - com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
- upperRight - Variable in class com.funnelback.publicui.search.model.padre.GeoBoundingBox
- URI - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Serve
-
URI of the document to serve
- URIHandlingUtils - Class in com.funnelback.common.utils
- URIHandlingUtils() - Constructor for class com.funnelback.common.utils.URIHandlingUtils
- url - Variable in class com.funnelback.publicui.search.model.anchors.AnchorModel
- url - Variable in class com.funnelback.publicui.search.model.padre.ClusterNav
-
URL to reach this navigation item.
- url - Variable in class com.funnelback.publicui.search.model.padre.QuickLinks.QuickLink
- url - Variable in class com.funnelback.publicui.search.model.padre.Spell
- url - Variable in class com.funnelback.publicui.search.model.related.RelatedDocument
- url - Variable in class com.funnelback.publicui.search.model.transaction.cache.CacheQuestion
-
URL of the document to retrieve the cached copy of
- URL - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Cache
-
URL of the original document
- URL - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Cart
-
URL of the result being added/removed
- URL - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Click
-
Target URL to redirect to.
- UrlAdvert - Class in com.funnelback.publicui.search.model.curator.data
-
An 'advert' for a URL to be displayed within search results.
- UrlAdvert() - Constructor for class com.funnelback.publicui.search.model.curator.data.UrlAdvert
- urlCounts - Variable in class com.funnelback.publicui.search.model.padre.ResultPacket
-
URL counts (Used in faceted navigation).
- UrlPath - Class in com.funnelback.plugin.index.model.indexingconfig
- UrlPath() - Constructor for class com.funnelback.plugin.index.model.indexingconfig.UrlPath
- urlPaths - Variable in class com.funnelback.plugin.index.model.indexingconfig.XmlIndexingConfig
-
The URL at this path will be used as the documents URL.
- urls - Variable in class com.funnelback.publicui.search.model.anchors.AnchorDetail
- URLSignature - Class in com.funnelback.publicui.utils
-
Utilities to compute a signature for a given URL
- URLSignature() - Constructor for class com.funnelback.publicui.utils.URLSignature
- urlToOpen - Variable in class com.funnelback.plugin.index.model.querycompletion.action.OpenUrl
- USER_MANAGEMENT - com.funnelback.plugin.docs.model.ProductSubtopic.ApplicationAdministration
- userId - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistory
-
ID of the User who performed the search
- userId - Variable in class com.funnelback.publicui.search.model.transaction.session.SearchHistoryPK
- userId - Variable in class com.funnelback.publicui.search.model.transaction.session.SessionResult
-
ID of the user who clicked on the result
- userId - Variable in class com.funnelback.publicui.search.model.transaction.session.SessionResultPK
- userKeys - Variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion
-
User keys for early binding Document Level Security.
- userMsg - Variable in class com.funnelback.publicui.search.model.padre.Error
-
User-friendly message.
- USUK - com.funnelback.publicui.search.model.padre.QSup.Source
-
US / UK conflation
V
- validateKey(String) - Static method in class com.funnelback.common.utils.SharedConfigKeyUtils
- validateUniversalIpAddress(URL) - Static method in class com.funnelback.common.utils.URIHandlingUtils
-
Ensure cloud provider (i.e.
- value - Variable in class com.funnelback.publicui.search.model.collection.QueryProcessorOption
-
QPO value
- value - Variable in class com.funnelback.publicui.search.model.facetednavigation.FacetSelectedDetails
- valueOf(String) - Static method in enum com.funnelback.common.facetednavigation.models.FacetConstraintJoin
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.common.facetednavigation.models.FacetSelectionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.common.facetednavigation.models.FacetValues
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.filter.api.filters.PreFilterCheck
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue.AllowedType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.details.model.PluginConfigKeyType.Format
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.details.model.PluginTarget
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.Audience
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.MarketplaceSubtype
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.AnalyticsReporting
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.ApplicationAdministration
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.IntegrationDevelopment
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.docs.model.ProductTopic
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.index.model.indexingconfig.WhenNoContentPathsAreSet
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.index.model.metadatamapping.MetadataSourceType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.index.model.metadatamapping.MetadataType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.plugin.search.model.Sort
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.publicui.search.model.padre.QSup.Source
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.publicui.search.model.transaction.ExecutionContext
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.publicui.search.model.transaction.facet.FacetDisplayType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.publicui.search.model.transaction.facet.order.Order
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.publicui.search.model.transaction.SearchError.Reason
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.funnelback.publicui.search.model.transaction.SearchTransaction.ExtraSearches
-
Returns the enum constant of this type with the specified name.
- values - Variable in class com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue
-
Define a list of fixed values that plugin configuration key value can be set to to display in plugin configuration admin UI and in auto-generated documentation
- values - Variable in class com.funnelback.publicui.search.model.facetednavigation.FacetParameter
-
The category values selected within the facet.
- values() - Static method in enum com.funnelback.common.facetednavigation.models.FacetConstraintJoin
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.common.facetednavigation.models.FacetSelectionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.common.facetednavigation.models.FacetValues
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.common.facetednavigation.models.FacetValuesOrder
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.filter.api.filters.PreFilterCheck
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.details.model.PluginConfigKeyAllowedValue.AllowedType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.details.model.PluginConfigKeyType.Format
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.details.model.PluginTarget
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.Audience
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.MarketplaceSubtype
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.AnalyticsReporting
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.ApplicationAdministration
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.IntegrationDevelopment
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.RankingSorting
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.ResultsPage
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.ProductSubtopic.SystemAdministration
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.docs.model.ProductTopic
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.index.model.indexingconfig.WhenNoContentPathsAreSet
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.index.model.metadatamapping.MetadataSourceType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.index.model.metadatamapping.MetadataType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.plugin.search.model.Sort
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.publicui.search.model.padre.QSup.Source
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.publicui.search.model.transaction.ExecutionContext
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.publicui.search.model.transaction.facet.FacetDisplayType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.publicui.search.model.transaction.facet.order.Order
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.publicui.search.model.transaction.SearchError.Reason
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.publicui.search.model.transaction.SearchQuestion.SearchQuestionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.funnelback.publicui.search.model.transaction.SearchTransaction.ExtraSearches
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Method in class com.funnelback.publicui.search.model.util.map.DelegateMap
- values() - Method in class com.funnelback.publicui.utils.MultimapToSingleStringMapWrapper
- values() - Method in class com.funnelback.publicui.utils.SingleValueMapWrapper
- vectorScore - Variable in class com.funnelback.publicui.search.model.padre.Result
-
The vector result distance score; the lower value the better, as it means closer distance, so closer match
W
- WEB - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- weight - Variable in class com.funnelback.plugin.index.model.querycompletion.AutoCompletionEntry
-
Used to rank suggestions which matches the partial query, in case multiple suggestion matches a given partial query.
- weights - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.ContentOptimiserModel
- whenNoContentPathsAreSet - Variable in class com.funnelback.plugin.index.model.indexingconfig.XmlIndexingConfig
-
May be set null.
- WhenNoContentPathsAreSet - Enum in com.funnelback.plugin.index.model.indexingconfig
- WhenNoContentPathsAreSet() - Constructor for enum com.funnelback.plugin.index.model.indexingconfig.WhenNoContentPathsAreSet
- win - Variable in class com.funnelback.publicui.search.model.transaction.contentoptimiser.RankingFeature
- WORKFLOW_SCRIPTS - com.funnelback.plugin.docs.model.ProductSubtopic.Indexing
X
- X_FORWARDED_FOR - Static variable in class com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters.Header
-
Header used to provide the originating user's IP address, which may differ from the normal remote address if the request is forwarded by a proxy or wrapped by a CMS.
- XML - com.funnelback.plugin.docs.model.ProductSubtopic.DataSources
- XML - com.funnelback.plugin.index.model.metadatamapping.MetadataSourceType
-
Used when the metadata must come from XML documents.
- XML - Static variable in class com.funnelback.common.utils.SharedXMLUtils
-
XML file extension
- XML - Variable in class com.funnelback.filter.api.DocumentType._DocumentType
- xmlIndexingConfig(IndexConfigProviderContext) - Method in interface com.funnelback.plugin.index.IndexingConfigProvider
-
Supply additional configuration used for XML processing.
- XmlIndexingConfig - Class in com.funnelback.plugin.index.model.indexingconfig
- XmlIndexingConfig() - Constructor for class com.funnelback.plugin.index.model.indexingconfig.XmlIndexingConfig
_
- _DocumentType() - Constructor for class com.funnelback.filter.api.DocumentType._DocumentType
All Classes All Packages