v0.2.48..v0.2.49 changeset ToEnglishTranslationComparisonVisitor.cpp

diff --git a/hoot-core/src/main/cpp/hoot/core/visitors/ToEnglishTranslationComparisonVisitor.cpp b/hoot-core/src/main/cpp/hoot/core/visitors/ToEnglishTranslationComparisonVisitor.cpp
new file mode 100644
index 0000000..e8871be
--- /dev/null
+++ b/hoot-core/src/main/cpp/hoot/core/visitors/ToEnglishTranslationComparisonVisitor.cpp
@@ -0,0 +1,128 @@
+/*
+ * This file is part of Hootenanny.
+ *
+ * Hootenanny is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * --------------------------------------------------------------------
+ *
+ * The following copyright notices are generated automatically. If you
+ * have a new notice to add, please use the format:
+ * " * @copyright Copyright ..."
+ * This will properly maintain the copyright information. DigitalGlobe
+ * copyrights will be updated automatically.
+ *
+ * @copyright Copyright (C) 2018, 2019 DigitalGlobe (http://www.digitalglobe.com/)
+ */
+
+#include "ToEnglishTranslationComparisonVisitor.h"
+
+// hoot
+#include <hoot/core/util/Factory.h>
+#include <hoot/core/util/ConfigOptions.h>
+#include <hoot/core/util/Settings.h>
+#include <hoot/core/util/Log.h>
+
+namespace hoot
+{
+
+HOOT_FACTORY_REGISTER(ElementVisitor, ToEnglishTranslationComparisonVisitor)
+
+ToEnglishTranslationComparisonVisitor::ToEnglishTranslationComparisonVisitor() :
+ToEnglishTranslationVisitor(),
+_numTagsCompared(0)
+{
+}
+
+void ToEnglishTranslationComparisonVisitor::setConfiguration(const Settings& conf)
+{
+  ConfigOptions opts(conf);
+
+  if (opts.getLanguageTranslationSourceLanguages().size() > 1 ||
+      opts.getLanguageTranslationSourceLanguages().contains("detect", Qt::CaseInsensitive))
+  {
+    throw HootException(
+      QString("ToEnglishTranslationComparisonVisitor supports only one source language ") +
+      QString("and does not support detect mode."));
+  }
+
+  ToEnglishTranslationVisitor::setConfiguration(conf);
+
+  if (_ignorePreTranslatedTags ||
+      opts.getLanguageTranslationDetectedLanguageOverridesSpecifiedSourceLanguages() ||
+      opts.getLanguageTranslationPerformExhaustiveSearchWithNoDetection())
+  {
+    throw IllegalArgumentException(
+      "ToEnglishTranslationComparisonVisitor does not support enabling any of the following options:\n"
+      "language.translation.detected.language.overrides.specified.source.languages\n"
+      "language.translation.perform.exhaustive.search.with.no.detection\n"
+      "language.ignore.pre.translated.tags\nDisabling the options.");
+  }
+
+  _translationScorer.reset(
+    Factory::getInstance().constructObject<StringDistance>(
+      opts.getLanguageTranslationComparisonScorer()));
+
+  //use a different collection of tag keys here as a list and ignore the parse names option, since
+  //we need to retain the key ordering to be in sync with _preTranslatedTagKeys and don't care
+  //about the parse names option for the purposes of translation performance comparison
+  _tagKeysAsList = opts.getLanguageTagKeys();
+
+  _preTranslatedTagKeys = opts.getLanguageTranslationComparisonPretranslatedTagKeys();
+  if (_preTranslatedTagKeys.size() != opts.getLanguageTagKeys().size())
+  {
+    throw HootException(
+      QString("When performing language translation comparison, the number of pre-translated ") +
+      QString("tag keys must match that of the keys of the tags to be translated."));
+  }
+}
+
+void ToEnglishTranslationComparisonVisitor::visit(const std::shared_ptr<Element>& e)
+{
+  const Tags& tags = e->getTags();
+  bool atLeastOneTranslationCompared = false;
+  for (int i = 0; i < _preTranslatedTagKeys.size(); i++)
+  {
+    const QString toTranslateTagKey = _tagKeysAsList.at(i);
+    LOG_VART(toTranslateTagKey);
+    const QString preTranslatedTagKey = _preTranslatedTagKeys.at(i);
+    LOG_VART(preTranslatedTagKey);
+    //only care about features that have both the pre-translated tag and the tag we want to compare
+    //our translation to it with
+    if (tags.contains(toTranslateTagKey) && tags.contains(preTranslatedTagKey))
+    {
+      atLeastOneTranslationCompared = true;
+      _preTranslatedVal = tags.get(preTranslatedTagKey).trimmed();
+      LOG_VARD(_preTranslatedVal);
+
+      if (ToEnglishTranslationVisitor::_translate(e, toTranslateTagKey))
+      {
+        const double similarityScore =
+          _translationScorer->compare(_preTranslatedVal, _translatedText);
+        LOG_VARD(similarityScore);
+        _element->getTags().appendValue(
+          "hoot:translated:similarity:score:" + _toTranslateTagKey + ":en",
+          QString::number(similarityScore));
+        _numProcessedTags++;
+      }
+    }
+  }
+
+  if (atLeastOneTranslationCompared)
+  {
+    _numProcessedElements++;
+  }
+  _numTotalElements++;
+}
+
+}