NatLibFi/record-loader-melinda

/**
 *
 * @licstart  The following is the entire license notice for the JavaScript code in this file. 
 *
 * Melinda-related modules for recordLoader
 *
 * Copyright (c) 2015-2017 University Of Helsinki (The National Library Of Finland)
 *
 * This file is part of record-loader-melinda
 *
 * record-loader-melinda is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *  
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *  
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @licend  The above is the entire license notice
 * for the JavaScript code in this file.
 *
 **/

/* istanbul ignore next: umd wrapper */
(function (root, factory) {

  'use strict';

  if (typeof define === 'function' && define.amd) {
    define([
      '@natlibfi/es6-polyfills/lib/polyfills/promise',
      '@natlibfi/es6-polyfills/lib/polyfills/object',
      '@natlibfi/json-similarity',
      '@natlibfi/marc-record-rank/lib/rank',
      'marc-record-js',
      '@natlibfi/record-loader-prototypes/lib/processors/match/prototype'
    ], factory);
  } else if (typeof module === 'object' && module.exports) {
    module.exports = factory(
      require('@natlibfi/es6-polyfills/lib/polyfills/promise'),
      require('@natlibfi/es6-polyfills/lib/polyfills/object'),
      require('@natlibfi/json-similarity'),
      require('@natlibfi/marc-record-rank/lib/rank'),
      require('marc-record-js'),
      require('@natlibfi/record-loader-prototypes/lib/processors/match/prototype')
    );
  }

}(this, factory));

function factory(Promise, Object, jsonSimilarity, rankFactory, MarcRecord, processorFactory) {

  'use strict';

  return function(parameters)
  {

    var logger, fn_read_record_store, fn_rank, obj;

    parameters = typeof parameters === 'object' ? JSON.parse(JSON.stringify(parameters)) : {};

    fn_rank = parameters.rank ? rankFactory(parameters.rank) : undefined;
    obj = processorFactory();

    function findBestMatch(result, record)
    {

      var rank_result, better, worse;

      if (result.length === 0) {
        return [record];
      } else {
        
        rank_result = fn_rank(result[0], record);
        better = rank_result >= 0 ? result[0] : record;
        worse = rank_result < 0 ? result[0] : record;

        logger.debug('Record ' + better.get(/^001$/).shift().value + ' ranks better thank ' + worse.get(/^001$/).shift().value);
        
        return [better];

      }

    }

    return Object.assign(obj, {
      setLogger: function(logger_arg)
      {
        logger = logger_arg;
        return obj;
      },
      setReadRecordStore: function(fn_read_record_store_arg)
      {
        fn_read_record_store = fn_read_record_store_arg;
        return obj;
      },
      run: function(record)
      {

        record = new MarcRecord(record);

        return obj.findMatchCandidates(record).then(function(found_records) {

          var results = {
            matchDetails: []
          };

          logger.debug('Found ' + found_records.length + ' match candidates for record ' + record.get(/^001$/).shift().value);

          results.matchedRecords = found_records
            .filter(function(found_record) {
              var result = jsonSimilarity(record.toJsonObject(), found_record, parameters.matching);
              results.matchDetails.push(result);
              return result.match;

            })
            .reduce(fn_rank ? findBestMatch : function(product, record) {
              return product.concat(record);
            }, []);

          logger.debug('Match details: ' + JSON.stringify(results.matchDetails, undefined, 4));

          return results;
        
        });

      },
      findMatchCandidates: function(record)
      {
        return Promise.resolve([]);
      },
    });

  };

}