nopaque/app/static/js/nopaque.lists.js

class RessourceList extends List {
  constructor(idOrElement, subscriberList, type, options={}) {
    if (!['corpus', 'job'].includes(type)) {
      console.error("Unknown Type!");
      return;
    }
    super(idOrElement, {...RessourceList.options['common'],
                        ...RessourceList.options[type],
                        ...options});
    this.type = type;
    subscriberList.push(this);
  }


  _init(ressources) {
    this.addRessources(Object.values(ressources));
    this.sort("creation_date", {order: "desc"});
  }


  _update(patch) {
    let item, pathArray;

    for (let operation of patch) {
      /* "/ressourceId/valueName" -> ["ressourceId", "valueName"] */
      pathArray = operation.path.split("/").slice(1);
      switch(operation.op) {
        case "add":
          if (pathArray.includes("results")) {break;}
          this.addRessources([operation.value]);
          break;
        case "remove":
          this.remove("id", pathArray[0]);
          break;
        case "replace":
          item = this.get("id", pathArray[0])[0];
          switch(pathArray[1]) {
            case "status":
              item.values({status: operation.value});
              break;
            default:
              break;
          }
        default:
          break;
      }
    }
  }


  addRessources(ressources) {
    this.add(ressources.map(x => RessourceList.dataMapper[this.type](x)));
  }
}
RessourceList.dataMapper = {
  corpus: corpus => ({creation_date: corpus.creation_date,
                      description: corpus.description,
                      id: corpus.id,
                      "analyse-link": `/corpora/${corpus.id}/analyse`,
                      "edit-link": `/corpora/${corpus.id}`,
                      status: corpus.status,
                      title: corpus.title}),
  job: job => ({creation_date: job.creation_date,
                description: job.description,
                id: job.id,
                link: `/jobs/${job.id}`,
                service: job.service,
                status: job.status,
                title: job.title})
};
RessourceList.options = {
  common: {page: 4, pagination: {innerWindow: 8, outerWindow: 1}},
  corpus: {item: `<tr>
                    <td>
                      <a class="btn-floating disabled">
                        <i class="material-icons service">book</i>
                      </a>
                    </td>
                    <td>
                      <b class="title"></b><br>
                      <i class="description"></i>
                    </td>
                    <td>
                      <span class="badge new status" data-badge-caption="">
                      </span>
                    </td>
                    <td class="right-align">
                      <a class="btn-small edit-link waves-effect waves-light">
                        <i class="material-icons">edit</i>
                      </a>
                      <a class="btn-small analyse-link waves-effect waves-light">
                        Analyse<i class="material-icons right">search</i>
                      </a>
                    </td>
                  </tr>`,
           valueNames: ["creation_date", "description", "title",
                        {data: ["id"]},
                        {name: "analyse-link", attr: "href"},
                        {name: "edit-link", attr: "href"},
                        {name: "status", attr: "data-status"}]},
  job: {item: `<tr>
                 <td>
                   <a class="btn-floating disabled">
                     <i class="material-icons service"></i>
                   </a>
                 </td>
                 <td>
                   <b class="title"></b><br>
                   <i class="description"></i>
                 </td>
                 <td>
                   <span class="badge new status" data-badge-caption=""></span>
                 </td>
                 <td class="right-align">
                   <a class="btn-small link waves-effect waves-light">
                    View<i class="material-icons right">send</i>
                  </a>
                 </td>
               </tr>`,
        valueNames: ["creation_date", "description", "title",
                     {data: ["id"]},
                     {name: "link", attr: "href"},
                     {name: "service", attr: "data-service"},
                     {name: "status", attr: "data-status"}]}
};


class ResultsList extends List {

  // get display options from display options form element
  static getDisplayOptions(displayOptionsFormElement) {
    // gets display options parameters
    let displayOptionsFormData
    let displayOptionsData;
    displayOptionsFormData = new FormData(displayOptionsFormElement);
    displayOptionsData =
      {
        "resultsPerPage": displayOptionsFormData.get("display-options-form-results_per_page"),
        "resultsContex": displayOptionsFormData.get("display-options-form-result_context"),
        "expertMode": displayOptionsFormData.get("display-options-form-expert_mode")
      };
    return displayOptionsData
  }

  // ###### Functions to inspect one match, to show more details ######
  // activate inspect buttons if progress is 100
  activateInspect() {
    let inspectBtnElements;
    if (progress === 100) {
      inspectBtnElements = document.getElementsByClassName("inspect");
      for (let inspectBtn of inspectBtnElements) {
        inspectBtn.classList.remove("disabled");
      }
    } else {
      return
    }
  }

  //gets result cpos infos for one dataIndex to send back to the server
  inspect(dataIndex) {
    let contextResultsElement;
    contextResultsElement = document.getElementById("context-results");
    contextResultsElement.innerHTML = "";  // clear it from old inspects
    contextModal.open();
    nopaque.socket.emit("corpus_analysis_inspect_match",
            {
              payload: {
                       first_cpos: results.resultsJSON.matches[dataIndex].c[0],
                       last_cpos: results.resultsJSON.matches[dataIndex].c[1]
                      }
            }
          );
  }

  showMatchContext(response) {
    let c;
    let contextData;
    let contextModalLoading;
    let contextModalReady;
    let contextResultsElement;
    let expertModeSwitchElement;
    let lc;
    let partElement;
    let rc;
    let token;
    let tokenElement;
    let tokenElements;
    contextData = response.payload;
    contextResultsElement = document.getElementById("context-results");
    expertModeSwitchElement = document.getElementById("display-options-form-expert_mode");
    // check if cpos ranges are used or not
    if (contextData.cpos_ranges == true) {
      // python range like function from MDN
      // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from#Sequence_generator_(range)
      const range = (start, stop, step) => Array.from({ length: (stop - start) / step + 1}, (_, i) => start + (i * step));
      lc = range(contextData.match.lc[0], contextData.match.lc[1], 1)
      c = range(contextData.match.c[0], contextData.match.c[1], 1)
      rc = range(contextData.match.rc[0], contextData.match.rc[1], 1)
    } else {
      lc = contextData.match.lc;
      c = contextData.match.c;
      rc = contextData.match.rc;
    }
    // create sentence strings as tokens
    partElement = document.createElement("p");
    for (let cpos of lc) {
      token = contextData.cpos_lookup[cpos];
      partElement.insertAdjacentHTML("beforeend",
        `<span class="token" data-cpos="${cpos}">${token.word} </span>`);
      contextResultsElement.append(partElement);
    }
    for (let cpos of c) {
      token = contextData.cpos_lookup[cpos];
      partElement.insertAdjacentHTML("beforeend",
        `<span class="token bold light-green" data-cpos="${cpos}"` +
        `style="text-decoration-line: underline;">${token.word} </span>`);
      contextResultsElement.append(partElement);
    }
    for (let cpos of rc) {
      token = contextData.cpos_lookup[cpos];
      partElement.insertAdjacentHTML("beforeend",
        `<span class="token" data-cpos="${cpos}">${token.word} </span>`);
      contextResultsElement.append(partElement);
    }
    if (expertModeSwitchElement.checked) {
      tokenElements = partElement.getElementsByClassName("token");
      this.expertModeOn(tokenElements, contextData);
    }
  }

  // ###### Display options changing live how the matches are being displayed ######

  // Event function that changes the shown hits per page.
  // Just alters the resultsList.page property
  changeHitsPerPage(event) {
    try {
      resultsList.page = event.target.value;
      resultsList.update();
      nopaque.flash("Updated matches per page.")
    } catch (e) {
      console.log("resultsList has no results right now.");
    }
  }

  // Event function triggered on context select change
  // also if pagination is clicked
  changeContext(event) {
    let array;
    let lc;
    let newContextValue;
    let rc;
    try {
        if (event.type === "change") {
            nopaque.flash("Updated context per match!");
        }
    } catch (e) {
    } finally {
        newContextValue = document.getElementById("display-options-form-result_context").value;
        lc = document.getElementsByClassName("left-context");
        rc = document.getElementsByClassName("right-context");
        for (let element of lc) {
          array = Array.from(element.childNodes);
          for (let element of array.reverse().slice(newContextValue)) {
            element.classList.add("hide");
          }
          for (let element of array.slice(0, newContextValue)) {
            element.classList.remove("hide");
          }
        }
        for (let element of rc) {
          array = Array.from(element.childNodes);
          for (let element of array.slice(newContextValue)) {
            element.classList.add("hide");
          }
          for (let element of array.slice(0, newContextValue)) {
            element.classList.remove("hide");
          }
        }
    }
  }

  // ###### Expert view event functions ######

  // Event function to check if pagination is used and then look if
  // expertModeSwitchElement is checked
  // if checked than expertModeOn is executed
  // if unchecked expertModeOff is executed
  eventHandlerCheck(event) {
    if (expertModeSwitchElement.checked) {
      this.expertModeOn(event.currentTarget.tokenElements, resultsJSON);
    } else if (!expertModeSwitchElement.checked) {
      event.preventDefault();
      this.expertModeOff(event.currentTarget.tokenElements);
    }
  }

  // function to apply extra information and animation to every token
  expertModeOn(tokenElements) {
    let token;
    for (let tokenElement of tokenElements) {
      tokenElement.classList.add("chip");
      tokenElement.classList.add("hoverable");
      tokenElement.classList.add("expert-view");
      tokenElement.addEventListener("mouseover", (event) => {
        token = results.resultsJSON.cpos_lookup[event.target.dataset.cpos];
        this.addToolTipToTokenElement(event.target, token);
      });
    }
  }

  // fuction that creates Tooltip for one token and extracts the corresponding
  // infos from the result JSON
  addToolTipToTokenElement(tokenElement, token) {
    M.Tooltip.init(tokenElement,
     {"html": `<table>
                 <tr>
                   <th>Token information</th>
                   <th>Source information</th>
                 </tr>
                 <tr>
                   <td class="left-align">
                     Word: ${token.word}<br>
                     Lemma: ${token.lemma}<br>
                     POS: ${token.pos}<br>
                     Simple POS: ${token.simple_pos}<br>
                     NER: ${token.ner}
                   </td>
                   <td class="left-align">
                     Title: ${resultsJSON.text_lookup[token.text].title}
                     <br>
                     Author: ${resultsJSON.text_lookup[token.text].author}
                     <br>
                     Publishing year: ${resultsJSON.text_lookup[token.text].publishing_year}
                   </td>
                 </tr>
               </table>`}
    );
  }

  // function to remove extra informations and animations from tokens
  expertModeOff(tokenElements) {
    console.log("expertModeOff!");
    for (let tokenElement of tokenElements) {
      tokenElement.classList.remove("chip");
      tokenElement.classList.remove("hoverable");
      tokenElement.classList.remove("expert-view");
      tokenElement.outerHTML = tokenElement.outerHTML; // this is actually a workaround, but it works pretty fast
      // TODO: use M.Tooltip.destroy()
    }
  }

  createResultRowElement(item, chunk) {
    let c;
    let cCellElement;
    let cpos;
    let inspectBtn
    let lc;
    let lcCellElement;
    let matchNrElement;
    let matchRowElement;
    let rc;
    let rcCellElement;
    let textTitles;
    let textTitlesCellElement;
    let token;
    let values;
    // gather values from item
    values = item.values();
    if (chunk.cpos_ranges == true) {
      // python range like function from MDN
      // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from#Sequence_generator_(range)
      const range = (start, stop, step) => Array.from({ length: (stop - start) / step + 1}, (_, i) => start + (i * step));
      lc = range(values.lc[0], values.lc[1], 1)
      c = range(values.c[0], values.c[1], 1)
      rc = range(values.rc[0], values.rc[1], 1)
    } else {
      lc = values.lc;
      c = values.c;
      rc = values.rc;
    }
    // get infos for full match row
    matchRowElement = document.createElement("tr");
    matchRowElement.setAttribute("data-index", values.index)
    lcCellElement = document.createElement("td");
    lcCellElement.classList.add("left-context");
    matchRowElement.appendChild(lcCellElement);
    for (cpos of lc) {
      token = chunk.cpos_lookup[cpos];
      lcCellElement.insertAdjacentHTML("beforeend",
        `<span class="token" data-cpos="${cpos}">${token.word} </span>`);
    }

    // get infos for hit of match
    textTitles = new Set();
    cCellElement = document.createElement("td");
    cCellElement.classList.add("match-hit");
    textTitlesCellElement = document.createElement("td");
    textTitlesCellElement.classList.add("titles");
    matchNrElement = document.createElement("td");
    matchNrElement.classList.add("match-nr");
    matchRowElement.appendChild(cCellElement);
    for (cpos of c) {
      token = chunk.cpos_lookup[cpos];
      cCellElement.insertAdjacentHTML("beforeend",
        `<span class="token" data-cpos="${cpos}">${token.word} </span>`);
      // get text titles of every hit cpos token
      textTitles.add(chunk.text_lookup[token.text].title);
      // add button to trigger more context to every match td
      inspectBtn = document.createElement("a");
      inspectBtn.setAttribute("class", `btn-floating btn-flat waves-effect` +
                                       `waves-light grey right inspect disabled`
                              );
      inspectBtn.innerHTML = '<i class="material-icons">search</i>';
      inspectBtn.onclick = () => {this.inspect(values.index)};
    }
    // add text titles at front as first td of one row
    cCellElement.appendChild(inspectBtn);
    textTitlesCellElement.innerText = [...textTitles].join(", ");
    matchRowElement.insertAdjacentHTML("afterbegin", textTitlesCellElement.outerHTML);
    matchNrElement.innerText = values.index + 1;
    matchRowElement.insertAdjacentHTML("afterbegin", matchNrElement.outerHTML);

    // get infos for right context of match
    rcCellElement = document.createElement("td");
    rcCellElement.classList.add("right-context");
    matchRowElement.appendChild(rcCellElement);
    for (cpos of rc) {
      token = chunk.cpos_lookup[cpos];
      rcCellElement.insertAdjacentHTML("beforeend",
        `<span class="token" data-cpos="${cpos}">${token.word} </span>`);
    }
    return matchRowElement
  }
}