@sitevision/api 1.1.0-alpha.1 → 2.0.0-alpha.0

package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts

@@ -24,39 +24,6 @@ import ExceptionSuppressingProxy from "../ExceptionSuppressingProxy";
  *    or indirectly via {@link senselogic.sitevision.api.Utils#getExceptionSuppressingCollection(java.util.Collection)}.
  *    You would typically use the latter if you should iterate a collection with the Velocity #foreach loop.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Returns <code>true</code> if decorated iterator has more elements. (In other words, returns <code>true</code>
- * if <code>next</code> would return an element rather than throwing an exception.)
- *
- * <p>
- * This method will never throw an exception
- * </p>Returns a proxy for the next element of the decorated iterator. Calling this method repeatedly until the {@link #hasNext()} method
- * returns <code>false</code> will return each element in the underlying collection exactly once.
- *
- * <p>
- *    <strong>Note!</strong> The returned element will be embedded in an <code>ExceptionSuppressingProxy</code> that will be reused for
- *    <em>all</em> next() invocations on this iterator. In other words, the proxied item of the returned element will change,
- *    but never the returned element itself. This implies that you shouldn't keep references to an item retrieved from a next()
- *    invocation during iteration. If you do, don't be surprised if the element contains something else than it did when you set the reference...
- * </p>
- *
- * <p>
- * This method will never throw an exception.
- * </p>
- * <p>
- *    <strong>Note! </strong>Be aware of <code>null</code> items since they're never proxied. If the underlying collection contains a
- *    <code>null</code> item, this iterator will just return <code>null</code>, not a proxy. In other words: even though this method
- *    won't throw any exceptions, invoking a method on the returned object might throw a <code>NullPointerException</code>.
- * </p>Tries to remove from the underlying collection the last element returned by decorated iterator (optional operation).
- * This method can be called only once per call to <code>next</code>. The behavior of an iterator is unspecified if
- * the underlying collection is modified while the iteration is in progress in any way other than by calling this method.
- *
- * <p>
- * This method will never throw an exception.
- * </p>
- * <p>
- * <strong>Note!</strong> Since exceptions are suppressed, you can never tell if the remove operation actually succeeded
- * or if the underlying collection doesn't support removal (i.e. <code>UnsupportedOperationException</code> thrown by the
- * decorated iterator is catched by this iterator).
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09

package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  hasNext: function hasNext() {},
+  next: function next() {},
+  remove: function remove() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts

@@ -63,7 +63,7 @@
  *
  *       $!proxy.thisMethodSometimesThrowsExceptions() <em>## Method invoked through a proxy, might return null</em>
  *    &lt;/p&gt;
- * </code></pre>Returns current statusReturns the exception that was thrown during last method invocation of the proxied object.Returns the proxied objectThe status indicating that this proxy has no object set, nothing to proxy.The status indicating that last method invocation did not throw an exception.The status indicating that last method invocation did throw an exception
+ * </code></pre>The status indicating that this proxy has no object set, nothing to proxy.The status indicating that last method invocation did not throw an exception.The status indicating that last method invocation did throw an exception
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
  */

package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getCurrentStatus: function getCurrentStatus() {},
+  getCurrentException: function getCurrentException() {},
+  getProxiedObject: function getProxiedObject() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/search/SearchFactory/index.d.ts

@@ -0,0 +1,114 @@
+import ExtendedDismaxParserBuilder from "../searcher/builder/ExtendedDismaxParserBuilder";
+import FilterBuilder from "../searcher/builder/FilterBuilder";
+import HighlightBuilder from "../searcher/builder/HighlightBuilder";
+import IndexUtil from "../index/IndexUtil";
+import IndexingUtil from "../index/IndexingUtil";
+import SearcherBuilder from "../searcher/builder/SearcherBuilder";
+import SortBuilder from "../searcher/builder/SortBuilder";
+
+import SearchUtil from "../SearchUtil";
+import SpellCheckBuilder from "../searcher/builder/SpellCheckBuilder";
+import StandardParserBuilder from "../searcher/builder/StandardParserBuilder";
+import QueryStringUtil from "../query/QueryStringUtil";
+import MonitorBuilder from "../searcher/builder/MonitorBuilder";
+
+/**
+ * Factory for creating search-related instances.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getSearchFactory()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+
+interface SearchFactory {
+  /**
+   * Gets a ExtendedDismaxParserBuilder instance.
+   * @return a ExtendedDismaxParserBuilder instance
+   */
+  getExtendedDismaxParserBuilder(): ExtendedDismaxParserBuilder;
+
+  /**
+   * Gets a FilterBuilder instance.
+   * @return a FilterBuilder instance
+   */
+  getFilterBuilder(): FilterBuilder;
+
+  /**
+   * Gets a HighlightBuilder instance.
+   * @return a HighlightBuilder instance
+   */
+  getHighlightBuilder(): HighlightBuilder;
+
+  /**
+   * Gets an IndexUtil instance.
+   * @return an IndexUtil instance
+   */
+  getIndexUtil(): IndexUtil;
+
+  /**
+   * Gets an IndexingUtil instance.
+   * @return an IndexingUtil instance
+   * @since Sitevision 3.6.4
+   */
+  getIndexingUtil(): IndexingUtil;
+
+  /**
+   * Gets a SearcherBuilder instance.
+   * @return a SearcherBuilder instance
+   */
+  getSearcherBuilder(): SearcherBuilder;
+
+  /**
+   * Gets a SortBuilder instance.
+   * @return a SortBuilder instance
+   */
+  getSortBuilder(): SortBuilder;
+
+  /**
+   * Convenience method to get a SearchSortField instance.
+   * @param aField name of the sortable index field
+   * @param aIsAscending the sort order (true == ascending, false == descending)
+   * @return a SearchSortField instance
+   * @throws IllegalArgumentException if aField is null or whitespace-only
+   */
+  getSearchSortField(
+    aField: java.lang.String,
+    aIsAscending: boolean
+  ): SearchSortField;
+
+  /**
+   * Convenience method to get a SearchUtil instance.
+   *
+   * <em>A SearchUtil instance can also be retrieved via the {@link senselogic.sitevision.api.Utils#getSearchUtil()}</em>
+   * @return a SearchUtil instance
+   */
+  getSearchUtil(): SearchUtil;
+
+  /**
+   * Gets a SpellCheckBuilder instance.
+   * @return a SpellCheckBuilder instance
+   */
+  getSpellCheckBuilder(): SpellCheckBuilder;
+
+  /**
+   * Gets a StandardParserBuilder instance.
+   * @return a StandardParserBuilder instance
+   */
+  getStandardParserBuilder(): StandardParserBuilder;
+
+  /**
+   * Gets a QueryStringUtil instance.
+   * @return a QueryStringUtil instance
+   */
+  getQueryStringUtil(): QueryStringUtil;
+
+  /**
+   * Gets a MonitorBuilder instance.
+   * @return a MonitorBuilder instance
+   * @since Sitevision 4.1
+   */
+  getMonitorBuilder(): MonitorBuilder;
+}

package/hidden/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts

@@ -5,19 +5,7 @@
  *    <strong>Note!</strong> {@link senselogic.sitevision.api.search.SearchHit} has - as of Sitevision 3.0 - several typed <code>getField</code>
  *    methods that you would typically instead of this interface when you want to get "non-String" values!
  *    <a href="../../../../senselogic/sitevision/api/search/SearchHit.html#knowyourfields">More information about field values/types</a>
- * </p>Returns the Date for a string field that contains a date value generated via Lucene's DateTools class.Returns the Calendar for a string field that contains a date value generated via Lucene's DateTools class.Returns the Locale for a string field that contains a locale-based value that contains language ("en") or language and country ("en_US").
- *
- * <p>
- * A <code>toString()</code> on a english american locale returns the String <code>"en_US"</code>, but to create a locale
- * from that string you can NOT just create it by doing: <code>new Locale("en_US")</code>. You must split language (en)
- * and country (US) since the proper way of creating the Locale is: <code>new Locale("en", "US")</code>. Language must
- * be lowercased and country must be uppercased. This method will handle that (i.e. <code>aLocaleFieldValue == "EN_us"</code>
- * -&gt; <code>new Locale("en", "US")</code>).
  * </p>
- *
- * <p>
- * <strong>Note!</strong> This method does <em>NOT</em> handle variants!
- * </p>Returns the Integer for a string field that contains a integer value generated via Lucene's NumberTools (i.e. long) class.Returns the Long for a string field that contains a long value generated via Lucene's NumberTools class.Returns the Double for a string field that contains a double value generated to be a sortable search value.
  * @author Magnus Lövgren
  * @see senselogic.sitevision.api.search.SearchHit#getBooleanField(String)
  * @see senselogic.sitevision.api.search.SearchHit#getDateField(String)

package/hidden/senselogic/sitevision/api/search/SearchFieldUtil/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  dateFieldToDate: function dateFieldToDate() {},
+  dateFieldToCalendar: function dateFieldToCalendar() {},
+  localeFieldToLocale: function localeFieldToLocale() {},
+  intFieldToInt: function intFieldToInt() {},
+  longFieldToLong: function longFieldToLong() {},
+  doubleFieldToDouble: function doubleFieldToDouble() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts

@@ -5,7 +5,7 @@ import SearchHit from "../SearchHit";
  * This interface is deprecated and non-functional as of Sitevision 3.0. The Sitevision search engine has been replaced
  * (from Lucene to Solr) and highlighting of arbitrary fields in a search result via <code>SearchHighlighter</code> is no longer possible.
  * In Solr you should specify the field(-s) that should be highlighted when you execute the query.
- * </p>Returns a highlighted fragment for the default highlighting field.Returns a highlighted fragment for a specified field.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 2.7_06
  * @deprecated This interface will do absolutely nothing as of Sitevision 3.0 (search engine has been replaced). Interface methods will not do anything (i.e. always return <code>null</code>) and this interface will be completely removed in future releases of Sitevision.

package/hidden/senselogic/sitevision/api/search/SearchHighlighter/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getHighlightedFragment: function getHighlightedFragment() {}
+};
+exports["default"] = _default;