SearchLogic (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.search.v20.SearchLogic

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class SearchLogic
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
Controls how searches are processed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchLogic.SearchLimitAction`
`static class`	`SearchLogic.SearchLimitReportMode`
`static class`	`SearchLogic.SearchTimeoutAction`
`static class`	`SearchLogic.SearchTimeoutReportMode`
`static class`	`SearchLogic.SliceDownAction`
`static class`	`SearchLogic.SliceDownReportMode`

Field Summary

Fields
Modifier and Type	Field and Description
`ContentRestriction`	`contentRestriction`
`java.lang.String`	`customQueryProcessingFactoryClassId`
`java.lang.String`	`dataModel`
`static boolean`	`DEFAULT_FETCH_MASKS`
`static boolean`	`DEFAULT_HANDLE_NEGATIVE_SECURITY_TOKENS`
`static boolean`	`DEFAULT_RETRIEVE_SOURCE_FIELD`
`static java.lang.String`	`DEFAULT_SEARCH_LIMIT_ACTION`
`static java.lang.String`	`DEFAULT_SEARCH_LIMIT_REPORT_MODE`
`static java.lang.String`	`DEFAULT_SEARCH_TIMEOUT_ACTION`
`static java.lang.String`	`DEFAULT_SEARCH_TIMEOUT_REPORT_MODE`
`static java.lang.String`	`DEFAULT_SLICE_DOWN_ACTION`
`static java.lang.String`	`DEFAULT_SLICE_DOWN_REPORT_MODE`
`com.exalead.search.v30.FacetsConfig`	`facetsConfig`
`boolean`	`fetchMasks`
`boolean`	`handleNegativeSecurityTokens`
`com.exalead.search.v30.HitConfig`	`hitConfig`
`com.exalead.search.v30.LimitsConfig`	`limitsConfig`
`java.lang.String`	`name`
`PostFilterConfig`	`postFilterConfig`
`QueryRestrictionConfig`	`queryRestrictionConfig`
`com.exalead.search.v30.RelatedTermsSynthesisConfig`	`relatedTermsSynthesisConfig`
`com.exalead.search.v30.RelevanceConfig`	`relevanceConfig`
`boolean`	`retrieveSourceField`
`java.lang.String`	`searchLimitAction`
`java.lang.String`	`searchLimitReportMode`
`java.lang.String`	`searchTimeoutAction`
`java.lang.String`	`searchTimeoutReportMode`
`java.lang.String`	`sliceDownAction`
`java.lang.String`	`sliceDownReportMode`
`com.exalead.search.v30.Sort`	`sort`
`com.exalead.search.v30.SpellCheckerConfig`	`spellCheckerConfig`
`TimezoneConfig`	`timezoneConfig`
`java.lang.String`	`tokenizationConfig`
`UQLConfig`	`uQLConfig`
`java.util.List<com.exalead.search.v30.VirtualFieldDefinition>`	`virtualFieldDefinition`

Constructor Summary

Constructors
Constructor and Description

SearchLogic()

SearchLogic(SearchLogic o)
Copy constructor

Constructors
Constructor and Description
`SearchLogic()`
`SearchLogic(SearchLogic o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this SearchLogic.
`static SearchLogic`	`fromString(java.lang.String s)` String representation of this SearchLogic.
`ContentRestriction`	`getContentRestriction()` Content restriction configuration for this search logic.
`java.lang.String`	`getCustomQueryProcessingFactoryClassId()` Java class implementing the QueryProcessingRunnerFactory interface to build the thread-specific QueryProcessingRunners (which expand the actual query).
`java.lang.String`	`getDataModel()` Name of the data model this search logic targets. A Search Logic can only target one data model.
`com.exalead.search.v30.FacetsConfig`	`getFacetsConfig()` Facets configuration for this search logic.
`com.exalead.search.v30.HitConfig`	`getHitConfig()` Hit content configuration for this search logic.
`com.exalead.search.v30.LimitsConfig`	`getLimitsConfig()` Limits configuration for this search logic.
`java.lang.String`	`getName()` Name of the search logic. This name is referred to with the 'logic' parameter in the Search API.
`PostFilterConfig`	`getPostFilterConfig()` Post filtering configuration for this search logic.
`QueryRestrictionConfig`	`getQueryRestrictionConfig()` Query restriction configuration for this search logic.
`com.exalead.search.v30.RelatedTermsSynthesisConfig`	`getRelatedTermsSynthesisConfig()` Related terms configuration for this search logic.
`com.exalead.search.v30.RelevanceConfig`	`getRelevanceConfig()` Relevance configuration for this search logic.
`java.lang.String`	`getSearchLimitAction()` What to do if a search limit is reached. One of "error" or "ignore".
`SearchLogic.SearchLimitAction`	`getSearchLimitActionAsEnum()` What to do if a search limit is reached. One of "error" or "ignore".
`java.lang.String`	`getSearchLimitReportMode()` Specifies how to report a search limit error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`SearchLogic.SearchLimitReportMode`	`getSearchLimitReportModeAsEnum()` Specifies how to report a search limit error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`java.lang.String`	`getSearchTimeoutAction()` What to do when slices time out. One of "error" or "ignore".
`SearchLogic.SearchTimeoutAction`	`getSearchTimeoutActionAsEnum()` What to do when slices time out. One of "error" or "ignore".
`java.lang.String`	`getSearchTimeoutReportMode()` Specifies how to report a timeout error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`SearchLogic.SearchTimeoutReportMode`	`getSearchTimeoutReportModeAsEnum()` Specifies how to report a timeout error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`java.lang.String`	`getSliceDownAction()` What to do if one of the slice is down when the search is performed. A slice is considered as down if all replicas are down (and if the master is also down in the default search target configuration).
`SearchLogic.SliceDownAction`	`getSliceDownActionAsEnum()` What to do if one of the slice is down when the search is performed. A slice is considered as down if all replicas are down (and if the master is also down in the default search target configuration).
`java.lang.String`	`getSliceDownReportMode()` Specifies how to report a down slice error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`SearchLogic.SliceDownReportMode`	`getSliceDownReportModeAsEnum()` Specifies how to report a down slice error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`com.exalead.search.v30.Sort`	`getSort()` Sort configuration for this search logic.
`com.exalead.search.v30.SpellCheckerConfig`	`getSpellCheckerConfig()` Spell checker configuration for this search logic.
`TimezoneConfig`	`getTimezoneConfig()`
`java.lang.String`	`getTokenizationConfig()` Name of the tokenization configuration to use when using this search logic. For consistency, this should be the same tokenization configuration as in the dictionary and analysis configurations.
`UQLConfig`	`getUQLConfig()` UQL configuration for this search logic.
`java.util.List<com.exalead.search.v30.VirtualFieldDefinition>`	`getVirtualFieldDefinition()` Virtual fields configuration for this search logic.
`java.util.Map<java.lang.String,com.exalead.search.v30.VirtualFieldDefinition>`	`getVirtualFieldDefinitionAsMap()` Get the map of VirtualFieldDefinition, indexed by name
`com.exalead.search.v30.VirtualFieldDefinition`	`getVirtualFieldDefinitionByName(java.lang.String _lookup)` Get the VirtualFieldDefinition for which the name matches _lookup
`static boolean`	`isA(java.lang.String str, SearchLogic.SearchLimitAction item)`
`static boolean`	`isA(java.lang.String str, SearchLogic.SearchLimitReportMode item)`
`static boolean`	`isA(java.lang.String str, SearchLogic.SearchTimeoutAction item)`
`static boolean`	`isA(java.lang.String str, SearchLogic.SearchTimeoutReportMode item)`
`static boolean`	`isA(java.lang.String str, SearchLogic.SliceDownAction item)`
`static boolean`	`isA(java.lang.String str, SearchLogic.SliceDownReportMode item)`
`boolean`	`isFetchMasks()` Fetches masks in searcher.
`boolean`	`isHandleNegativeSecurityTokens()` When enabled the security restriction will handle document security token starting with ~ as negative token. The negative security tokens are prioritary above standard tokens. The query restriction generated for a query with the tokens tok1, tok2, tok3 is ((tok1 OR tok2 OR tok3) AND NOT ~tok1 AND NOT ~tok2 AND NOT ~tok3). If the security sources return a lot of security tokens and the connectors do not push negative security tokens it can be interesting to disable negative security tokens handling to speed up the queries (the security query restriction will be (tok1 OR tok2 OR tok3) in this case.
`static boolean`	`isOneOf(java.lang.String str, SearchLogic.SearchLimitAction... items)`
`static boolean`	`isOneOf(java.lang.String str, SearchLogic.SearchLimitReportMode... items)`
`static boolean`	`isOneOf(java.lang.String str, SearchLogic.SearchTimeoutAction... items)`
`static boolean`	`isOneOf(java.lang.String str, SearchLogic.SearchTimeoutReportMode... items)`
`static boolean`	`isOneOf(java.lang.String str, SearchLogic.SliceDownAction... items)`
`static boolean`	`isOneOf(java.lang.String str, SearchLogic.SliceDownReportMode... items)`
`boolean`	`isRetrieveSourceField()` Should the "source" field be automatically added to the retrieved field?
`SearchLogic`	`makeCopy()` Creates and returns a deep copy of this SearchLogic.
`static SearchLogic`	`readFrom(java.io.InputStream is)` Read this SearchLogic from an XML fragment.
`boolean`	`removeVirtualFieldDefinitionByName(java.lang.String _lookup)` Removes the VirtualFieldDefinition for which the name matches _lookup
`void`	`setContentRestriction(ContentRestriction contentRestriction)` Content restriction configuration for this search logic.
`void`	`setCustomQueryProcessingFactoryClassId(java.lang.String customQueryProcessingFactoryClassId)` Java class implementing the QueryProcessingRunnerFactory interface to build the thread-specific QueryProcessingRunners (which expand the actual query).
`void`	`setDataModel(java.lang.String dataModel)` Name of the data model this search logic targets. A Search Logic can only target one data model.
`void`	`setFacetsConfig(com.exalead.search.v30.FacetsConfig facetsConfig)` Facets configuration for this search logic.
`void`	`setFetchMasks(boolean fetchMasks)` Fetches masks in searcher.
`void`	`setHandleNegativeSecurityTokens(boolean handleNegativeSecurityTokens)` When enabled the security restriction will handle document security token starting with ~ as negative token. The negative security tokens are prioritary above standard tokens. The query restriction generated for a query with the tokens tok1, tok2, tok3 is ((tok1 OR tok2 OR tok3) AND NOT ~tok1 AND NOT ~tok2 AND NOT ~tok3). If the security sources return a lot of security tokens and the connectors do not push negative security tokens it can be interesting to disable negative security tokens handling to speed up the queries (the security query restriction will be (tok1 OR tok2 OR tok3) in this case.
`void`	`setHitConfig(com.exalead.search.v30.HitConfig hitConfig)` Hit content configuration for this search logic.
`void`	`setLimitsConfig(com.exalead.search.v30.LimitsConfig limitsConfig)` Limits configuration for this search logic.
`void`	`setName(java.lang.String name)` Name of the search logic. This name is referred to with the 'logic' parameter in the Search API.
`void`	`setPostFilterConfig(PostFilterConfig postFilterConfig)` Post filtering configuration for this search logic.
`void`	`setQueryRestrictionConfig(QueryRestrictionConfig queryRestrictionConfig)` Query restriction configuration for this search logic.
`void`	`setRelatedTermsSynthesisConfig(com.exalead.search.v30.RelatedTermsSynthesisConfig relatedTermsSynthesisConfig)` Related terms configuration for this search logic.
`void`	`setRelevanceConfig(com.exalead.search.v30.RelevanceConfig relevanceConfig)` Relevance configuration for this search logic.
`void`	`setRetrieveSourceField(boolean retrieveSourceField)` Should the "source" field be automatically added to the retrieved field?
`void`	`setSearchLimitAction(SearchLogic.SearchLimitAction item)` What to do if a search limit is reached. One of "error" or "ignore".
`void`	`setSearchLimitAction(java.lang.String searchLimitAction)` What to do if a search limit is reached. One of "error" or "ignore".
`void`	`setSearchLimitReportMode(SearchLogic.SearchLimitReportMode item)` Specifies how to report a search limit error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`void`	`setSearchLimitReportMode(java.lang.String searchLimitReportMode)` Specifies how to report a search limit error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`void`	`setSearchTimeoutAction(SearchLogic.SearchTimeoutAction item)` What to do when slices time out. One of "error" or "ignore".
`void`	`setSearchTimeoutAction(java.lang.String searchTimeoutAction)` What to do when slices time out. One of "error" or "ignore".
`void`	`setSearchTimeoutReportMode(SearchLogic.SearchTimeoutReportMode item)` Specifies how to report a timeout error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`void`	`setSearchTimeoutReportMode(java.lang.String searchTimeoutReportMode)` Specifies how to report a timeout error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`void`	`setSliceDownAction(SearchLogic.SliceDownAction item)` What to do if one of the slice is down when the search is performed. A slice is considered as down if all replicas are down (and if the master is also down in the default search target configuration).
`void`	`setSliceDownAction(java.lang.String sliceDownAction)` What to do if one of the slice is down when the search is performed. A slice is considered as down if all replicas are down (and if the master is also down in the default search target configuration).
`void`	`setSliceDownReportMode(SearchLogic.SliceDownReportMode item)` Specifies how to report a down slice error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`void`	`setSliceDownReportMode(java.lang.String sliceDownReportMode)` Specifies how to report a down slice error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
`void`	`setSort(com.exalead.search.v30.Sort sort)` Sort configuration for this search logic.
`void`	`setSpellCheckerConfig(com.exalead.search.v30.SpellCheckerConfig spellCheckerConfig)` Spell checker configuration for this search logic.
`void`	`setTimezoneConfig(TimezoneConfig timezoneConfig)`
`void`	`setTokenizationConfig(java.lang.String tokenizationConfig)` Name of the tokenization configuration to use when using this search logic. For consistency, this should be the same tokenization configuration as in the dictionary and analysis configurations.
`void`	`setUQLConfig(UQLConfig uQLConfig)` UQL configuration for this search logic.
`java.lang.String`	`toString()` String representation of this SearchLogic.
`SearchLogic`	`withContentRestriction(ContentRestriction contentRestriction)`
`SearchLogic`	`withCustomQueryProcessingFactoryClassId(java.lang.String customQueryProcessingFactoryClassId)`
`SearchLogic`	`withDataModel(java.lang.String dataModel)`
`SearchLogic`	`withFacetsConfig(com.exalead.search.v30.FacetsConfig facetsConfig)`
`SearchLogic`	`withFetchMasks(boolean fetchMasks)`
`SearchLogic`	`withFetchMasks(java.lang.Boolean fetchMasks)`
`SearchLogic`	`withHandleNegativeSecurityTokens(boolean handleNegativeSecurityTokens)`
`SearchLogic`	`withHandleNegativeSecurityTokens(java.lang.Boolean handleNegativeSecurityTokens)`
`SearchLogic`	`withHitConfig(com.exalead.search.v30.HitConfig hitConfig)`
`SearchLogic`	`withLimitsConfig(com.exalead.search.v30.LimitsConfig limitsConfig)`
`SearchLogic`	`withName(java.lang.String name)`
`SearchLogic`	`withPostFilterConfig(PostFilterConfig postFilterConfig)`
`SearchLogic`	`withQueryRestrictionConfig(QueryRestrictionConfig queryRestrictionConfig)`
`SearchLogic`	`withRelatedTermsSynthesisConfig(com.exalead.search.v30.RelatedTermsSynthesisConfig relatedTermsSynthesisConfig)`
`SearchLogic`	`withRelevanceConfig(com.exalead.search.v30.RelevanceConfig relevanceConfig)`
`SearchLogic`	`withRetrieveSourceField(boolean retrieveSourceField)`
`SearchLogic`	`withRetrieveSourceField(java.lang.Boolean retrieveSourceField)`
`SearchLogic`	`withSearchLimitAction(java.lang.String searchLimitAction)`
`SearchLogic`	`withSearchLimitReportMode(java.lang.String searchLimitReportMode)`
`SearchLogic`	`withSearchTimeoutAction(java.lang.String searchTimeoutAction)`
`SearchLogic`	`withSearchTimeoutReportMode(java.lang.String searchTimeoutReportMode)`
`SearchLogic`	`withSliceDownAction(java.lang.String sliceDownAction)`
`SearchLogic`	`withSliceDownReportMode(java.lang.String sliceDownReportMode)`
`SearchLogic`	`withSort(com.exalead.search.v30.Sort sort)`
`SearchLogic`	`withSpellCheckerConfig(com.exalead.search.v30.SpellCheckerConfig spellCheckerConfig)`
`SearchLogic`	`withTimezoneConfig(TimezoneConfig timezoneConfig)`
`SearchLogic`	`withTokenizationConfig(java.lang.String tokenizationConfig)`
`SearchLogic`	`withUQLConfig(UQLConfig uQLConfig)`
`SearchLogic`	`withVirtualFieldDefinition(java.util.Collection<com.exalead.search.v30.VirtualFieldDefinition> __values)`
`SearchLogic`	`withVirtualFieldDefinition(com.exalead.search.v30.VirtualFieldDefinition... __values)` Virtual fields configuration for this search logic.
`void`	`writeTo(java.io.OutputStream os)` Write this SearchLogic as an XML fragment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - uQLConfig
```
public UQLConfig uQLConfig
```
  - spellCheckerConfig
```
public com.exalead.search.v30.SpellCheckerConfig spellCheckerConfig
```
  - relevanceConfig
```
public com.exalead.search.v30.RelevanceConfig relevanceConfig
```
  - sort
```
public com.exalead.search.v30.Sort sort
```
  - hitConfig
```
public com.exalead.search.v30.HitConfig hitConfig
```
  - relatedTermsSynthesisConfig
```
public com.exalead.search.v30.RelatedTermsSynthesisConfig relatedTermsSynthesisConfig
```
  - limitsConfig
```
public com.exalead.search.v30.LimitsConfig limitsConfig
```
  - virtualFieldDefinition
```
public java.util.List<com.exalead.search.v30.VirtualFieldDefinition> virtualFieldDefinition
```
  - facetsConfig
```
public com.exalead.search.v30.FacetsConfig facetsConfig
```
  - postFilterConfig
```
public PostFilterConfig postFilterConfig
```
  - contentRestriction
```
public ContentRestriction contentRestriction
```
  - queryRestrictionConfig
```
public QueryRestrictionConfig queryRestrictionConfig
```
  - name
```
public java.lang.String name
```
  - tokenizationConfig
```
public java.lang.String tokenizationConfig
```
  - dataModel
```
public java.lang.String dataModel
```
  - customQueryProcessingFactoryClassId
```
public java.lang.String customQueryProcessingFactoryClassId
```
  - fetchMasks
```
public boolean fetchMasks
```
  - DEFAULT_FETCH_MASKS
```
public static final boolean DEFAULT_FETCH_MASKS
```
    See Also:
    
    Constant Field Values
  - sliceDownAction
```
public java.lang.String sliceDownAction
```
  - DEFAULT_SLICE_DOWN_ACTION
```
public static final java.lang.String DEFAULT_SLICE_DOWN_ACTION
```
    See Also:
    
    Constant Field Values
  - sliceDownReportMode
```
public java.lang.String sliceDownReportMode
```
  - DEFAULT_SLICE_DOWN_REPORT_MODE
```
public static final java.lang.String DEFAULT_SLICE_DOWN_REPORT_MODE
```
    See Also:
    
    Constant Field Values
  - searchTimeoutAction
```
public java.lang.String searchTimeoutAction
```
  - DEFAULT_SEARCH_TIMEOUT_ACTION
```
public static final java.lang.String DEFAULT_SEARCH_TIMEOUT_ACTION
```
    See Also:
    
    Constant Field Values
  - searchTimeoutReportMode
```
public java.lang.String searchTimeoutReportMode
```
  - DEFAULT_SEARCH_TIMEOUT_REPORT_MODE
```
public static final java.lang.String DEFAULT_SEARCH_TIMEOUT_REPORT_MODE
```
    See Also:
    
    Constant Field Values
  - searchLimitAction
```
public java.lang.String searchLimitAction
```
  - DEFAULT_SEARCH_LIMIT_ACTION
```
public static final java.lang.String DEFAULT_SEARCH_LIMIT_ACTION
```
    See Also:
    
    Constant Field Values
  - searchLimitReportMode
```
public java.lang.String searchLimitReportMode
```
  - DEFAULT_SEARCH_LIMIT_REPORT_MODE
```
public static final java.lang.String DEFAULT_SEARCH_LIMIT_REPORT_MODE
```
    See Also:
    
    Constant Field Values
  - retrieveSourceField
```
public boolean retrieveSourceField
```
  - DEFAULT_RETRIEVE_SOURCE_FIELD
```
public static final boolean DEFAULT_RETRIEVE_SOURCE_FIELD
```
    See Also:
    
    Constant Field Values
  - handleNegativeSecurityTokens
```
public boolean handleNegativeSecurityTokens
```
  - DEFAULT_HANDLE_NEGATIVE_SECURITY_TOKENS
```
public static final boolean DEFAULT_HANDLE_NEGATIVE_SECURITY_TOKENS
```
    See Also:
    
    Constant Field Values
  - timezoneConfig
```
public TimezoneConfig timezoneConfig
```
- Constructor Detail
  - SearchLogic
```
public SearchLogic()
```
  - SearchLogic
```
public SearchLogic(SearchLogic o)
```
    Copy constructor
- Method Detail
  - isA
```
public static boolean isA(java.lang.String str,
                          SearchLogic.SliceDownAction item)
```
  - isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              SearchLogic.SliceDownAction... items)
```
  - setSliceDownAction
```
public void setSliceDownAction(SearchLogic.SliceDownAction item)
```
    What to do if one of the slice is down when the search is performed.
    A slice is considered as down if all replicas are down (and if the master is also down in the default search target configuration). One of "error" or "ignore". Default is "ignore".
  - getSliceDownActionAsEnum
```
public SearchLogic.SliceDownAction getSliceDownActionAsEnum()
```
    What to do if one of the slice is down when the search is performed.
    A slice is considered as down if all replicas are down (and if the master is also down in the default search target configuration). One of "error" or "ignore". Default is "ignore".
  - isA
```
public static boolean isA(java.lang.String str,
                          SearchLogic.SliceDownReportMode item)
```
  - isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              SearchLogic.SliceDownReportMode... items)
```
  - setSliceDownReportMode
```
public void setSliceDownReportMode(SearchLogic.SliceDownReportMode item)
```
    Specifies how to report a down slice error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - getSliceDownReportModeAsEnum
```
public SearchLogic.SliceDownReportMode getSliceDownReportModeAsEnum()
```
    Specifies how to report a down slice error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - isA
```
public static boolean isA(java.lang.String str,
                          SearchLogic.SearchTimeoutAction item)
```
  - isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              SearchLogic.SearchTimeoutAction... items)
```
  - setSearchTimeoutAction
```
public void setSearchTimeoutAction(SearchLogic.SearchTimeoutAction item)
```
    What to do when slices time out.
    One of "error" or "ignore". Default is "ignore".
  - getSearchTimeoutActionAsEnum
```
public SearchLogic.SearchTimeoutAction getSearchTimeoutActionAsEnum()
```
    What to do when slices time out.
    One of "error" or "ignore". Default is "ignore".
  - isA
```
public static boolean isA(java.lang.String str,
                          SearchLogic.SearchTimeoutReportMode item)
```
  - isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              SearchLogic.SearchTimeoutReportMode... items)
```
  - setSearchTimeoutReportMode
```
public void setSearchTimeoutReportMode(SearchLogic.SearchTimeoutReportMode item)
```
    Specifies how to report a timeout error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - getSearchTimeoutReportModeAsEnum
```
public SearchLogic.SearchTimeoutReportMode getSearchTimeoutReportModeAsEnum()
```
    Specifies how to report a timeout error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - isA
```
public static boolean isA(java.lang.String str,
                          SearchLogic.SearchLimitAction item)
```
  - isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              SearchLogic.SearchLimitAction... items)
```
  - setSearchLimitAction
```
public void setSearchLimitAction(SearchLogic.SearchLimitAction item)
```
    What to do if a search limit is reached.
    One of "error" or "ignore". Default is "ignore".
  - getSearchLimitActionAsEnum
```
public SearchLogic.SearchLimitAction getSearchLimitActionAsEnum()
```
    What to do if a search limit is reached.
    One of "error" or "ignore". Default is "ignore".
  - isA
```
public static boolean isA(java.lang.String str,
                          SearchLogic.SearchLimitReportMode item)
```
  - isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              SearchLogic.SearchLimitReportMode... items)
```
  - setSearchLimitReportMode
```
public void setSearchLimitReportMode(SearchLogic.SearchLimitReportMode item)
```
    Specifies how to report a search limit error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - getSearchLimitReportModeAsEnum
```
public SearchLogic.SearchLimitReportMode getSearchLimitReportModeAsEnum()
```
    Specifies how to report a search limit error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - setUQLConfig
```
public void setUQLConfig(UQLConfig uQLConfig)
```
    UQL configuration for this search logic.
  - getUQLConfig
```
public UQLConfig getUQLConfig()
```
    UQL configuration for this search logic.
  - withUQLConfig
```
public SearchLogic withUQLConfig(UQLConfig uQLConfig)
```
  - setSpellCheckerConfig
```
public void setSpellCheckerConfig(com.exalead.search.v30.SpellCheckerConfig spellCheckerConfig)
```
    Spell checker configuration for this search logic.
  - getSpellCheckerConfig
```
public com.exalead.search.v30.SpellCheckerConfig getSpellCheckerConfig()
```
    Spell checker configuration for this search logic.
  - withSpellCheckerConfig
```
public SearchLogic withSpellCheckerConfig(com.exalead.search.v30.SpellCheckerConfig spellCheckerConfig)
```
  - setRelevanceConfig
```
public void setRelevanceConfig(com.exalead.search.v30.RelevanceConfig relevanceConfig)
```
    Relevance configuration for this search logic.
  - getRelevanceConfig
```
public com.exalead.search.v30.RelevanceConfig getRelevanceConfig()
```
    Relevance configuration for this search logic.
  - withRelevanceConfig
```
public SearchLogic withRelevanceConfig(com.exalead.search.v30.RelevanceConfig relevanceConfig)
```
  - setSort
```
public void setSort(com.exalead.search.v30.Sort sort)
```
    Sort configuration for this search logic.
  - getSort
```
public com.exalead.search.v30.Sort getSort()
```
    Sort configuration for this search logic.
  - withSort
```
public SearchLogic withSort(com.exalead.search.v30.Sort sort)
```
  - setHitConfig
```
public void setHitConfig(com.exalead.search.v30.HitConfig hitConfig)
```
    Hit content configuration for this search logic.
  - getHitConfig
```
public com.exalead.search.v30.HitConfig getHitConfig()
```
    Hit content configuration for this search logic.
  - withHitConfig
```
public SearchLogic withHitConfig(com.exalead.search.v30.HitConfig hitConfig)
```
  - setRelatedTermsSynthesisConfig
```
public void setRelatedTermsSynthesisConfig(com.exalead.search.v30.RelatedTermsSynthesisConfig relatedTermsSynthesisConfig)
```
    Related terms configuration for this search logic.
  - getRelatedTermsSynthesisConfig
```
public com.exalead.search.v30.RelatedTermsSynthesisConfig getRelatedTermsSynthesisConfig()
```
    Related terms configuration for this search logic.
  - withRelatedTermsSynthesisConfig
```
public SearchLogic withRelatedTermsSynthesisConfig(com.exalead.search.v30.RelatedTermsSynthesisConfig relatedTermsSynthesisConfig)
```
  - setLimitsConfig
```
public void setLimitsConfig(com.exalead.search.v30.LimitsConfig limitsConfig)
```
    Limits configuration for this search logic.
  - getLimitsConfig
```
public com.exalead.search.v30.LimitsConfig getLimitsConfig()
```
    Limits configuration for this search logic.
  - withLimitsConfig
```
public SearchLogic withLimitsConfig(com.exalead.search.v30.LimitsConfig limitsConfig)
```
  - getVirtualFieldDefinition
```
public java.util.List<com.exalead.search.v30.VirtualFieldDefinition> getVirtualFieldDefinition()
```
    Virtual fields configuration for this search logic.
  - getVirtualFieldDefinitionByName
```
public com.exalead.search.v30.VirtualFieldDefinition getVirtualFieldDefinitionByName(java.lang.String _lookup)
```
    Get the VirtualFieldDefinition for which the name matches _lookup
    
    Returns:
    
    null if no matching VirtualFieldDefinition is found
  - getVirtualFieldDefinitionAsMap
```
public java.util.Map<java.lang.String,com.exalead.search.v30.VirtualFieldDefinition> getVirtualFieldDefinitionAsMap()
```
    Get the map of VirtualFieldDefinition, indexed by name
  - removeVirtualFieldDefinitionByName
```
public boolean removeVirtualFieldDefinitionByName(java.lang.String _lookup)
```
    Removes the VirtualFieldDefinition for which the name matches _lookup
    
    Returns:
    
    false if no matching VirtualFieldDefinition is found, true if one was found
  - withVirtualFieldDefinition
```
public SearchLogic withVirtualFieldDefinition(com.exalead.search.v30.VirtualFieldDefinition... __values)
```
    Virtual fields configuration for this search logic.
  - withVirtualFieldDefinition
```
public SearchLogic withVirtualFieldDefinition(java.util.Collection<com.exalead.search.v30.VirtualFieldDefinition> __values)
```
  - setFacetsConfig
```
public void setFacetsConfig(com.exalead.search.v30.FacetsConfig facetsConfig)
```
    Facets configuration for this search logic.
  - getFacetsConfig
```
public com.exalead.search.v30.FacetsConfig getFacetsConfig()
```
    Facets configuration for this search logic.
  - withFacetsConfig
```
public SearchLogic withFacetsConfig(com.exalead.search.v30.FacetsConfig facetsConfig)
```
  - setPostFilterConfig
```
public void setPostFilterConfig(PostFilterConfig postFilterConfig)
```
    Post filtering configuration for this search logic.
  - getPostFilterConfig
```
public PostFilterConfig getPostFilterConfig()
```
    Post filtering configuration for this search logic.
  - withPostFilterConfig
```
public SearchLogic withPostFilterConfig(PostFilterConfig postFilterConfig)
```
  - setContentRestriction
```
public void setContentRestriction(ContentRestriction contentRestriction)
```
    Content restriction configuration for this search logic.
  - getContentRestriction
```
public ContentRestriction getContentRestriction()
```
    Content restriction configuration for this search logic.
  - withContentRestriction
```
public SearchLogic withContentRestriction(ContentRestriction contentRestriction)
```
  - setQueryRestrictionConfig
```
public void setQueryRestrictionConfig(QueryRestrictionConfig queryRestrictionConfig)
```
    Query restriction configuration for this search logic.
  - getQueryRestrictionConfig
```
public QueryRestrictionConfig getQueryRestrictionConfig()
```
    Query restriction configuration for this search logic.
  - withQueryRestrictionConfig
```
public SearchLogic withQueryRestrictionConfig(QueryRestrictionConfig queryRestrictionConfig)
```
  - setName
```
public void setName(java.lang.String name)
```
    Name of the search logic.
    This name is referred to with the 'logic' parameter in the Search API.
  - getName
```
public java.lang.String getName()
```
    Name of the search logic.
    This name is referred to with the 'logic' parameter in the Search API.
  - withName
```
public SearchLogic withName(java.lang.String name)
```
  - setTokenizationConfig
```
public void setTokenizationConfig(java.lang.String tokenizationConfig)
```
    Name of the tokenization configuration to use when using this search logic.
    For consistency, this should be the same tokenization configuration as in the dictionary and analysis configurations.
  - getTokenizationConfig
```
public java.lang.String getTokenizationConfig()
```
    Name of the tokenization configuration to use when using this search logic.
    For consistency, this should be the same tokenization configuration as in the dictionary and analysis configurations.
  - withTokenizationConfig
```
public SearchLogic withTokenizationConfig(java.lang.String tokenizationConfig)
```
  - setDataModel
```
public void setDataModel(java.lang.String dataModel)
```
    Name of the data model this search logic targets.
    A Search Logic can only target one data model.
  - getDataModel
```
public java.lang.String getDataModel()
```
    Name of the data model this search logic targets.
    A Search Logic can only target one data model.
  - withDataModel
```
public SearchLogic withDataModel(java.lang.String dataModel)
```
  - setCustomQueryProcessingFactoryClassId
```
public void setCustomQueryProcessingFactoryClassId(java.lang.String customQueryProcessingFactoryClassId)
```
    Java class implementing the QueryProcessingRunnerFactory interface
    to build the thread-specific QueryProcessingRunners (which expand the actual
    query).
  - getCustomQueryProcessingFactoryClassId
```
public java.lang.String getCustomQueryProcessingFactoryClassId()
```
    Java class implementing the QueryProcessingRunnerFactory interface
    to build the thread-specific QueryProcessingRunners (which expand the actual
    query).
  - withCustomQueryProcessingFactoryClassId
```
public SearchLogic withCustomQueryProcessingFactoryClassId(java.lang.String customQueryProcessingFactoryClassId)
```
  - setFetchMasks
```
public void setFetchMasks(boolean fetchMasks)
```
    Fetches masks in searcher. Required to get the "mask" field in the hits.
  - isFetchMasks
```
public boolean isFetchMasks()
```
    Fetches masks in searcher. Required to get the "mask" field in the hits.
  - withFetchMasks
```
public SearchLogic withFetchMasks(boolean fetchMasks)
```
  - withFetchMasks
```
public SearchLogic withFetchMasks(java.lang.Boolean fetchMasks)
```
  - setSliceDownAction
```
public void setSliceDownAction(java.lang.String sliceDownAction)
```
    What to do if one of the slice is down when the search is performed.
    A slice is considered as down if all replicas are down (and if the master is also down in the default search target configuration). One of "error" or "ignore". Default is "ignore".
  - getSliceDownAction
```
public java.lang.String getSliceDownAction()
```
    What to do if one of the slice is down when the search is performed.
    A slice is considered as down if all replicas are down (and if the master is also down in the default search target configuration). One of "error" or "ignore". Default is "ignore".
  - withSliceDownAction
```
public SearchLogic withSliceDownAction(java.lang.String sliceDownAction)
```
  - setSliceDownReportMode
```
public void setSliceDownReportMode(java.lang.String sliceDownReportMode)
```
    Specifies how to report a down slice error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - getSliceDownReportMode
```
public java.lang.String getSliceDownReportMode()
```
    Specifies how to report a down slice error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - withSliceDownReportMode
```
public SearchLogic withSliceDownReportMode(java.lang.String sliceDownReportMode)
```
  - setSearchTimeoutAction
```
public void setSearchTimeoutAction(java.lang.String searchTimeoutAction)
```
    What to do when slices time out.
    One of "error" or "ignore". Default is "ignore".
  - getSearchTimeoutAction
```
public java.lang.String getSearchTimeoutAction()
```
    What to do when slices time out.
    One of "error" or "ignore". Default is "ignore".
  - withSearchTimeoutAction
```
public SearchLogic withSearchTimeoutAction(java.lang.String searchTimeoutAction)
```
  - setSearchTimeoutReportMode
```
public void setSearchTimeoutReportMode(java.lang.String searchTimeoutReportMode)
```
    Specifies how to report a timeout error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - getSearchTimeoutReportMode
```
public java.lang.String getSearchTimeoutReportMode()
```
    Specifies how to report a timeout error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - withSearchTimeoutReportMode
```
public SearchLogic withSearchTimeoutReportMode(java.lang.String searchTimeoutReportMode)
```
  - setSearchLimitAction
```
public void setSearchLimitAction(java.lang.String searchLimitAction)
```
    What to do if a search limit is reached.
    One of "error" or "ignore". Default is "ignore".
  - getSearchLimitAction
```
public java.lang.String getSearchLimitAction()
```
    What to do if a search limit is reached.
    One of "error" or "ignore". Default is "ignore".
  - withSearchLimitAction
```
public SearchLogic withSearchLimitAction(java.lang.String searchLimitAction)
```
  - setSearchLimitReportMode
```
public void setSearchLimitReportMode(java.lang.String searchLimitReportMode)
```
    Specifies how to report a search limit error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - getSearchLimitReportMode
```
public java.lang.String getSearchLimitReportMode()
```
    Specifies how to report a search limit error in 'Troubleshooting > Logs':
    - quiet: No log.
    - local: Error is reported in the Process log.
    - global: Error is reported in both Process and Global logs.
  - withSearchLimitReportMode
```
public SearchLogic withSearchLimitReportMode(java.lang.String searchLimitReportMode)
```
  - setRetrieveSourceField
```
public void setRetrieveSourceField(boolean retrieveSourceField)
```
    Should the "source" field be automatically added to the retrieved field?
  - isRetrieveSourceField
```
public boolean isRetrieveSourceField()
```
    Should the "source" field be automatically added to the retrieved field?
  - withRetrieveSourceField
```
public SearchLogic withRetrieveSourceField(boolean retrieveSourceField)
```
  - withRetrieveSourceField
```
public SearchLogic withRetrieveSourceField(java.lang.Boolean retrieveSourceField)
```
  - setHandleNegativeSecurityTokens
```
public void setHandleNegativeSecurityTokens(boolean handleNegativeSecurityTokens)
```
    When enabled the security restriction will handle document security token starting with ~ as negative token.
    The negative security tokens are prioritary above standard tokens.
    The query restriction generated for a query with the tokens tok1, tok2, tok3 is ((tok1 OR tok2 OR tok3) AND NOT ~tok1 AND NOT ~tok2 AND NOT ~tok3).
    If the security sources return a lot of security tokens and the connectors do not push negative security tokens
    it can be interesting to disable negative security tokens handling to speed up the queries (the security query restriction will be
    (tok1 OR tok2 OR tok3) in this case.
  - isHandleNegativeSecurityTokens
```
public boolean isHandleNegativeSecurityTokens()
```
    When enabled the security restriction will handle document security token starting with ~ as negative token.
    The negative security tokens are prioritary above standard tokens.
    The query restriction generated for a query with the tokens tok1, tok2, tok3 is ((tok1 OR tok2 OR tok3) AND NOT ~tok1 AND NOT ~tok2 AND NOT ~tok3).
    If the security sources return a lot of security tokens and the connectors do not push negative security tokens
    it can be interesting to disable negative security tokens handling to speed up the queries (the security query restriction will be
    (tok1 OR tok2 OR tok3) in this case.
  - withHandleNegativeSecurityTokens
```
public SearchLogic withHandleNegativeSecurityTokens(boolean handleNegativeSecurityTokens)
```
  - withHandleNegativeSecurityTokens
```
public SearchLogic withHandleNegativeSecurityTokens(java.lang.Boolean handleNegativeSecurityTokens)
```
  - setTimezoneConfig
```
public void setTimezoneConfig(TimezoneConfig timezoneConfig)
```
  - getTimezoneConfig
```
public TimezoneConfig getTimezoneConfig()
```
  - withTimezoneConfig
```
public SearchLogic withTimezoneConfig(TimezoneConfig timezoneConfig)
```
  - makeCopy
```
public SearchLogic makeCopy()
```
    Creates and returns a deep copy of this SearchLogic.
  - readFrom
```
public static SearchLogic readFrom(java.io.InputStream is)
                            throws javax.xml.bind.JAXBException
```
    Read this SearchLogic from an XML fragment.
    
    Throws:
    
    javax.xml.bind.JAXBException
  - writeTo
```
public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException
```
    Write this SearchLogic as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static SearchLogic fromString(java.lang.String s)
                              throws javax.xml.bind.JAXBException,
                                     java.io.UnsupportedEncodingException
```
    String representation of this SearchLogic.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this SearchLogic.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this SearchLogic.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class SearchLogic

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

uQLConfig

spellCheckerConfig

relevanceConfig

sort

hitConfig

relatedTermsSynthesisConfig

limitsConfig

virtualFieldDefinition

facetsConfig

postFilterConfig

contentRestriction

queryRestrictionConfig

name

tokenizationConfig

dataModel

customQueryProcessingFactoryClassId

fetchMasks

DEFAULT_FETCH_MASKS

sliceDownAction

DEFAULT_SLICE_DOWN_ACTION

sliceDownReportMode

DEFAULT_SLICE_DOWN_REPORT_MODE

searchTimeoutAction

DEFAULT_SEARCH_TIMEOUT_ACTION

searchTimeoutReportMode

DEFAULT_SEARCH_TIMEOUT_REPORT_MODE

searchLimitAction

DEFAULT_SEARCH_LIMIT_ACTION

searchLimitReportMode

DEFAULT_SEARCH_LIMIT_REPORT_MODE

retrieveSourceField

DEFAULT_RETRIEVE_SOURCE_FIELD

handleNegativeSecurityTokens

DEFAULT_HANDLE_NEGATIVE_SECURITY_TOKENS

timezoneConfig

Constructor Detail

SearchLogic

SearchLogic

Method Detail

isA

isOneOf

setSliceDownAction

getSliceDownActionAsEnum

isA

isOneOf

setSliceDownReportMode

getSliceDownReportModeAsEnum

isA

isOneOf

setSearchTimeoutAction

getSearchTimeoutActionAsEnum

isA

isOneOf

setSearchTimeoutReportMode

getSearchTimeoutReportModeAsEnum

isA

isOneOf

setSearchLimitAction

getSearchLimitActionAsEnum

isA

isOneOf

setSearchLimitReportMode

getSearchLimitReportModeAsEnum

setUQLConfig

getUQLConfig

withUQLConfig

setSpellCheckerConfig

getSpellCheckerConfig

withSpellCheckerConfig

setRelevanceConfig

getRelevanceConfig

withRelevanceConfig

setSort