Flier.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: Flier.java
 * Description: Class for representing flier with informations for comet handlers
 */

/**
 * @file Flier.java
 *
 * @brief Flier with informations for comet handlers
 */

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

import cz.vutbr.fit.knot.annotations.app.TextModification;
import cz.vutbr.fit.knot.annotations.entity.AnnotType;
import cz.vutbr.fit.knot.annotations.entity.Annotation;
import cz.vutbr.fit.knot.annotations.entity.Subscription;
import java.util.ArrayList;
import java.util.Iterator;

/**
 * Class for representing flier with informations for comet handlers.
 * It's created as part of informations about client request (class RequestInfo)
 * and then sent to all comet handlers to process.
 * 
 * @brief Flier with informations for comet handlers
 * @author idytrych
 */
public class Flier {
  /** List of added annotations */
  private ArrayList<Annotation> addedAnnotations;
  /** List of changed annotations */
  private ArrayList<Annotation> editedAnnotations;
  /** List of removed annotations */
  private ArrayList<Annotation> removedAnnotations;
  /** List of removed nested annotations (due attribute changes) */
  private ArrayList<Annotation> removedNestedAnnotations;
  /** List of automatically updated annotations */
  private ArrayList<Annotation> autoUpdatedAnnotations;

  /** List of added annotation types */
  private ArrayList<AnnotType> addedTypes;
  /** List of changed annotation types */
  private ArrayList<AnnotType> editedTypes;
  /** List of removed annotation types */
  private ArrayList<AnnotType> removedTypes;

  /** List of annotated document text modifications */
  private ArrayList<TextModification> textModifications;
  /** List of annotated document reverse text modifications */
  private ArrayList<TextModification> reverseTextModifications;
  /** Text modification set ID */
  private int textModificationSetID;

  /** Id of session from which this flier originated */
  private Long CreatedInSessId = null;
  /** Session from which this flier originated */
  private EditorSession CreatedInSession = null;
  /** List of newly added subscriptions */
  ArrayList<Subscription> newSubscriptions = null;
  /** List of changed subscriptions */
  ArrayList<Subscription> changedSubscriptions = null;
  /** Array of tmp and serv uri pairs of just added annotations */
  private ArrayList<ArrayList<String>> justAddedAnnotations;

  /**
   * Constructor (initialize arrays)
   */
  public Flier() {
    this.addedAnnotations = new ArrayList<Annotation>();
    this.editedAnnotations = new ArrayList<Annotation>();
    this.removedAnnotations = new ArrayList<Annotation>();
    this.removedNestedAnnotations = new ArrayList<Annotation>();
    this.autoUpdatedAnnotations = new ArrayList<Annotation>();
    this.addedTypes = new ArrayList<AnnotType>();
    this.editedTypes = new ArrayList<AnnotType>();
    this.removedTypes = new ArrayList<AnnotType>();
    this.textModifications = new ArrayList<TextModification>();
    this.reverseTextModifications = new ArrayList<TextModification>();
    this.newSubscriptions = new ArrayList<Subscription>();
    this.changedSubscriptions = new ArrayList<Subscription>();
    this.justAddedAnnotations = new ArrayList<ArrayList<String>>();
  }

  /**
   * Gets list of added annotations
   *
   * @return Returns list of added annotations
   */
  public ArrayList<Annotation> getAddedAnnotations() {
    return addedAnnotations;
  }

  /**
   * Gets list of added annotation types
   *
   * @return Returns list of added annotation types
   */
  public ArrayList<AnnotType> getAddedTypes() {
    return addedTypes;
  }

  /**
   * Gets list of changed annotations
   *
   * @return Returns list of changed annotations
   */
  public ArrayList<Annotation> getEditedAnnotations() {
    return editedAnnotations;
  }

  /**
   * Gets list of changed annotation types
   *
   * @return Returns list of changed annotation types
   */
  public ArrayList<AnnotType> getEditedTypes() {
    return editedTypes;
  }

  /**
   * Gets list of removed annotations
   *
   * @return Returns list of removed annotations
   */
  public ArrayList<Annotation> getRemovedAnnotations() {
    return removedAnnotations;
  }

  /**
   * Gets list of removed nested annotations (due attribute changes)
   *
   * @return Returns list of removed nested annotations
   */
  public ArrayList<Annotation> getRemovedNestedAnnotations() {
    return removedNestedAnnotations;
  }
  
  /**
   * Gets list of removed annotation types
   *
   * @return Returns list of removed annotation types
   */
  public ArrayList<AnnotType> getRemovedTypes() {
    return removedTypes;
  }

  /**
   * Gets list of annotated document text modifications
   *
   * @return Returns list of annotated document text modifications
   */
  public ArrayList<TextModification> getTextModifications() {
    return textModifications;
  }

  /**
   * Gets list of annotated document reverse text modifications
   *
   * @return Returns list of annotated document reverse text modifications
   */
  public ArrayList<TextModification> getReverseTextModifications() {
    return reverseTextModifications;
  }
  
  /**
   * Adds added annotation to the list
   *
   * @param annotation Added annotation
   */
  public void AddAddedAnnotation(Annotation annotation) {
    addedAnnotations.add(annotation);
  }

  /**
   * Sets added annotations 
   *
   * @param annotations Added annotations in list
   */
  public void setAddedAnnotations(ArrayList<Annotation> annotations) {
    addedAnnotations = annotations;
  }
  
  /**
   * Adds changed annotation to the list
   *
   * @param annotation Changed annotation
   */
  public void AddEditedAnnotation(Annotation annotation) {
    editedAnnotations.add(annotation);
  }

  /**
   * Adds removed annotation to the list
   *
   * @param annotation Removed annotation
   */
  public void AddRemovedAnnotation(Annotation annotation) {
    removedAnnotations.add(annotation);
  }

  /**
   * Adds removed nested annotation to the list
   *
   * @param annotation Removed nested annotation
   */
  public void AddRemovedNestedAnnotation(Annotation annotation) {
    removedNestedAnnotations.add(annotation);
  }
  
  /**
   * Gets list of automatically updated annotations
   *
   * @return Returns list of automatically updated annotations
   */
  public ArrayList<Annotation> getAutoUpdatedAnnotations() {
    return autoUpdatedAnnotations;
  }

  /**
   * Sets list of automatically updated annotations
   *
   * @param autoUpdatedAnnotations List of automatically updated annotations
   */
  public void setAutoUpdatedAnnotations(ArrayList<Annotation> autoUpdatedAnnotations) {
    this.autoUpdatedAnnotations = autoUpdatedAnnotations;
  }

  /**
   * Adds automatically updated annotation to the list
   *
   * @param autoUpdatedAnnotation Automatically updated annotation
   */
  public void addAutoUpdatedAnnotation(Annotation autoUpdatedAnnotation) {
    this.autoUpdatedAnnotations.add(autoUpdatedAnnotation);
  }

  /**
   * Adds added annotation type to the list
   *
   * @param annotType Added annotation type
   */
  public void AddAddedType(AnnotType annotType) {
    addedTypes.add(annotType);
  }

  /**
   * Adds changed annotation type to the list
   *
   * @param annotType Changed annotation type
   */
  public void AddEditedType(AnnotType annotType) {
    editedTypes.add(annotType);
  }

  /**
   * Adds removed annotation type to the list
   *
   * @param annotType Removed annotation type
   */
  public void AddRemovedType(AnnotType annotType) {
    removedTypes.add(annotType);
  }

  /**
   * Adds annotated document text modification to the list
   *
   * @param modification Annotated document text modification
   */
  public void AddTextModification(TextModification modification) {
    textModifications.add(modification);
  }


  /**
   * Sets the list of annotated document text modifications
   *
   * @param textModifications List of annotated document text modifications
   */
  public void setTextModifications(ArrayList<TextModification> textModifications) {
    this.textModifications = textModifications;
  }

  /**
   * Sets the list of annotated document reverse text modifications
   *
   * @param reverseTextModifications List of annotated document reverse text modifications
   */
  public void setReverseTextModifications(ArrayList<TextModification> reverseTextModifications) {
    this.reverseTextModifications = reverseTextModifications;
  }
  
  /**
   * Gets id of session from which this flier originated
   *
   * @return Returns id of session from which this flier originated
   */
  public Long getCreatedInSessId() {
    return CreatedInSessId;
  }

  /**
   * Sets id of session from which this flier originated
   *
   * @param CreatedInSessId Id of session from which this flier originated
   */
  public void setCreatedInSessId(long CreatedInSessId) {
    this.CreatedInSessId = CreatedInSessId;
  }

  /**
   * Gets session from which this flier originated
   *
   * @return Returns session from which this flier originated
   */
  public EditorSession getCreatedInSession() {
    return CreatedInSession;
  }

  /**
   * Sets session from which this flier originated
   *
   * @param CreatedInSession Session from which this flier originated
   */
  public void setCreatedInSession(EditorSession CreatedInSession) {
    this.CreatedInSession = CreatedInSession;
  }
  
  /**
   * Gets list of newly added subscriptions
   * 
   * @return Returns list of newly added subscriptions
   */
  public ArrayList<Subscription> getNewSubscriptions() {
    return newSubscriptions;
  }

  /**
   * Adds new subscription into list of newly added subscriptions
   * 
   * @param newSubscription New subscription to add
   */
  public void addNewSubscription(Subscription newSubscription) {
    this.newSubscriptions.add(newSubscription);
  }

  /**
   * Sets list of newly added subscriptions
   * 
   * @param newSubscriptions List of newly added subscriptions
   */
  public void setNewSubscriptions(ArrayList<Subscription> newSubscriptions) {
    this.newSubscriptions = newSubscriptions;
  }
  
  /**
   * Gets list of changed subscriptions.
   * 
   * @return list of changed subscriptions
   */
  public ArrayList<Subscription> getChangedSubscriptions() {
    return changedSubscriptions;
  }

  /**
   * Set list of changed subscriptions.
   * 
   * @param changedSubscriptions list of changed subscriptions
   */
  public void setChangedSubscriptions(ArrayList<Subscription> changedSubscriptions) {
    this.changedSubscriptions = changedSubscriptions;
  }
  
  /**
   * Adds changed subscription into list of changed subscriptions.
   * 
   * @param changedSubscription changed suscription to add
   */
  public void addChangedSubscription(Subscription changedSubscription) {
    this.changedSubscriptions.add(changedSubscription);
  }

  /**
   * Sets list of changed annotations
   * 
   * @param editedAnnotations List of changed annotations
   */
  public void setEditedAnnotations(ArrayList<Annotation> editedAnnotations) {
    this.editedAnnotations = editedAnnotations;
  }
  
  /**
   * Sets text modification set ID
   * 
   * @param id Text modification set ID
   */
  public void setTextModificationSetID(int id){
    this.textModificationSetID = id;
  }
  
  /**
   * Gets text modification set ID
   * 
   * @return Returns text modification set ID
   */
  public int getTextModificationSetID(){
    return this.textModificationSetID;
  }
  
  /**
   * Add pair of uris for just added annotation to list.
   * 
   * @param tmpUri temporary uri of just added annotation
   * @param serverUri server uri of just added annotation
   */
  public void addJustAddedAnnotation(String tmpUri, String serverUri){
    ArrayList<String> justAddedAnnot = new ArrayList<String>(2);
    justAddedAnnot.add(tmpUri);
    justAddedAnnot.add(serverUri);
    
    this.justAddedAnnotations.add(justAddedAnnot);
  }
  
  /**
   * Delete pair of uris of just added annotation from list.
   * 
   * @param serverUri server uri of searched couple
   */
  public void deleteTmpUri(String serverUri){
    Iterator<ArrayList<String>> addedIt = justAddedAnnotations.iterator();
    while(addedIt.hasNext()){
      ArrayList<String> addedAnnot = addedIt.next();
      if(addedAnnot.get(1).equals(serverUri)){
        String result = addedAnnot.get(0);
        addedIt.remove();
      }
    }
  } 
  
  /**
   * Finds temporary uri of just added annotation according to server uri.
   * 
   * @param serverUri server uri of searched couple
   * 
   * @return temporary uri of annotation
   */
  public String getTmpUri(String serverUri){
    Iterator<ArrayList<String>> addedIt = justAddedAnnotations.iterator();
    while(addedIt.hasNext()){
      ArrayList<String> addedAnnot = addedIt.next();
      if(addedAnnot.get(1).equals(serverUri)){
        String result = addedAnnot.get(0);
        return result;
      }
    }
    
    return null;
  } 
  
  /**
   * Tests if there is pair with given server uri.
   * 
   * @param serverUri server uri of searched couple
   * 
   * @return true if found, false otherwise
   */
  public boolean isInJustAdded(String serverUri){
    Iterator<ArrayList<String>> addedIt = justAddedAnnotations.iterator();
    while(addedIt.hasNext()){
      ArrayList<String> addedAnnot = addedIt.next();
      if(addedAnnot.get(1).equals(serverUri)){
        return true;
      }
    }
    
    return false;
  }
  
}  // class Flier