SuggestionManagerModule.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SuggestionManagerModule.java
 * Description: Class implements AnotServerModule calss for prupose of on server 
 *              suggestion.
 */

/**
 * @file SuggestionManagerModule.java
 * 
 * @brief Class implements module for suggestiong of annotations.
 */

/**
 * @package cz.vutbr.fit.knot.annotations.modules.suggestionManager
 * 
 * @brief Classes responsible for management of suggestions
 */
package cz.vutbr.fit.knot.annotations.modules.suggestionManager;

import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.comet.AnnotServerModule;
import cz.vutbr.fit.knot.annotations.comet.EditorSession;
import cz.vutbr.fit.knot.annotations.comet.Flier;
import cz.vutbr.fit.knot.annotations.comet.RequestInfo;

/**
 * Class implements AnotServerModule calss for prupose of suggestiong of annotations.
 * The module retrieves suggestions from NER or SEC API, stores them with their 
 * feedback and provides related services to the clients.
 *
 * @brief Class implements module for suggestiong of annotations.
 *
 * @author Martin Petr (xpetrm05)
 */
public class SuggestionManagerModule implements AnnotServerModule{

  /**
   * This method is called when client sent message and these message has been
   * processed. Changes in types, annotations and in other entities are
   * persisted after calling this method from all modules. 
   * It performs: 
   * - cleanup of suggestions in session after synchronization of document
   *
   * In this module it always returns empty string.
   * 
   * @param requestInfo Informations about client request
   * @return String with messages for client or empty string
   */
  @Override
  public String processRequestBeforePersist(RequestInfo requestInfo) {
    if (requestInfo.getSyncDocumentData() != null) {  // if document was just synchronized
      // Clean up
      requestInfo.getSession().getSuggestionsCache().clear();
    }
    return "";
  }

  /**
   * This method is called when client sent message, these message has been
   * processed and changes in entities are persisted. Composed response is sent
   * to client after calling this method from all modules. 
   * It performs: 
   * - starting of new thread which will handles main functionality of this module
   *
   * @param requestInfo Informations about client request
   * @param persistFailed True if changes not persisted, false otherwise.
   * @return String with messages for client or empty string
   */
  @Override
  public String processRequestAfterPersist(RequestInfo requestInfo, boolean persistFailed) {
    if(persistFailed) {
      return "";
    }
    SuggestionManager suggestThread = new SuggestionManager(requestInfo);
    suggestThread.start();
    return ""; 
  }

  /**
   * This method is called for each sleeping comet handler when he receives
   * flier (part of informations about this or another client request).
   *
   * In this module it always returns empty string.
   *
   * @param flier Flier, which has been sent to all comet handlers.
   * @param session Session associated with comet handler.
   * @return If this handler hasn't react to this flier (not interested) return
   *         null, else return messages for client in single string.
   */
  @Override
  public String messagesFromFlier(Flier flier, EditorSession session) {
    return "";
  }

  /**
   * Returns name of this module. Name will be included in XML element
   * attribute so usable characters are restricted.
   *
   * @param lang Requested language of name
   * @return Name of this module
   */
  @Override
  public String getModuleName(int lang) {
    return "Suggestion Manager Module";
  }

  /**
   * Returns description of this module. It will be part of information
   * about server functions.
   *
   * @param lang Requested language of description
   * @return Description of this module
   */
  @Override
  public String getModuleDescription(int lang) {
    return "Suggestions module suggest annotations and actualize suggestions.";
  }
}  // public class SuggestionManagerModule