java.lang.Object
org.elasticsearch.compute.operator.Warnings
Utilities to collect warnings for running an executor.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic WarningscreateOnlyWarnings(DriverContext.WarningsMode warningsMode, int lineNumber, int columnNumber, String sourceText) Create a new warnings object based on the given mode which warns that evaluation resulted in warnings.static WarningscreateWarnings(DriverContext.WarningsMode warningsMode, int lineNumber, int columnNumber, String sourceText) Create a new warnings object based on the given modestatic WarningscreateWarningsTreatedAsFalse(DriverContext.WarningsMode warningsMode, int lineNumber, int columnNumber, String sourceText) Create a new warnings object based on the given mode which warns that it treats the result asfalse.voidregisterException(Class<? extends Exception> exceptionClass, String message) Register an exception to be included in the warnings.voidregisterException(Exception exception)
-
Field Details
-
NOOP_WARNINGS
-
-
Method Details
-
createWarnings
public static Warnings createWarnings(DriverContext.WarningsMode warningsMode, int lineNumber, int columnNumber, String sourceText) Create a new warnings object based on the given mode- Parameters:
warningsMode- The warnings collection strategy to uselineNumber- The line number of the source text. Same as `source.getLineNumber()`columnNumber- The column number of the source text. Same as `source.getColumnNumber()`sourceText- The source text that caused the warning. Same as `source.text()`- Returns:
- A warnings collector object
-
createWarningsTreatedAsFalse
public static Warnings createWarningsTreatedAsFalse(DriverContext.WarningsMode warningsMode, int lineNumber, int columnNumber, String sourceText) Create a new warnings object based on the given mode which warns that it treats the result asfalse.- Parameters:
warningsMode- The warnings collection strategy to uselineNumber- The line number of the source text. Same as `source.getLineNumber()`columnNumber- The column number of the source text. Same as `source.getColumnNumber()`sourceText- The source text that caused the warning. Same as `source.text()`- Returns:
- A warnings collector object
-
createOnlyWarnings
public static Warnings createOnlyWarnings(DriverContext.WarningsMode warningsMode, int lineNumber, int columnNumber, String sourceText) Create a new warnings object based on the given mode which warns that evaluation resulted in warnings.- Parameters:
warningsMode- The warnings collection strategy to uselineNumber- The line number of the source text. Same as `source.getLineNumber()`columnNumber- The column number of the source text. Same as `source.getColumnNumber()`sourceText- The source text that caused the warning. Same as `source.text()`- Returns:
- A warnings collector object
-
registerException
-
registerException
Register an exception to be included in the warnings.This overload avoids the need to instantiate the exception, which can be expensive. Instead, it asks only the required pieces to build the warning.
-