OptionalNode (lettucemod unspecified)

java.lang.Object
- com.redis.lettucemod.search.querybuilder.QueryNode
- - com.redis.lettucemod.search.querybuilder.IntersectNode
  - - com.redis.lettucemod.search.querybuilder.OptionalNode

All Implemented Interfaces:

Node
```
public class OptionalNode
extends IntersectNode
```
Created by mnunberg on 2/23/18. The optional node affects scoring and ordering. If it evaluates to true, the result is ranked higher. It is helpful to combine it with a UnionNode to rank a document higher if it meets one of several criteria. In RS: ~(@lang:en @country:us).

- Nested Class Summary
  - Nested classes/interfaces inherited from interface com.redis.lettucemod.search.querybuilder.Node
    Node.ParenMode
- Constructor Summary
  
  Constructors
  Constructor Description
  
  OptionalNode()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  java.lang.String toString(Node.ParenMode mode)
  Returns the string form of this node.
  - Methods inherited from class com.redis.lettucemod.search.querybuilder.IntersectNode
    getJoinString
  - Methods inherited from class com.redis.lettucemod.search.querybuilder.QueryNode
    add, add, add, add, shouldUseParens, toString
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OptionalNode
```
public OptionalNode()
```
- Method Detail
  - toString
```
public java.lang.String toString(Node.ParenMode mode)
```
    Description copied from interface: Node
    
    Returns the string form of this node.
    
    Specified by:
    
    toString in interface Node
    
    Overrides:
    
    toString in class QueryNode
    
    Parameters:
    
    mode - Whether the string should be encapsulated in parentheses (...)
    
    Returns:
    
    The string query.