DefaultFunctionLibrary.java

  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.  */

  27. package gov.nist.secauto.metaschema.core.metapath.function.library;

  29. import com.google.auto.service.AutoService;

  31. import gov.nist.secauto.metaschema.core.metapath.MetapathConstants;
  32. import gov.nist.secauto.metaschema.core.metapath.function.FunctionLibrary;
  33. import gov.nist.secauto.metaschema.core.metapath.function.IFunctionLibrary;
  34. import gov.nist.secauto.metaschema.core.metapath.item.atomic.IBooleanItem;
  35. import gov.nist.secauto.metaschema.core.metapath.item.atomic.IDateItem;
  36. import gov.nist.secauto.metaschema.core.metapath.item.atomic.IDateTimeItem;
  37. import gov.nist.secauto.metaschema.core.metapath.item.atomic.IDecimalItem;
  38. import gov.nist.secauto.metaschema.core.metapath.item.atomic.IDurationItem;
  39. import gov.nist.secauto.metaschema.core.metapath.item.atomic.IIntegerItem;
  40. import gov.nist.secauto.metaschema.core.metapath.item.atomic.INcNameItem;
  41. import gov.nist.secauto.metaschema.core.metapath.item.atomic.INonNegativeIntegerItem;
  42. import gov.nist.secauto.metaschema.core.metapath.item.atomic.INumericItem;
  43. import gov.nist.secauto.metaschema.core.metapath.item.atomic.IPositiveIntegerItem;
  44. import gov.nist.secauto.metaschema.core.metapath.item.atomic.IStringItem;

  46. @AutoService(IFunctionLibrary.class)
  47. public class DefaultFunctionLibrary
  48.     extends FunctionLibrary {

  50.   /**
  51.    * Initialize the built-in function library.
  52.    */
  53.   public DefaultFunctionLibrary() { // NOPMD - intentional
  54.     // https://www.w3.org/TR/xpath-functions-31/#func-abs
  55.     registerFunction(NumericFunction.signature(MetapathConstants.NS_XPATH_FUNCTIONS, "abs", INumericItem::abs));
  56.     // https://www.w3.org/TR/xpath-functions-31/#func-adjust-dateTime-to-timezone
  57.     // https://www.w3.org/TR/xpath-functions-31/#func-adjust-date-to-timezone
  58.     // https://www.w3.org/TR/xpath-functions-31/#func-adjust-time-to-timezone
  59.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-avg
  60.     // https://www.w3.org/TR/xpath-functions-31/#func-base-uri
  61.     registerFunction(FnBaseUri.SIGNATURE_NO_ARG);
  62.     registerFunction(FnBaseUri.SIGNATURE_ONE_ARG);
  63.     // https://www.w3.org/TR/xpath-functions-31/#func-boolean
  64.     registerFunction(FnBoolean.SIGNATURE);
  65.     // https://www.w3.org/TR/xpath-functions-31/#func-ceiling
  66.     registerFunction(NumericFunction.signature(MetapathConstants.NS_XPATH_FUNCTIONS, "ceiling", INumericItem::ceiling));
  67.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-compare
  68.     registerFunction(FnCompare.SIGNATURE);
  69.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-concat
  70.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-contains
  71.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-count
  72.     // https://www.w3.org/TR/xpath-functions-31/#func-current-date
  73.     // https://www.w3.org/TR/xpath-functions-31/#func-current-dateTime
  74.     // https://www.w3.org/TR/xpath-functions-31/#func-current-time
  75.     // https://www.w3.org/TR/xpath-functions-31/#func-data
  76.     registerFunction(FnData.SIGNATURE_NO_ARG);
  77.     registerFunction(FnData.SIGNATURE_ONE_ARG);
  78.     // https://www.w3.org/TR/xpath-functions-31/#func-day-from-date
  79.     // https://www.w3.org/TR/xpath-functions-31/#func-day-from-dateTime
  80.     // https://www.w3.org/TR/xpath-functions-31/#func-days-from-duration
  81.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-deep-equal
  82.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-distinct-values
  83.     // https://www.w3.org/TR/xpath-functions-31/#func-doc
  84.     registerFunction(FnDoc.SIGNATURE);
  85.     // https://www.w3.org/TR/xpath-functions-31/#func-doc-available
  86.     // https://www.w3.org/TR/xpath-functions-31/#func-document-uri
  87.     registerFunction(FnDocumentUri.SIGNATURE_NO_ARG);
  88.     registerFunction(FnDocumentUri.SIGNATURE_ONE_ARG);
  89.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-empty
  90.     // https://www.w3.org/TR/xpath-functions-31/#func-encode-for-uri
  91.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-ends-with
  92.     // https://www.w3.org/TR/xpath-functions-31/#func-exactly-one
  93.     // https://www.w3.org/TR/xpath-functions-31/#func-exists
  94.     registerFunction(FnExists.SIGNATURE);
  95.     registerFunction(FnFalse.SIGNATURE);
  96.     // https://www.w3.org/TR/xpath-functions-31/#func-floor
  97.     registerFunction(NumericFunction.signature(MetapathConstants.NS_XPATH_FUNCTIONS, "floor", INumericItem::floor));
  98.     // https://www.w3.org/TR/xpath-functions-31/#func-format-date
  99.     // https://www.w3.org/TR/xpath-functions-31/#func-format-dateTime
  100.     // https://www.w3.org/TR/xpath-functions-31/#func-format-integer
  101.     // https://www.w3.org/TR/xpath-functions-31/#func-format-number
  102.     // https://www.w3.org/TR/xpath-functions-31/#func-format-time
  103.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-generate-id
  104.     // https://www.w3.org/TR/xpath-functions-31/#func-has-children
  105.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-head
  106.     // https://www.w3.org/TR/xpath-functions-31/#func-hours-from-dateTime
  107.     // https://www.w3.org/TR/xpath-functions-31/#func-hours-from-duration
  108.     // https://www.w3.org/TR/xpath-functions-31/#func-hours-from-time
  109.     // https://www.w3.org/TR/xpath-functions-31/#func-implicit-timezone
  110.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-index-of
  111.     // https://www.w3.org/TR/xpath-functions-31/#func-innermost
  112.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-insert-before
  113.     // https://www.w3.org/TR/xpath-functions-31/#func-iri-to-uri
  114.     // https://www.w3.org/TR/xpath-functions-31/#func-last
  115.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-lower-case
  116.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-matches
  117.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-max
  118.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-min
  119.     // https://www.w3.org/TR/xpath-functions-31/#func-minutes-from-dateTime
  120.     // https://www.w3.org/TR/xpath-functions-31/#func-minutes-from-duration
  121.     // https://www.w3.org/TR/xpath-functions-31/#func-minutes-from-time
  122.     // https://www.w3.org/TR/xpath-functions-31/#func-month-from-date
  123.     // https://www.w3.org/TR/xpath-functions-31/#func-month-from-dateTime
  124.     // https://www.w3.org/TR/xpath-functions-31/#func-months-from-duration
  125.     // https://www.w3.org/TR/xpath-functions-31/#func-normalize-space
  126.     // https://www.w3.org/TR/xpath-functions-31/#func-normalize-unicode
  127.     // https://www.w3.org/TR/xpath-functions-31/#func-not
  128.     registerFunction(FnNot.SIGNATURE);
  129.     // https://www.w3.org/TR/xpath-functions-31/#func-number
  130.     // https://www.w3.org/TR/xpath-functions-31/#func-one-or-more
  131.     // https://www.w3.org/TR/xpath-functions-31/#func-outermost
  132.     // https://www.w3.org/TR/xpath-functions-31/#func-parse-ietf-date
  133.     // https://www.w3.org/TR/xpath-functions-31/#func-path
  134.     registerFunction(FnPath.SIGNATURE_NO_ARG);
  135.     registerFunction(FnPath.SIGNATURE_ONE_ARG);
  136.     // https://www.w3.org/TR/xpath-functions-31/#func-position
  137.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-remove
  138.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-replace
  139.     // https://www.w3.org/TR/xpath-functions-31/#func-resolve-uri
  140.     registerFunction(FnResolveUri.SIGNATURE_ONE_ARG);
  141.     registerFunction(FnResolveUri.SIGNATURE_TWO_ARG);
  142.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-reverse
  143.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-root
  144.     // https://www.w3.org/TR/xpath-functions-31/#func-round
  145.     registerFunction(FnRound.SIGNATURE);
  146.     registerFunction(FnRound.SIGNATURE_WITH_PRECISION);
  147.     // https://www.w3.org/TR/xpath-functions-31/#func-round-half-to-even
  148.     // https://www.w3.org/TR/xpath-functions-31/#func-seconds-from-dateTime
  149.     // https://www.w3.org/TR/xpath-functions-31/#func-seconds-from-duration
  150.     // https://www.w3.org/TR/xpath-functions-31/#func-seconds-from-time
  151.     // https://www.w3.org/TR/xpath-functions-31/#func-starts-with
  152.     registerFunction(FnStartsWith.SIGNATURE);
  153.     // https://www.w3.org/TR/xpath-functions-31/#func-static-base-uri
  154.     registerFunction(FnStaticBaseUri.SIGNATURE);
  155.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-string-join
  156.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-string-length
  157.     // https://www.w3.org/TR/xpath-functions-31/#func-subsequence
  158.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-substring
  159.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-substring-after
  160.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-substring-before
  161.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-sum
  162.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-tail
  163.     // https://www.w3.org/TR/xpath-functions-31/#func-timezone-from-date
  164.     // https://www.w3.org/TR/xpath-functions-31/#func-timezone-from-dateTime
  165.     // https://www.w3.org/TR/xpath-functions-31/#func-timezone-from-time
  166.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-tokenize
  167.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-translate
  168.     registerFunction(FnTrue.SIGNATURE);
  169.     // https://www.w3.org/TR/xpath-functions-31/#func-unparsed-text
  170.     // https://www.w3.org/TR/xpath-functions-31/#func-unparsed-text-available
  171.     // https://www.w3.org/TR/xpath-functions-31/#func-unparsed-text-lines
  172.     // P1: https://www.w3.org/TR/xpath-functions-31/#func-upper-case
  173.     // https://www.w3.org/TR/xpath-functions-31/#func-year-from-date
  174.     // https://www.w3.org/TR/xpath-functions-31/#func-year-from-dateTime
  175.     // https://www.w3.org/TR/xpath-functions-31/#func-years-from-duration
  176.     // https://www.w3.org/TR/xpath-functions-31/#func-zero-or-one

  178.     // xpath casting functions
  179.     registerFunction(
  180.         CastFunction.signature(MetapathConstants.NS_XML_SCHEMA, "boolean", IBooleanItem.class, IBooleanItem::cast));
  181.     registerFunction(CastFunction.signature(
  182.         MetapathConstants.NS_XML_SCHEMA, "date", IDateItem.class, IDateItem::cast));
  183.     registerFunction(CastFunction.signature(
  184.         MetapathConstants.NS_XML_SCHEMA, "dateTime", IDateTimeItem.class, IDateTimeItem::cast));
  185.     registerFunction(CastFunction.signature(
  186.         MetapathConstants.NS_XML_SCHEMA, "decimal", IDecimalItem.class, IDecimalItem::cast));
  187.     registerFunction(CastFunction.signature(
  188.         MetapathConstants.NS_XML_SCHEMA, "duration", IDurationItem.class, IDurationItem::cast));
  189.     registerFunction(CastFunction.signature(
  190.         MetapathConstants.NS_XML_SCHEMA, "integer", IIntegerItem.class, IIntegerItem::cast));
  191.     registerFunction(CastFunction.signature(
  192.         MetapathConstants.NS_XML_SCHEMA, "NCName", INcNameItem.class, INcNameItem::cast));
  193.     registerFunction(CastFunction.signature(
  194.         MetapathConstants.NS_XML_SCHEMA, "nonNegativeInteger", INonNegativeIntegerItem.class,
  195.         INonNegativeIntegerItem::cast));
  196.     registerFunction(CastFunction.signature(
  197.         MetapathConstants.NS_XML_SCHEMA, "positiveInteger", IPositiveIntegerItem.class,
  198.         IPositiveIntegerItem::cast));
  199.     registerFunction(CastFunction.signature(
  200.         MetapathConstants.NS_XML_SCHEMA, "string", IStringItem.class, IStringItem::cast));

  202.     // metapath casting functions
  203.     registerFunction(CastFunction.signature(
  204.         MetapathConstants.NS_METAPATH, "boolean", IBooleanItem.class, IBooleanItem::cast));
  205.     registerFunction(CastFunction.signature(
  206.         MetapathConstants.NS_METAPATH, "date", IDateItem.class, IDateItem::cast));
  207.     registerFunction(CastFunction.signature(
  208.         MetapathConstants.NS_METAPATH, "date-time", IDateTimeItem.class, IDateTimeItem::cast));
  209.     registerFunction(CastFunction.signature(
  210.         MetapathConstants.NS_METAPATH, "decimal", IDecimalItem.class, IDecimalItem::cast));
  211.     registerFunction(CastFunction.signature(
  212.         MetapathConstants.NS_METAPATH, "duration", IDurationItem.class, IDurationItem::cast));
  213.     registerFunction(CastFunction.signature(
  214.         MetapathConstants.NS_METAPATH, "integer", IIntegerItem.class, IIntegerItem::cast));
  215.     registerFunction(CastFunction.signature(
  216.         MetapathConstants.NS_METAPATH, "ncname", INcNameItem.class, INcNameItem::cast));
  217.     registerFunction(CastFunction.signature(
  218.         MetapathConstants.NS_METAPATH, "non-negative-integer", INonNegativeIntegerItem.class,
  219.         INonNegativeIntegerItem::cast));
  220.     registerFunction(CastFunction.signature(
  221.         MetapathConstants.NS_METAPATH, "positive-integer", IPositiveIntegerItem.class,
  222.         IPositiveIntegerItem::cast));
  223.     registerFunction(CastFunction.signature(
  224.         MetapathConstants.NS_METAPATH, "string", IStringItem.class, IStringItem::cast));

  226.     // extra functions
  227.     registerFunction(MpRecurseDepth.SIGNATURE_ONE_ARG);
  228.     registerFunction(MpRecurseDepth.SIGNATURE_TWO_ARG);
  229.   }

  231. }
Created with JaCoCo 0.8.10.202304240956