All files / lib/ner enum-named-entity.js

100% Statements 26/26
100% Branches 19/19
100% Functions 9/9
100% Lines 26/26

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123                                              42x                     119x 119x                     504x 504x 2x   502x 355x   502x                   334x     334x 334x 478x 478x 556x                       10x     10x 10x 13x 13x 11x 14x 14x 13x                                   380x                     42x  
/*
 * Copyright (c) AXA Group Operations Spain S.A.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
const NamedEntity = require('./named-entity');
 
/**
 * Class for the Enumerated Named Entity.
 */
class EnumNamedEntity extends NamedEntity {
  /**
   * Constructor of the class.
   * @param {Object} settings Settings for the instance.
   */
  constructor(settings) {
    super(settings);
    this.type = 'enum';
  }
 
  /**
   * Get or create an option inside a locale
   * @param {string} language Locale of the language.
   * @param {string} optionName Name of the option.
   * @param {boolean} create Flag indicating if should create if not exists.
   * @returns {Object} Option object.
   */
  getOption(language, optionName, create = true) {
    const locale = this.getLocale(language, create);
    if (!locale) {
      return undefined;
    }
    if (!locale[optionName] && create) {
      locale[optionName] = [];
    }
    return locale[optionName];
  }
 
  /**
   * Add texts to the given languages of an option.
   * @param {String} optionName Name of the option.
   * @param {String[]} srcLanguages Language or languages for adding the texts.
   * @param {String[]} srcTexts Text or texts to be added.
   */
  addText(optionName, srcLanguages, srcTexts) {
    const languages = Array.isArray(srcLanguages)
      ? srcLanguages
      : [srcLanguages];
    const texts = Array.isArray(srcTexts) ? srcTexts : [srcTexts];
    languages.forEach(language => {
      const option = this.getOption(language, optionName);
      texts.forEach(text => {
        option.push(text);
      });
    });
  }
 
  /**
   * Remove texts for the given languages of the option.
   * @param {String} optionName Name of the option.
   * @param {String[]} srcLanguages Languages affected.
   * @param {String[]} srcTexts Texts to be removed.
   */
  removeText(optionName, srcLanguages, srcTexts) {
    const languages = Array.isArray(srcLanguages)
      ? srcLanguages
      : [srcLanguages];
    const texts = Array.isArray(srcTexts) ? srcTexts : [srcTexts];
    languages.forEach(language => {
      const option = this.getOption(language, optionName, false);
      if (option) {
        texts.forEach(text => {
          const index = option.indexOf(text);
          if (index !== -1) {
            option.splice(index, 1);
          }
        });
      }
    });
  }
 
  /**
   * Given an utterance and language, extract the different occurances of this
   * named entity in the utterance.
   * @param {String} utterance Source utterance to extract information.
   * @param {String} language Locale of the language.
   * @param {Object} similar Instance of SimilarSearch.
   * @param {Object[]} wordPositions Optional array of word positions.
   * @param {number} threshold Threshold of accuracy.
   * @return {Object[]} Edges found.
   */
  extract(utterance, language, similar, wordPositions, threshold) {
    return similar.getEdgesFromEntity(
      utterance,
      this,
      language,
      this.name,
      threshold,
      wordPositions
    );
  }
}
 
module.exports = EnumNamedEntity;