/*
    * Portions of this software was developed by employees of the National Institute
    * of Standards and Technology (NIST), an agency of the Federal Government and is
    * being made available as a public service. Pursuant to title 17 United States
    * Code Section 105, works of NIST employees are not subject to copyright
    * protection in the United States. This software may be subject to foreign
    * copyright. Permission in the United States and in foreign countries, to the
    * extent that NIST may hold copyright, to use, copy, modify, create derivative
    * works, and distribute this software and its documentation without fee is hereby
   * granted on a non-exclusive basis, provided that this notice and disclaimer
   * of warranty appears in all copies.
   *
   * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
   * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
   * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
   * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
   * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
   * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
   * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
   * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
   * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
   * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
   * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
   */
  
  package gov.nist.secauto.metaschema.core.metapath;
  
  import gov.nist.secauto.metaschema.core.metapath.function.FunctionUtils;
  import gov.nist.secauto.metaschema.core.metapath.function.OperationFunctions;
  import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
  import gov.nist.secauto.metaschema.core.metapath.item.atomic.IDayTimeDurationItem;
  import gov.nist.secauto.metaschema.core.metapath.item.atomic.INumericItem;
  import gov.nist.secauto.metaschema.core.metapath.item.atomic.IYearMonthDurationItem;
  
  import edu.umd.cs.findbugs.annotations.NonNull;
  
  class Division
      extends AbstractBasicArithmeticExpression {
  
    /**
     * An expression that gets the quotient result by dividing the dividend by the
     * divisor.
     *
     * @param dividend
     *          the expression whose result is to be divided
     * @param divisor
     *          the expression whose result is to divide by
     */
    protected Division(@NonNull IExpression dividend, @NonNull IExpression divisor) {
      super(dividend, divisor);
    }
  
    @Override
    public <RESULT, CONTEXT> RESULT accept(IExpressionVisitor<RESULT, CONTEXT> visitor, CONTEXT context) {
      return visitor.visitDivision(this, context);
    }
  
    /**
     * Get the quotient result by dividing the dividend by the divisor.
     *
     * @param dividend
     *          the item to be divided
     * @param divisor
     *          the item to divide by
     * @return the quotient result or an empty {@link ISequence} if either item is
     *         {@code null}
     */
    @Override
    @NonNull
    protected IAnyAtomicItem operation(@NonNull IAnyAtomicItem dividend, @NonNull IAnyAtomicItem divisor) {
      return divide(dividend, divisor);
    }
  
    /**
     * Get the quotient result by dividing the dividend by the divisor.
     *
     * @param dividend
     *          the item to be divided
     * @param divisor
     *          the item to divide by
     * @return the quotient result
     */
    @NonNull
    public static IAnyAtomicItem divide(@NonNull IAnyAtomicItem dividend, // NOPMD - intentional
        @NonNull IAnyAtomicItem divisor) {
      IAnyAtomicItem retval = null;
      if (dividend instanceof IYearMonthDurationItem) {
        IYearMonthDurationItem left = (IYearMonthDurationItem) dividend;
        if (divisor instanceof INumericItem) {
          retval = OperationFunctions.opDivideYearMonthDuration(left, (INumericItem) divisor);
        } else if (divisor instanceof IYearMonthDurationItem) {
          // TODO: find a way to support this
          throw new UnsupportedOperationException();
        }
      } else if (dividend instanceof IDayTimeDurationItem) {
        IDayTimeDurationItem left = (IDayTimeDurationItem) dividend;
        if (divisor instanceof INumericItem) {
          retval = OperationFunctions.opDivideDayTimeDuration(left, (INumericItem) divisor);
       } else if (divisor instanceof IDayTimeDurationItem) {
         retval = OperationFunctions.opDivideDayTimeDurationByDayTimeDuration(left, (IDayTimeDurationItem) divisor);
       }
     } else {
       // handle as numeric
       INumericItem left = FunctionUtils.toNumeric(dividend);
       if (divisor instanceof INumericItem) {
         INumericItem right = FunctionUtils.toNumeric(divisor);
         retval = OperationFunctions.opNumericDivide(left, right);
       } else if (divisor instanceof IYearMonthDurationItem) {
         retval = OperationFunctions.opMultiplyYearMonthDuration((IYearMonthDurationItem) divisor, left);
       } else if (divisor instanceof IDayTimeDurationItem) {
         retval = OperationFunctions.opMultiplyDayTimeDuration((IDayTimeDurationItem) divisor, left);
       }
     }
     if (retval == null) {
       throw new InvalidTypeMetapathException(
           null,
           String.format("The expression '%s / %s' is not supported", dividend.getClass().getName(),
               divisor.getClass().getName()));
     }
     return retval;
   }
 }