All Classes Interface Summary Class Summary Enum Summary
| Class |
Description |
| Action |
Action defines an 'action' performed by the curator system to modify search
results in some way.
|
| Action.Phase |
Phases in which an action may be executed
|
| ActionSet |
ActionSet defines a group of actions (which may share a single trigger) and
provides convenience methods across the group.
|
| ActionTypeIdResolver |
|
| AddParameterOperation |
An Operation that adds a parameter and its value to the map. |
| AddQueryTerm |
Action to add a specified term to the users query before running it.
|
| AllDocumentsFill |
|
| AllQueryWordsTrigger |
A trigger which activates only when the current query contains all the words
given as triggers.
|
| AnchorDescription |
|
| AnchorDetail |
|
| AnchorModel |
|
| AndTrigger |
A trigger which activates only when all of the given 'sub' triggers activate.
|
| 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.
|
| AutowireCuratorConfigurer |
|
| BestBet |
A best bet
|
| BestBet.Schema |
Constants for the PADRE XML result packet tags.
|
| BestBetFactory |
|
| ByCountOfFirstCategoryValueComparator |
|
| ByDateComparator |
Compare Facet.CategoryValue containing date-based facet values
and sort them in reverse chronological order. |
| ByFirstCategoryValueComparator |
This is used in the old sorting model where for gscopes we had to sort the categories
and hoped that each category had exactly one value.
|
| BySelectedFirst |
|
| ByStringAsNumberComparator |
|
| CacheQuestion |
This class contains all the input parameters for a cache request
|
| CartClickLog |
A cart click log, for adding/removing/processing cart links
|
| CartClickLog.Type |
Type of car event
|
| CartResult |
A Cart result presented to the user.
|
| CartResultDBModel |
A result in a results cart
|
| CartResultMetaDataDBModel |
Entity class to model the CartResultMetadata table for efficient deletion.
|
| Category |
A contextual navigation category (type, topic, site).
|
| Category.Schema |
Constants for the PADRE XML result packet tags.
|
| CategoryDefinition |
Category definition for faceted navigation.
|
| CategoryDefinition.CountSupplier |
|
| CategoryDefinition.FacetSearchData |
|
| CategoryDefinition.MetadataAndValue |
Aggregate of a metadata class + a value.
|
| CategoryDefinition.SearchResonseForCountSupplier |
|
| CategoryFactory |
|
| CategoryValueComputedDataHolder |
Holds the data of a category value.
|
| ClickHistory |
A single entry in the user's click history
|
| ClickHistoryMetaDataDBModel |
Entity class to model the ClickHistoryMetadata table for efficient deletion.
|
| ClickLog |
A click log, for search results or best bets
(ex featured pages).
|
| ClickLog.Type |
Type of click
|
| Cluster |
A contextual navigation cluster (belongs to a Category). |
| Cluster.Schema |
Constants for the PADRE XML result packet tags.
|
| ClusterFactory |
|
| ClusterNav |
Contextual navigation details to navigate through
results and clusters.
|
| ClusterNav.Schema |
Constants for the PADRE XML result packet tags.
|
| ClusterNavFactory |
|
| Collapsed |
Information about collapsed results, for a given
Result |
| Collection |
A search collection.
|
| Collection.CollectionBuilder |
|
| Collection.Hook |
Groovy Hook scripts names.
|
| CollectionFill |
|
| Configurer |
Interface for classes which configure the CuratorConfig tree.
|
| ContentOptimiserModel |
|
| ContextualNavigation |
Contextual navigation parent class.
|
| ContextualNavigation.Schema |
Constants for the PADRE XML result packet tags.
|
| ContextualNavigationFactory |
|
| ContextualNavigationLog |
Contextual navigation log
|
| Converters |
|
| CoolerWeighting |
Ranking weighting, defined using -cool command line
flags on the query processor.
|
| CountryNameTrigger |
A trigger which activates only when the current request originates from a
country whose name exists in the targetCountries list.
|
| Criteria |
|
| Curator |
A Curator will contain and additional information (exhibits) which has
been added to the result packet by curator actions.
|
| CuratorClasses |
|
| CuratorConfig |
CuratorConfig represents the configuration of the curator system which can be
used to modify result presentation under certain conditions.
|
| CuratorYamlConfig |
CuratorYamlConfig represents the configuration of the curator system which can be
used to modify result presentation under certain conditions as it was represented
in yaml in v13.0.0.
|
| DateCount |
A date count (Used in faceted navigation).
|
| DateFieldFill |
|
| DateFieldFill.ConstraintAndLabel |
|
| DateRangeTrigger |
A trigger which activates only when the current date and time falls after the
given start date but before the given end date.
|
| DefaultPadreSwCmd |
Holds the command and env given to padre-sw
To use this
export "QUERY_STRING=blah"
then run what is in command
|
| DelegateMap<K,V> |
|
| Details |
Details (header) of a PADRE result packet
|
| Details.Schema |
Constants for the PADRE XML result packet tags.
|
| DetailsFactory |
|
| DisplayMessage |
Action to display the specified message within the search results.
|
| DisplayProperties |
Action to display the specified properties within the search results.
|
| DisplayUrlAdvert |
Action to display the specified URL advert within the search results.
|
| DocumentContentModel |
|
| DoNothingCuratorConfigurer |
|
| Error |
PADRE error data.
|
| Error.Schema |
Constants for the PADRE XML result packet tags.
|
| ErrorFactory |
|
| ExactQueryTrigger |
A trigger which activates only when the current query exactly matches the
given trigger query.
|
| 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.
|
| Explain.Schema |
Constants to enable extracting the Explain data from the PADRE XML result packet tags.
|
| ExplainFactory |
|
| ExtraSearchFuture |
Internal use see DefaultExtraSearchFuture
|
| Facet |
Facets, generated from the result data (Metadata counts,
GScope counts, URL counts).
|
| Facet.Category |
Category of a facet, such as "Location, based on the metadata class X".
|
| Facet.CategoryValue |
Value of a facet category, such as "Location = Sydney".
|
| FacetComparatorProvider |
|
| FacetComparatorProvider.AsIsComparator |
|
| FacetComparators |
|
| FacetConfigOrder |
Leaves the order of categories as they are, which should be the order
in which they appear in the facet config.
|
| FacetDefinition |
Definition of a facet.
|
| FacetDisplayType |
|
| FacetedNavigationConfig |
Faceted navigation configuration.
|
| FacetedNavigationLog |
A faceted navigation click log
|
| FacetedNavigationProperties |
|
| FacetExtras |
Holds extra information on faceted navigation.
|
| FacetExtraSearchNames |
|
| FacetParameter |
Representation of a parameter for selecting a particular facet category (or
categories) within the faceted navigation system.
|
| FacetSelectedDetails |
|
| FacetSelectionTrigger |
A trigger which activates when a particular facet category is selected.
|
| FacetURL |
|
| GeoBoundingBox |
The smallest bounding box the coordinates of all result within the daat limit.
|
| GeoBoundingBox.LatLong |
|
| GroovyAction |
Perform an action which is specified by an external Groovy class.
|
| GroovyActionInterface |
Interface representing a curator action which can be implemented in an
external Groovy class (to be subsequently used from within GroovyAction).
|
| GroovyTrigger |
A trigger which activates only when the current query contains all the words
given as triggers.
|
| GroovyTriggerInterface |
Interface representing a curator trigger which can be implemented in an
external Groovy class (to be subsequently used from within GroovyTrigger).
|
| GScopeBasedCategory |
|
| GScopeItem |
|
| HasNoBeans |
Add this to anything that runs Configurer which does not require any Autowired
annotation processing. |
| IndexedTermCounts |
Holds the count of each indexed term for a metadata class 'metadataClass'.
|
| InteractionLog |
User interaction (query completion) log
|
| Location |
This class represents a location along with a range of 'names' which apply to
it, such as countries, cities, postalCodes etc.
|
| Location.LocationBuilder |
|
| Location.Subdivision |
|
| Log |
Log event
|
| Message |
Message represents a 'message' added by curator to be displayed within the
search results.
|
| MetadataBasedCategory |
|
| MetadataFieldFill |
|
| MetaDataId |
|
| NotAnyTrigger |
A trigger which activates only when none of the given 'sub' triggers activate.
|
| Operation |
|
| Order |
|
| OrTrigger |
A trigger which activates only when at least one of the 'sub' triggers
activates.
|
| PadreNative |
|
| PadreNative.SizeOf |
|
| PadreSwCmd |
The search transaction only knows about this.
|
| ParameterMatchesValueCriteria |
Criteria that checks that a specific parameter
is present and possess the desired value. |
| ParameterPresentCriteria |
A Criteria that checks that a parameter is present,
regardless of its value. |
| ParamTransformRuleFactory |
Builds a list of parameters transformation rules by
parsing a list of text rules (extracted from cgi_transform.cfg.
|
| PriorityQueryProcessorOptions |
|
| Profile |
A search profile.
|
| Profile.ProfileBuilder |
|
| PromoteUrls |
Action to promote a set of URLs within the search results, causing them to be
displayed at the top of the result set in the order given.
|
| Properties |
Properties represents arbitrary structured data added by the curator system
to be displayed within the search results.
|
| PublicUIWarningLog |
Log written in the public ui warning file
|
| 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
|
| QueryRegularExpressionTrigger |
A trigger which activates when the current query matches the given regular
expression.
|
| QuerySubstringTrigger |
A trigger which activates when the given substring is contained within the
current query.
|
| QuickLinks |
Quick links, associated to a Result. |
| QuickLinks.QuickLink |
A single quick link.
|
| QuickLinks.Schema |
Constants for the PADRE XML result packet tags.
|
| QuickLinksFactory |
|
| Range |
A range of values (used for numeric metadata ranges)
|
| RankingFeature |
|
| RankingFeatureCategory |
|
| RankingFeatureMaxOther |
|
| RankingFeatureMaxPossible |
|
| RankingFeatureMaxPossibleMultiWordOnly |
|
| RelatedDocument |
|
| RemoveAllValuesOperation |
An Operation that removes all the value of a given parameter name
from the map. |
| RemoveSpecificValuesOperation |
An Operation that removes specific values of a parameter from the
map. |
| RemoveUrls |
Action to remove a set of URLs within the search results, causing them to be
excluded from the result set even if they match the given query.
|
| ReplaceQueryTerm |
Action to replace a specified term within the users query before running it.
|
| RequestParameterTrigger |
A trigger which activates when a request parameter has a particular value
(e.g.
|
| Result |
A single search result.
|
| Result.Schema |
Constants for the PADRE XML result packet tags.
|
| ResultFactory |
Builds Results from various input sources. |
| ResultFactory.Metadata |
|
| ResultFactory.MetadataClass |
|
| ResultFactory.MetadataValue |
|
| ResultPacket |
A PADRE result packet, containing search results.
|
| ResultPacket.Schema |
Constants for the PADRE XML result packet tags.
|
| ResultPacket.Schema.DocumentsPerCollection |
|
| ResultPacket.Schema.IndexTermCount |
|
| ResultPacket.Schema.IndexTermCount.Count |
|
| ResultPacket.Schema.RMSums |
|
| ResultPacket.Schema.SumByCount |
|
| ResultPacket.Schema.SumByCount.Sum |
|
| ResultPacket.Schema.UniqueCount |
|
| ResultPacket.Schema.UniqueCount.Count |
|
| ResultsSummary |
Search result summary, with document counts and
information about the current page returned.
|
| ResultsSummary.Schema |
Constants for the PADRE XML result packet tags.
|
| ResultsSummaryFactory |
|
| ResultsSummaryFactory.ResultSummaryFiller |
|
| 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)
|
| RMCItemResultFactory |
|
| SearchError |
|
| SearchError.Reason |
Generic reasons of errors.
|
| SearchHistory |
|
| SearchHistoryPK |
|
| 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.
|
| 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.
|
| SearchTransactionUtils |
|
| SearchUser |
User performing the search.
|
| ServerConfigReadOnlyWhichAlsoHasAStringGetMethod |
|
| SessionResult |
Search result base class when used in a session context
|
| SessionResultPK |
|
| SetQuery |
Action to set the query to the given value, replacing any previously specified by the user.
|
| Spell |
A spelling suggestion
|
| Spell.Schema |
Constants for the PADRE XML result packet tags.
|
| SpellFactory |
|
| StringMatchType |
Enumeration of different string matching types available within Curator triggers.
|
| SumByGroup |
Holds the sum of numeric metadata class 'on' grouped by the values in metadata class 'by'.
|
| TierBar |
A tier bar
|
| TierBarFactory |
|
| TransactionFacetedNavigationConfigHelper |
|
| TransformQuery |
Action to transform the user's query based on a regular expression replacement.
|
| TransformRule |
Parameter transformation rule.
|
| Trigger |
Triggers control when curator actions are performed (or not).
|
| TriggerActions |
An association between a curator Trigger and the ActionSet
to perform for this trigger. |
| TriggerTypeIdResolver |
Jackson TypeIdResolver (works out which class to create for different JSON
file IDs) which understands curator triggers.
|
| UniqueByGroup |
Holds the count of unique values for a metadata class 'on' grouped by the values in metadata class 'by'.
|
| UrlAdvert |
An 'advert' for a URL to be displayed within search results.
|
| URLFill |
|
| UserSegmentTrigger |
A trigger which activates only when the current request originates user matching
some particular Predictive Segmenter constraint.
|