21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/apidocs/resources/glass.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/CommerceExperts/open-commerce-search/4a5cc11a7a871b647c92fdf5a5bf9694ef5483b3/docs/apidocs/resources/glass.png
--------------------------------------------------------------------------------
/docs/apidocs/resources/x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/CommerceExperts/open-commerce-search/4a5cc11a7a871b647c92fdf5a5bf9694ef5483b3/docs/apidocs/resources/x.png
--------------------------------------------------------------------------------
/docs/assets/css/style.scss:
--------------------------------------------------------------------------------
1 | ---
2 | ---
3 |
4 | @import "{{ site.theme }}";
5 |
6 | #project_title {
7 | font-size: 32px;
8 | margin-top: 8px;
9 | }
10 | #project_logo {
11 | float: left;
12 | width: 100px;
13 | border: 0;
14 | box-shadow: none;
15 | margin: 0 10px 0 0;
16 | }
17 |
--------------------------------------------------------------------------------
/docs/assets/ocss_logo_only.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/CommerceExperts/open-commerce-search/4a5cc11a7a871b647c92fdf5a5bf9694ef5483b3/docs/assets/ocss_logo_only.png
--------------------------------------------------------------------------------
/docs/javadoc.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: javadoc
3 | ---
4 |
5 |
6 |
12 |
--------------------------------------------------------------------------------
/docs/openapi/.openapi-generator-ignore:
--------------------------------------------------------------------------------
1 | # OpenAPI Generator Ignore
2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3 |
4 | # Use this file to prevent files from being overwritten by the generator.
5 | # The patterns follow closely to .gitignore or .dockerignore.
6 |
7 | # As an example, the C# client generator defines ApiClient.cs.
8 | # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9 | #ApiClient.cs
10 |
11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12 | #foo/*/qux
13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14 |
15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16 | #foo/**/qux
17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18 |
19 | # You can also negate patterns with an exclamation (!).
20 | # For example, you can ignore all files in a docs folder with the file extension .md:
21 | #docs/*.md
22 | # Then explicitly reverse the ignore rule for a single file:
23 | #!docs/README.md
24 |
--------------------------------------------------------------------------------
/docs/openapi/.openapi-generator/FILES:
--------------------------------------------------------------------------------
1 | Apis/IndexerApi.md
2 | Apis/SearchApi.md
3 | Apis/SuggestApi.md
4 | Apis/UpdateApi.md
5 | Models/ArrangedSearchQuery.md
6 | Models/Attribute.md
7 | Models/BulkImportData.md
8 | Models/Category.md
9 | Models/Document.md
10 | Models/Document_data_value.md
11 | Models/DynamicProductSet.md
12 | Models/Facet.md
13 | Models/FacetEntry.md
14 | Models/GenericProductSet.md
15 | Models/HierarchialFacetEntry.md
16 | Models/ImportSession.md
17 | Models/IntervalFacetEntry.md
18 | Models/Product.md
19 | Models/ProductSet.md
20 | Models/QueryStringProductSet.md
21 | Models/RangeFacetEntry.md
22 | Models/ResultHit.md
23 | Models/SearchQuery.md
24 | Models/SearchResult.md
25 | Models/SearchResultSlice.md
26 | Models/Sorting.md
27 | Models/StaticProductSet.md
28 | Models/Suggestion.md
29 | README.md
30 |
--------------------------------------------------------------------------------
/docs/openapi/.openapi-generator/VERSION:
--------------------------------------------------------------------------------
1 | 7.9.0
2 |
--------------------------------------------------------------------------------
/docs/openapi/Apis/SuggestApi.md:
--------------------------------------------------------------------------------
1 | # SuggestApi
2 |
3 | All URIs are relative to *http://localhost*
4 |
5 | | Method | HTTP request | Description |
6 | |------------- | ------------- | -------------|
7 | | [**suggest**](SuggestApi.md#suggest) | **GET** /suggest-api/v1/{indexname}/suggest | Autocomplete the user input |
8 |
9 |
10 |
11 | # **suggest**
12 | > List suggest(indexname, userQuery, limit, filter)
13 |
14 | Autocomplete the user input
15 |
16 | Runs a suggestion request on the data of a certain index.
17 |
18 | ### Parameters
19 |
20 | |Name | Type | Description | Notes |
21 | |------------- | ------------- | ------------- | -------------|
22 | | **indexname** | **String**| index name that should be searched for autocompletions | [default to null] |
23 | | **userQuery** | **String**| the simple raw query typed by the user | [default to null] |
24 | | **limit** | **Integer**| A optional limit for the suggestions | [optional] [default to null] |
25 | | **filter** | **String**| Optional comma-separated list of filter values. | [optional] [default to null] |
26 |
27 | ### Return type
28 |
29 | [**List**](../Models/Suggestion.md)
30 |
31 | ### Authorization
32 |
33 | [basic-auth](../index.md#basic-auth)
34 |
35 | ### HTTP request headers
36 |
37 | - **Content-Type**: Not defined
38 | - **Accept**: */*, text/plain
39 |
40 |
--------------------------------------------------------------------------------
/docs/openapi/Models/Attribute.md:
--------------------------------------------------------------------------------
1 | # Attribute
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **code** | **String** | Optional: code is considered as ID of the attribute value, e.g. \"FF0000\" for color | [optional] [default to null] |
7 | | **name** | **String** | The name SHOULD be URL friendly identifier for the attribute, since it could be used to build according filter parameters. | [default to null] |
8 | | **value** | **String** | Human readable representation of that attribute, e.g. 'Red' for the attribute 'Color' | [default to null] |
9 |
10 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/openapi/Models/BulkImportData.md:
--------------------------------------------------------------------------------
1 | # BulkImportData
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **documents** | [**List**](Document.md) | An array of Documents or Products that should be indexed into the given index.Products have the speciality to contain other documents as variants. | [default to null] |
7 | | **session** | [**ImportSession**](ImportSession.md) | | [default to null] |
8 |
9 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/openapi/Models/Category.md:
--------------------------------------------------------------------------------
1 | # Category
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **id** | **String** | Optional ID for a consistent filtering | [optional] [default to null] |
7 | | **name** | **String** | actual category name | [default to null] |
8 |
9 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/openapi/Models/Document.md:
--------------------------------------------------------------------------------
1 | # Document
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **attributes** | [**List**](Attribute.md) | multiple attributes can be delivered separately from standard data fields | [optional] [default to null] |
7 | | **categories** | [**List**](array.md) | A category path is a list of Category objects that are defined in a hierarchical parent-child relationship.Multiple category paths can be defined per document, therefor this property is a list of category arrays. | [optional] [default to null] |
8 | | **data** | [**Map**](Document_data_value.md) | The data property should be used for standard fields, such as title, description, price. Only values of the following types are accepted (others will be dropped silently): Standard primitive types (Boolean, String, Integer, Double) and arrays of these types. Attributes (key-value objects with ID) should be passed to the attributes property. | [default to null] |
9 | | **id** | **String** | | [default to null] |
10 |
11 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/openapi/Models/Document_data_value.md:
--------------------------------------------------------------------------------
1 | # Document_data_value
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 |
7 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
8 |
9 |
--------------------------------------------------------------------------------
/docs/openapi/Models/DynamicProductSet.md:
--------------------------------------------------------------------------------
1 | # DynamicProductSet
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **asSeparateSlice** | **Boolean** | | [optional] [default to null] |
7 | | **name** | **String** | | [optional] [default to null] |
8 | | **size** | **Integer** | | [optional] [default to null] |
9 | | **type** | **String** | | [optional] [default to null] |
10 | | **variantBoostTerms** | **String** | | [optional] [default to null] |
11 | | **filters** | **Map** | | [optional] [default to null] |
12 | | **limit** | **Integer** | | [optional] [default to null] |
13 | | **query** | **String** | | [optional] [default to null] |
14 | | **sort** | **String** | | [optional] [default to null] |
15 |
16 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
17 |
18 |
--------------------------------------------------------------------------------
/docs/openapi/Models/DynamicProductSet_allOf.md:
--------------------------------------------------------------------------------
1 | # DynamicProductSet_allOf
2 | ## Properties
3 |
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **filters** | **Map** | | [optional] [default to null]
7 | **limit** | **Integer** | | [optional] [default to null]
8 | **name** | **String** | | [optional] [default to null]
9 | **query** | **String** | | [optional] [default to null]
10 | **size** | **Integer** | | [optional] [default to null]
11 | **sort** | **String** | | [optional] [default to null]
12 | **type** | **String** | | [optional] [default to null]
13 |
14 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
15 |
16 |
--------------------------------------------------------------------------------
/docs/openapi/Models/Facet.md:
--------------------------------------------------------------------------------
1 | # Facet
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **absoluteFacetCoverage** | **Long** | This is the amount of matched documents that are covered by that facet. | [optional] [default to null] |
7 | | **entries** | [**List**](FacetEntry.md) | The entries of that facet. | [optional] [default to null] |
8 | | **fieldName** | **String** | This is the name coming from the data. Separate label information should be available in the meta data. | [optional] [default to null] |
9 | | **filtered** | **Boolean** | | [optional] [default to null] |
10 | | **isFiltered** | **Boolean** | Is set to true if there an active filter from that facet. | [optional] [default to null] |
11 | | **meta** | **Map** | Optional meta data for that facet, e.g. display hints like a label or a facet-type. | [optional] [default to null] |
12 | | **type** | **String** | The type of the facet, so the kind of FacetEntries it contains. See the according FacetEntry variants for more details. | [optional] [default to null] |
13 |
14 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
15 |
16 |
--------------------------------------------------------------------------------
/docs/openapi/Models/FacetEntry.md:
--------------------------------------------------------------------------------
1 | # FacetEntry
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **docCount** | **Long** | Estimated amount of documents that will be returned, if this facet entry is picked as filter. | [optional] [default to null] |
7 | | **id** | **String** | | [optional] [default to null] |
8 | | **key** | **String** | | [optional] [default to null] |
9 | | **link** | **URI** | | [optional] [default to null] |
10 | | **selected** | **Boolean** | Should be set to true in the response, if that filter is actually selected. | [optional] [default to null] |
11 | | **type** | **String** | | [optional] [default to null] |
12 |
13 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/openapi/Models/GenericProductSet.md:
--------------------------------------------------------------------------------
1 | # GenericProductSet
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **asSeparateSlice** | **Boolean** | | [optional] [default to null] |
7 | | **name** | **String** | | [optional] [default to null] |
8 | | **size** | **Integer** | | [optional] [default to null] |
9 | | **type** | **String** | | [optional] [default to null] |
10 | | **variantBoostTerms** | **String** | | [optional] [default to null] |
11 | | **parameters** | **Map** | | [optional] [default to null] |
12 |
13 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/openapi/Models/HierarchialFacetEntry.md:
--------------------------------------------------------------------------------
1 | # HierarchialFacetEntry
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **docCount** | **Long** | Estimated amount of documents that will be returned, if this facet entry is picked as filter. | [optional] [default to null] |
7 | | **id** | **String** | | [optional] [default to null] |
8 | | **key** | **String** | | [optional] [default to null] |
9 | | **link** | **URI** | | [optional] [default to null] |
10 | | **selected** | **Boolean** | Should be set to true in the response, if that filter is actually selected. | [optional] [default to null] |
11 | | **type** | **String** | | [optional] [default to null] |
12 | | **children** | [**List**](FacetEntry.md) | Child facet entries to that particular facet. The child facets again could be HierarchialFacetEntries. | [optional] [default to null] |
13 | | **path** | **String** | | [optional] [default to null] |
14 |
15 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
16 |
17 |
--------------------------------------------------------------------------------
/docs/openapi/Models/HierarchialFacetEntry_allOf.md:
--------------------------------------------------------------------------------
1 | # HierarchialFacetEntry_allOf
2 | ## Properties
3 |
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **children** | [**List**](FacetEntry.md) | Child facet entries to that particular facet. The child facets again could be HierarchialFacetEntries. | [optional] [default to null]
7 | **docCount** | **Long** | Estimated amount of documents that will be returned, if this facet entry is picked as filter. | [optional] [default to null]
8 | **id** | **String** | | [optional] [default to null]
9 | **key** | **String** | | [optional] [default to null]
10 | **link** | **URI** | | [optional] [default to null]
11 | **path** | **String** | | [optional] [default to null]
12 | **selected** | **Boolean** | Should be set to true in the response, if that filter is actually selected. | [optional] [default to null]
13 | **type** | **String** | | [optional] [default to null]
14 |
15 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
16 |
17 |
--------------------------------------------------------------------------------
/docs/openapi/Models/ImportSession.md:
--------------------------------------------------------------------------------
1 | # ImportSession
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **finalIndexName** | **String** | | [default to null] |
7 | | **temporaryIndexName** | **String** | | [default to null] |
8 |
9 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/openapi/Models/IntervalFacetEntry.md:
--------------------------------------------------------------------------------
1 | # IntervalFacetEntry
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **docCount** | **Long** | Estimated amount of documents that will be returned, if this facet entry is picked as filter. | [optional] [default to null] |
7 | | **id** | **String** | | [optional] [default to null] |
8 | | **key** | **String** | | [optional] [default to null] |
9 | | **link** | **URI** | | [optional] [default to null] |
10 | | **selected** | **Boolean** | Should be set to true in the response, if that filter is actually selected. | [optional] [default to null] |
11 | | **type** | **String** | | [optional] [default to null] |
12 | | **lowerBound** | **BigDecimal** | | [optional] [default to null] |
13 | | **upperBound** | **BigDecimal** | | [optional] [default to null] |
14 |
15 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
16 |
17 |
--------------------------------------------------------------------------------
/docs/openapi/Models/IntervalFacetEntry_allOf.md:
--------------------------------------------------------------------------------
1 | # IntervalFacetEntry_allOf
2 | ## Properties
3 |
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **docCount** | **Long** | Estimated amount of documents that will be returned, if this facet entry is picked as filter. | [optional] [default to null]
7 | **id** | **String** | | [optional] [default to null]
8 | **key** | **String** | | [optional] [default to null]
9 | **link** | **URI** | | [optional] [default to null]
10 | **lowerBound** | **BigDecimal** | | [optional] [default to null]
11 | **selected** | **Boolean** | Should be set to true in the response, if that filter is actually selected. | [optional] [default to null]
12 | **type** | **String** | | [optional] [default to null]
13 | **upperBound** | **BigDecimal** | | [optional] [default to null]
14 |
15 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
16 |
17 |
--------------------------------------------------------------------------------
/docs/openapi/Models/ProductSet.md:
--------------------------------------------------------------------------------
1 | # ProductSet
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **asSeparateSlice** | **Boolean** | | [optional] [default to null] |
7 | | **name** | **String** | | [optional] [default to null] |
8 | | **size** | **Integer** | | [optional] [default to null] |
9 | | **type** | **String** | | [optional] [default to null] |
10 | | **variantBoostTerms** | **String** | | [optional] [default to null] |
11 |
12 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/openapi/Models/Product_allOf.md:
--------------------------------------------------------------------------------
1 | # Product_allOf
2 | ## Properties
3 |
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **variants** | [**List**](Document.md) | for products without variants, it can be null or rather us a document directly. | [optional] [default to null]
7 |
8 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
9 |
10 |
--------------------------------------------------------------------------------
/docs/openapi/Models/QueryStringProductSet.md:
--------------------------------------------------------------------------------
1 | # QueryStringProductSet
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **asSeparateSlice** | **Boolean** | | [optional] [default to null] |
7 | | **name** | **String** | | [optional] [default to null] |
8 | | **size** | **Integer** | | [optional] [default to null] |
9 | | **type** | **String** | | [optional] [default to null] |
10 | | **variantBoostTerms** | **String** | | [optional] [default to null] |
11 | | **fieldWeights** | **Map** | | [optional] [default to null] |
12 | | **filters** | **Map** | | [optional] [default to null] |
13 | | **limit** | **Integer** | | [optional] [default to null] |
14 | | **query** | **String** | | [optional] [default to null] |
15 | | **sort** | **String** | | [optional] [default to null] |
16 |
17 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
18 |
19 |
--------------------------------------------------------------------------------
/docs/openapi/Models/RangeFacetEntry.md:
--------------------------------------------------------------------------------
1 | # RangeFacetEntry
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **docCount** | **Long** | Estimated amount of documents that will be returned, if this facet entry is picked as filter. | [optional] [default to null] |
7 | | **id** | **String** | | [optional] [default to null] |
8 | | **key** | **String** | | [optional] [default to null] |
9 | | **link** | **URI** | | [optional] [default to null] |
10 | | **selected** | **Boolean** | Should be set to true in the response, if that filter is actually selected. | [optional] [default to null] |
11 | | **type** | **String** | | [optional] [default to null] |
12 | | **lowerBound** | **BigDecimal** | | [optional] [default to null] |
13 | | **selectedMax** | **BigDecimal** | | [optional] [default to null] |
14 | | **selectedMin** | **BigDecimal** | | [optional] [default to null] |
15 | | **upperBound** | **BigDecimal** | | [optional] [default to null] |
16 |
17 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
18 |
19 |
--------------------------------------------------------------------------------
/docs/openapi/Models/RangeFacetEntry_allOf.md:
--------------------------------------------------------------------------------
1 | # RangeFacetEntry_allOf
2 | ## Properties
3 |
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **docCount** | **Long** | Estimated amount of documents that will be returned, if this facet entry is picked as filter. | [optional] [default to null]
7 | **id** | **String** | | [optional] [default to null]
8 | **key** | **String** | | [optional] [default to null]
9 | **link** | **URI** | | [optional] [default to null]
10 | **lowerBound** | **BigDecimal** | | [optional] [default to null]
11 | **selected** | **Boolean** | Should be set to true in the response, if that filter is actually selected. | [optional] [default to null]
12 | **selectedMax** | **BigDecimal** | | [optional] [default to null]
13 | **selectedMin** | **BigDecimal** | | [optional] [default to null]
14 | **type** | **String** | | [optional] [default to null]
15 | **upperBound** | **BigDecimal** | | [optional] [default to null]
16 |
17 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
18 |
19 |
--------------------------------------------------------------------------------
/docs/openapi/Models/ResultHit.md:
--------------------------------------------------------------------------------
1 | # ResultHit
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **document** | [**Document**](Document.md) | | [optional] [default to null] |
7 | | **index** | **String** | | [optional] [default to null] |
8 | | **matchedQueries** | **List** | | [optional] [default to null] |
9 | | **metaData** | **Map** | | [optional] [default to null] |
10 |
11 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/openapi/Models/SearchQuery.md:
--------------------------------------------------------------------------------
1 | # SearchQuery
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **limit** | **Integer** | The amount of products to return in the result | [optional] [default to null] |
7 | | **offset** | **Integer** | The amount of products to omit from the whole result to select the returned results. | [optional] [default to null] |
8 | | **q** | **String** | the user query | [optional] [default to null] |
9 | | **sort** | **String** | Full sorting parameter value. This is the name of the sorting and optionally a dash as prefix, thats means the sorting should be descending. Several sorting criterion can be defined by separating the values using comma. | [optional] [default to null] |
10 | | **withFacets** | **Boolean** | flag to specify if facets should be returned with the requested response. Should be set to false in case only the next batch of hits is requested (e.g. for endless scrolling). | [optional] [default to null] |
11 |
12 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/openapi/Models/Sorting.md:
--------------------------------------------------------------------------------
1 | # Sorting
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **active** | **Boolean** | | [optional] [default to null] |
7 | | **field** | **String** | | [optional] [default to null] |
8 | | **isActive** | **Boolean** | | [optional] [default to null] |
9 | | **label** | **String** | | [optional] [default to null] |
10 | | **link** | **URI** | | [optional] [default to null] |
11 | | **sortOrder** | **String** | | [optional] [default to null] |
12 |
13 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/openapi/Models/StaticProductSet.md:
--------------------------------------------------------------------------------
1 | # StaticProductSet
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **asSeparateSlice** | **Boolean** | | [optional] [default to null] |
7 | | **name** | **String** | | [optional] [default to null] |
8 | | **size** | **Integer** | | [optional] [default to null] |
9 | | **type** | **String** | | [optional] [default to null] |
10 | | **variantBoostTerms** | **String** | | [optional] [default to null] |
11 | | **ids** | **List** | | [optional] [default to null] |
12 |
13 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/openapi/Models/StaticProductSet_allOf.md:
--------------------------------------------------------------------------------
1 | # StaticProductSet_allOf
2 | ## Properties
3 |
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **ids** | **List** | | [optional] [default to null]
7 | **name** | **String** | | [optional] [default to null]
8 | **size** | **Integer** | | [optional] [default to null]
9 | **type** | **String** | | [optional] [default to null]
10 |
11 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/openapi/Models/Suggestion.md:
--------------------------------------------------------------------------------
1 | # Suggestion
2 | ## Properties
3 |
4 | | Name | Type | Description | Notes |
5 | |------------ | ------------- | ------------- | -------------|
6 | | **payload** | **Map** | arbitrary payload attached to that suggestion. Default: null | [optional] [default to null] |
7 | | **phrase** | **String** | The phrase that is suggested and/or used as suggestion label. | [optional] [default to null] |
8 | | **type** | **String** | Optional type of that suggestion. Should be different for the different kind of suggested data. Default: 'keyword' | [optional] [default to null] |
9 |
10 | [[Back to Model list]](../index.md#documentation-for-models) [[Back to API list]](../index.md#documentation-for-api-endpoints) [[Back to README]](../index.md)
11 |
12 |
--------------------------------------------------------------------------------
/indexer-service/data/nodes/0/node.lock:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/CommerceExperts/open-commerce-search/4a5cc11a7a871b647c92fdf5a5bf9694ef5483b3/indexer-service/data/nodes/0/node.lock
--------------------------------------------------------------------------------
/indexer-service/src/main/java/de/cxp/ocs/conf/IndexConfiguration.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.conf;
2 |
3 | import org.springframework.boot.context.properties.NestedConfigurationProperty;
4 |
5 | import de.cxp.ocs.config.DataProcessorConfiguration;
6 | import de.cxp.ocs.config.FieldConfiguration;
7 | import de.cxp.ocs.config.IndexSettings;
8 | import lombok.Getter;
9 | import lombok.NonNull;
10 | import lombok.Setter;
11 |
12 | @Getter
13 | public class IndexConfiguration {
14 |
15 | @Setter
16 | @NonNull
17 | @NestedConfigurationProperty
18 | private IndexSettings indexSettings = new IndexSettings();
19 |
20 | @Setter
21 | @NonNull
22 | @NestedConfigurationProperty
23 | private DataProcessorConfiguration dataProcessorConfiguration = new DataProcessorConfiguration();
24 |
25 | @Setter
26 | @NonNull
27 | @NestedConfigurationProperty
28 | private FieldConfiguration fieldConfiguration = new FieldConfiguration();
29 |
30 | }
31 |
--------------------------------------------------------------------------------
/indexer-service/src/main/java/de/cxp/ocs/conf/converter/ConfigureableField.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.conf.converter;
2 |
3 | import de.cxp.ocs.config.Field;
4 |
5 | /**
6 | * ConfigureableDataprocessor implementations manipulate, extract,
7 | * enrich, ... fields. As the configuration of that implementations has a huge
8 | * diversity, the configuration is done via YAML through the
9 | * DataProcessorConfiguration. To enable more type save programming than
10 | * working on a Map, the ConfigureableDataprocessor parses that
11 | * map into ConfigureableField implementations for specifying
12 | * ConfigureableDataprocessor implementations.
13 | */
14 | public interface ConfigureableField {
15 |
16 | /**
17 | * Gets the name of the field the ConfigureableDataprocessor is
18 | * working on. This field is used the extract the record value before
19 | * passing it to further processing steps.
20 | *
21 | * @return the name of the {@link Field}.
22 | */
23 | String getFieldName();
24 |
25 | // TODO: Let the ConfigureableField implementations do the mapping from
26 | // confMap to concrete class? static method does not work on interfaces,
27 | // could some builder or factory pattern be used
28 | }
29 |
--------------------------------------------------------------------------------
/indexer-service/src/main/java/de/cxp/ocs/elasticsearch/IndexableItemMapperFactory.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch;
2 |
3 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
4 | import com.fasterxml.jackson.annotation.JsonInclude;
5 | import com.fasterxml.jackson.databind.ObjectMapper;
6 |
7 | import de.cxp.ocs.indexer.model.FacetEntry;
8 | import de.cxp.ocs.indexer.model.IndexableItem;
9 | import de.cxp.ocs.indexer.model.VariantItem;
10 |
11 | /**
12 | * Creates a {@link ObjectMapper} for {@link IndexableItem}.
13 | */
14 | public class IndexableItemMapperFactory {
15 |
16 | public static ObjectMapper createObjectMapper() {
17 | final ObjectMapper objectMapper = new ObjectMapper();
18 |
19 | objectMapper.addMixIn(IndexableItem.class, IncludeOnlyNonEmptyMixin.class);
20 | objectMapper.addMixIn(FacetEntry.class, IncludeOnlyNonNullMixin.class);
21 | objectMapper.addMixIn(VariantItem.class, VariantItemMixin.class);
22 |
23 | return objectMapper;
24 | }
25 |
26 | @JsonInclude(JsonInclude.Include.NON_NULL)
27 | public static abstract class IncludeOnlyNonNullMixin {}
28 |
29 | @JsonInclude(JsonInclude.Include.NON_EMPTY)
30 | public static abstract class IncludeOnlyNonEmptyMixin {}
31 |
32 | @JsonIgnoreProperties("master")
33 | public static abstract class VariantItemMixin {}
34 |
35 | }
36 |
--------------------------------------------------------------------------------
/indexer-service/src/main/resources/application.yml:
--------------------------------------------------------------------------------
1 | server:
2 | port: 8535
3 | compression:
4 | enabled: true
5 | mime-types:
6 | - text/html
7 | - text/css
8 | - application/javascript
9 | - application/json
10 |
11 | endpoints:
12 | prometheus:
13 | sensitive: true
14 |
15 | management:
16 | endpoints:
17 | web:
18 | exposure:
19 | include: "health,metrics,prometheus"
20 | metrics:
21 | enabled: true
22 | tags:
23 | application: "${spring.application.name}"
24 |
25 | spring:
26 | cloud.config.enabled: false
27 | jackson.deserialization.fail_on_unknown_properties: false
28 |
29 | ocs:
30 | connection-configuration:
31 | hosts: ${ES_HOSTS:http://localhost:9200}
32 | auth: ${ES_AUTH}
--------------------------------------------------------------------------------
/indexer-service/src/main/resources/bootstrap.properties:
--------------------------------------------------------------------------------
1 | spring.application.name=indexer
2 | spring.main.banner-mode=OFF
3 |
4 | # Optional Spring Cloud Config
5 | #spring.cloud.config.enabled=true
6 | #spring.config.import=configserver:http://localhost:8536/
--------------------------------------------------------------------------------
/indexer-service/src/main/resources/elasticsearch/_index_templates/ocs_czech_template.json:
--------------------------------------------------------------------------------
1 | {
2 | "index_patterns": "ocs-*-cs",
3 | "priority": 200,
4 | "composed_of": [
5 | "ocs_default"
6 | ],
7 | "template": {
8 | "settings": {
9 | "analysis": {
10 | "filter": {
11 | "custom_stemmer": {
12 | "type": "stemmer",
13 | "language": "czech"
14 | },
15 | "custom_stop_filter": {
16 | "type": "stop",
17 | "stopwords": "_czech_"
18 | }
19 | },
20 | "analyzer": {
21 | "standard": {
22 | "filter": [
23 | "lowercase",
24 | "custom_stop_filter",
25 | "custom_stemmer"
26 | ],
27 | "char_filter": [
28 | "html",
29 | "irrelevant_chars"
30 | ],
31 | "type": "custom",
32 | "tokenizer": "standard"
33 | }
34 | }
35 | }
36 | }
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/indexer-service/src/main/resources/elasticsearch/_index_templates/ocs_default_template.json:
--------------------------------------------------------------------------------
1 | {
2 | "index_patterns": "ocs-*",
3 | "priority": 110,
4 | "composed_of": [
5 | "ocs_default"
6 | ]
7 | }
8 |
--------------------------------------------------------------------------------
/indexer-service/src/main/resources/elasticsearch/_index_templates/ocs_english_template.json:
--------------------------------------------------------------------------------
1 | {
2 | "index_patterns": "ocs-*-en",
3 | "priority": 200,
4 | "composed_of": [
5 | "ocs_default"
6 | ],
7 | "template": {
8 | "settings": {
9 | "analysis": {
10 | "filter": {
11 | "custom_stemmer": {
12 | "type": "stemmer",
13 | "language": "light_english"
14 | },
15 | "custom_stop_filter": {
16 | "type": "stop",
17 | "stopwords": "_english_"
18 | }
19 | },
20 | "analyzer": {
21 | "standard": {
22 | "filter": [
23 | "lowercase",
24 | "custom_stop_filter",
25 | "custom_stemmer"
26 | ],
27 | "char_filter": [
28 | "html",
29 | "irrelevant_chars"
30 | ],
31 | "type": "custom",
32 | "tokenizer": "standard"
33 | }
34 | }
35 | }
36 | }
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/indexer-service/src/main/resources/elasticsearch/_index_templates/ocs_french_template.json:
--------------------------------------------------------------------------------
1 | {
2 | "index_patterns": "ocs-*-fr",
3 | "priority": 200,
4 | "composed_of": [
5 | "ocs_default"
6 | ],
7 | "template": {
8 | "settings": {
9 | "analysis": {
10 | "filter": {
11 | "custom_stemmer": {
12 | "type": "stemmer",
13 | "language": "light_french"
14 | },
15 | "custom_stop_filter": {
16 | "type": "stop",
17 | "stopwords": "_french_"
18 | }
19 | },
20 | "analyzer": {
21 | "standard": {
22 | "filter": [
23 | "lowercase",
24 | "custom_stop_filter",
25 | "custom_stemmer"
26 | ],
27 | "char_filter": [
28 | "html",
29 | "irrelevant_chars"
30 | ],
31 | "type": "custom",
32 | "tokenizer": "standard"
33 | }
34 | }
35 | }
36 | }
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/indexer-service/src/main/resources/logback-spring.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | ${spring.application.name}
5 |
6 |
8 |
10 | true
11 |
12 |
13 |
14 |
15 | %date{dd-MM-yyyy HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
--------------------------------------------------------------------------------
/integration-tests/src/test/resources/indexer.application-test.yml:
--------------------------------------------------------------------------------
1 | ocs:
2 | index-config:
3 | multi_category:
4 | field-configuration:
5 | fields:
6 | id:
7 | name: id
8 | type: id
9 | usage:
10 | - Result
11 | field-level: master
12 | title:
13 | name: title
14 | type: string
15 | usage:
16 | - Search
17 | - Result
18 | price:
19 | name: price
20 | type: number
21 | usage:
22 | - Facet
23 | - Result
24 | categories:
25 | name: categories
26 | type: category
27 | usage:
28 | - Facet
29 | - Result
30 | taxonomy:
31 | name: taxonomy
32 | type: category
33 | usage:
34 | - Facet
35 | - Result
36 |
--------------------------------------------------------------------------------
/integration-tests/src/test/resources/querqy-test-rules.txt:
--------------------------------------------------------------------------------
1 | "bike" =>
2 | DOWN(0.5): accessories
3 | UP(2): carbon
4 |
--------------------------------------------------------------------------------
/ocs-commons/src/main/java/de/cxp/ocs/config/ConnectionConfiguration.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | import lombok.Getter;
4 | import lombok.NoArgsConstructor;
5 | import lombok.NonNull;
6 | import lombok.Setter;
7 |
8 | @Getter
9 | @Setter
10 | @NoArgsConstructor
11 | public class ConnectionConfiguration {
12 |
13 | /**
14 | * Sets the hosts to where Elasticsearch is running, comma separated for
15 | * multiple hosts.
16 | */
17 | @NonNull
18 | private String hosts;
19 |
20 | /**
21 | * If required, username + password are expected, separated by colon.
22 | * Example: "elastic:my$ecretPassw0rd"
23 | */
24 | private String auth;
25 | }
26 |
--------------------------------------------------------------------------------
/ocs-commons/src/main/java/de/cxp/ocs/config/FieldConfigIncompatibilityException.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | public class FieldConfigIncompatibilityException extends Exception {
4 |
5 | private static final long serialVersionUID = 312492302L;
6 |
7 | public FieldConfigIncompatibilityException() {
8 | super();
9 | }
10 |
11 | public FieldConfigIncompatibilityException(String message) {
12 | super(message);
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/ocs-commons/src/main/java/de/cxp/ocs/config/IndexedField.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | import lombok.Data;
4 | import lombok.EqualsAndHashCode;
5 |
6 | /**
7 | * Represents a field configuration that is reversely fetched from the
8 | * search-index rather than from the configuration. With that it also contains
9 | * more information it may gather from the index.
10 | */
11 | @Data
12 | @EqualsAndHashCode(callSuper = true)
13 | public class IndexedField extends Field {
14 |
15 | public IndexedField(String name) {
16 | super(name);
17 | }
18 |
19 | private int valueCardinality = 0;
20 |
21 | }
22 |
--------------------------------------------------------------------------------
/ocs-commons/src/main/java/de/cxp/ocs/elasticsearch/ElasticSearchBuilder.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch;
2 |
3 | import org.elasticsearch.client.RestClientBuilder;
4 | import org.elasticsearch.client.RestHighLevelClient;
5 |
6 | public class ElasticSearchBuilder implements AutoCloseable {
7 |
8 | private RestHighLevelClient highLevelClient;
9 | private RestClientBuilder restClientBuilder;
10 |
11 | public ElasticSearchBuilder(RestClientBuilder clientBuilder) {
12 | restClientBuilder = clientBuilder;
13 | }
14 |
15 | public RestHighLevelClient getRestHLClient() {
16 | if (highLevelClient == null) {
17 | synchronized (this) {
18 | if (highLevelClient == null) {
19 | highLevelClient = new RestHighLevelClient(restClientBuilder);
20 | }
21 | }
22 | }
23 | return highLevelClient;
24 | }
25 |
26 | @Override
27 | public void close() throws Exception {
28 | synchronized (this) {
29 | if (highLevelClient != null) {
30 | highLevelClient.close();
31 | highLevelClient = null;
32 | }
33 | }
34 | }
35 |
36 | }
37 |
--------------------------------------------------------------------------------
/ocs-java-client/src/main/java/de/cxp/ocs/client/DocumentBulkSplit.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.client;
2 |
3 | import java.util.ArrayList;
4 | import java.util.List;
5 |
6 | import de.cxp.ocs.model.index.Document;
7 | import de.cxp.ocs.model.index.Product;
8 |
9 | /**
10 | * Helper class that is used to split an "abstract" document list into explicit product and document lists.
11 | *
12 | * @author rudi
13 | *
14 | */
15 | class DocumentBulkSplit {
16 |
17 | List products = new ArrayList<>();
18 | List documents = new ArrayList<>();
19 |
20 | public DocumentBulkSplit(List docs) {
21 | for (Document d : docs) {
22 | if (d instanceof Product) {
23 | products.add((Product) d);
24 | }
25 | else {
26 | documents.add(d);
27 | }
28 | }
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/ocs-java-client/src/main/java/de/cxp/ocs/client/SearchApi.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.client;
2 |
3 | import java.util.Map;
4 |
5 | import de.cxp.ocs.model.index.Document;
6 | import de.cxp.ocs.model.params.ArrangedSearchQuery;
7 | import de.cxp.ocs.model.result.SearchResult;
8 | import feign.Headers;
9 | import feign.Param;
10 | import feign.QueryMap;
11 | import feign.RequestLine;
12 |
13 | interface SearchApi {
14 |
15 | @RequestLine("GET /search-api/v1/tenants")
16 | String[] getTenants();
17 |
18 | @RequestLine("GET /search-api/v1/search/{tenant}?q={q}&sort={sort}&offset={offset}&limit={limit}&withFacets={withFacets}")
19 | SearchResult search(
20 | @Param("tenant") String tenant,
21 | @Param("q") String q,
22 | @Param("sort") String sort,
23 | @Param("offset") int offset,
24 | @Param("limit") int limit,
25 | @Param("withFacets") boolean withFacets,
26 | @QueryMap Map filters) throws Exception;
27 |
28 | @RequestLine("POST /search-api/v1/search/arranged/{tenant}")
29 | @Headers("Content-Type: application/json")
30 | SearchResult arrangedSearch(@Param("tenant") String tenant, ArrangedSearchQuery searchQuery);
31 |
32 | @RequestLine("GET /search-api/v1/doc/{tenant}/{id}")
33 | Document getDocument(@Param("tenant") String tenant, @Param("id") String docId);
34 | }
35 |
--------------------------------------------------------------------------------
/ocs-java-client/src/main/java/de/cxp/ocs/client/SuggestApi.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.client;
2 |
3 | import java.util.List;
4 |
5 | import de.cxp.ocs.model.suggest.Suggestion;
6 | import feign.Param;
7 | import feign.RequestLine;
8 |
9 | interface SuggestApi {
10 |
11 | @RequestLine("GET /suggest-api/v1/{indexname}/suggest?userQuery={userQuery}&limit={limit}&filter={filter}")
12 | List suggest(
13 | @Param("indexname") String indexname,
14 | @Param("userQuery") String userQuery,
15 | @Param("limit") int limit,
16 | @Param("filter") String filter) throws Exception;
17 | }
18 |
--------------------------------------------------------------------------------
/ocs-java-client/src/main/java/de/cxp/ocs/client/SuggestClient.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.client;
2 |
3 | import java.util.List;
4 | import java.util.function.Consumer;
5 |
6 | import de.cxp.ocs.api.SuggestService;
7 | import de.cxp.ocs.model.suggest.Suggestion;
8 | import feign.Feign;
9 | import feign.Feign.Builder;
10 | import feign.jackson.JacksonDecoder;
11 |
12 | public class SuggestClient implements SuggestService {
13 |
14 | private SuggestApi target;
15 |
16 | /**
17 | * With this constructor the Feign::Builder can be configured.
18 | *
19 | * @param endpointUrl
20 | * @param feignConfigurer
21 | */
22 | public SuggestClient(String endpointUrl, Consumer feignConfigurer) {
23 | Builder fb = Feign.builder();
24 | feignConfigurer.accept(fb);
25 | target = fb.target(SuggestApi.class, endpointUrl);
26 | }
27 |
28 | /**
29 | * Initializes the SearchClient with the given endpointUrl and
30 | * recommended settings.
31 | *
32 | * @param endpointUrl
33 | */
34 | public SuggestClient(String endpointUrl) {
35 | this(endpointUrl, f -> {
36 | f.decoder(new JacksonDecoder());
37 | });
38 | }
39 |
40 | @Override
41 | public List suggest(String index, String userQuery, Integer limit, String filter) throws Exception {
42 | return target.suggest(index, userQuery, limit, filter);
43 | }
44 |
45 | }
46 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/.gitignore:
--------------------------------------------------------------------------------
1 | /target/
2 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/config/BoostMode.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | /**
4 | * The boost_mode specified, how the score is combined with the score of the
5 | * query.
6 | */
7 | public enum BoostMode {
8 | MULTIPLY, REPLACE, SUM, AVG, MAX, MIN
9 | }
10 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/config/DataProcessorConfiguration.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | import java.util.ArrayList;
4 | import java.util.LinkedHashMap;
5 | import java.util.List;
6 | import java.util.Map;
7 |
8 | import lombok.Data;
9 | import lombok.NoArgsConstructor;
10 |
11 | /**
12 | * Configuration wrapper for which Document-Pre/Post-Processors to be used and
13 | * custom settings for them.
14 | */
15 | @NoArgsConstructor
16 | @Data
17 | public class DataProcessorConfiguration {
18 |
19 | /**
20 | * List of activated processors.
21 | */
22 | private final List processors = new ArrayList<>();
23 |
24 | /**
25 | *
26 | * Settings for the single document pre/post processors. As a key the full
27 | * canonical class name of the according processor is expected. The value is
28 | * a custom string-to-string map with arbitrary settings for a processor.
29 | *
30 | *
31 | * Check the java-doc of the available processors for more details.
32 | *
33 | */
34 | private final Map> configuration = new LinkedHashMap<>();
35 |
36 | private boolean useDefaultConfig;
37 | }
38 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/config/FacetType.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | public enum FacetType {
4 | TERM, HIERARCHICAL, INTERVAL, RANGE;
5 | }
6 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/config/FieldConstants.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | public final class FieldConstants {
4 |
5 | public final static String SEARCH_SUFFIX_STANDARD = "standard";
6 | public final static String SEARCH_SUFFIX_SPLIT = "split";
7 | public final static String SEARCH_SUFFIX_PARTIAL = "partial";
8 | public final static String SEARCHABLE_NUMERIC_DATA = "searchable_numeric_patterns";
9 |
10 | public final static String SEARCH_DATA = "searchData";
11 | public final static String RESULT_DATA = "resultData";
12 | public final static String SORT_DATA = "sortData";
13 | public final static String FILTER_DATA = "filterData";
14 | public final static String SCORES = "scores";
15 | public final static String VARIANTS = "variants";
16 | public final static String TERM_FACET_DATA = "termFacetData";
17 | public final static String NUMBER_FACET_DATA = "numberFacetData";
18 | public final static String PATH_FACET_DATA = "pathFacetData";
19 |
20 | public final static String FIELD_NAME_ATTRIBUTES = "attributes";
21 |
22 | }
23 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/config/FieldLevel.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | public enum FieldLevel {
4 | MASTER, VARIANT, BOTH
5 | }
6 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/config/FieldType.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | public enum FieldType {
4 | STRING, NUMBER, CATEGORY,
5 | /**
6 | * Raw type is just passed to Elasticsearch as is without any validation or transformation.
7 | * If multiple source-fields are used for the same raw target field,
8 | * merging is done as usual. However since no validation is done, the responsibility
9 | * for proper data types is in the hand of the indexer-client. Handle with care.
10 | * With great power comes great responsibility.
11 | */
12 | RAW,
13 | @Deprecated ID,
14 | }
15 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/config/FieldUsage.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | /**
4 | * Enum describing the usage of an field that will be indexed.
5 | */
6 | public enum FieldUsage {
7 |
8 | /**
9 | * Fields with this usage are analyzed in all set up ways made ready for full-text search.
10 | */
11 | SEARCH,
12 |
13 | /**
14 | * Fields with this usage are made ready to returned in the response at the matched hits.
15 | */
16 | RESULT,
17 |
18 | /**
19 | * Fields with this usage are prepared for sorting.
20 | */
21 | SORT,
22 |
23 | /**
24 | * Fields with this usage are prepared for automatic facet creation and filtering.
25 | */
26 | FACET,
27 |
28 | /**
29 | * Fields with this usage are prepared to be used for filtering without automatic facet generation.
30 | */
31 | FILTER,
32 |
33 | /**
34 | * Fields with this usage are prepared to be used for scoring
35 | */
36 | SCORE;
37 |
38 | }
39 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/config/IndexSettings.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | import lombok.Getter;
4 | import lombok.Setter;
5 |
6 | @Setter
7 | public class IndexSettings {
8 |
9 | public int replicaCount = 1;
10 |
11 | public String refreshInterval = "5s";
12 |
13 | public int minimumDocumentCount = 1;
14 |
15 | public int waitTimeMsForHealthyIndex = 3000;
16 |
17 | @Getter
18 | public boolean useDefaultConfig;
19 | }
20 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/config/QueryStrategy.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | public enum QueryStrategy {
4 | DefaultQuery, PredictionQuery, ConfigurableQuery, NgramQueryBuilder;
5 | }
6 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/config/ScoreMode.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.config;
2 |
3 | /**
4 | * The score_mode specifies how the computed scores are combined
5 | */
6 | public enum ScoreMode {
7 | MULTIPLY, SUM, AVG, FIRST, MAX, MIN
8 | }
9 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/filter/InternalResultFilter.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.filter;
2 |
3 | import java.util.Arrays;
4 | import java.util.HashSet;
5 | import java.util.Set;
6 |
7 | import de.cxp.ocs.config.Field;
8 |
9 | public interface InternalResultFilter {
10 |
11 | Field getField();
12 |
13 | boolean isFilterOnId();
14 |
15 | boolean isNegated();
16 |
17 | String getFieldPrefix();
18 |
19 | boolean isNestedFilter();
20 |
21 | String[] getValues();
22 |
23 | void appendFilter(InternalResultFilter sibling);
24 |
25 | static String[] unifiyValues(String[] values1, String[] values2) {
26 | if (values1 == null || values1.length == 0) return values2 == null ? new String[0] : values2;
27 | if (values2 == null || values2.length == 0) return values1;
28 |
29 | Set merged = new HashSet<>(Arrays.asList(values1));
30 | merged.addAll(Arrays.asList(values2));
31 | return merged.toArray(String[]::new);
32 | }
33 |
34 | }
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/package-info.java:
--------------------------------------------------------------------------------
1 | /**
2 | * Internal API Model to build queries.
3 | *
4 | * TODO: remove the "elasticsearch" part of the package name and make sure there is no dependency to elasticsearch.
5 | */
6 | package de.cxp.ocs.elasticsearch.model;
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/query/AnalyzedQuery.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.query;
2 |
3 | import java.util.List;
4 |
5 | import de.cxp.ocs.elasticsearch.model.visitor.QueryTermVisitor;
6 |
7 | public interface AnalyzedQuery {
8 |
9 | /**
10 | * The original input terms that were used to create that query string.
11 | *
12 | * @return list of unescaped terms
13 | */
14 | List getInputTerms();
15 |
16 | default int getTermCount() {
17 | return getInputTerms().size();
18 | }
19 |
20 | /**
21 | * Transform into string according to the
22 | * ElasticSearch
24 | * Query String syntax.
25 | *
26 | * TODO: change into Visitor Pattern Style: A method that accepts a visitor that is passed trough all the terms of
27 | * the query. Similar to org.apache.lucene.search.QueryVisitor. This can then be used to generate the required
28 | * query (LuceneQuery, structured ElasticsearchQuery, SQL Query.. =)).
29 | *
30 | * @return term in query-string-query format.
31 | */
32 | String toQueryString();
33 |
34 | void accept(QueryTermVisitor visitor);
35 | }
36 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/query/MatchAllQuery.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.query;
2 |
3 | import java.util.Collections;
4 | import java.util.List;
5 |
6 | import de.cxp.ocs.elasticsearch.model.visitor.QueryTermVisitor;
7 |
8 | public final class MatchAllQuery implements AnalyzedQuery {
9 |
10 | public final static MatchAllQuery INSTANCE = new MatchAllQuery();
11 |
12 | @Override
13 | public List getInputTerms() {
14 | return Collections.emptyList();
15 | }
16 |
17 | @Override
18 | public int getTermCount() {
19 | return 0;
20 | }
21 |
22 | @Override
23 | public String toQueryString() {
24 | return "*";
25 | }
26 |
27 | @Override
28 | public void accept(QueryTermVisitor visitor) {
29 | // noop
30 | }
31 |
32 | }
33 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/query/QueryBoosting.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.query;
2 |
3 | import lombok.AllArgsConstructor;
4 | import lombok.Data;
5 | import lombok.NonNull;
6 | import lombok.RequiredArgsConstructor;
7 |
8 | @Data
9 | @AllArgsConstructor
10 | @RequiredArgsConstructor
11 | public class QueryBoosting {
12 |
13 | private String field;
14 |
15 | @NonNull
16 | private final String rawTerm;
17 |
18 | @NonNull
19 | private final BoostType type;
20 |
21 | private final float weight;
22 |
23 | public enum BoostType { UP, DOWN }
24 |
25 | public boolean isUpBoosting() {
26 | return BoostType.UP.equals(type);
27 | }
28 |
29 | @Override
30 | public String toString() {
31 | return "boost:[" + (field == null ? "" : field + ":") + rawTerm + " " + type + "(" + weight + ")]";
32 | }
33 |
34 | }
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/query/SingleTermQuery.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.query;
2 |
3 | import java.util.Collections;
4 | import java.util.List;
5 |
6 | import de.cxp.ocs.elasticsearch.model.term.QueryStringTerm;
7 | import de.cxp.ocs.elasticsearch.model.term.WeightedTerm;
8 | import de.cxp.ocs.elasticsearch.model.visitor.QueryTermVisitor;
9 | import lombok.RequiredArgsConstructor;
10 |
11 | @RequiredArgsConstructor
12 | public class SingleTermQuery implements AnalyzedQuery {
13 |
14 | private final String inputTerm;
15 |
16 | private final QueryStringTerm term;
17 |
18 | public SingleTermQuery(WeightedTerm weightedTerm) {
19 | inputTerm = weightedTerm.getRawTerm();
20 | term = weightedTerm;
21 | }
22 |
23 | @Override
24 | public List getInputTerms() {
25 | return Collections.singletonList(inputTerm);
26 | }
27 |
28 | @Override
29 | public int getTermCount() {
30 | return 1;
31 | }
32 |
33 | @Override
34 | public String toQueryString() {
35 | return term.toQueryString();
36 | }
37 |
38 | @Override
39 | public void accept(QueryTermVisitor visitor) {
40 | visitor.visitTerm(term);
41 | }
42 |
43 | @Override
44 | public String toString() {
45 | return toQueryString();
46 | }
47 |
48 |
49 | }
50 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/term/Occur.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.term;
2 |
3 | import lombok.AccessLevel;
4 | import lombok.RequiredArgsConstructor;
5 |
6 | @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
7 | public enum Occur {
8 |
9 | SHOULD(""), MUST("+"), MUST_NOT("-"), FILTER("#");
10 |
11 | private final String prefix;
12 |
13 | @Override
14 | public String toString() {
15 | return prefix;
16 | }
17 |
18 | public static Occur fromChar(char c) {
19 | switch (c) {
20 | case '-':
21 | return Occur.MUST_NOT;
22 | case '+':
23 | return Occur.MUST;
24 | case '#':
25 | return Occur.FILTER;
26 | default:
27 | return Occur.SHOULD;
28 | }
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/term/QueryFilterTerm.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.term;
2 |
3 | import org.apache.commons.text.StringEscapeUtils;
4 |
5 | import lombok.*;
6 |
7 | @Data
8 | @AllArgsConstructor
9 | @RequiredArgsConstructor
10 | @NoArgsConstructor
11 | public class QueryFilterTerm implements QueryStringTerm {
12 |
13 | @NonNull
14 | private String field;
15 | @NonNull
16 | private String rawTerm;
17 |
18 | private Occur occur = Occur.MUST;
19 |
20 | @Override
21 | public String toQueryString() {
22 | return occur.toString()
23 | + field
24 | + ":"
25 | + StringEscapeUtils.escapeJava(rawTerm);
26 | }
27 |
28 | @Override
29 | public boolean isEnclosed() {
30 | return false;
31 | }
32 |
33 | @Override
34 | public String toString() {
35 | return toQueryString();
36 | }
37 | }
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/term/QueryStringTerm.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.term;
2 |
3 | /**
4 | * A single term for a query-string-query
5 | */
6 | public interface QueryStringTerm {
7 |
8 | /**
9 | * Prepare the term for a query-string-query.
10 | *
11 | * @return term in query-string-query format.
12 | */
13 | String toQueryString();
14 |
15 | /**
16 | * @return the single original unescaped term.
17 | */
18 | String getRawTerm();
19 |
20 | Occur getOccur();
21 |
22 | /**
23 | * @return if that query is already enclosed in quotes or brackets.
24 | */
25 | boolean isEnclosed();
26 |
27 | }
28 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/term/RawTerm.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.term;
2 |
3 | import lombok.RequiredArgsConstructor;
4 |
5 | /**
6 | * Use carefully - don't use for userinput directly.
7 | *
8 | * XXX: think about replacing it
9 | */
10 | @RequiredArgsConstructor
11 | public class RawTerm implements QueryStringTerm {
12 |
13 | private final String rawQueryTerm;
14 |
15 | @Override
16 | public String toQueryString() {
17 | return rawQueryTerm;
18 | }
19 |
20 | @Override
21 | public String getRawTerm() {
22 | return rawQueryTerm;
23 | }
24 |
25 | @Override
26 | public Occur getOccur() {
27 | if (rawQueryTerm.length() > 0) {
28 | return Occur.fromChar(rawQueryTerm.charAt(0));
29 | }
30 | return Occur.SHOULD;
31 | }
32 |
33 | @Override
34 | public boolean isEnclosed() {
35 | return rawQueryTerm.charAt(0) == '(' || rawQueryTerm.charAt(0) == '"';
36 | }
37 |
38 | @Override
39 | public String toString() {
40 | return toQueryString();
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/util/QueryStringUtil.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.util;
2 |
3 | import java.util.Collection;
4 | import java.util.Iterator;
5 |
6 | import de.cxp.ocs.elasticsearch.model.term.QueryStringTerm;
7 |
8 | public class QueryStringUtil {
9 |
10 | public static String buildQueryString(Collection searchTerms, String joinToken) {
11 | return buildQueryString(searchTerms.stream().map(QueryStringTerm::toQueryString).iterator(), joinToken);
12 | }
13 |
14 | public static String buildQueryString(Iterator searchTermIterator, String joinToken) {
15 | StringBuilder queryString = new StringBuilder();
16 |
17 | // untrim :)
18 | if (joinToken.charAt(0) != ' ') joinToken = " " + joinToken;
19 | if (joinToken.charAt(joinToken.length() - 1) != ' ') joinToken = joinToken + " ";
20 |
21 | while (searchTermIterator.hasNext()) {
22 | queryString.append(searchTermIterator.next());
23 | if (searchTermIterator.hasNext()) queryString.append(joinToken);
24 | }
25 | return queryString.toString();
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/visitor/AbstractTermVisitor.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.visitor;
2 |
3 | import java.util.function.Consumer;
4 |
5 | import de.cxp.ocs.elasticsearch.model.query.AnalyzedQuery;
6 | import de.cxp.ocs.elasticsearch.model.term.QueryStringTerm;
7 |
8 | public abstract class AbstractTermVisitor implements QueryTermVisitor {
9 |
10 | @Override
11 | public void visitSubQuery(AnalyzedQuery query) {
12 | query.accept(this);
13 | }
14 |
15 | public static QueryTermVisitor forEachTerm(Consumer termConcumer) {
16 | return new AbstractTermVisitor() {
17 |
18 | @Override
19 | public void visitTerm(QueryStringTerm term) {
20 | termConcumer.accept(term);
21 | }
22 | };
23 | }
24 |
25 | }
26 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/model/visitor/QueryTermVisitor.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.model.visitor;
2 |
3 | import de.cxp.ocs.elasticsearch.model.query.AnalyzedQuery;
4 | import de.cxp.ocs.elasticsearch.model.term.QueryStringTerm;
5 |
6 | public interface QueryTermVisitor {
7 |
8 | void visitTerm(QueryStringTerm term);
9 |
10 | void visitSubQuery(AnalyzedQuery query);
11 |
12 | }
13 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/elasticsearch/query/TextMatchQuery.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.elasticsearch.query;
2 |
3 | import lombok.AllArgsConstructor;
4 | import lombok.Getter;
5 | import lombok.Setter;
6 |
7 | /**
8 | * A carrier of search queries on master and variant level. Both will be
9 | * combined into a final query that includes filters and all the rest.
10 | */
11 | @Getter
12 | @AllArgsConstructor
13 | public class TextMatchQuery {
14 |
15 | public TextMatchQuery(Q masterQuery, Q variantQuery, boolean isWithSpellCorrection, boolean acceptNoResult) {
16 | this(masterQuery, variantQuery, isWithSpellCorrection, acceptNoResult, null);
17 | }
18 |
19 | @Setter
20 | private Q masterLevelQuery;
21 |
22 | private Q variantLevelQuery;
23 |
24 | /**
25 | * Set to 'true' if the according queries already consider spelling errors,
26 | * e.g. because a fuzzy search is done anyways.
27 | */
28 | private boolean isWithSpellCorrection = false;
29 |
30 | // TODO: do this with configuration so it's not necessary to decide at the
31 | // builder level
32 | private boolean acceptNoResult = false;
33 |
34 | private String queryDescription;
35 |
36 | }
37 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/indexer/model/FacetEntry.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.indexer.model;
2 |
3 | import java.util.Collection;
4 |
5 | import lombok.AllArgsConstructor;
6 | import lombok.Data;
7 | import lombok.NoArgsConstructor;
8 | import lombok.NonNull;
9 | import lombok.experimental.Accessors;
10 |
11 | @NoArgsConstructor
12 | @AllArgsConstructor
13 | @Data
14 | @Accessors(chain = true)
15 | public class FacetEntry {
16 |
17 | @NonNull
18 | private String name;
19 |
20 | // optional attribute ID
21 | private String id;
22 |
23 | @NonNull
24 | private Object value;
25 |
26 | public FacetEntry(String name) {
27 | this.name = name;
28 | }
29 |
30 | public FacetEntry(String name, T value) {
31 | this.name = name;
32 | this.value = value;
33 | }
34 |
35 | public FacetEntry(String name, Collection values) {
36 | this.name = name;
37 | this.value = values;
38 | }
39 |
40 | }
41 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/indexer/model/IndexableItem.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.indexer.model;
2 |
3 | import java.util.ArrayList;
4 | import java.util.List;
5 |
6 | import lombok.AllArgsConstructor;
7 | import lombok.Data;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 |
11 | /**
12 | * {@link DataItem} that can be used to be indexed directly. This is not
13 | * the case for sub-items such as {@link VariantItem}s
14 | */
15 | @AllArgsConstructor
16 | @Data
17 | @ToString(callSuper = true)
18 | @EqualsAndHashCode(callSuper = true)
19 | public class IndexableItem extends DataItem {
20 |
21 | private final String id;
22 |
23 | /**
24 | * A list of categories a item belongs to.
25 | */
26 | private final List> pathFacetData = new ArrayList<>();
27 |
28 | }
29 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/indexer/model/MasterItem.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.indexer.model;
2 |
3 | import java.util.ArrayList;
4 | import java.util.List;
5 |
6 | import lombok.Data;
7 | import lombok.EqualsAndHashCode;
8 | import lombok.NonNull;
9 |
10 | @Data
11 | @EqualsAndHashCode(callSuper = true)
12 | public class MasterItem extends IndexableItem {
13 |
14 | public MasterItem(@NonNull String id) {
15 | super(id);
16 | }
17 |
18 | /**
19 | * A list of variants that belong to this master item. Can be empty
20 | * in cases no variants are managed.
21 | */
22 | private final List variants = new ArrayList<>();
23 |
24 | }
25 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/indexer/model/VariantItem.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.indexer.model;
2 |
3 | import lombok.EqualsAndHashCode;
4 | import lombok.NoArgsConstructor;
5 |
6 | @NoArgsConstructor
7 | @EqualsAndHashCode(callSuper = true)
8 | public class VariantItem extends DataItem {
9 |
10 | public VariantItem(MasterItem master) {
11 | this.master = master;
12 | }
13 |
14 | /**
15 | * The master item that belongs to this variant.
16 | */
17 | private MasterItem master;
18 |
19 | public MasterItem getMaster() {
20 | return master;
21 | }
22 |
23 | }
24 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/spi/search/ConfigurableExtension.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.spi.search;
2 |
3 | import java.util.Map;
4 |
5 | /**
6 | * super-interface for all extension interfaces that optionally can accepts
7 | * custom settings.
8 | */
9 | public interface ConfigurableExtension {
10 |
11 | default void initialize(Map settings) {}
12 |
13 | }
14 |
--------------------------------------------------------------------------------
/ocs-plugin-spi/src/main/java/de/cxp/ocs/spi/search/ESQueryFactory.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.spi.search;
2 |
3 | import java.util.Map;
4 |
5 | import org.elasticsearch.index.query.QueryBuilder;
6 |
7 | import de.cxp.ocs.config.FieldConfigAccess;
8 | import de.cxp.ocs.config.QueryBuildingSetting;
9 | import de.cxp.ocs.elasticsearch.model.query.ExtendedQuery;
10 | import de.cxp.ocs.elasticsearch.query.TextMatchQuery;
11 |
12 | /**
13 | *
14 | * A reusable query factory that receives the analyzed user query to build
15 | * Elasticsearch queries (one for Master level and one for the variant level).
16 | *
18 | * Resolvers that need a bit more time can defined itself as async, so that in case of several product sets in a
19 | * single request, all of them could run async in parallel.
20 | *
9 | * A Limiter is used for results that have different kind of suggestions, for
10 | * example if several different data sources are used at different suggesters,
11 | * as it's done at the
12 | * {@link de.cxp.ocs.smartsuggest.querysuggester.CompoundQuerySuggester}.
13 | *
14 | *
15 | * It could also be used to retrieve more suggestions, group or sort them by a
16 | * certain criterion and limit them afterwards.
17 | *
18 | */
19 | public interface Limiter {
20 |
21 | List limit(List suggestions, int limit);
22 |
23 | }
24 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/monitoring/DistributionSummaryAdapter.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.monitoring;
2 |
3 | import io.micrometer.core.instrument.DistributionSummary;
4 |
5 | public interface DistributionSummaryAdapter {
6 |
7 | void record(double size);
8 |
9 | static DistributionSummaryAdapter of(DistributionSummary summary) {
10 | return summary::record;
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/monitoring/Instrumentable.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.monitoring;
2 |
3 | import io.micrometer.core.instrument.Tag;
4 |
5 | public interface Instrumentable {
6 |
7 | /**
8 | * Optional meter registry (adapter that gives access to the actual
9 | * meter-registry). If not available, no metrics should be measured.
10 | *
11 | * @param metricsRegistryAdapter
12 | * optional adapter
13 | * @param tags
14 | * these "standard" tags should be used for all added sensors. More
15 | * tags can be added.
16 | */
17 | void instrument(MeterRegistryAdapter metricsRegistryAdapter, Iterable tags);
18 |
19 | }
20 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/monitoring/MeterRegistryAdapter.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.monitoring;
2 |
3 | import io.micrometer.core.instrument.MeterRegistry;
4 | import lombok.NonNull;
5 |
6 | public interface MeterRegistryAdapter {
7 |
8 | @NonNull
9 | MeterRegistry getMetricsRegistry();
10 |
11 | static MeterRegistryAdapter of(MeterRegistry registry) {
12 | return () -> registry;
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/querysuggester/GroupingSuggester.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.querysuggester;
2 |
3 | import java.util.List;
4 | import java.util.Set;
5 |
6 | import de.cxp.ocs.smartsuggest.limiter.Limiter;
7 | import lombok.RequiredArgsConstructor;
8 | import lombok.Setter;
9 | import lombok.experimental.Accessors;
10 |
11 | @RequiredArgsConstructor
12 | public class GroupingSuggester implements QuerySuggester {
13 |
14 | private final QuerySuggester delegate;
15 | private final Limiter limiter;
16 |
17 | @Setter
18 | @Accessors(chain = true)
19 | private int prefetchLimitFactor = 1;
20 |
21 | @Override
22 | public List suggest(String term, int maxResults, Set tags) throws SuggestException {
23 | List fetchedResults = delegate.suggest(term, maxResults * prefetchLimitFactor, tags);
24 | return limiter.limit(fetchedResults, maxResults);
25 | }
26 |
27 | @Override
28 | public long recordCount() {
29 | return delegate.recordCount();
30 | }
31 |
32 | @Override
33 | public boolean isReady() {
34 | return delegate.isReady();
35 | }
36 |
37 | @Override
38 | public void close() throws Exception {
39 | delegate.close();
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/querysuggester/NoopQuerySuggester.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.querysuggester;
2 |
3 | import static java.util.Collections.emptyList;
4 |
5 | import java.util.List;
6 | import java.util.Set;
7 |
8 | import lombok.AllArgsConstructor;
9 | import lombok.NoArgsConstructor;
10 |
11 | @NoArgsConstructor
12 | @AllArgsConstructor
13 | public class NoopQuerySuggester implements QuerySuggester {
14 |
15 | private boolean isReady = false;
16 |
17 | @Override
18 | public void close() throws Exception {}
19 |
20 | @Override
21 | public List suggest(String term, int maxResults, Set tags) throws SuggestException {
22 | return emptyList();
23 | }
24 |
25 | @Override
26 | public boolean isReady() {
27 | return isReady;
28 | }
29 |
30 | @Override
31 | public long recordCount() {
32 | return 0;
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/querysuggester/QueryIndexer.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.querysuggester;
2 |
3 | import java.io.IOException;
4 | import java.time.Instant;
5 | import java.util.concurrent.CompletableFuture;
6 |
7 | import de.cxp.ocs.smartsuggest.spi.SuggestRecord;
8 |
9 | public interface QueryIndexer {
10 |
11 | /**
12 | * @return The time of the last successful indexing
13 | */
14 | Instant getIndexModTime();
15 |
16 | /**
17 | * @param suggestions
18 | * the suggestions to index
19 | * @param modificationTime
20 | * timestamp (millis) of the data origin
21 | * @return future that is ready as soon as the indexation is done
22 | * @throws IOException
23 | * in case indexation fails
24 | */
25 | CompletableFuture index(Iterable suggestions, long modificationTime) throws IOException;
26 | }
27 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/querysuggester/SuggestException.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.querysuggester;
2 |
3 | import java.io.Serial;
4 |
5 | public class SuggestException extends RuntimeException {
6 |
7 | @Serial private static final long serialVersionUID = -4055077488050336590L;
8 |
9 | public SuggestException(String message, Throwable cause) {
10 | super(message, cause);
11 | }
12 |
13 | public SuggestException(Throwable cause) {
14 | super(cause);
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/querysuggester/SuggesterEngine.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.querysuggester;
2 |
3 | public enum SuggesterEngine {
4 |
5 | /**
6 | * Implementation that uses Apache Lucene
7 | */
8 | LUCENE,
9 |
10 | }
11 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/querysuggester/SuggesterFactory.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.querysuggester;
2 |
3 | import de.cxp.ocs.smartsuggest.monitoring.Instrumentable;
4 | import de.cxp.ocs.smartsuggest.spi.IndexArchive;
5 | import de.cxp.ocs.smartsuggest.spi.SuggestConfig;
6 | import de.cxp.ocs.smartsuggest.spi.SuggestData;
7 |
8 | import java.io.IOException;
9 |
10 | public interface SuggesterFactory extends Instrumentable {
11 |
12 | T getSuggester(SuggestData suggestData, SuggestConfig suggestConfig);
13 |
14 | IndexArchive createArchive(QuerySuggester querySuggester) throws IOException;
15 |
16 | T recover(IndexArchive baseDir, SuggestConfig suggestConfig) throws IOException;
17 |
18 | }
19 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/querysuggester/lucene/PerfResult.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.querysuggester.lucene;
2 |
3 | import lombok.AllArgsConstructor;
4 | import lombok.Data;
5 | import lombok.Getter;
6 | import lombok.ToString;
7 | import org.apache.commons.lang3.time.StopWatch;
8 |
9 | import java.util.ArrayList;
10 | import java.util.List;
11 |
12 | @Data
13 | public class PerfResult {
14 |
15 | private String inputQuery;
16 | private int resultCount;
17 | private StopWatch totalTime;
18 | private List steps = new ArrayList<>();
19 |
20 | @ToString.Exclude
21 | private long _lastSplit = 0;
22 |
23 | public PerfResult(String inputQuery) {
24 | this.inputQuery = inputQuery;
25 | totalTime = new StopWatch();
26 | totalTime.start();
27 | }
28 |
29 | @ToString
30 | @Getter
31 | @AllArgsConstructor
32 | public static class StepTime {
33 |
34 | String step;
35 | long timeMs;
36 | int results;
37 | }
38 |
39 | public void addStep(String step, int results) {
40 | // get time since last step
41 | long splitTime = totalTime.getDuration().toMillis();
42 | steps.add(new StepTime(step, splitTime - _lastSplit, results));
43 | _lastSplit = splitTime;
44 | }
45 |
46 | public void stop() {
47 | totalTime.stop();
48 | }
49 | }
50 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/querysuggester/lucene/SuggestionBestMatchIterator.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.querysuggester.lucene;
2 |
3 | import de.cxp.ocs.smartsuggest.spi.SuggestRecord;
4 |
5 | import java.util.Iterator;
6 |
7 | class SuggestionBestMatchIterator extends SuggestionIterator {
8 |
9 | SuggestionBestMatchIterator(Iterator innerIterator) {
10 | super(innerIterator);
11 | }
12 |
13 | @Override
14 | protected String getSearchText(SuggestRecord suggestion) {
15 | return suggestion.getPrimaryText();
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/querysuggester/lucene/SuggestionVariantIterator.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.querysuggester.lucene;
2 |
3 | import de.cxp.ocs.smartsuggest.spi.SuggestRecord;
4 |
5 | import java.util.Iterator;
6 |
7 | class SuggestionVariantIterator extends SuggestionIterator {
8 |
9 | private final static String EMPTY = "";
10 | private final static int MaxTermLength = 32000;
11 |
12 | SuggestionVariantIterator(Iterator innerIterator) {
13 | super(innerIterator);
14 | }
15 |
16 | @Override
17 | protected String getSearchText(SuggestRecord suggestion) {
18 | String searchText = suggestion.getSecondaryText();
19 | if (searchText == null) {
20 | searchText = EMPTY;
21 | }
22 | else if (searchText.length() > MaxTermLength) {
23 | searchText = searchText.substring(0, MaxTermLength);
24 | }
25 | return searchText;
26 | }
27 |
28 | }
29 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/spi/CommonPayloadFields.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.spi;
2 |
3 | import java.util.HashMap;
4 | import java.util.Map;
5 |
6 | /**
7 | * Common keys for the payload attached to {@link SuggestRecord}s.
8 | */
9 | public final class CommonPayloadFields {
10 |
11 | public static final String PAYLOAD_TYPE_KEY = "type";
12 | public static final String PAYLOAD_TYPE_OTHER = "other";
13 | public static final String PAYLOAD_COUNT_KEY = "count";
14 | public static final String PAYLOAD_LABEL_KEY = "meta.label";
15 | public static final String PAYLOAD_GROUPMATCH_KEY = "meta.matchGroupName";
16 | public static final String PAYLOAD_WEIGHT_KEY = "meta.weight";
17 | public static final String PAYLOAD_MATCH_KEY = "meta.matchKey";
18 |
19 |
20 | private CommonPayloadFields() {}
21 |
22 | public static Map payloadOfTypeAndCount(String type, String count) {
23 | Map payload = new HashMap<>(2);
24 | payload.put(PAYLOAD_TYPE_KEY, type);
25 | payload.put(PAYLOAD_COUNT_KEY, count);
26 | return payload;
27 | }
28 |
29 | }
30 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/spi/DatedData.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.spi;
2 |
3 | /**
4 | * Data that's actuality can be assigned to a date and time.
5 | */
6 | public interface DatedData {
7 |
8 | /**
9 | * Get unix timestamp in millis for the last time this data was modified.
10 | *
11 | * @return unix time in millis
12 | */
13 | long getModificationTime();
14 | }
15 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/spi/IndexArchive.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.spi;
2 |
3 | import java.io.File;
4 |
5 | /**
6 | * Wrapper around an archive file that can be stored and loaded. The file is expected to be a .tar.gz file.
7 | *
8 | * @param zippedTarFile
9 | * The file is expected to be a .tar.gz file
10 | * @param dataModificationTime
11 | * modification time of the data in this archive (not the file creation time).
12 | */
13 | public record IndexArchive(File zippedTarFile, long dataModificationTime) implements DatedData {
14 |
15 | @Override
16 | public long getModificationTime() {
17 | return dataModificationTime;
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/spi/IndexArchiveProvider.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.spi;
2 |
3 | import java.io.IOException;
4 |
5 | public interface IndexArchiveProvider extends AbstractDataProvider {
6 |
7 | void store(String indexName, IndexArchive archive) throws IOException;
8 |
9 | }
10 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/spi/SuggestConfigProvider.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.spi;
2 |
3 | import lombok.NonNull;
4 |
5 | public interface SuggestConfigProvider {
6 |
7 | /**
8 | * Retrieve config for a given index. In case only some index specific values should be set, the default suggest
9 | * config can be used since it may contain global settings (if not null).
10 | *
11 | * @param indexName
12 | * @param defaultSuggestConfig
13 | * copy of the suggest config that was set as default for the whole service.
14 | * It can be modified and returned or a different config object can be returned.
15 | * Returning null is considered equivalent to returning that default config.
16 | * @return
17 | */
18 | SuggestConfig getConfig(@NonNull
19 | String indexName, SuggestConfig defaultSuggestConfig);
20 |
21 | /**
22 | * Return priority when this config provider should be asked for the configuration. Providers with a low priority
23 | * value (e.g. 1) will be asked first and providers with a higher value will be called later and can overwrite
24 | * previously set values.
25 | *
26 | * @return priority value, defaults to 100
27 | */
28 | default int getPriority() {
29 | return 100;
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/spi/SuggestDataProvider.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.spi;
2 |
3 | /**
4 | * Implementations of this SPI are capable of providing source data for the suggest index.
5 | */
6 | public interface SuggestDataProvider extends AbstractDataProvider {
7 |
8 | /**
9 | * In case the same data provider implementation more than once for an index
10 | * to provide different kind of data, each instance should return a different
11 | * name, so that the data sources can be archived and recovered separately.
12 | * Per default the class-name is returned.
13 | *
14 | * @return name to distinguish data source
15 | */
16 | default String getName() {
17 | return this.getClass().getSimpleName();
18 | }
19 |
20 | }
21 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/spi/standard/DefaultSuggestConfigProvider.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.spi.standard;
2 |
3 | import de.cxp.ocs.smartsuggest.spi.SuggestConfig;
4 | import de.cxp.ocs.smartsuggest.spi.SuggestConfigProvider;
5 | import lombok.NonNull;
6 |
7 | public class DefaultSuggestConfigProvider implements SuggestConfigProvider {
8 |
9 | private SuggestConfig defaultSuggestConfig = new SuggestConfig();
10 |
11 | public DefaultSuggestConfigProvider() {}
12 |
13 | public DefaultSuggestConfigProvider(@NonNull SuggestConfig defaultSuggestConfig) {
14 | this.defaultSuggestConfig = defaultSuggestConfig;
15 | }
16 |
17 | @Override
18 | public SuggestConfig getConfig(@NonNull String indexName, SuggestConfig indexConfig) {
19 | return indexConfig == null ? defaultSuggestConfig.clone() : indexConfig;
20 | }
21 |
22 | @Override
23 | public int getPriority() {
24 | return Integer.MAX_VALUE;
25 | }
26 |
27 | }
28 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/main/java/de/cxp/ocs/smartsuggest/spi/test/SdpMock.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.spi.test;
2 |
3 | import de.cxp.ocs.smartsuggest.spi.SuggestData;
4 | import de.cxp.ocs.smartsuggest.spi.SuggestDataProvider;
5 | import lombok.NonNull;
6 | import lombok.RequiredArgsConstructor;
7 | import lombok.Setter;
8 | import lombok.experimental.Accessors;
9 |
10 | @RequiredArgsConstructor
11 | @Accessors(fluent = true)
12 | @Setter
13 | class SdpMock implements SuggestDataProvider {
14 |
15 | @NonNull
16 | private final String indexName;
17 | private SuggestData suggestData = null;
18 | private String name = "sdpMock";
19 |
20 | @Override
21 | public String getName() {
22 | return name;
23 | }
24 |
25 | @Override
26 | public boolean hasData(String indexName) {
27 | return this.indexName.equals(indexName) && suggestData != null;
28 | }
29 |
30 | @Override
31 | public long getLastDataModTime(String indexName) {
32 | return suggestData == null ? -1L : suggestData.getModificationTime();
33 | }
34 |
35 | @Override
36 | public SuggestData loadData(String indexName) {
37 | return suggestData;
38 | }
39 | }
40 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/test/java/de/cxp/ocs/smartsuggest/updater/LocalIndexArchiveProvider.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.updater;
2 |
3 | import de.cxp.ocs.smartsuggest.spi.IndexArchive;
4 | import de.cxp.ocs.smartsuggest.spi.IndexArchiveProvider;
5 |
6 | import java.util.HashMap;
7 | import java.util.Map;
8 | import java.util.Optional;
9 |
10 | public class LocalIndexArchiveProvider implements IndexArchiveProvider {
11 |
12 | final private Map cached = new HashMap<>();
13 |
14 | @Override
15 | public void store(String indexName, IndexArchive archive) {
16 | cached.put(indexName, archive);
17 | }
18 |
19 | @Override
20 | public boolean hasData(String indexName) {
21 | return cached.containsKey(indexName);
22 | }
23 |
24 | @Override
25 | public long getLastDataModTime(String indexName) {
26 | return Optional.ofNullable(cached.get(indexName)).map(IndexArchive::dataModificationTime).orElse(-1L);
27 | }
28 |
29 | @Override
30 | public IndexArchive loadData(String indexName) {
31 | return cached.get(indexName);
32 | }
33 |
34 | }
35 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/test/java/de/cxp/ocs/smartsuggest/util/TestDataProvider.java:
--------------------------------------------------------------------------------
1 | package de.cxp.ocs.smartsuggest.util;
2 |
3 | import java.util.HashMap;
4 | import java.util.Map;
5 |
6 | import de.cxp.ocs.smartsuggest.spi.SuggestData;
7 | import de.cxp.ocs.smartsuggest.spi.SuggestDataProvider;
8 |
9 | public class TestDataProvider implements SuggestDataProvider {
10 |
11 | Map modDates = new HashMap<>();
12 | Map suggestData = new HashMap<>();
13 |
14 | public TestDataProvider putData(String indexName, SuggestData data) {
15 | suggestData.put(indexName, data);
16 | modDates.put(indexName, data.getModificationTime() > 0 ? data.getModificationTime() : System.currentTimeMillis());
17 | return this;
18 | }
19 |
20 | @Override
21 | public boolean hasData(String indexName) {
22 | return suggestData.containsKey(indexName);
23 | }
24 |
25 | @Override
26 | public long getLastDataModTime(String indexName) {
27 | return modDates.getOrDefault(indexName, -1L);
28 | }
29 |
30 | @Override
31 | public SuggestData loadData(String indexName) {
32 | return suggestData.get(indexName);
33 | }
34 |
35 | }
36 |
--------------------------------------------------------------------------------
/suggest-service-parent/smartsuggest-lib/src/test/resources/log4j.properties:
--------------------------------------------------------------------------------
1 | #
2 | # The logging properties used
3 | #
4 | log4j.rootLogger=INFO, out
5 |
6 | # uncomment the following line to turn on Camel debugging
7 | #log4j.logger.org.apache.camel=DEBUG
8 |
9 | # CONSOLE appender not used by default
10 | log4j.appender.out=org.apache.log4j.ConsoleAppender
11 | log4j.appender.out.layout=org.apache.log4j.PatternLayout
12 | #log4j.appender.out.layout.ConversionPattern=[%30.30t] %-30.30c{1} %-5p %m%n
13 | log4j.appender.out.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %m%n
14 |
15 |
--------------------------------------------------------------------------------
/suggest-service-parent/suggest-service/src/main/resources/config.yml:
--------------------------------------------------------------------------------
1 | #rapidoid config
2 | log:
3 | level: info
4 | fancy: false
--------------------------------------------------------------------------------
/suggest-service-parent/suggest-service/src/main/resources/logback.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
6 |
7 | %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
8 |
9 |
10 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/suggest-service-parent/suggest-service/src/main/resources/static/auto-complete.css:
--------------------------------------------------------------------------------
1 | .autocomplete-suggestions {
2 | text-align: left; cursor: default; border: 1px solid #ccc; border-top: 0; background: #fff; box-shadow: -1px 1px 3px rgba(0,0,0,.1);
3 |
4 | /* core styles should not be changed */
5 | position: absolute; display: none; z-index: 9999; max-height: 254px; overflow: hidden; overflow-y: auto; box-sizing: border-box;
6 | }
7 | .autocomplete-suggestion { position: relative; padding: 0 .6em; line-height: 23px; white-space: nowrap; overflow: hidden; text-overflow: ellipsis; font-size: 1.02em; color: #333; }
8 | .autocomplete-suggestion b { font-weight: normal; color: #1f8dd6; }
9 | .autocomplete-suggestion.selected { background: #f0f0f0; }
10 |
--------------------------------------------------------------------------------
/suggest-service-parent/suggest-service/src/main/resources/static/favicon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/CommerceExperts/open-commerce-search/4a5cc11a7a871b647c92fdf5a5bf9694ef5483b3/suggest-service-parent/suggest-service/src/main/resources/static/favicon.png
--------------------------------------------------------------------------------