The slop (proximity) works like an edit distance (see PhraseQuery.setSlop
). So, the terms could be reordered or have extra terms added. This means that the proximity would be the maximum number of terms added into the whole query. That is:
"jakarta apache lucene"~3
Will match:
- "jakarta lucene apache" (distance: 2)
- "jakarta extra words here apache lucene" (distance: 3)
- "jakarta some words apache separated lucene" (distance: 3)
But not:
- "lucene jakarta apache" (distance: 4)
- "jakarta too many extra words here apache lucene" (distance: 5)
- "jakarta some words apache further separated lucene" (distance: 4)
Some people have been confused by:
"lucene jakarta apache" (distance: 4)
The simple explanation is that swapping terms takes two edits, so:
- jakarta apache lucene (distance: 0)
- jakarta lucene apache (first swap, distance: 2)
- lucene jakarta apache (second swap, distance: 4)
The longer, but more accurate, explanation is that every edit allows a term to be moved by one position. The first move of a swap transposes two terms on top of each other. Keeping this in mind explains why any set of three terms can be rearranged into any order with distance no greater than 4.
- jakarta apache lucene (distance: 0)
- jakarta [apache,lucene] (distance: 1)
- [jakarta,apache,lucene] (all transposed at the same position, distance: 2)
- lucene [jakarta,apache] (distance: 3)
- lucene jakarta apache (distance: 4)