FindByIntervalOperator (Punch Punch Language Runtime Library 6.4.5 API)

java.lang.Object
- org.thales.punch.libraries.punchlang.operator.FindByIntervalOperator

```
public class FindByIntervalOperator
extends Object
```
The FindByIntervalOperator lets you efficiently find elements associated to interval given a value. Basically this provides a IntervalTree data structure with O(log(n)) complexity. Suppose you have the following data in a tuple named "intervals" (remember : simply put a json file in the 'jsons' resource directory).
```
 [
 { "user" : "bob", "min" : 0, "max" : 10 },
 { "user" : ["ted", "bob"], "min" : 5, "max" : 7 },
 { "user" : "dimi", "min" : 11, "max" : 20 },
 { "user" : "flo", "min" : 8, "max" : 12 }
 ]
 
```
Running
```
 Tuple result;
 findByInterval("intervals").on(6).into(result);
 print(result);
 
```
produces
```
 [
   {"min":5,"color":"blue","user":["ted","bob"],"max":7},
   {"min":0,"color":"red","user":"bob","max":10}
 ]
 
```
I.e. what you get is a list of all elements whose interval (here guessed from the min and max fields) surrounds the value (6 in this example, matching two elements in this example). Just like the FindByKeyOperator operator, you can request the result be reorganised as unions. Running
```
 Tuple result;
 findByInterval(intervals).union().on(6).into(result);
 print(result);
 
```
produces
```
 {
 "color":["red","blue"],
 "user":["ted","bob"]
 }
 
```
Note that with the union, the interval boundaries are not part of the result. This example is available here : finding.punch. To run it, use the json files from json.

Constructor Summary

Constructors
Constructor and Description
`FindByIntervalOperator(Tuple sourceTuple)` Create a `FindByIntervalOperator` operator expecting ranges of min max values given either as arrays of 2 values, i.e.
`FindByIntervalOperator(Tuple sourceTuple, String intervalKey)` Create a FindInterval operator expecting ranges of min max given in arrays of 2 value, i.e.
`FindByIntervalOperator(Tuple sourceTuple, String minKey, String maxKey)` Create a `FindByIntervalOperator` operator expecting ranges of min max, i.e.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FindByIntervalOperator`	`between(Tuple tuple)` Look for all Json elements whose interval encloses the value contained in this tuple.
`FindByIntervalOperator`	`defaultMatch(String defaultMatch)` Set a default value if no match is found.
`boolean`	`into(Tuple into)` Actually perform the query and put the result into 'into'
`FindByIntervalOperator`	`largestFirst()` Request the largest first
`FindByIntervalOperator`	`on(long input)` Set the search value.
`FindByIntervalOperator`	`on(String input)` Set the search value.
`FindByIntervalOperator`	`on(Tuple tuple)` Fire the operator on the provided tuple.
`FindByIntervalOperator`	`smallestFirst()` Request the smallest first
`FindByIntervalOperator`	`union()` Request a unioned result.

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

- Constructor Detail
  - FindByIntervalOperator
```
public FindByIntervalOperator(Tuple sourceTuple,
                              String intervalKey)
```
    Create a FindInterval operator expecting ranges of min max given in arrays of 2 value, i.e.
```
 {
   "interval" : [10, 100]
   "otherstuffs" : ...
  }
  
```
    By default the key used to identify the array is "interval". This constructor lets you change that to another field.
    Parameters:
    
    sourceTuple - the input json representing an interval tree
    
    intervalKey - the name of the property providing the interval
  - FindByIntervalOperator
```
public FindByIntervalOperator(Tuple sourceTuple,
                              String minKey,
                              String maxKey)
```
    Create a FindByIntervalOperator operator expecting ranges of min max, i.e.
```
 {
   "min" : 10,
   "max" : 100,
   "otherstuffs" : ...
  }
  
```
    By default, the expected property keys are "min" and "max". You can change that to other values with this constructor.
    Parameters:
    
    sourceTuple - the input map representing an interval tree
    
    minKey - the name of the property providing the start interval
    
    maxKey - the name of the property providing the start interval
  - FindByIntervalOperator
```
public FindByIntervalOperator(Tuple sourceTuple)
```
    Create a FindByIntervalOperator operator expecting ranges of min max values given either as arrays of 2 values, i.e. *
```
 {
   "interval" : [10, 100]
   "otherstuffs" : ...
  }
  
```
    or as named fields :
```
 {
   "min" : 10,
   "max" : 100,
   "otherstuffs" : ...
  }
  
```
    By default, the expected property keys are "interval", "min" and "max". You can change that using other constructors.
    Parameters:
    
    sourceTuple - the input map representing an interval tree
- Method Detail
  - smallestFirst
```
public FindByIntervalOperator smallestFirst()
```
    Request the smallest first
    
    Returns:
    
    this operator
  - largestFirst
```
public FindByIntervalOperator largestFirst()
```
    Request the largest first
    
    Returns:
    
    this operator
  - defaultMatch
```
public FindByIntervalOperator defaultMatch(String defaultMatch)
```
    Set a default value if no match is found.
    
    Parameters:
    
    defaultMatch - the default value
    
    Returns:
    
    this operator
  - between
```
public FindByIntervalOperator between(Tuple tuple)
```
    Look for all Json elements whose interval encloses the value contained in this tuple. The expected value is a long.
    
    Parameters:
    
    tuple - the tuple holding the long value
    
    Returns:
    
    this operator
  - on
```
public FindByIntervalOperator on(Tuple tuple)
```
    Fire the operator on the provided tuple. That tuple must contain a long or a long string representation.
    
    Parameters:
    
    tuple - the value for looking your intervals
    
    Returns:
    
    this operator
  - on
```
public FindByIntervalOperator on(long input)
```
    Set the search value.
    
    Parameters:
    
    input - the long input
    
    Returns:
    
    this operator
  - on
```
public FindByIntervalOperator on(String input)
```
    Set the search value. This is only to add string value representing a long value.
    
    Parameters:
    
    input - the long input as a String.
    
    Returns:
    
    this operator
  - union
```
public FindByIntervalOperator union()
```
    Request a unioned result.
    
    Returns:
    
    this operator
  - into
```
public boolean into(Tuple into)
```
    Actually perform the query and put the result into 'into'
    
    Parameters:
    
    into - the destination tuple
    
    Returns:
    
    true if something as found, false otherwise

Class FindByIntervalOperator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FindByIntervalOperator

FindByIntervalOperator

FindByIntervalOperator

Method Detail

smallestFirst

largestFirst

defaultMatch

between

on

on

on

union

into