View Javadoc
1   /*
2    * Portions of this software was developed by employees of the National Institute
3    * of Standards and Technology (NIST), an agency of the Federal Government and is
4    * being made available as a public service. Pursuant to title 17 United States
5    * Code Section 105, works of NIST employees are not subject to copyright
6    * protection in the United States. This software may be subject to foreign
7    * copyright. Permission in the United States and in foreign countries, to the
8    * extent that NIST may hold copyright, to use, copy, modify, create derivative
9    * works, and distribute this software and its documentation without fee is hereby
10   * granted on a non-exclusive basis, provided that this notice and disclaimer
11   * of warranty appears in all copies.
12   *
13   * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14   * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15   * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17   * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18   * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
19   * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20   * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21   * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22   * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23   * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24   * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25   */
26  
27  package gov.nist.secauto.metaschema.core.metapath;
28  
29  import gov.nist.secauto.metaschema.core.metapath.item.ItemUtils;
30  import gov.nist.secauto.metaschema.core.metapath.item.node.IFlagNodeItem;
31  import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem;
32  
33  import java.util.stream.Stream;
34  
35  import edu.umd.cs.findbugs.annotations.NonNull;
36  
37  class Flag // NOPMD - intentional name
38      extends AbstractNamedInstanceExpression<IFlagNodeItem> {
39  
40    /**
41     * Construct a new expression that finds any child {@link IFlagNodeItem} that
42     * matches the provided {@code test}.
43     *
44     * @param test
45     *          the test to use to match
46     */
47    protected Flag(@NonNull IExpression test) {
48      super(test);
49    }
50  
51    @Override
52    public Class<IFlagNodeItem> getBaseResultType() {
53      return IFlagNodeItem.class;
54    }
55  
56    @Override
57    public <RESULT, CONTEXT> RESULT accept(IExpressionVisitor<RESULT, CONTEXT> visitor, CONTEXT context) {
58      return visitor.visitFlag(this, context);
59    }
60  
61    @Override
62    public ISequence<? extends IFlagNodeItem> accept(
63        DynamicContext dynamicContext,
64        ISequence<?> focus) {
65      return ISequence.of(focus.asStream()
66          .map(item -> ItemUtils.checkItemIsNodeItemForStep(item))
67          .flatMap(item -> {
68            assert item != null;
69            return match(item);
70          }));
71    }
72  
73    /**
74     * Get a stream of matching child node items for the provided {@code context}.
75     *
76     * @param focusedItem
77     *          the node item to match child items of
78     * @return the stream of matching node items
79     */
80    @SuppressWarnings("null")
81    @NonNull
82    protected Stream<? extends IFlagNodeItem> match(@NonNull INodeItem focusedItem) {
83      Stream<? extends IFlagNodeItem> retval;
84      if (getTest() instanceof Name) {
85        String name = ((Name) getTest()).getValue();
86  
87        IFlagNodeItem item = focusedItem.getFlagByName(name);
88        retval = item == null ? Stream.empty() : Stream.of(item);
89      } else {
90        // wildcard
91        retval = focusedItem.flags();
92      }
93      return retval;
94    }
95  }