MLE-14737 Extracted error message for missing Optic query

Just a refactoring. Need to be able to override this in Flux.

Author: rjrudin

src/main/java/com/marklogic/spark/ContextSupport.java

@@ -23,9 +23,7 @@
 
 import java.io.Serializable;
 import java.util.HashMap;
-import java.util.Locale;
 import java.util.Map;
-import java.util.ResourceBundle;
 import java.util.concurrent.TimeUnit;
 
 public class ContextSupport implements Serializable {
@@ -107,11 +105,7 @@ public final boolean optionExists(String option) {
     }
 
     public final String getOptionNameForMessage(String option) {
-        // Allows ETL tool to override what's shown in a validation error.
-        // Feels like this should be in another class which can cache the ResourceBundle reference.
-        ResourceBundle bundle = ResourceBundle.getBundle("marklogic-spark-messages", Locale.getDefault());
-        String optionName = bundle.getString(option);
-        return optionName != null && optionName.trim().length() > 0 ? optionName.trim() : option;
+        return Util.getOptionNameForErrorMessage(option);
     }
 
     private void parseConnectionString(String value, Map<String, String> connectionProps) {

src/main/java/com/marklogic/spark/DefaultSource.java

@@ -138,7 +138,7 @@ private boolean isReadTriplesOperation(Map<String, String> properties) {
     private StructType inferSchemaFromOpticQuery(Map<String, String> caseSensitiveOptions) {
         final String query = caseSensitiveOptions.get(Options.READ_OPTIC_QUERY);
         if (query == null || query.trim().length() < 1) {
-            throw new ConnectorException(String.format("No Optic query found; must define %s", Options.READ_OPTIC_QUERY));
+            throw new ConnectorException(Util.getOptionNameForErrorMessage("spark.marklogic.read.noOpticQuery"));
         }
         RowManager rowManager = new ContextSupport(caseSensitiveOptions).connectToMarkLogic().newRowManager();
         RawQueryDSLPlan dslPlan = rowManager.newRawQueryDSLPlan(new StringHandle(query));

src/main/java/com/marklogic/spark/Util.java

@@ -20,9 +20,7 @@
 import org.slf4j.LoggerFactory;
 import scala.collection.immutable.HashMap;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.stream.Stream;
 
 public interface Util {
@@ -80,4 +78,18 @@ static boolean isReadWithCustomCodeOperation(Map<String, String> properties) {
             Options.READ_JAVASCRIPT_FILE, Options.READ_XQUERY_FILE
         );
     }
+
+    /**
+     * Allows Flux to override what's shown in a validation error. The connector is fine showing option names
+     * such as "spark.marklogic.read.opticQuery", but that is meaningless to a Flux user. This can also be used to
+     * access any key in the messages properties file.
+     *
+     * @param option
+     * @return
+     */
+    static String getOptionNameForErrorMessage(String option) {
+        ResourceBundle bundle = ResourceBundle.getBundle("marklogic-spark-messages", Locale.getDefault());
+        String optionName = bundle.getString(option);
+        return optionName != null && optionName.trim().length() > 0 ? optionName.trim() : option;
+    }
 }

src/main/java/com/marklogic/spark/reader/optic/OpticReadContext.java

@@ -75,7 +75,7 @@ public OpticReadContext(Map<String, String> properties, StructType schema, int d
 
         final String dslQuery = properties.get(Options.READ_OPTIC_QUERY);
         if (dslQuery == null || dslQuery.trim().length() < 1) {
-            throw new IllegalArgumentException(String.format("No Optic query found; must define %s", Options.READ_OPTIC_QUERY));
+            throw new ConnectorException(Util.getOptionNameForErrorMessage("spark.marklogic.read.noOpticQuery"));
         }
 
         DatabaseClient client = connectToMarkLogic();

src/main/resources/marklogic-spark-messages.properties

@@ -4,6 +4,7 @@ spark.marklogic.client.uri=
 spark.marklogic.read.batchSize=
 spark.marklogic.read.documents.partitionsPerForest=
 spark.marklogic.read.numPartitions=
+spark.marklogic.read.noOpticQuery=No Optic query found; must define spark.marklogic.read.opticQuery
 spark.marklogic.write.batchSize=
 spark.marklogic.write.documentType=
 spark.marklogic.write.fileRows.documentType=