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.FunctionUtils;
30 import gov.nist.secauto.metaschema.core.metapath.function.OperationFunctions;
31 import gov.nist.secauto.metaschema.core.metapath.item.atomic.INumericItem;
32
33 import edu.umd.cs.findbugs.annotations.NonNull;
34 import edu.umd.cs.findbugs.annotations.Nullable;
35
36 class Modulo
37 extends AbstractArithmeticExpression<INumericItem> {
38
39 /**
40 * Create an expression that gets the numeric remainder from dividing the
41 * dividend by the divisor, also called the "modulo operation".
42 *
43 * @param dividend
44 * the item to be divided
45 * @param divisor
46 * the item to divide by
47 */
48 protected Modulo(@NonNull IExpression dividend, @NonNull IExpression divisor) {
49 super(dividend, divisor, INumericItem.class);
50 }
51
52 @Override
53 public Class<INumericItem> getBaseResultType() {
54 return INumericItem.class;
55 }
56
57 @Override
58 public <RESULT, CONTEXT> RESULT accept(IExpressionVisitor<RESULT, CONTEXT> visitor, CONTEXT context) {
59 return visitor.visitModulo(this, context);
60 }
61
62 @Override
63 public ISequence<? extends INumericItem> accept(DynamicContext dynamicContext, ISequence<?> focus) {
64 INumericItem dividend = FunctionUtils.toNumeric(getLeft().accept(dynamicContext, focus), true);
65 INumericItem divisor = FunctionUtils.toNumeric(getRight().accept(dynamicContext, focus), true);
66 return resultOrEmpty(dividend, divisor);
67 }
68
69 /**
70 * Get the numeric remainder from dividing the dividend by the divisor.
71 *
72 * @param dividend
73 * the item to be divided
74 * @param divisor
75 * the item to divide by
76 * @return the remainder or an empty {@link ISequence} if either item is
77 * {@code null}
78 */
79 @NonNull
80 protected static ISequence<? extends INumericItem> resultOrEmpty(@Nullable INumericItem dividend,
81 @Nullable INumericItem divisor) {
82 ISequence<? extends INumericItem> retval;
83 if (dividend == null || divisor == null) {
84 retval = ISequence.empty();
85 } else {
86 INumericItem result = OperationFunctions.opNumericIntegerDivide(dividend, divisor);
87 retval = ISequence.of(result);
88 }
89 return retval;
90 }
91 }