Skip to content

Commit 1314baf

Browse files
committed
Update in javadocs for DerivedFieldSupportedTypes and DerivedFieldType
Signed-off-by: Rishabh Maurya <rishabhmaurya05@gmail.com>
1 parent 0325284 commit 1314baf

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

server/src/main/java/org/opensearch/index/mapper/DerivedFieldSupportedTypes.java

+5
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@
3131
import java.util.function.Function;
3232
import java.util.stream.Collectors;
3333

34+
/**
35+
* Contains logic to get the FieldMapper for a given type of derived field. Also, for a given type of derived field,
36+
* it is used to create an IndexableField for the provided type and object. It is useful when indexing into
37+
* lucene MemoryIndex in {@link org.opensearch.index.query.DerivedFieldQuery}.
38+
*/
3439
enum DerivedFieldSupportedTypes {
3540

3641
BOOLEAN("boolean", (name, context) -> {

server/src/main/java/org/opensearch/index/mapper/DerivedFieldType.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
/**
3535
* MappedFieldType for Derived Fields
36-
* Contains logic to different type of queries on derived fields
36+
* Contains logic to execute different type of queries on a derived field of given type.
3737
* @opensearch.internal
3838
*/
3939
public final class DerivedFieldType extends MappedFieldType {

0 commit comments

Comments
 (0)