Removed Metapath result type "NODE", which has no difference from "IT…

…EM". Replaced existing entries with "ITEM".
david-waltermire · Oct 27, 2024 · 37bda90 · 37bda90
1 parent d538437
commit 37bda90
Show file tree

Hide file tree

Showing 25 changed files with 33 additions and 38 deletions.
diff --git a/core/metaschema b/core/metaschema
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/MetapathExpression.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/MetapathExpression.java
@@ -20,7 +20,6 @@
 import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
 import gov.nist.secauto.metaschema.core.metapath.item.atomic.IDecimalItem;
 import gov.nist.secauto.metaschema.core.metapath.item.atomic.INumericItem;
-import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem;
 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
 
 import org.antlr.v4.runtime.CharStreams;
@@ -66,11 +65,6 @@ public enum ResultType {
      * The result is expected to be an {@link ISequence} value.
      */
     SEQUENCE,
-    /**
-     * The result is expected to be an {@link INodeItem} value.
-     */
-    // TODO: audit use of this value, replace with ITEM where appropriate
-    NODE,
     /**
      * The result is expected to be an {@link IItem} value.
      */
@@ -117,7 +111,8 @@ public static MetapathExpression compile(@NonNull String path) {
    */
   @NonNull
   public static MetapathExpression compile(@NonNull String path, @NonNull StaticContext context) {
-    @NonNull MetapathExpression retval;
+    @NonNull
+    MetapathExpression retval;
     if (".".equals(path)) {
       retval = CONTEXT_NODE;
     } else {
@@ -337,7 +332,6 @@ protected <T> T toResultType(@NonNull ISequence<?> sequence, @NonNull ResultType
       result = FnBoolean.fnBoolean(sequence).toBoolean();
       break;
     case ITEM:
-    case NODE:
       result = sequence.getFirstItem(true);
       break;
     case NUMBER:

diff --git a/core/src/test/java/gov/nist/secauto/metaschema/core/metapath/cst/BuildCstVisitorTest.java b/core/src/test/java/gov/nist/secauto/metaschema/core/metapath/cst/BuildCstVisitorTest.java
@@ -128,7 +128,8 @@ void testAbbreviatedParentAxis() {
     // select starting node
     IDocumentNodeItem document = newTestDocument();
     IFieldNodeItem field
-        = MetapathExpression.compile("/root/field1", staticContext).evaluateAs(document, ResultType.NODE);
+        = MetapathExpression.compile("/root/field1", staticContext)
+            .evaluateAs(document, ResultType.ITEM);
     assert field != null;
 
     // evaluate
@@ -145,12 +146,12 @@ void testParentAxisMatch() {
     // select starting node
     IDocumentNodeItem document = newTestDocument();
     IFieldNodeItem field = MetapathExpression.compile("/root/field1", staticContext)
-        .evaluateAs(document, ResultType.NODE);
+        .evaluateAs(document, ResultType.ITEM);
     assert field != null;
 
     // compile expression
     IItem result = MetapathExpression.compile("parent::root", staticContext)
-        .evaluateAs(field, ResultType.NODE);
+        .evaluateAs(field, ResultType.ITEM);
     assert result != null;
 
     assertAll(
@@ -165,7 +166,7 @@ void testParentAxisNonMatch() {
     // select starting node
     IDocumentNodeItem document = newTestDocument();
     IFieldNodeItem field = MetapathExpression.compile("/root/field1", staticContext)
-        .evaluateAs(document, ResultType.NODE);
+        .evaluateAs(document, ResultType.ITEM);
     assert field != null;
 
     // compile expression
@@ -221,7 +222,7 @@ void testAbbreviatedForwardAxisFlagName() {
     // select starting node
     IDocumentNodeItem document = newTestDocument();
     IFieldNodeItem field = MetapathExpression.compile("/root/field2", staticContext)
-        .evaluateAs(document, ResultType.NODE);
+        .evaluateAs(document, ResultType.ITEM);
     assert field != null;
 
     // evaluate
@@ -242,7 +243,7 @@ void testForwardstepChild() {
     // select starting node
     IDocumentNodeItem document = newTestDocument();
     IRootAssemblyNodeItem root = MetapathExpression.compile("/root", staticContext)
-        .evaluateAs(document, ResultType.NODE, new DynamicContext(staticContext));
+        .evaluateAs(document, ResultType.ITEM, new DynamicContext(staticContext));
     assert root != null;
 
     // evaluate

diff --git a/...test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayAppendTest.java b/...test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayAppendTest.java
@@ -38,7 +38,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   @MethodSource("provideValues")
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...rc/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayGetTest.java b/...rc/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayGetTest.java
@@ -38,7 +38,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...ava/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayInsertBeforeTest.java b/...ava/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayInsertBeforeTest.java
@@ -41,7 +41,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   @MethodSource("provideValues")
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...c/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayJoinTest.java b/...c/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayJoinTest.java
@@ -47,7 +47,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   @MethodSource("provideValues")
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...rc/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayPutTest.java b/...rc/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayPutTest.java
@@ -42,7 +42,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayRemoveTest.java b/...test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayRemoveTest.java
@@ -47,7 +47,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...est/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayReverseTest.java b/...est/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayReverseTest.java
@@ -45,7 +45,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   @MethodSource("provideValues")
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...c/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArraySizeTest.java b/...c/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArraySizeTest.java
@@ -44,7 +44,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IIntegerItem expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...st/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArraySubarrayTest.java b/...st/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArraySubarrayTest.java
@@ -52,7 +52,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   @MethodSource("provideValues")
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...c/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayTailTest.java b/...c/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayTailTest.java
@@ -43,7 +43,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IArrayItem<?> expected, @NonNull String metapath) {
 
     IArrayItem<?> result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...test/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnLowerCaseTest.java b/...test/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnLowerCaseTest.java
@@ -33,7 +33,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   @MethodSource("provideValues")
   void testExpression(@NonNull IStringItem expected, @NonNull String metapath) {
     IStringItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...t/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnStringLengthTest.java b/...t/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnStringLengthTest.java
@@ -44,7 +44,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   @MethodSource("provideValues")
   void testExpression(@NonNull IIntegerItem expected, @NonNull String metapath) {
     IIntegerItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 

diff --git a/...rc/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnStringTest.java b/...rc/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnStringTest.java
@@ -52,7 +52,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   @MethodSource("provideValues")
   void testExpression(@NonNull IStringItem expected, @NonNull String metapath) {
     IStringItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 

diff --git a/...test/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnUpperCaseTest.java b/...test/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnUpperCaseTest.java
@@ -33,7 +33,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   @MethodSource("provideValues")
   void testExpression(@NonNull IStringItem expected, @NonNull String metapath) {
     IStringItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapContainsTest.java b/...test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapContainsTest.java
@@ -47,7 +47,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...rc/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapEntryTest.java b/...rc/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapEntryTest.java
@@ -38,7 +38,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IMapItem<?> expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...src/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapFindTest.java b/...src/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapFindTest.java
@@ -53,7 +53,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...rc/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapMergeTest.java b/...rc/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapMergeTest.java
@@ -86,7 +86,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IItem expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/.../src/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapPutTest.java b/.../src/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapPutTest.java
@@ -58,7 +58,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IMapItem<?> expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...c/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapRemoveTest.java b/...c/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapRemoveTest.java
@@ -74,7 +74,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IMapItem<?> expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...src/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapSizeTest.java b/...src/test/java/gov/nist/secauto/metaschema/core/metapath/function/library/MapSizeTest.java
@@ -38,7 +38,7 @@ private static Stream<Arguments> provideValues() { // NOPMD - false positive
   void testExpression(@NonNull IIntegerItem expected, @NonNull String metapath) {
 
     IItem result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 }
diff --git a/...src/test/java/gov/nist/secauto/metaschema/core/metapath/item/function/IArrayItemTest.java b/...src/test/java/gov/nist/secauto/metaschema/core/metapath/item/function/IArrayItemTest.java
@@ -41,7 +41,7 @@ private static Stream<Arguments> squareConstructorValues() { // NOPMD - false po
   @MethodSource("squareConstructorValues")
   void testSquareConstructor(@NonNull IArrayItem<?> expected, @NonNull String metapath) {
     IArrayItem<?> result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
 
@@ -60,7 +60,7 @@ private static Stream<Arguments> curlyConstructorValues() { // NOPMD - false pos
   @MethodSource("curlyConstructorValues")
   void testCurlyConstructor(@NonNull IArrayItem<?> expected, @NonNull String metapath) {
     IArrayItem<?> result = MetapathExpression.compile(metapath)
-        .evaluateAs(null, MetapathExpression.ResultType.NODE, newDynamicContext());
+        .evaluateAs(null, MetapathExpression.ResultType.ITEM, newDynamicContext());
     assertEquals(expected, result);
   }
+2 −2		schema/metaschema/metaschema-module-metaschema.xml
+3 −0		schema/xml/metaschema.xsd