Update javadocs

opensearch-project · Mar 21, 2024 · 6ba0349 · 6ba0349
1 parent f71522a
commit 6ba0349
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/server/src/main/java/org/opensearch/index/mapper/DerivedFieldValueFetcher.java b/server/src/main/java/org/opensearch/index/mapper/DerivedFieldValueFetcher.java
@@ -16,7 +16,9 @@
 import java.util.List;
 
 /**
- * ValueFetcher used by Derived Fields.
+ * The value fetcher contains logic to execute script and fetch the value in form of List<Object>.
+ * It expects DerivedFieldScript.LeafFactory as an input and sets the contract with consumer to call
+ * {@link #setNextReader(LeafReaderContext)} whenever a segment is switched.
  */
 public final class DerivedFieldValueFetcher implements ValueFetcher {
     private DerivedFieldScript derivedFieldScript;

diff --git a/server/src/main/java/org/opensearch/script/DerivedFieldScript.java b/server/src/main/java/org/opensearch/script/DerivedFieldScript.java
@@ -45,6 +45,7 @@
 
 /**
  * Definition of Script for DerivedField.
+ * It will be used to execute scripts defined against derived fields of any type
  *
  * @opensearch.internal
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -45,6 +45,7 @@ @@
     /**
      * Definition of Script for DerivedField.
+     * It will be used to execute scripts defined against derived fields of any type
      *
      * @opensearch.internal
      */
@@ Expand Down @@