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.IIntegerItem;
32 import gov.nist.secauto.metaschema.core.metapath.item.atomic.INumericItem;
33
34 import edu.umd.cs.findbugs.annotations.NonNull;
35 import edu.umd.cs.findbugs.annotations.Nullable;
36
37 class IntegerDivision
38 extends AbstractArithmeticExpression<IIntegerItem> {
39
40 /**
41 * Create an expression that gets the whole number quotient result by dividing
42 * the dividend by the divisor.
43 *
44 * @param dividend
45 * the expression whose item result will be divided
46 * @param divisor
47 * the expression whose item result will be divided by
48 */
49 protected IntegerDivision(@NonNull IExpression dividend, @NonNull IExpression divisor) {
50 super(dividend, divisor, IIntegerItem.class);
51 }
52
53 @Override
54 public Class<IIntegerItem> getBaseResultType() {
55 return IIntegerItem.class;
56 }
57
58 @Override
59 public <RESULT, CONTEXT> RESULT accept(IExpressionVisitor<RESULT, CONTEXT> visitor, CONTEXT context) {
60 return visitor.visitIntegerDivision(this, context);
61 }
62
63 @Override
64 public ISequence<? extends IIntegerItem> accept(DynamicContext dynamicContext, ISequence<?> focus) {
65 INumericItem dividend = FunctionUtils.toNumericOrNull(
66 getFirstDataItem(getLeft().accept(dynamicContext, focus), true));
67 INumericItem divisor = FunctionUtils.toNumericOrNull(
68 getFirstDataItem(getRight().accept(dynamicContext, focus), true));
69
70 return resultOrEmpty(dividend, divisor);
71 }
72
73 /**
74 * Get the whole number quotient result by dividing the dividend by the divisor.
75 *
76 * @param dividend
77 * the item to be divided
78 * @param divisor
79 * the item to divide by
80 * @return the quotient result or an empty {@link ISequence} if either item is
81 * {@code null}
82 */
83 @NonNull
84 protected static ISequence<? extends IIntegerItem> resultOrEmpty(@Nullable INumericItem dividend,
85 @Nullable INumericItem divisor) {
86 ISequence<? extends IIntegerItem> retval;
87 if (dividend == null || divisor == null) {
88 retval = ISequence.empty();
89 } else {
90 IIntegerItem result = divide(dividend, divisor);
91 retval = ISequence.of(result);
92 }
93 return retval;
94 }
95
96 /**
97 * Get the whole number quotient result by dividing the dividend by the divisor.
98 *
99 * @param dividend
100 * the item to be divided
101 * @param divisor
102 * the item to divide by
103 * @return the quotient result
104 */
105 public static IIntegerItem divide(@NonNull INumericItem dividend, @NonNull INumericItem divisor) {
106 return OperationFunctions.opNumericIntegerDivide(dividend, divisor);
107 }
108 }