PvlTranslationManager.cpp

Go to the documentation of this file.

#include "IString.h"
#include "Message.h"
#include "IException.h"
#include "PvlTranslationManager.h"

using namespace std;
namespace Isis {

  PvlTranslationManager::PvlTranslationManager(const QString &transFile) {
    AddTable(transFile);
  }

  PvlTranslationManager::PvlTranslationManager(Isis::Pvl &inputLabel,
      const QString &transFile) {
    p_fLabel = inputLabel;

    // Internalize the translation table
    AddTable(transFile);
  }

  PvlTranslationManager::PvlTranslationManager(Isis::Pvl &inputLabel,
      std::istream &transStrm) {
    p_fLabel = inputLabel;

    // Internalize the translation table
    AddTable(transStrm);
  }

  QString PvlTranslationManager::Translate(QString nName, int findex) {
    const Isis::PvlContainer *con;
    int inst = 0;
    PvlKeyword grp;

    while((grp = InputGroup(nName, inst++)).Name() != "") {
      if((con = GetContainer(grp)) != NULL) {
        if(con->HasKeyword(InputKeywordName(nName))) {
          return PvlTranslationTable::Translate(nName,
                                                (*con)[InputKeywordName(nName)][findex]);
        }
      }
    }

    return Isis::PvlTranslationTable::Translate(nName);
  }

  Isis::PvlKeyword PvlTranslationManager::DoTranslation(
    const QString nName) {
    const Isis::PvlContainer *con = NULL;
    Isis::PvlKeyword key;

    int inst = 0;
    PvlKeyword grp;

    while((grp = InputGroup(nName, inst++)).Name() != "") {
      if((con = GetContainer(grp)) != NULL) {
        if(con->HasKeyword(InputKeywordName(nName))) {
          key.SetName(OutputName(nName));

          for(int v = 0; v < (*con)[(InputKeywordName(nName))].Size(); v++) {
            key.AddValue(Isis::PvlTranslationTable::Translate(nName,
                         (*con)[InputKeywordName(nName)][v]),
                         (*con)[InputKeywordName(nName)].Unit(v));
          }

          return key;
        }
      }
    }

    return Isis::PvlKeyword(OutputName(nName),
                            PvlTranslationTable::Translate(nName, ""));
  }



  // Automatically translate all the output names found in the translation table
  // If a output name does not translate an error will be thrown by one
  // of the support members
  // Store the translated key, value pairs in the argument pvl
  void PvlTranslationManager::Auto(Isis::Pvl &outputLabel) {
    // Attempt to translate every group in the translation table
    for(int i = 0; i < TranslationTable().Groups(); i++) {
      Isis::PvlGroup &g = TranslationTable().Group(i);
      if(IsAuto(g.Name())) {
        try {
          Isis::PvlContainer *con = CreateContainer(g.Name(), outputLabel);
          (*con) += PvlTranslationManager::DoTranslation(g.Name());
        }
        catch(IException &e) {
          if(!IsOptional(g.Name())) {
            throw;
          }
        }
      }
    }
  }

  const PvlKeyword &PvlTranslationManager::InputKeyword(
    const QString nName) const {

    int instanceNumber = 0;
    PvlKeyword inputGroupKeyword = InputGroup(nName, instanceNumber);
    bool anInputGroupFound = false;

    while(inputGroupKeyword.Name() != "") {
      const PvlContainer *containingGroup = GetContainer(inputGroupKeyword);
      if(containingGroup != NULL) {
        anInputGroupFound = true;

        if(containingGroup->HasKeyword(InputKeywordName(nName))) {
          return containingGroup->FindKeyword(InputKeywordName(nName));
        }
      }

      instanceNumber ++;
      inputGroupKeyword = InputGroup(nName, instanceNumber);
    }

    if(anInputGroupFound) {
      QString msg = "Unable to find input keyword [" + InputKeywordName(nName) +
                   "] for output name [" + nName + "] in file [" + TranslationTable().FileName() + "]";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
    else {
      QString container = "";

      for(int i = 0; i < InputGroup(nName).Size(); i++) {
        if(i > 0) container += ",";

        container += InputGroup(nName)[i];
      }

      QString msg = "Unable to find input group [" + container +
                   "] for output name [" + nName + "] in file [" + TranslationTable().FileName() + "]";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
  }


  bool PvlTranslationManager::InputHasKeyword(const QString nName) {

    // Set the current position in the input label pvl
    // by finding the input group corresponding to the output group
    const Isis::PvlContainer *con;
    int inst = 0;
    //while ((con = GetContainer(InputGroup(nName, inst++))) != NULL) {
    //if ((con = GetContainer (InputGroup(nName))) != NULL) {

    PvlKeyword grp;
    while((grp = InputGroup(nName, inst++)).Name() != "") {
      if((con = GetContainer(grp)) != NULL) {
        if(con->HasKeyword(InputKeywordName(nName))) return true;
      }
    }

    return false;
  }

  /*
   * Indicates if the input group corresponding to the output name exists in
   * the label
   *
   * @param nName The output name used to identify the input keyword.

   bool PvlTranslationManager::InputHasGroup (const QString nName) {

     if (GetContainer (InputGroup(nName)) != NULL) {
       return true;
     }

     return false;
   }
  */

  // Return a container from the input label according tund
  const Isis::PvlContainer *PvlTranslationManager::GetContainer(
    const PvlKeyword &inputGroup) const {


    // Return the root container if "ROOT" is the ONLY thing in the list
    if(inputGroup.Size() == 1 &&
        PvlKeyword::StringEqual(inputGroup[0], "ROOT")) {
      return &p_fLabel;
    }

    const Isis::PvlObject *currentObject = &p_fLabel;

    // Search for object containing our solution
    int objectIndex;
    for(objectIndex = 0;
        objectIndex < inputGroup.Size() - 1;
        objectIndex ++) {
      if(currentObject->HasObject(inputGroup[objectIndex])) {
        currentObject = &currentObject->FindObject(inputGroup[objectIndex]);
      }
      else {
        return NULL;
      }
    }

    // Our solution can be an object or a group
    if(currentObject->HasObject(inputGroup[objectIndex])) {
      return &currentObject->FindObject(inputGroup[objectIndex]);
    }
    else if(currentObject->HasGroup(inputGroup[objectIndex])) {
      return &currentObject->FindGroup(inputGroup[objectIndex]);
    }
    else {
      return NULL;
    }
  }


  // Create the requsted container and any containers above it and
  // return a reference to the container
  // list is an Isis::PvlKeyword with an array of container types an their names
  Isis::PvlContainer *PvlTranslationManager::CreateContainer(const QString nName,
      Isis::Pvl &pvl) {

    // Get the array of Objects/Groups from the OutputName keyword
    Isis::PvlKeyword np = OutputPosition(nName);

    Isis::PvlObject *obj = &pvl;

    // Look at every pair in the output position
    for(int c = 0; c < np.Size(); c += 2) {
      // If this pair is an object
      if(np[c].toUpper() == "OBJECT") {
        // If the object doesn't exist create it
        if(!obj->HasObject(np[c+1])) {
          obj->AddObject(np[c+1]);
        }
        obj = &(obj->FindObject(np[c+1]));
      }
      // If this pair is a group
      else if(np[c].toUpper() == "GROUP") {
        // If the group doesn't exist create it
        if(!obj->HasGroup(np[c+1])) {
          obj->AddGroup(np[c+1]);
        }
        return (Isis::PvlContainer *) & (obj->FindGroup(np[c+1]));

      }
    }

    return (Isis::PvlContainer *) obj;
  }
} // end namespace isis