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.FunctionUtils;
30  import gov.nist.secauto.metaschema.core.metapath.function.OperationFunctions;
31  import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
32  import gov.nist.secauto.metaschema.core.metapath.item.atomic.IDateItem;
33  import gov.nist.secauto.metaschema.core.metapath.item.atomic.IDateTimeItem;
34  import gov.nist.secauto.metaschema.core.metapath.item.atomic.IDayTimeDurationItem;
35  import gov.nist.secauto.metaschema.core.metapath.item.atomic.INumericItem;
36  import gov.nist.secauto.metaschema.core.metapath.item.atomic.IYearMonthDurationItem;
37  
38  import edu.umd.cs.findbugs.annotations.NonNull;
39  
40  class Subtraction
41      extends AbstractBasicArithmeticExpression {
42  
43    /**
44     * An expression that gets the difference of two atomic data items.
45     *
46     * @param minuend
47     *          an expression whose result is the value being subtracted from
48     * @param subtrahend
49     *          an expression whose result is the value being subtracted
50     */
51    protected Subtraction(@NonNull IExpression minuend, @NonNull IExpression subtrahend) {
52      super(minuend, subtrahend);
53    }
54  
55    @Override
56    public <RESULT, CONTEXT> RESULT accept(IExpressionVisitor<RESULT, CONTEXT> visitor, CONTEXT context) {
57      return visitor.visitSubtraction(this, context);
58    }
59  
60    /**
61     * Get the difference of two atomic items.
62     *
63     * @param minuend
64     *          the item being subtracted from
65     * @param subtrahend
66     *          the item being subtracted
67     * @return the difference of the items or an empty {@link ISequence} if either
68     *         item is {@code null}
69     */
70    @Override
71    @NonNull
72    protected IAnyAtomicItem operation(@NonNull IAnyAtomicItem minuend, @NonNull IAnyAtomicItem subtrahend) {
73      return subtract(minuend, subtrahend);
74    }
75  
76    /**
77     * Get the difference of two atomic items.
78     *
79     * @param minuend
80     *          the item being subtracted from
81     * @param subtrahend
82     *          the item being subtracted
83     * @return the difference of the items
84     */
85    @NonNull
86    public static IAnyAtomicItem subtract(@NonNull IAnyAtomicItem minuend, // NOPMD - intentional
87        @NonNull IAnyAtomicItem subtrahend) {
88  
89      IAnyAtomicItem retval = null;
90      if (minuend instanceof IDateItem) {
91        IDateItem left = (IDateItem) minuend;
92  
93        if (subtrahend instanceof IDateItem) {
94          retval = OperationFunctions.opSubtractDates(left, (IDateItem) subtrahend);
95        } else if (subtrahend instanceof IYearMonthDurationItem) {
96          retval = OperationFunctions.opSubtractYearMonthDurationFromDate(left, (IYearMonthDurationItem) subtrahend);
97        } else if (subtrahend instanceof IDayTimeDurationItem) {
98          retval = OperationFunctions.opSubtractDayTimeDurationFromDate(left, (IDayTimeDurationItem) subtrahend);
99        }
100     } else if (minuend instanceof IDateTimeItem) {
101       IDateTimeItem left = (IDateTimeItem) minuend;
102       if (subtrahend instanceof IDateTimeItem) {
103         retval = OperationFunctions.opSubtractDateTimes(left, (IDateTimeItem) subtrahend);
104       } else if (subtrahend instanceof IYearMonthDurationItem) {
105         retval = OperationFunctions.opSubtractYearMonthDurationFromDateTime(left, (IYearMonthDurationItem) subtrahend);
106       } else if (subtrahend instanceof IDayTimeDurationItem) {
107         retval = OperationFunctions.opSubtractDayTimeDurationFromDateTime(left, (IDayTimeDurationItem) subtrahend);
108       }
109     } else if (minuend instanceof IYearMonthDurationItem) {
110       IYearMonthDurationItem left = (IYearMonthDurationItem) minuend;
111       if (subtrahend instanceof IYearMonthDurationItem) {
112         retval = OperationFunctions.opSubtractYearMonthDurations(left, (IYearMonthDurationItem) subtrahend);
113       }
114     } else if (minuend instanceof IDayTimeDurationItem) {
115       IDayTimeDurationItem left = (IDayTimeDurationItem) minuend;
116       if (subtrahend instanceof IDayTimeDurationItem) {
117         retval = OperationFunctions.opSubtractDayTimeDurations(left, (IDayTimeDurationItem) subtrahend);
118       }
119     } else {
120       // handle as numeric
121       INumericItem left = FunctionUtils.toNumeric(minuend);
122       INumericItem right = FunctionUtils.toNumeric(subtrahend);
123       retval = OperationFunctions.opNumericSubtract(left, right);
124     }
125     if (retval == null) {
126       throw new InvalidTypeMetapathException(
127           null,
128           String.format("The expression '%s - %s' is not supported", minuend.getClass().getName(),
129               subtrahend.getClass().getName()));
130     }
131     return retval;
132   }
133 }