Rename ignore_empty_value to remove_empty_values

Author: marc-gr

docs/reference/enrich-processor/xml-processor.md

@@ -18,7 +18,7 @@ $$$xml-options$$$
 | `ignore_missing` | no | `false` | If `true` and `field` does not exist, the processor quietly exits without modifying the document. |
 | `ignore_failure` | no | `false` | Ignore failures for the processor. When `true` and XML parsing fails, adds `_xmlparsefailure` tag to the document. See [Handling pipeline failures](docs-content://manage-data/ingest/transform-enrich/ingest-pipelines.md#handling-pipeline-failures). |
 | `to_lower` | no | `false` | Convert XML element names and attribute names to lowercase. |
-| `ignore_empty_value` | no | `false` | If `true`, the processor will filter out null and empty values from the parsed XML structure, including empty elements, elements with null values, and elements with whitespace-only content. |
+| `remove_empty_values` | no | `false` | If `true`, the processor will filter out null and empty values from the parsed XML structure, including empty elements, elements with null values, and elements with whitespace-only content. |
 | `remove_namespaces` | no | `false` | If `true`, removes namespace prefixes from element and attribute names. |
 | `force_content` | no | `false` | If `true`, forces text content and attributes to always parse to a hash value with `#text` key for content. |
 | `force_array` | no | `false` | If `true`, forces all parsed values to be arrays. Single elements are wrapped in arrays. |
@@ -37,7 +37,7 @@ $$$xml-options$$$
   "xml": {
     "field": "xml_field",
     "target_field": "parsed_xml",
-    "ignore_empty_value": true
+    "remove_empty_values": true
   }
 }
 ```
@@ -94,7 +94,7 @@ Result:
 
 ### Filtering empty values
 
-When `ignore_empty_value` is set to `true`, the processor will remove empty elements from the parsed XML:
+When `remove_empty_values` is set to `true`, the processor will remove empty elements from the parsed XML:
 
 ```console
 POST _ingest/pipeline/_simulate
@@ -105,7 +105,7 @@ POST _ingest/pipeline/_simulate
         "xml": {
           "field": "xml_content",
           "target_field": "parsed_xml",
-          "ignore_empty_value": true
+          "remove_empty_values": true
         }
       }
     ]
@@ -624,7 +624,7 @@ The XML processor supports:
 
 - **Elements with text content**: Converted to key-value pairs where the element name is the key and text content is the value
 - **Nested elements**: Converted to nested JSON objects
-- **Empty elements**: Converted to `null` values (can be filtered with `ignore_empty_value`)
+- **Empty elements**: Converted to `null` values (can be filtered with `remove_empty_values`)
 - **Repeated elements**: Converted to arrays when multiple elements with the same name exist at the same level
 - **XML attributes**: Included as properties in the JSON object alongside element content. When an element has both attributes and text content, the text is stored under a special `#text` key
 - **Mixed content**: Elements with both text and child elements include text under a special `#text` key while attributes and child elements become object properties

modules/ingest-common/src/main/java/org/elasticsearch/ingest/common/XmlProcessor.java

@@ -44,7 +44,7 @@
  * - XPath extraction with namespace support
  * - Configurable options: force_array, force_content, remove_namespaces, to_lower
  * - Strict parsing mode for XML validation
- * - Empty value filtering with ignore_empty_value option
+ * - Empty value filtering with remove_empty_values option
  * - Logstash-compatible error handling and behavior
  */
 public final class XmlProcessor extends AbstractProcessor {
@@ -71,7 +71,7 @@ public final class XmlProcessor extends AbstractProcessor {
     private final boolean ignoreMissing;
     private final boolean ignoreFailure;
     private final boolean toLower;
-    private final boolean ignoreEmptyValue;
+    private final boolean removeEmptyValues;
     private final boolean storeXml;
     private final boolean removeNamespaces;
     private final boolean forceContent;
@@ -89,7 +89,7 @@ public final class XmlProcessor extends AbstractProcessor {
         boolean ignoreMissing,
         boolean ignoreFailure,
         boolean toLower,
-        boolean ignoreEmptyValue,
+        boolean removeEmptyValues,
         boolean storeXml,
         boolean removeNamespaces,
         boolean forceContent,
@@ -104,7 +104,7 @@ public final class XmlProcessor extends AbstractProcessor {
         this.ignoreMissing = ignoreMissing;
         this.ignoreFailure = ignoreFailure;
         this.toLower = toLower;
-        this.ignoreEmptyValue = ignoreEmptyValue;
+        this.removeEmptyValues = removeEmptyValues;
         this.storeXml = storeXml;
         this.removeNamespaces = removeNamespaces;
         this.forceContent = forceContent;
@@ -127,8 +127,8 @@ public boolean isIgnoreMissing() {
         return ignoreMissing;
     }
 
-    public boolean isIgnoreEmptyValue() {
-        return ignoreEmptyValue;
+    public boolean isRemoveEmptyValues() {
+        return removeEmptyValues;
     }
 
     public boolean isStoreXml() {
@@ -206,7 +206,7 @@ public String getType() {
 
     /**
      * Determines if a value should be considered empty for filtering purposes.
-     * Used by the ignore_empty_value feature to filter out empty content.
+     * Used by the remove_empty_values feature to filter out empty content.
      *
      * Considers empty:
      * - null values
@@ -432,7 +432,7 @@ public XmlProcessor create(
             boolean ignoreMissing = ConfigurationUtils.readBooleanProperty(TYPE, processorTag, config, "ignore_missing", false);
             boolean ignoreFailure = ConfigurationUtils.readBooleanProperty(TYPE, processorTag, config, "ignore_failure", false);
             boolean toLower = ConfigurationUtils.readBooleanProperty(TYPE, processorTag, config, "to_lower", false);
-            boolean ignoreEmptyValue = ConfigurationUtils.readBooleanProperty(TYPE, processorTag, config, "ignore_empty_value", false);
+            boolean removeEmptyValues = ConfigurationUtils.readBooleanProperty(TYPE, processorTag, config, "remove_empty_values", false);
             boolean storeXml = ConfigurationUtils.readBooleanProperty(TYPE, processorTag, config, "store_xml", true);
             boolean removeNamespaces = ConfigurationUtils.readBooleanProperty(TYPE, processorTag, config, "remove_namespaces", false);
             boolean forceContent = ConfigurationUtils.readBooleanProperty(TYPE, processorTag, config, "force_content", false);
@@ -502,7 +502,7 @@ public XmlProcessor create(
                 ignoreMissing,
                 ignoreFailure,
                 toLower,
-                ignoreEmptyValue,
+                removeEmptyValues,
                 storeXml,
                 removeNamespaces,
                 forceContent,
@@ -628,8 +628,8 @@ public void startElement(String uri, String localName, String qName, org.xml.sax
                 String attrName = getAttributeName(attributes.getURI(i), attributes.getLocalName(i), attributes.getQName(i));
                 String attrValue = attributes.getValue(i);
 
-                // Apply ignoreEmptyValue filtering to attributes
-                if (ignoreEmptyValue == false || isEmptyValue(attrValue) == false) {
+                // Apply removeEmptyValues filtering to attributes
+                if (removeEmptyValues == false || isEmptyValue(attrValue) == false) {
                     element.put(attrName, attrValue);
                 }
             }
@@ -683,7 +683,7 @@ public void characters(char[] ch, int start, int length) throws org.xml.sax.SAXE
             // Add to DOM text node if needed
             if (buildDom && !domElementStack.isEmpty()) {
                 String text = new String(ch, start, length);
-                if (!text.trim().isEmpty() || !ignoreEmptyValue) {
+                if (!text.trim().isEmpty() || !removeEmptyValues) {
                     org.w3c.dom.Text textNode = domDocument.createTextNode(text);
                     domElementStack.peek().appendChild(textNode);
                 }
@@ -705,7 +705,7 @@ public void endElement(String uri, String localName, String qName) throws org.xm
             // Add repeated elements as arrays
             for (Map.Entry<String, List<Object>> entry : repeatedElements.entrySet()) {
                 List<Object> values = entry.getValue();
-                if (ignoreEmptyValue == false || values.isEmpty() == false) {
+                if (removeEmptyValues == false || values.isEmpty() == false) {
                     element.put(entry.getKey(), values);
                 }
             }
@@ -718,7 +718,7 @@ public void endElement(String uri, String localName, String qName) throws org.xm
             Object elementValue;
             if (hasText == false && hasChildren == false) {
                 // Empty element
-                if (ignoreEmptyValue == false) {
+                if (removeEmptyValues == false) {
                     elementValue = applyForceArray(elementName, null);
                 } else {
                     elementValue = null;
@@ -727,12 +727,12 @@ public void endElement(String uri, String localName, String qName) throws org.xm
                 // Only text content
                 if (forceContent) {
                     Map<String, Object> contentMap = new HashMap<>();
-                    if (ignoreEmptyValue == false || isEmptyValue(trimmedText) == false) {
+                    if (removeEmptyValues == false || isEmptyValue(trimmedText) == false) {
                         contentMap.put("#text", trimmedText);
                     }
                     elementValue = contentMap;
                 } else {
-                    if (ignoreEmptyValue && isEmptyValue(trimmedText)) {
+                    if (removeEmptyValues && isEmptyValue(trimmedText)) {
                         elementValue = null;
                     } else {
                         elementValue = trimmedText;
@@ -744,7 +744,7 @@ public void endElement(String uri, String localName, String qName) throws org.xm
                 elementValue = (forceArray && forceContent) ? applyForceArray(elementName, element) : element;
             } else {
                 // Both text and children/attributes
-                if (ignoreEmptyValue == false || isEmptyValue(trimmedText) == false) {
+                if (removeEmptyValues == false || isEmptyValue(trimmedText) == false) {
                     element.put("#text", trimmedText);
                 }
                 elementValue = (forceArray && forceContent) ? applyForceArray(elementName, element) : element;

modules/ingest-common/src/test/java/org/elasticsearch/ingest/common/XmlProcessorFactoryTests.java

@@ -140,8 +140,8 @@ private Map<String, Object> createConfigWithOptions(String fieldName, String...
                 case "to_lower":
                     config.put("to_lower", true);
                     break;
-                case "ignore_empty_value":
-                    config.put("ignore_empty_value", true);
+                case "remove_empty_values":
+                    config.put("remove_empty_values", true);
                     break;
                 case "store_xml":
                     config.put("store_xml", false); // Test false case since default is true
@@ -186,14 +186,14 @@ public void testCreate() throws Exception {
         config.put("ignore_missing", true);
         config.put("ignore_failure", true);
         config.put("to_lower", true);
-        config.put("ignore_empty_value", true);
+        config.put("remove_empty_values", true);
 
         XmlProcessor processor = createProcessor(config);
 
         assertThat(processor.getField(), equalTo(DEFAULT_FIELD));
         assertThat(processor.getTargetField(), equalTo(DEFAULT_TARGET_FIELD));
         assertThat(processor.isIgnoreMissing(), equalTo(true));
-        assertThat(processor.isIgnoreEmptyValue(), equalTo(true));
+        assertThat(processor.isRemoveEmptyValues(), equalTo(true));
     }
 
     public void testCreateWithDefaults() throws Exception {
@@ -203,22 +203,22 @@ public void testCreateWithDefaults() throws Exception {
         assertThat(processor.getField(), equalTo(DEFAULT_FIELD));
         assertThat(processor.getTargetField(), equalTo(DEFAULT_FIELD));
         assertThat(processor.isIgnoreMissing(), equalTo(false));
-        assertThat(processor.isIgnoreEmptyValue(), equalTo(false));
+        assertThat(processor.isRemoveEmptyValues(), equalTo(false));
     }
 
     public void testCreateMissingField() throws Exception {
         Map<String, Object> config = new HashMap<>(); // Empty config - no field specified
         expectCreationFailure(config, ElasticsearchParseException.class, "[field] required property is missing");
     }
 
-    public void testCreateWithIgnoreEmptyValueOnly() throws Exception {
+    public void testCreateWithRemoveEmptyValuesOnly() throws Exception {
         Map<String, Object> config = createBaseConfig();
-        config.put("ignore_empty_value", true);
+        config.put("remove_empty_values", true);
 
         XmlProcessor processor = createProcessor(config);
 
         assertThat(processor.getField(), equalTo(DEFAULT_FIELD));
-        assertThat(processor.isIgnoreEmptyValue(), equalTo(true));
+        assertThat(processor.isRemoveEmptyValues(), equalTo(true));
         assertThat(processor.isIgnoreMissing(), equalTo(false)); // other flags should remain default
     }
 

modules/ingest-common/src/test/java/org/elasticsearch/ingest/common/XmlProcessorTests.java

@@ -475,9 +475,9 @@ public void testIgnoreMissing() {
     }
 
     /**
-     * Test that ignore_empty_value correctly filters out empty values from arrays and mixed content.
+     * Test that remove_empty_values correctly filters out empty values from arrays and mixed content.
      */
-    public void testIgnoreEmptyValue() {
+    public void testRemoveEmptyValues() {
         // XML with mixed empty and non-empty elements, including array elements with mixed empty/non-empty values
         String xml = "<root>"
             + "  <empty></empty>"
@@ -495,7 +495,7 @@ public void testIgnoreEmptyValue() {
             + "</root>";
 
         Map<String, Object> config = new HashMap<>();
-        config.put("ignore_empty_value", true);
+        config.put("remove_empty_values", true);
         XmlProcessor processor = createTestProcessor(config);
 
         IngestDocument ingestDocument = createTestIngestDocument(xml);