TextModification.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: TextModification.java
 * Description: Class representing modification of annotated document text
 */

/**
 * @file TextModification.java
 *
 * @brief Class representing modification of annotated document text
 */

package cz.vutbr.fit.knot.annotations.app;

/**
 * Class representing modification of annotated document text
 *
 * @brief Class representing modification of annotated document text
 * @author idytrych
 */
public class TextModification {
  /**
   * Class for throwing exceptions which are directly related to some text
   * modification.
   * 
   * @brief Class for throwing exceptions which are directly related to some text modification.
   */
  public static class TextModificationException extends Exception {
    /** Related text modification */
    private TextModification _tm; 
    
    /** Constructor */
    public TextModificationException() {}
    
    /**
     * Constructor
     * 
     * @param msg Message
     */
    public TextModificationException (String msg) { 
      this(msg, null); 
    }
    
    /**
     * Constructor
     * 
     * @param msg Message
     * @param tm Related text modification
     */
    public TextModificationException (String msg, TextModification tm) { 
      super(msg);
      _tm = tm;
    }
    
    /**
     * Gets related text modification
     * 
     * @return Returns related text modification
     */
    public TextModification getTextModification() {
      return _tm;
    }
  };  // public static class TextModificationException
  
  /** XPath of element in which modification was occurred */
  private String path;
  /** Offset of replaced text fragment */
  private Integer offset;
  /** Length of replaced text fragment */
  private Integer length;
  /** New content of fragment */
  private String newContent;
  /** Mode of text modification */
  private Integer mode;

  /**
   * Constructor with default mode (replace)
   * If offset is null, whole content of element was replaced.
   *
   * @param path XPath of element in which modification was occurred
   * @param offset Offset of replaced text fragment in given element
   * @param length Length of replaced text fragment
   * @param newContent New content of fragment
   */
  public TextModification(String path, Integer offset, Integer length, String newContent) {
    this.path = path;
    this.offset = offset;
    this.length = length;
    this.newContent = newContent;
    this.mode = Constants.TEXT_MOD_REPLACE;
  }
  
  /**
   * Constructor
   * If offset is null, whole content of element was replaced.
   *
   * @param path XPath of element in which modification was occurred
   * @param offset Offset of replaced text fragment in given element
   * @param length Length of replaced text fragment
   * @param newContent New content of fragment
   * @param mode Mode of text modification
   */
  public TextModification(String path, Integer offset, Integer length, String newContent, Integer mode) {
    this.path = path;
    this.offset = offset;
    this.length = length;
    this.newContent = newContent;
    this.mode = mode;
  }

  /**
   * Constructor
   *
   * @param path XPath of element in which modification was occurred
   * @param newContent New content of fragment
   * @param mode Mode of text modification
   */
  public TextModification(String path, String newContent, Integer mode) {
    this.path = path;
    this.newContent = newContent;
    this.mode = mode;
  }

  /**
   * Gets length of replaced text fragment
   *
   * @return Returns length of replaced text fragment
   */
  public Integer getLength() {
    return length;
  }

  /**
   * Sets length of replaced text fragment
   *
   * @param length Length of replaced text fragment
   */
  public void setLength(Integer length) {
    this.length = length;
  }

  /**
   * Gets new content of document fragment
   *
   * @return Returns length of replaced text fragment
   */
  public String getNewContent() {
    return newContent;
  }

  /**
   * Sets new content of document fragment
   *
   * @param newContent New content of document fragment
   */
  public void setNewContent(String newContent) {
    this.newContent = newContent;
  }

  /**
   * Gets offset of replaced text fragment
   *
   * @return Returns offset of replaced text fragment
   */
  public Integer getOffset() {
    return offset;
  }

  /**
   * Sets offset of replaced text fragment
   *
   * @param offset Offset of replaced text fragment
   */
  public void setOffset(Integer offset) {
    this.offset = offset;
  }

  /**
   * Gets XPath of element in which modification was occurred
   *
   * @return Returns XPath of element in which modification was occurred
   */
  public String getPath() {
    return path;
  }

  /**
   * Sets XPath of element in which modification was occurred
   *
   * @param path XPath of element in which modification was occurred
   */
  public void setPath(String path) {
    this.path = path;
  }

  /**
   * Gets mode of text modification
   *
   * @return Returns mode of text modification replace/insertBefore/insertAfter
   */
  public Integer getMode() {
    return mode;
  }

  /**
   * Sets mode of text modification
   *
   * @return Returns mode of text modification replace/insertBefore/insertAfter
   */
  public void setMode(Integer mode) {
    this.mode = mode;
  }

  @Override
  public String toString() {
    return "TextModification{" + "path=" + path + "offset=" + offset + "length=" + length + "newContent=" + newContent + '}';
  }

  /**
   * Returns serialized informations about text modification in XML for protocol 1.x
   *
   * @return Returns serialized informations about text modification in XML
   */
  public String toXMLString() {
    String pathAttr = (path != null)? " path=\"" + path + "\"" : "";
    String offsetAttr = (offset != null)? " offset=\"" + offset + "\"" : "";
    String lengthAttr = (length != null)? " length=\"" + length + "\"" : "";

    // TODO: if mode != Constants.TEXT_MOD_REPLACE it will not work correctly
    //       It is necessary to transform such modification to supported mode
    //       and serialize in this mode.
    
    String resStr = "<textModification" + pathAttr;
    
    if (offset != null) {     // modification of the part of node (not whole)
       resStr += offsetAttr;
       resStr += lengthAttr;
    }
    
    if (newContent == null || newContent.isEmpty()) { // no new content == delete modification
       resStr += " />";
    } else {                  // new content == insert modification
       resStr += ">";
       resStr += "<![CDATA[";
       resStr += newContent;
       resStr += "]]>";
       resStr += "</textModification>";
    }
    
    return resStr;
  }

  /**
   * Returns serialized informations about text modification in XML for protocol V2
   *
   * @return Returns serialized informations about text modification in XML for protocol V2
   */
    public String toXMLStringV2(){
      String resStr = "";
      String pathStr = (path != null) ? "path=\"" + path + "\"" : "";
      String contentStr = "<![CDATA[";
      
      if(newContent != null){
        contentStr += newContent;
      }
      contentStr += "]]>";

      if(mode == Constants.TEXT_MOD_REPLACE){
        resStr = "<replace " + pathStr;
        resStr += (offset != null) ? " offset=\"" + offset + "\"" : "";
        resStr += (length != null) ? " length=\"" + length + "\"" : "";
        resStr += ">" + contentStr + "</replace>";
      }
      else if(mode == Constants.TEXT_MOD_INS_BEFORE){
        resStr = "<insertBefore " + pathStr + ">" + contentStr + "</insertBefore>";
      }
      else if(mode == Constants.TEXT_MOD_INS_AFTER){
        resStr = "<insertAfter " + pathStr + ">" + contentStr + "</insertAfter>";
      }
      
      return resStr;
    }

}  // class TextModification