CloneParams.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: CloneParams.java
 * Description: Class representing paramethers for document cloning
 */

/**
 * @file CloneParams.java
 *
 * @brief Class representing paramethers for document cloning
 */

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

import cz.vutbr.fit.knot.annotations.entity.AnnotDocument;
import java.util.ArrayList;
import java.util.Iterator;
import javax.servlet.http.HttpServletRequest;
import org.w3c.dom.Document;

/**
 * Class representing paramethers for document cloning.
 *
 * @brief Class representing paramethers for document cloning
 * @author Martin Petr (xpetrm05)
 */
public class CloneParams {
  /** Document clone request from servlet */
  private HttpServletRequest request;
  
  /** Content of new cloned document */
  private String newDocumentContent;
  
  /** Uri of old clonned document */
  private String oldDocumentUri;
  
  /** New uri of document */
  private String newDocumentUri;
  
  /** Old document */
  private AnnotDocument oldDocument;
  
  /** New clonned document */
  private AnnotDocument newDocument;
  
  /** Parsed document with new content */
  private Document parsedDoc;
  
  /** List of clonned annotations */
  private ArrayList<AnnotCloneItem> cloneAnnotations;

  /**
   * Constructor
   */
  public CloneParams() {
    cloneAnnotations = new ArrayList<AnnotCloneItem>();
  }

  /**
   * Constructor
   * 
   * @param request document clone request from servlet
   */
  public CloneParams(HttpServletRequest request) {
    cloneAnnotations = new ArrayList<AnnotCloneItem>();
    this.request = request;
  }

  /**
   * Gets document clone request from servlet.
   * 
   * @return document clone request from servlet.
   */
  public HttpServletRequest getRequest() {
    return request;
  }

  /**
   * Sets document clone request from servlet.
   * 
   * @param request document clone request from servlet.
   */
  public void setRequest(HttpServletRequest request) {
    this.request = request;
  }

  /**
   * Gets content of new cloned document.
   * 
   * @return content of new cloned document.
   */
  public String getNewDocumentContent() {
    return newDocumentContent;
  }

  /**
   * Sets content of new cloned document.
   * 
   * @param newDocumentContent content of new cloned document.
   */
  public void setNewDocumentContent(String newDocumentContent) {
    this.newDocumentContent = newDocumentContent;
  }

  /**
   * Gets uri of old clonned document.
   * 
   * @return uri of old clonned document.
   */
  public String getOldDocumentUri() {
    return oldDocumentUri;
  }

  /**
   * Sets uri of old clonned document.
   * 
   * @param oldDocumentUri uri of old clonned document.
   */
  public void setOldDocumentUri(String oldDocumentUri) {
    this.oldDocumentUri = oldDocumentUri;
  }

  /**
   * Gets new uri of document.
   * 
   * @return new uri of document.
   */
  public String getNewDocumentUri() {
    return newDocumentUri;
  }

  /**
   * Sets new uri of document.
   * 
   * @param newDocumentUri new uri of document.
   */
  public void setNewDocumentUri(String newDocumentUri) {
    this.newDocumentUri = newDocumentUri;
  }

  /**
   * Gets old document.
   * 
   * @return old document.
   */
  public AnnotDocument getOldDocument() {
    return oldDocument;
  }

  /**
   * Sets old document.
   * 
   * @param oldDocument old document
   */
  public void setOldDocument(AnnotDocument oldDocument) {
    this.oldDocument = oldDocument;
  }

  /**
   * Gets new clonned document.
   * 
   * @return new clonned document
   */
  public AnnotDocument getNewDocument() {
    return newDocument;
  }

  /**
   * Sets new clonned document.
   * 
   * @param newDocument new clonned document
   */
  public void setNewDocument(AnnotDocument newDocument) {
    this.newDocument = newDocument;
  }

  /**
   * Gets parsed document with new content.
   * 
   * @return parsed document with new content
   */
  public Document getParsedDoc() {
    return parsedDoc;
  }

  /**
   * Sets parsed document with new content.
   * 
   * @param parsedDoc parsed document with new content
   */
  public void setParsedDoc(Document parsedDoc) {
    this.parsedDoc = parsedDoc;
  }
  
  /**
   * Gets list of clonned annotations.
   * 
   * @return list of clonned annotations
   */
  ArrayList<AnnotCloneItem> getCloneAnnotations(){
    return this.cloneAnnotations;
  }
  
  /**
   * Sets add clonned annotation to list.
   * 
   * @param cloneAnnotationInfo clonned annotation
   */
  public void addCloneAnnotation(AnnotCloneItem cloneAnnotationInfo){
    cloneAnnotations.add(cloneAnnotationInfo);
  }
  
  /**
   * Method finds clonned annotation by id in old document.
   * 
   * @param oldId id of annotation in old document
   * @return clonned annotation founded by old id
   */
  public AnnotCloneItem findCloneAnnotation(Integer oldId){
    Iterator<AnnotCloneItem> cloneAnnotIt = cloneAnnotations.iterator();
    while(cloneAnnotIt.hasNext()){
      AnnotCloneItem currentItem = cloneAnnotIt.next();
      if(currentItem.getOldId().equals(oldId)){
        return currentItem;
      }
    }
    return null;
  }

  @Override
  public String toString() {
    return "CloneParams{" + 
            "request=" + request + 
            ", newDocumentContent=" + newDocumentContent + 
            ", oldDocumentUri=" + oldDocumentUri + 
            ", newDocumentUri=" + newDocumentUri + 
            ", oldDocument=" + oldDocument + 
            ", newDocument=" + newDocument + '}';
  }
}  // public class CloneParams