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.function.library.FnBoolean;
30  import gov.nist.secauto.metaschema.core.metapath.item.IItem;
31  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
32  
33  import java.math.BigInteger;
34  import java.util.List;
35  import java.util.Map;
36  import java.util.concurrent.atomic.AtomicInteger;
37  import java.util.stream.Collectors;
38  import java.util.stream.Stream;
39  
40  import edu.umd.cs.findbugs.annotations.NonNull;
41  
42  class Predicate implements IExpression {
43    @NonNull
44    private final IExpression base;
45    @NonNull
46    private final List<IExpression> predicates;
47  
48    /**
49     * Construct a new predicate expression.
50     *
51     * @param base
52     *          the base to evaluate against
53     * @param predicates
54     *          the expression(s) to apply as a filter
55     */
56    protected Predicate(@NonNull IExpression base, @NonNull List<IExpression> predicates) {
57      this.base = base;
58      this.predicates = predicates;
59    }
60  
61    /**
62     * Get the base sub-expression.
63     *
64     * @return the sub-expression
65     */
66    @NonNull
67    public IExpression getBase() {
68      return base;
69    }
70  
71    /**
72     * Retrieve the list of predicates to filter with.
73     *
74     * @return the list of predicates
75     */
76    @NonNull
77    public List<IExpression> getPredicates() {
78      return predicates;
79    }
80  
81    @Override
82    public List<? extends IExpression> getChildren() {
83      return ObjectUtils.notNull(
84          Stream.concat(Stream.of(getBase()), getPredicates().stream()).collect(Collectors.toList()));
85    }
86  
87    @Override
88    public @NonNull ISequence<? extends IItem> accept(@NonNull DynamicContext dynamicContext,
89        @NonNull ISequence<?> focus) {
90  
91      ISequence<?> retval = getBase().accept(dynamicContext, focus);
92  
93      if (dynamicContext.getConfiguration().isFeatureEnabled(MetapathEvaluationFeature.METAPATH_EVALUATE_PREDICATES)) {
94        // evaluate the predicates for this step
95        AtomicInteger index = new AtomicInteger();
96  
97        Stream<? extends IItem> stream = ObjectUtils.notNull(
98            retval.asStream().map(item -> {
99              // build a positional index of the items
100             return Map.entry(BigInteger.valueOf(index.incrementAndGet()), item);
101           }).filter(entry -> {
102             @SuppressWarnings("null")
103             @NonNull IItem item = entry.getValue();
104 
105             // return false if any predicate evaluates to false
106             return !predicates.stream()
107                 .map(predicateExpr -> {
108                   boolean bool;
109                   if (predicateExpr instanceof IntegerLiteral) {
110                     // reduce the result to the matching item
111                     BigInteger predicateIndex = ((IntegerLiteral) predicateExpr).getValue();
112 
113                     // get the position of the item
114                     final BigInteger position = entry.getKey();
115 
116                     // it is a match if the position matches
117                     bool = position.equals(predicateIndex);
118                   } else {
119                     ISequence<?> innerFocus = ISequence.of(item);
120                     ISequence<?> predicateResult = predicateExpr.accept(dynamicContext, innerFocus);
121                     bool = FnBoolean.fnBoolean(predicateResult).toBoolean();
122                   }
123                   return bool;
124                 }).anyMatch(x -> !x);
125           }).map(entry -> entry.getValue()));
126 
127       retval = ISequence.of(stream);
128     }
129     return retval;
130   }
131 
132   @Override
133   public <RESULT, CONTEXT> RESULT accept(@NonNull IExpressionVisitor<RESULT, CONTEXT> visitor, CONTEXT context) {
134     return visitor.visitPredicate(this, context);
135   }
136 
137 }