StoryScope.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: StoryScope.java
 * Description: Class representing StoryScope for needs of Storyscope Interface
 */

/**
 * @file StoryScope.java
 *
 * @brief Class representing StoryScope for needs of Storyscope Interface
 */

package cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface;

import cz.vutbr.fit.knot.annotations.app.AppBean;
import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.comet.SubscribedSource;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.persistence.Basic;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;
import javax.persistence.Transient;


/**
 * This class represent StoryScope for needs of SEC Interface.
 *
 * @brief Class representing StoryScope for needs of SEC Interface.
 * @author Martin Petr (xpetrm05)
 */
@Entity
@Table(name = "storyScopes")
@NamedQueries({
  @NamedQuery(name = "StoryScope.findAll", query = "SELECT s FROM StoryScope s"),
  @NamedQuery(name = "StoryScope.findById", query = "SELECT s FROM StoryScope s WHERE s.id = :id")})
public class StoryScope implements Serializable {
  /** ID of StoryScope */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  
  /** Name of StoryScope */
  @Basic(optional = false)
  @Column(name = "name")
  private String name;
  
  /** URL address of SEC Client */
  @Basic(optional = false)
  @Column(name = "clientUrl")
  private String clientURL;
  /** Array of add messages */
  @Transient
  private ArrayList<String> addMessages = null;
  /** Array of change messages */
  @Transient
  private ArrayList<String> changeMessages = null;
  /** Array of remove messages */
  @Transient
  private ArrayList<String> deleteMessages = null;
  
  /**
   * Constructor
   */
  public StoryScope() {
  }
  
  /**
   * Constructor
   * 
   * @param id ID of StoryScope
   * @param name name of StoryScope
   * @param clientURL URL address of SEC Client
   */
  public StoryScope(Integer id, String name, String clientURL){
    this.id = id;
    this.name = name;
    this.clientURL = clientURL;
  }
  
  /**
   * Gets id of StoryScope
   *
   * @return Returns id of StoryScope
   */
  public Integer getId() {
    return id;
  }
  
  /**
   * Sets id of StoryScope
   *
   * @param id Id of StoryScope
   */
  public void setId(Integer id) {
    this.id = id;
  }
  
  /**
   * Gets name of StoryScope
   *
   * @return Returns name of StoryScope
   */
  public String getName() {
    return name;
  }
  
  /**
   * Sets name of StoryScope
   *
   * @param name Name of StoryScope
   */
  public void setName(String name) {
    this.name = name;
  }
  
  /**
   * Gets URL addres of SEC Client of StoryScope
   *
   * @return Returns URL address of SEC client of StoryScope
   */
  public String getClientURL() {
    return clientURL;
  }
  
  /**
   * Sets URL addres of SEC Client of StoryScope
   *
   * @param clientURL URL addres of SEC Client
   */
  public void setClientURL(String clientURL) {
    this.clientURL = clientURL;
  }
  
  /**
   * Gets list of all subscriptions for StoryScope
   *
   * @return List of subscriptions
   */
  public List<Object> getSubscriptions() {
    Object[] params = {"storyScope", id};
    @SuppressWarnings("unchecked")
    List<Object> retList = AppBean.getPersistenceManager().queryDB("SubscribedItem.findSubscribed", params);
    
    return retList;
  }

  /**
   * Gets array list of subscribed sources for StoryScope converted to
   * SubscribeSource
   * objects.
   *
   * @return Array list of subscribed sources
   */
  public ArrayList<SubscribedSource> getSubscribedList(){
    Object[] params = {"storyScope",id};
    
    @SuppressWarnings("unchecked")
    ArrayList<SubscribedSource> retList = this.makeArrayList(AppBean.getPersistenceManager().queryDB("SubscribedItem.findSubscribed",params));
    
    return retList;
  }
  
  /**
   * Gets array list of unsubscribed sources for StoryScope converted 
   * to SubscribedSource objects.
   *
   * @return Array list of unsubscribed sources
   */
  public ArrayList<SubscribedSource> getUnsubscribedList(){
    Object[] params = {"storyScope",id};
    
    @SuppressWarnings("unchecked")
    ArrayList<SubscribedSource> retList = this.makeArrayList(AppBean.getPersistenceManager().queryDB("SubscribedItem.findUnsubscribed",params));
    
    return retList;
  }

  /**
   * Gets string with all messages with added annotations for current StoryScope
   * that can't be delivered before.
   *
   * @return String with added annotations messages
   */
  public String getMessagesAdd(){
      return messagesToString(savedMessagesToAL(getSavedMessagesFromDB(SavedMessage.MESSAGE_ADD)));
  }
  
  /**
   * Gets string with all messages with changed annotations for current StoryScope 
   * that can't be delivered before.
   *
   * @return String with changed annotations messages
   */
  public String getMessagesChange(){
    return messagesToString(savedMessagesToAL(getSavedMessagesFromDB(SavedMessage.MESSAGE_CHANGE)));
  }
  
  /**
   * Gets string with all messages with deleted annotations for current StoryScope 
   * that can't be delivered before.
   *
   * @return String with deleted annotations messages
   */
  public String getMessagesDelete(){
    return messagesToString(savedMessagesToAL(getSavedMessagesFromDB(SavedMessage.MESSAGE_DELETE)));
  }
  
  /**
   * Method deletes all messages with annotations for current StoryScope.
   */
  public void deleteMessages(){
    Object[] params = {"storyScopeId",id};
    // get all saved messages for current StoryScope from DB
    @SuppressWarnings("unchecked")
    List<SavedMessage> messages =  AppBean.getPersistenceManager().queryDB("SavedMessage.findByStoryScopeId",params);
    
    //if there is no message in DB , nothing to do here
    if(messages != null){
      Iterator <SavedMessage> messagesIt = messages.iterator();
      while(messagesIt.hasNext()){
        //delete all founded saved messages from DB
        if(AppBean.getPersistenceManager().removeEntity(messagesIt.next())){
          if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
            String msg = "DB failure during deleting saved message form StoryScope account.";
            Logger.getLogger(StoryScope.class.getName()).log(Level.SEVERE, msg);
          }
        }
      }
    }
  }
  
  /**
   * Add new undelivered messages (one kind of messages) to StoryScope into
   * database
   *
   * @param messages list of undelivered messages
   * @param type of messages
   */
  public void addSavedMessages(ArrayList<String> messages, int type){
    Iterator<String> messagesIt = messages.iterator();
    while(messagesIt.hasNext()){
      //go trough the list 
      SavedMessage newSavedMessage = new SavedMessage(id,type,messagesIt.next());
      //try to save all new undelivered messages
      if(AppBean.getPersistenceManager().persistEntity(newSavedMessage)){
        if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
          String msg = "DB failure during saving message for StoryScope account.";
          Logger.getLogger(StoryScope.class.getName()).log(Level.SEVERE, msg);
        }
      }
    }
  }
  
  @Override
  public int hashCode() {
    int hash = 0;
    hash += (id != null ? id.hashCode() : 0);
    return hash;
  }
  
  /**
   * Compares this with other object and returns, whether objects are same type
   * and have same id.
   *
   * @param object Object to compare with
   * @return If object is same type and have same id, returns true, false otherwise
   */
  @Override
  public boolean equals(Object object) {
    if (!(object instanceof SubscribedItem)) {
      return false;
    }
    StoryScope tested = (StoryScope) object;
    if ((this.id == null && tested.id != null) || (this.id != null && !this.id.equals(tested.id))) {
      return false;
    }
    return true;
  }
  
  @Override
  public String toString() {
    return "cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope[id=" + id + ", name=" + name + ", client URL=" + clientURL + "]";
  }
  
  /**
   * Method converts list of SubscribedItems to ArrayList of SubscribedSources
   * that is used in SEC module and other parts of server.
   *
   * @param objList list of SubscribedItems to convert
   * @return Array list of subscriptions
   */
  private ArrayList<SubscribedSource> makeArrayList(List<SubscribedItem> objList){
    if(objList == null || objList.isEmpty()) return null;
    ArrayList <SubscribedSource> arrList = new ArrayList <SubscribedSource>();
    Iterator objListIterator = objList.iterator();

    while(objListIterator.hasNext()){
      
      SubscribedItem listElement = (SubscribedItem) objListIterator.next();
      String type = "*";
      String user = null;
      String source = null;
      
      if(listElement.getAnnotationType() != null){
        type = listElement.getAnnotationType().getUri();
      }
      
      if(listElement.getUser() != null){
        user = listElement.getUser().getURI();
      }
      if(listElement.getSource() != null){
        source = listElement.getSource();
      }
      
      SubscribedSource newSource = new SubscribedSource(type,user,source); 
      arrList.add(newSource);
    }
    
    return arrList;
  }
  
 /**
   * Method convert list of saved messages object to list of strings with messages 
   * (string representation of messages) for StoryScope.
   *
   * @param savedMessages list of saved messages to convert
   * @return Array list of strings with messages
   */
  private ArrayList<String> savedMessagesToAL(List<SavedMessage> savedMessages){
    ArrayList<String> result = new ArrayList<String>();
    if(savedMessages != null)
    {
      Iterator<SavedMessage> messagesIt = savedMessages.iterator(); 
      while(messagesIt.hasNext()){
        result.add(messagesIt.next().getMessage());
      }
    }
    return result;
  }
  
  /**
   * Method convert array strins with messages for StoryScope to one string object
   * that contains all messages. 
   *
   * @param messages list of saved messages to convert
   * @return String with messages all together
   */
  public static String messagesToString(ArrayList<String> messages){
    Iterator<String> messagesIt = messages.iterator();
    String result = "";
    while(messagesIt.hasNext()){
      result += messagesIt.next();
    }
    return result;
  }
  
  /**
   * Method gets saved messages of specific type (and for current StorySapce)
   * from database.
   *
   * @param typeOfMessages type of messages that will be returned
   * @return List of saved messages of specific type
   */
  private List<SavedMessage> getSavedMessagesFromDB(int typeOfMessages){
    Object[] params = {"storyScopeId",id,
                      "messageType",typeOfMessages};
    @SuppressWarnings("unchecked")
    List<SavedMessage> retList = AppBean.getPersistenceManager().queryDB("SavedMessage.findByStoryScopeAndType",params);
    
    return retList;
  }
  
} // class StoryScope