All Classes Interface Summary Class Summary Enum Summary Exception Summary
| Class |
Description |
| AnchorDescription |
|
| AnchorDetail |
|
| AnchorModel |
|
| Audience |
Source documentation meta tag "hc-audience"
|
| AutoCompletionAction |
This interface groups the options for what action occurs when an auto completion suggestion is selected.
|
| AutoCompletionConsumer |
|
| AutoCompletionDisplay |
This interface groups the options for how auto completion suggestions are displayed.
|
| AutoCompletionEntry |
Represents an entry to be provided as additional data for auto-completion.
|
| AutoConvertingMap<K,V> |
A map that can auto convert the key from one type to the expected type.
|
| AutoConvertingMap.Converter<T> |
Converter to convert from some other type to the expected type.
|
| AutoConvertingMapXStreamConverter |
|
| ByDateComparator |
Compare Facet.CategoryValue containing date-based facet values
and sort them in reverse chronological order. |
| BySelectedFirst |
|
| ByStringAsNumberComparator |
|
| BytesDocument |
A raw byte document.
|
| BytesDocumentFilter |
Filters a document where the content is converted to a byte[].
|
| CacheQuestion |
This class contains all the input parameters for a cache request
|
| CartResult |
A Cart result presented to the user.
|
| Category |
A contextual navigation category (type, topic, site).
|
| ClickHistory |
A single entry in the user's click history
|
| Cluster |
A contextual navigation cluster (belongs to a Category). |
| ClusterNav |
Contextual navigation details to navigate through
results and clusters.
|
| Collapsed |
Information about collapsed results, for a given
Result |
| ContentOptimiserModel |
|
| ContentPath |
|
| ContextualNavigation |
Contextual navigation parent class.
|
| Converters |
|
| CoolerWeighting |
Ranking weighting, defined using -cool command line
flags on the query processor.
|
| Curator |
A Curator will contain and additional information (exhibits) which has
been added to the result packet by curator actions.
|
| DateCount |
A date count (Used in faceted navigation).
|
| DelegateMap<K,V> |
|
| DeprecatedSearchLifeCyclePlugin |
Deprecated.
|
| Details |
Details (header) of a PADRE result packet
|
| DisplayTrigger |
An auto-completion display type which simply displays the trigger
string as the auto-completion suggestion.
|
| DocumentContentModel |
|
| DocumentPath |
|
| DocumentType |
Holds the information describing the type of the document.
|
| DocumentType._DocumentType |
|
| DocumentTypeFactory |
|
| Error |
PADRE error data.
|
| ExecutionContext |
Context where the Modern UI is being executed
|
| Exhibit |
Exhibits are individual 'blocks' of information made available for display
within search results by the curator system.
|
| Explain |
Search explain plan used in the Content Optimiser.
|
| ExternalMetadataConsumer |
|
| ExtraSearchFuture |
Internal use see DefaultExtraSearchFuture
|
| Facet |
Facets, generated from the result data (Metadata counts,
GScope counts, URL counts).
|
| Facet.CategoryValue |
Value of a facet category, such as "Location = Sydney".
|
| FacetComparatorProvider |
|
| FacetComparatorProvider.AsIsComparator |
|
| FacetComparatorProvider.ChainComparator<T> |
|
| FacetComparators |
|
| FacetConfigOrder |
Leaves the order of categories as they are, which should be the order
in which they appear in the facet config.
|
| FacetConstraintJoin |
Defines how selected constraints within a facet are applied.
|
| FacetConverter |
|
| FacetConverter.FacetWithFields |
XStream will only serialise fields so this is a Facet with selected and unselected fields for values
|
| FacetDisplayType |
|
| FacetExtras |
Holds extra information on faceted navigation.
|
| FacetParameter |
Representation of a parameter for selecting a particular facet category (or
categories) within the faceted navigation system.
|
| FacetProvider |
Provide extra faceted navigation to use during query processing.
|
| FacetSelectedDetails |
|
| FacetSelectionType |
Defines how facet selection works.
|
| FacetValues |
Defines where the (category) values to display in facet come from.
|
| FacetValuesOrder |
|
| FileScanner |
|
| FileTypePath |
|
| Filter |
Filters a document.
|
| FilterableDocument |
A Document which can be filtered by the filter framework.
|
| FilterContext |
A Jsoup filter context.
|
| FilterContext |
An immutable context supplied to the filters.
|
| FilterDocumentFactory |
|
| FilterException |
Thrown when an error occurs during filtering of a document and filtering of that document should not proceed.
|
| FilterResult |
The result of filtering a document.
|
| FunnelbackVersionI |
|
| GeoBoundingBox |
The smallest bounding box the coordinates of all result within the daat limit.
|
| GeoBoundingBox.LatLong |
|
| GscopeByQueryConsumer |
|
| GscopeByRegexConsumer |
|
| HTMLFragment |
An auto-completion display type which displays an HTML
fragment as the suggestion.
|
| IJSoupFilter |
Interface for filtering steps applied by JSoupProcessingFilterProvider.
|
| IndexConfigProviderContext |
|
| IndexedTermCounts |
Holds the count of each indexed term for a metadata class 'metadataClass'.
|
| IndexingConfigProvider |
An interface that may be implemented in a plugin to control indexing.
|
| InnerDocumentPath |
|
| InternalFilterContext |
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 FilterContext
And must not implement methods with the same name as methods declared in this interface |
| JavaScriptCallbackAction |
An auto-completion action type which executes
the given JavaScript code when the completion
is selected.
|
| JavaScriptCallbackDisplay |
An auto-completion display type which invokes a
JavaScript callback which is expected to return
HTML, which is then used as the display.
|
| JSONData |
An auto-completion display type which provides
JSON data which can be templated within the
auto-completion's javascript code as required.
|
| KillByExactMatchConsumer |
|
| KillByPartialMatchConsumer |
|
| KillByQueryMatchConsumer |
|
| Location |
This class represents a location along with a range of 'names' which apply to
it, such as countries, cities, postalCodes etc.
|
| Location.Subdivision |
|
| MapKeyFilter |
Filters the keys of a Map depending of a regex.
|
| MapUtils |
|
| MarketplaceSubtype |
Source documentation meta tag "marketplace-subtype"
|
| Message |
Message represents a 'message' added by curator to be displayed within the
search results.
|
| MetadataMappingConsumer |
|
| MetadataSourceType |
|
| MetadataType |
|
| MultimapToSingleStringMapWrapper |
|
| NamedFilter |
Gives a name to filters for clearer logging.
|
| NoContentDocument |
A document which may have its non-content parts inspected.
|
| OpenUrl |
An auto-completion action type which
directly opens the given URL rather than
changing the search page.
|
| Order |
|
| PadreSwCmd |
The search transaction only knows about this.
|
| PlainText |
An auto-completion display type which provides
some plain text which will be displayed
as the auto-completion suggestion.
|
| PluginBaseConfigContext |
|
| PluginBaseConfigFileContext |
|
| PluginBaseContext |
|
| PluginConfigFile |
Defines plugin configuration file properties
For example, to define JSON file
|
| PluginConfigKey<T> |
Defines plugin configuration key properties
For example, to define configuration key 'plugin.pluginID.config.foo.*'
|
| PluginConfigKeyAllowedValue<T> |
|
| PluginConfigKeyAllowedValue.AllowedType |
|
| PluginConfigKeyBase |
|
| PluginConfigKeyConditional<T> |
Define plugin configuration keys' dependency on each other to display it
in plugin configuration admin UI and in auto-generated documentation.
|
| PluginConfigKeyDetails<T> |
|
| PluginConfigKeyDetailsDeserializer<T> |
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
|
| PluginConfigKeyEncrypted |
Defines plugin configuration key properties for storing secret information (like passwords)
For example, to define configuration key 'plugin.pluginID.encrypted.token'
|
| PluginConfigKeyType |
Define a type of plugin configuration key
For example, if key value is expected to be `true` or `false`
|
| PluginConfigKeyType.Format |
Allowed types of plugin configuration key
|
| PluginDetails |
|
| PluginDetailsBase |
|
| PluginDocsDetails |
|
| PluginGatherContext |
|
| PluginGatherer |
A plugin may implement this if the plugin is to support gathering of documents.
|
| PluginStore |
|
| PluginTarget |
|
| PluginUtil |
|
| PluginUtilsBase |
|
| PreFilterCheck |
|
| PriorityQueryProcessorOptions |
|
| ProductSubtopic |
|
| ProductSubtopic.AnalyticsReporting |
"Analytics and reporting" product topic
|
| ProductSubtopic.ApplicationAdministration |
"Application administration" product topic
|
| ProductSubtopic.DataSources |
"Search data sources" product topic
|
| ProductSubtopic.Indexing |
"Search indexing" product topic
|
| ProductSubtopic.IntegrationDevelopment |
"Integration and development" product topic
|
| ProductSubtopic.RankingSorting |
"Search ranking and sorting" product topic
|
| ProductSubtopic.ResultsPage |
"Search results pages" product topic
|
| ProductSubtopic.SystemAdministration |
"System administration" product topic
|
| ProductSubtopicCategory |
Source documentation meta tag "product-subtopic"
|
| ProductTopic |
Source documentation meta tag "product-topic"
|
| Properties |
Properties represents arbitrary structured data added by the curator system
to be displayed within the search results.
|
| QieByQueryConsumer |
|
| QieByUrlConsumer |
|
| QSup |
A supplementary query, in the query blending mechanism.
|
| QSup.Source |
Query blending sources
|
| QueryProcessorOption<T> |
A PADRE query processor option, with a name and a value
|
| QuickLinks |
Quick links, associated to a Result. |
| QuickLinks.QuickLink |
A single quick link.
|
| Range |
A range of values (used for numeric metadata ranges)
|
| RankingFeature |
|
| RankingFeatureCategory |
|
| RankingFeatureMaxOther |
|
| RankingFeatureMaxPossible |
|
| RankingFeatureMaxPossibleMultiWordOnly |
|
| RelatedDocument |
|
| Result |
A single search result.
|
| ResultPacket |
A PADRE result packet, containing search results.
|
| ResultsSummary |
Search result summary, with document counts and
information about the current page returned.
|
| ResultType |
|
| ReturnCodes |
PADRE return codes.
|
| RMCItemResult |
Top n results for an RMC item count (Results that would
be returned is the RMC constraint is applied)
|
| RunQuery |
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.
|
| RunTriggerAsQuery |
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.
|
| SearchError |
|
| SearchError.Reason |
Generic reasons of errors.
|
| SearchHistory |
|
| SearchHistoryPK |
|
| SearchLifeCycleContext |
Context for search life cycle plugin
|
| SearchLifeCyclePlugin |
Plugins can implement this to add logic to a search life cycle.
|
| SearchPackageConfig |
|
| SearchQuestion |
This class contains all the input data related to a search.
|
| SearchQuestion.RequestParameters |
Common query string parameters names.
|
| SearchQuestion.RequestParameters.Cache |
Common request parameter names used in the cache
controller.
|
| SearchQuestion.RequestParameters.Cart |
Common request parameters used in the ResultsCartController
|
| SearchQuestion.RequestParameters.Click |
Common request parameter names used in the click
controller.
|
| SearchQuestion.RequestParameters.Click.Result |
|
| SearchQuestion.RequestParameters.ContextualNavigation |
Common request parameter names used in
contextual navigation.
|
| SearchQuestion.RequestParameters.Header |
Common request header names
|
| SearchQuestion.RequestParameters.Serve |
Common request parameter names used in the serve-*
controllers
|
| SearchQuestion.SearchQuestionType |
Enum for identifying special types of search requests requiring special processing
|
| SearchResponse |
This class contains all the output data related to a search.
|
| SearchServletFilterHook |
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 |
|
| SearchSession |
Contains data associated with the current user
and search session.
|
| SearchTransaction |
Represents a full search transaction consisting of
a question, a response and possible error.
|
| SearchTransaction.ExtraSearches |
Internal use: Keys for internal extra searches.
|
| SearchUser |
User performing the search.
|
| ServiceConfig |
|
| SessionResult |
Search result base class when used in a session context
|
| SessionResultPK |
|
| SetupContext |
Represents the 'setup' of a filter, which includes information
about the Funnelback installation and collection for which
documents will be filtered.
|
| SharedConfigKeyUtils |
|
| SharedQueryStringUtils |
Utilities for manipulating query strings.
|
| SharedXMLUtils |
Shared XML Utilities that can help parse documents and transform them in a safe
way that aims to avoid common OWASP vulnerabilities.
|
| SharedXMLUtils.NoOpEntityResolver |
|
| SingleValueMapWrapper |
|
| Sort |
Sort options for returned suggestions
|
| Spell |
A spelling suggestion
|
| StartUrlProvider |
Provide extra start URLs to use during crawling
|
| StartUrlProviderContext |
|
| StringDocument |
A filterable String Document
|
| StringDocumentFilter |
Filter a document where the content is converted to a String.
|
| SuggestionQuery |
To build the suggestion query which will query PADRE to a suggestion
|
| SumByGroup |
Holds the sum of numeric metadata class 'on' grouped by the values in metadata class 'by'.
|
| TierBar |
A tier bar
|
| UniqueByGroup |
Holds the count of unique values for a metadata class 'on' grouped by the values in metadata class 'by'.
|
| URIHandlingUtils |
|
| UrlAdvert |
An 'advert' for a URL to be displayed within search results.
|
| UrlPath |
|
| URLSignature |
Utilities to compute a signature for a given URL
|
| WhenNoContentPathsAreSet |
|
| XmlIndexingConfig |
|