Skip to content

Deprecate enablePositionIncrements parameter in StopTokenFilter #3653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 4, 2025
+57 −9
Merged

Deprecate enablePositionIncrements parameter in StopTokenFilter #3653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions elastic4s-domain/src/main/scala/com/sksamuel/elastic4s/analysis/TokenFilter.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,6 @@ case class StopTokenFilter(
language: Option[String] = None,
stopwords: Iterable[String] = Nil,
stopwordsPath: Option[String] = None,
enablePositionIncrements: Option[Boolean] = None, // ignored now as of 1.4.0
removeTrailing: Option[Boolean] = None,
ignoreCase: Option[Boolean] = None
) extends TokenFilter {
Expand All @@ -259,19 +258,35 @@ case class StopTokenFilter(
b.array("stopwords", stopwords.toArray)
language.foreach(b.field("stopwords", _))
stopwordsPath.foreach(b.field("stopwords_path", _))
enablePositionIncrements.foreach(b.field("enable_position_increments", _))
ignoreCase.foreach(b.field("ignore_case", _))
removeTrailing.foreach(b.field("remove_trailing", _))
b
}

def ignoreCase(boolean: Boolean): StopTokenFilter = copy(ignoreCase = boolean.some)
def removeTrailing(boolean: Boolean): StopTokenFilter = copy(removeTrailing = boolean.some)
def enablePositionIncrements(boolean: Boolean): StopTokenFilter = copy(enablePositionIncrements = boolean.some)
def language(language: String): StopTokenFilter = copy(language = language.some)
def stopwords(stopwords: Iterable[String]): StopTokenFilter = copy(stopwords = stopwords)
def stopwords(stopwords: String, rest: String*): StopTokenFilter = copy(stopwords = stopwords +: rest)
def stopwordsPath(path: String): StopTokenFilter = copy(stopwordsPath = path.some)
def ignoreCase(boolean: Boolean): StopTokenFilter = copy(ignoreCase = boolean.some)
def removeTrailing(boolean: Boolean): StopTokenFilter = copy(removeTrailing = boolean.some)
@deprecated(
"enablePositionIncrements is not supported anymore",
"9.1.1"
) def enablePositionIncrements(boolean: Boolean): StopTokenFilter = this
def language(language: String): StopTokenFilter = copy(language = language.some)
def stopwords(stopwords: Iterable[String]): StopTokenFilter = copy(stopwords = stopwords)
def stopwords(stopwords: String, rest: String*): StopTokenFilter = copy(stopwords = stopwords +: rest)
def stopwordsPath(path: String): StopTokenFilter = copy(stopwordsPath = path.some)
}

object StopTokenFilter {
@deprecated("Use apply without enablePositionIncrements parameter instead", "9.1.1")
def apply(
name: String,
language: Option[String],
stopwords: Iterable[String],
stopwordsPath: Option[String],
enablePositionIncrements: Option[Boolean],
removeTrailing: Option[Boolean],
ignoreCase: Option[Boolean]
): StopTokenFilter =
StopTokenFilter(name, language, stopwords, stopwordsPath, removeTrailing, ignoreCase)
}

object NamedStopTokenFilter {
Expand Down
9 changes: 9 additions & 0 deletions elastic4s-tests/src/test/resources/json/analysis/tokenfilter/stoptokenfilter_raw.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"type": "stop",
"stopwords": [
"a",
"an"
],
"remove_trailing": true,
"ignore_case": false
}
24 changes: 24 additions & 0 deletions elastic4s-tests/src/test/scala/com/sksamuel/elastic4s/analysis/TokenFilterTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,28 @@ class TokenFilterTest extends AnyWordSpec with Matchers with JsonSugar {
).build.string should matchJsonResource("/json/analysis/tokenfilter/reversetokenfilter_raw.json")
}
}

"StopTokenFilter" should {
"build json" in {
StopTokenFilter(
name = "my_stop",
language = None,
stopwords = List("a", "an"),
stopwordsPath = None,
removeTrailing = Some(true),
ignoreCase = Some(false)
).build.string should matchJsonResource("/json/analysis/tokenfilter/stoptokenfilter_raw.json")
}
"build json with deprecated constructor" in {
StopTokenFilter(
name = "my_stop",
language = None,
stopwords = List("a", "an"),
stopwordsPath = None,
enablePositionIncrements = Some(false),
removeTrailing = Some(true),
ignoreCase = Some(false)
).build.string should matchJsonResource("/json/analysis/tokenfilter/stoptokenfilter_raw.json")
}
}
}