@sitevision/api 2.0.0-alpha.0 → 2.0.0-alpha.2

package/hidden/senselogic/sitevision/api/search/searcher/builder/FilterBuilder/index.d.ts

@@ -1,103 +0,0 @@
-import Filter from "../../component/Filter";
-import Builder from "../../../../base/Builder";
-
-/**
- * <p>
- *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Filter} component with specific behaviour.
- * </p>
- *
- * <p>
- *    FilterBuilder has one <strong>mandatory attribute</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>filter query</em> - The query/queries. Must be non-null.
- *    </li>
- * </ul>
- *
- * <p>
- *    Using the FilterBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
- *    would typically use it like this:
- * </p>
- * <ol>
- *   <li>Get the FilterBuilder</li>
- *   <li>Add a filter query</li>
- *   <li>Possibly add another filter query</li>
- *   <li>...</li>
- *   <li>Do build</li>
- * </ol>
- * <p>
- *    When you have built a <code>Filter</code> instance, you can re-use the FilterBuilder to build more instances. Typically like:
- * </p>
- * <ol>
- *   <li>Clear the filter queries</li>
- *   <li>Add a filter query</li>
- *   <li>Possibly add another filter query</li>
- *   <li>...</li>
- *   <li>Do build</li>
- * </ol>
- * <p>
- *    <strong>Example of how this strategy could be implemented in Velocity:</strong>
- * </p>
- * <pre><code>
- *   <em>## Get the builder</em>
- *   #set ($searchFactory = $sitevisionUtils.searchFactory)
- *   #set ($filterBuilder = $searchFactory.FilterBuilder)
- *
- *   <em>## Create a Filter</em>
- *   #set ($nameMustStartWithAndersFilter = $filterBuilder.addFilterQuery('+name:Anders*').build())
- *
- *   <em>## Re-use the builder to create another Filter</em>
- *   #set ($nameMustContainMagnusFilter = $filterBuilder.clearFilterQueries().addFilterQuery('+name.analyzed:magnus*').build())
- * </code></pre>
- *
- * <p>
- *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.search.SearchFactory#getFilterBuilder()}.
- *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6
- */
-
-interface FilterBuilder {
-  /**
-   * Adds a filter query.
-   *
-   * <p>
-   *    <em>Solr note: this is the 'fq' param</em>
-   * </p>
-   *
-   * <p>
-   *    <strong>Query syntax note! </strong>Query strings should be expressed according to the <em>Solr query syntax</em>.
-   *    The syntax is basically the <em>
-   *    <a href="http://lucene.apache.org/core/4_10_3/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">
-   *    Lucene query syntax</a></em>
-   *    with <em><a href="http://wiki.apache.org/solr/SolrQuerySyntax#Differences_From_Lucene_Query_Parser">some minor differences</a></em>.
-   *    Also note that a general recommendation is to always use the <em>prefix operators</em> (<code>+</code>/<code>-</code>) instead of the
-   *    <em>boolean keywords</em> (AND/OR/NOT) to avoid unexpected behaviour. For deeper understanding, see for example
-   *    <a href="http://searchhub.org/2011/12/28/why-not-and-or-and-not/">Why Not AND, OR, And NOT?</a>.
-   * </p>
-   * @param aFilterQuery the filter query, a <code>null</code> or whitespace-only value will be ignored
-   * @return this builder
-   */
-  addFilterQuery(aFilterQuery: java.lang.String): FilterBuilder;
-
-  /**
-   * Removes all previously added filter queries.
-   * @return this builder
-   */
-  clearFilterQueries(): FilterBuilder;
-
-  /**
-   * Creates a Filter component instance using currently specified state/behaviour.
-   * @return a filter component
-   * @throws IllegalStateException if no filter query exist
-   */
-  build(): Filter;
-}

package/hidden/senselogic/sitevision/api/search/searcher/builder/HighlightBuilder/index.d.ts

@@ -1,153 +0,0 @@
-import Highlight from "../../component/Highlight";
-import Builder from "../../../../base/Builder";
-
-/**
- * <p>
- *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Highlight} component with specific behaviour.
- * </p>
- *
- * <p>
- *    HighlightBuilder has one <strong>mandatory attribute</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>highlighted field</em> - The name of the field(s) that should be highlighted. Must be non-null.
- *    </li>
- * </ul>
- * <p>
- *    HighlightBuilder also has some <strong>optional attributes</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>fragment char count</em> - The size of a highlighted fragment. Default is 200.
- *    </li>
- *    <li>
- *       <em>fragment pre string</em> - The start value of a highlighted section of a fragment. Default is "&lt;mark&gt;".
- *    </li>
- *    <li>
- *       <em>fragment post string</em> - The end value of a highlighted section of a fragment. Default is "&lt;/mark&gt;".
- *    </li>
- * </ul>
- *
- * <p>
- *    Using the HighlightBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
- *    would typically use it like this:
- * </p>
- * <ol>
- *   <li>Get the HighlightBuilder</li>
- *   <li>Add a highlighted field</li>
- *   <li>Possibly set a char count</li>
- *   <li>Possibly set pre + post</li>
- *   <li>Do build</li>
- * </ol>
- * <p>
- *    When you have built a <code>Highlight</code> instance, you can re-use the HighlightBuilder to build more instances. Typically like:
- * </p>
- * <ol>
- *   <li>Clear the highlighted fields</li>
- *   <li>Possibly change char count</li>
- *   <li>Possibly change pre + post</li>
- *   <li>Do build</li>
- * </ol>
- * <p>
- *    <strong>Example of how this strategy could be implemented in Velocity:</strong>
- * </p>
- * <pre><code>
- *   <em>## Get the builder</em>
- *   #set ($searchFactory = $sitevisionUtils.searchFactory)
- *   #set ($highlightBuilder = $searchFactory.highlightBuilder)
- *
- *   <em>## Create a Highlight</em>
- *   #set ($summaryHighlight = $highlightBuilder.addHighlightedField('summary').build())
- *
- *   <em>## Re-use the builder to create another Highlight</em>
- *   #set ($nameHighlight = $highlightBuilder.clearHighlightedFields().addHighlightedField('name').build())
- * </code></pre>
- *
- * <p>
- *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.search.SearchFactory#getHighlightBuilder()}.
- *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6
- */
-
-interface HighlightBuilder {
-  /**
-   * Adds a field that should be highlighted.
-   *
-   * <p>
-   *    <em>Solr note: this is the 'hl.fl' param</em>
-   * </p>
-   * @param aHighlightedField name of the field, a <code>null</code> or whitespace-only value will be ignored
-   * @return this builder
-   */
-  addHighlightedField(aHighlightedField: java.lang.String): HighlightBuilder;
-
-  /**
-   * Removes all previously added highlighted fields.
-   * @return this builder
-   */
-  clearHighlightedFields(): HighlightBuilder;
-
-  /**
-   * Sets the number of chars that highlighted fragment should contain.
-   *
-   * <p>
-   *    If no char count is specified, the default value of the index config will be used (200).
-   * </p>
-   *
-   * <p>
-   *    <em>Solr note: this is the 'hl.fragsize' param</em>
-   * </p>
-   * @param aCharCount the char count
-   * @return this builder
-   * @throws IllegalArgumentException if <code>aCharCount</code> is zero or negative
-   */
-  setFragmentCharCount(aCharCount: int): HighlightBuilder;
-
-  /**
-   * Sets the start value for the highlighted section(s) of a fragment.
-   *
-   * <p>
-   *    If the pre string and post string are not specified, the default value of the index config will be used
-   *    ('&lt;mark&gt;' and '&lt;/mark&gt;').
-   * </p>
-   *
-   * <p>
-   *    <em>Solr note: this is the 'hl.simple.pre' param</em>
-   * </p>
-   * @param aPreString a fragment start
-   * @return this builder
-   */
-  setFragmentPreString(aPreString: java.lang.String): HighlightBuilder;
-
-  /**
-   * Sets the end value for the highlighted section(s) of a fragment.
-   *
-   * <p>
-   *    <strong>Note! </strong> The fragment <em>pre</em> value must match the fragment <em>post</em> string!
-   *    E.g: if the <em>pre</em> string is "&lt;em&gt;", the <em>post</em> string would typically be "&lt;/em&gt;".
-   * </p>
-   *
-   * <p>
-   *    <em>Solr note: this is the 'hl.simple.post' param</em>
-   * </p>
-   * @param aPostString a fragment end
-   * @return this builder
-   */
-  setFragmentPostString(aPostString: java.lang.String): HighlightBuilder;
-
-  /**
-   * Creates a Highlight component instance using currently specified state/behaviour.
-   * @return a Highlight component
-   * @throws IllegalStateException if no highlighted field is specified, or if pre and post strings doesn't match (e.g. one of them is null)
-   */
-  build(): Highlight;
-}

package/hidden/senselogic/sitevision/api/search/searcher/builder/MonitorBuilder/index.d.ts

@@ -1,47 +0,0 @@
-import Monitor from "../../component/Monitor";
-import Builder from "../../../../base/Builder";
-
-/**
- * <p>
- *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Monitor} component.
- * </p>
- *
- * <p>
- *    MonitorBuilder has one <em>optional</em> attribute:
- * </p>
- * <ul>
- *    <li>
- *       <em>query logging</em> - the query logging mode. Default is on (i.e. <code>true</code>).
- *       <em>Important note!</em> Even though the query logging is enabled, it does not necessarily mean that the query actually will be logged
- *       (actual logging requires the <em>Search package 1</em> license).
- *    </li>
- * </ul>
- *
- * <p>
- *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.search.SearchFactory#getMonitorBuilder()}.
- *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 4.1
- */
-
-interface MonitorBuilder {
-  /**
-   * Sets the query logging mode on or off.
-   * @param aEnableQueryLogging whether or not the query logging mode should be turned on (true) or off (false).
-   * @return this builder
-   */
-  setEnableQueryLogging(aEnableQueryLogging: boolean): MonitorBuilder;
-
-  /**
-   * Creates a Monitor component instance using currently specified state/behaviour.
-   * @return a monitor component
-   */
-  build(): Monitor;
-}

package/hidden/senselogic/sitevision/api/search/searcher/builder/SearcherBuilder/index.d.ts

@@ -1,210 +0,0 @@
-import Filter from "../../component/Filter";
-import Highlight from "../../component/Highlight";
-import Node from "../../../../../../../javax/jcr/Node";
-import Parser from "../../component/Parser";
-import Sort from "../../component/Sort";
-import SpellCheck from "../../component/SpellCheck";
-import Monitor from "../../component/Monitor";
-import Searcher from "../../Searcher";
-import Builder from "../../../../base/Builder";
-
-/**
- * <p>
- *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.Searcher} with a specific setup of components.
- * </p>
- *
- * <p>
- *    The following components can be set. All components are optional.
- * </p>
- * <ul>
- *    <li>
- *       {@link senselogic.sitevision.api.search.searcher.component.Parser}<em>
- *          - what parser should be used to handle the queries and what field/fields should be queried?
- *       </em>
- *       Default: a <em>default multi-field parser</em>.
- *    </li>
- *    <li>
- *       {@link senselogic.sitevision.api.search.searcher.component.Filter}<em>
- *          - how should the result be limited?
- *       </em>
- *       Default: <code>null</code> (i.e. no filtering).
- *    </li>
- *    <li>
- *       {@link senselogic.sitevision.api.search.searcher.component.SpellCheck}<em>
- *          - should the search engine try to get suggestions (did you mean)?
- *       </em>
- *       Default: <code>null</code> (i.e. no suggestions).
- *    </li>
- *    <li>
- *       {@link senselogic.sitevision.api.search.searcher.component.Highlight}<em>
- *          - which fields should be highlighted and how?
- *       </em>
- *       Default: <code>null</code> (i.e. no highlighting).
- *    </li>
- *    <li>
- *       {@link senselogic.sitevision.api.search.searcher.component.Sort}<em>
- *          - how should the result be sorted?
- *       </em>
- *       Default: <code>null</code> (i.e. no sorting).
- *    </li>
- *    <li>
- *       {@link senselogic.sitevision.api.search.searcher.component.Monitor}<em>
- *          - how should querying be monitored? (e.g. should search query logging mode be on or off?)
- *       </em>
- *       Default: <code>null</code> (i.e. no monitoring).
- *    </li>
- * </ul>
- * <p>
- *    What <em>index</em> to query can also be specified. Default is the <em>default node index</em>
- *    (i.e. the main index with pages/images/files etc.).
- * </p>
- *
- * <p>
- *    <strong>Example of how to use the SearchBuilder to create a Searcher in Velocity:</strong>
- * </p>
- * <pre><code>
- *   <em>## Get the search factory</em>
- *   #set ($searchFactory = $sitevisionUtils.searchFactory)
- *
- *   <em>## Create a Filter component</em>
- *   #set ($filterBuilder = $searchFactory.filterBuilder)
- *   #set ($filter = $filterBuilder.addFilterQuery('metadata.category:responsive').build())
- *
- *   <em>## Create a Highlight component</em>
- *   #set ($highlightBuilder = $searchFactory.highlightBuilder)
- *   #set ($highlight = $highlightBuilder.addHighlightedField('summary').build())
- *
- *   <em>## Create a Sort component</em>
- *   #set ($lastPublishedSort = $searchFactory.getSearchSortField('lastpublished', true))
- *   #set ($sortBuilder = $searchFactory.sortBuilder)
- *   #set ($sort = $sortBuilder.addSortField($lastPublishedSort).build())
- *
- *   <em>## Get the search builder</em>
- *   #set ($searcherBuilder = $searchFactory.searcherBuilder)
- *
- *   <em>## Set all components and create the Searcher</em>
- *   #set ($searcher = $searcherBuilder.setFilter($filter).setHighlight($highlight).setSort($sort).build())
- *
- *   <em>## Search and handle the result</em>
- *   #set ($searchResult = $searcher.search('example*', 10))
- *   <em>...</em>
- * </code></pre>
- *
- * <p>
- *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.search.SearchFactory#getSearcherBuilder()}.
- *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6
- */
-
-interface SearcherBuilder {
-  /**
-   * Sets the filter component.
-   *
-   * <p>
-   *    A <code>Filter</code> instance is created via the {@link FilterBuilder#build()} method.
-   * </p>
-   * @param aFilter the filter component
-   * @return this builder
-   * @see FilterBuilder
-   */
-  setFilter(aFilter: Filter): SearcherBuilder;
-
-  /**
-   * Sets the highlight component.
-   *
-   * <p>
-   *    A <code>Highlight</code> instance is created via the {@link HighlightBuilder#build()} method.
-   * </p>
-   * @param aHighlight the highlight component
-   * @return this builder
-   * @see HighlightBuilder
-   */
-  setHighlight(aHighlight: Highlight): SearcherBuilder;
-
-  /**
-   * Sets the index to search in.
-   *
-   * <p>
-   *    <strong>Note!</strong> If no index is set, the <code>Searcher</code> that is constructed will use
-   *    the <em>default node index</em> (i.e. the main index with pages/images/files etc.).
-   * </p>
-   *
-   * <p>
-   *    <strong>Tip!</strong> Use the {@link senselogic.sitevision.api.search.index.IndexUtil} utility to get an index.
-   * </p>
-   * @param anIndex the index
-   * @return this builder
-   * @throws IllegalArgumentException if <code>anIndex</code> isn't an index node (primary node type name should be <code>sv:nodeIndex</code> or <code>sv:applicationIndex</code>)
-   */
-  setIndex(anIndex: Node): SearcherBuilder;
-
-  /**
-   * Sets the parser component.
-   *
-   * <p>
-   *    A <code>Parser</code> instance is created via the {@link ExtendedDismaxParserBuilder#build()} method
-   *    or the {@link StandardParserBuilder#build()} method.
-   * </p>
-   *
-   * <p>
-   *    <strong>Note!</strong> If no Parser is set, the <code>Searcher</code> that is constructed will use a <em>default multi-field
-   *    parser</em> (that can be constructed via {@link ExtendedDismaxParserBuilder}).
-   * </p>
-   * @param aParser the parser component
-   * @return this builder
-   * @see ExtendedDismaxParserBuilder
-   * @see StandardParserBuilder
-   */
-  setParser(aParser: Parser): SearcherBuilder;
-
-  /**
-   * Sets the sort component.
-   *
-   * <p>
-   *    A <code>Sort</code> instance is created via the {@link SortBuilder#build()} method.
-   * </p>
-   * @param aSort the sort component
-   * @return this builder
-   * @see SortBuilder
-   */
-  setSort(aSort: Sort): SearcherBuilder;
-
-  /**
-   * Sets the spell check (suggestions/did-you-mean) component.
-   *
-   * <p>
-   *    A <code>SpellCheck</code> instance is created via the {@link SpellCheckBuilder#build()} method.
-   * </p>
-   * @param aSpellCheck the spell check component
-   * @return this builder
-   * @see SpellCheckBuilder
-   */
-  setSpellCheck(aSpellCheck: SpellCheck): SearcherBuilder;
-
-  /**
-   * Sets the monitor component.
-   *
-   * <p>
-   *    A <code>Monitor</code> instance is created via the {@link MonitorBuilder#build()} method.
-   * </p>
-   * @param aMonitor the monitor component
-   * @return this builder
-   * @see MonitorBuilder
-   * @since Sitevision 4.1
-   */
-  setMonitor(aMonitor: Monitor): SearcherBuilder;
-
-  /**
-   * Creates a Searcher instance using currently specified components.
-   * @return a Searcher instance
-   */
-  build(): Searcher;
-}

package/hidden/senselogic/sitevision/api/search/searcher/builder/SortBuilder/index.d.ts

@@ -1,110 +0,0 @@
-import Sort from "../../component/Sort";
-import Builder from "../../../../base/Builder";
-
-/**
- * <p>
- *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Sort} component with specific behaviour.
- * </p>
- *
- * <p>
- *    SortBuilder has one <strong>mandatory attribute</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>sort fields</em> - The sort field(s) that should be used to sort a search result. Must be non-null.
- *    </li>
- * </ul>
- *
- * <p>
- *    Using the SortBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
- *    would typically use it like this:
- * </p>
- * <ol>
- *   <li>Get the SortBuilder</li>
- *   <li>Create a SearchSortField</li>
- *   <li>Add the SearchSortField to the SortBuilder</li>
- *   <li>Possibly create another SearchSortField and add it to the SortBuilder</li>
- *   <li>Do build</li>
- * </ol>
- * <p>
- *    When you have built a <code>Sort</code> instance, you can re-use the SortBuilder to build more instances. Typically like:
- * </p>
- * <ol>
- *   <li>Clear the sort fields</li>
- *   <li>Create a SearchSortField and add it to the SortBuilder</li>
- *   <li>Possibly create another SearchSortField and add it to the SortBuilder</li>
- *   <li>Do build</li>
- * </ol>
- *
- * <p>
- *    <strong>Example of how this strategy could be implemented in sever-side Javascript:</strong>
- * </p>
- * <pre><code>   <em>// Get the factory and the builder</em>
- *   var searchFactory = require('SearchFactory'),
- *       sortBuilder = searchFactory.getSortBuilder(),
- *       searchSortField,
- *       updatedDescSort,
- *       nameAscSort;
- *
- *   <em>// Create a Sort</em>
- *   searchSortField = searchFactory.getSearchSortField('lastpublished', false);
- *   updatedDescSort = sortBuilder.addSortField(searchSortField).build();
- *
- *   <em>// Re-use the builder to create another Sort</em>
- *   searchSortField = searchFactory.getSearchSortField('name.sortable', true);
- *   nameAscSort = sortBuilder.clearSortFields().addSortField(searchSortField).build();
- * </code></pre>
- *
- * <p>
- *    <strong>Example of how this strategy could be implemented in Velocity:</strong>
- * </p>
- * <pre><code>   <em>## Get the factory and the builder</em>
- *   #set ($searchFactory = $sitevisionUtils.searchFactory)
- *   #set ($sortBuilder = $searchFactory.sortBuilder)
- *
- *   <em>## Create a Sort</em>
- *   #set ($searchSortField = $searchFactory.getSearchSortField('lastpublished', false))
- *   #set ($updatedDescSort = $sortBuilder.addSortField($searchSortField).build())
- *
- *   <em>## Re-use the builder to create another Sort</em>
- *   #set ($searchSortField = $searchFactory.getSearchSortField('name.sortable', true))
- *   #set ($nameAscSort = $sortBuilder.clearSortFields().addSortField($searchSortField).build())
- * </code></pre>
- *
- * <p>
- *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.search.SearchFactory#getSortBuilder()}.
- *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6
- */
-
-interface SortBuilder {
-  /**
-   * Adds a sort field.
-   * @param aSearchSortField a sort field, a <code>null</code> value is ignored
-   * @return this builder
-   */
-  addSortField(
-    aSearchSortField: senselogic.sitevision.api.search.SearchSortField
-  ): SortBuilder;
-
-  /**
-   * Removes all previously added sort fields.
-   * @return this builder
-   */
-  clearSortFields(): SortBuilder;
-
-  /**
-   * Creates a Sort component instance using currently specified state/behaviour.
-   * @return a Sort component
-   * @throws IllegalStateException if no sort fields are added
-   */
-  build(): Sort;
-}

package/hidden/senselogic/sitevision/api/search/searcher/builder/SpellCheckBuilder/index.d.ts

@@ -1,57 +0,0 @@
-import SpellCheck from "../../component/SpellCheck";
-import Builder from "../../../../base/Builder";
-
-/**
- * <p>
- *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.SpellCheck} component.
- * </p>
- *
- * <p>
- *    SpellCheckBuilder has one <em>optional</em> attribute:
- * </p>
- * <ul>
- *    <li>
- *       <em>custom spellcheck query</em> - A custom expression/query to use when extracting "did you mean" suggestions.
- *    </li>
- * </ul>
- *
- * <p>
- *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.search.SearchFactory#getSpellCheckBuilder()}.
- *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6
- */
-
-interface SpellCheckBuilder {
-  /**
-   * Sets a custom query/expression spellchecker should use when the extracting result.
-   *
-   * <p>
-   *    The <em>display query</em> is used by {@link senselogic.sitevision.api.search.searcher.Searcher} as default spellcheck query
-   *    (i.e. if no custom value is set via this method).
-   * </p>
-   *
-   * <p>
-   *    <em>Solr note: this is the 'spellcheck.q' param</em>
-   * </p>
-   * @param aCustomSpellCheckQuery the custom query/expression <em>(Note that a <code>null</code> or whitespace-only value will be ignored by {@link senselogic.sitevision.api.search.searcher.Searcher}).</em>
-   * @return this builder
-   * @since Sitevision 4.0
-   */
-  setCustomSpellCheckQuery(
-    aCustomSpellCheckQuery: java.lang.String
-  ): SpellCheckBuilder;
-
-  /**
-   * Creates a SpellCheck component instance.
-   * @return a SpellCheck component.
-   */
-  build(): SpellCheck;
-}