P2MessagesCreator.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: P2MessagesCreator.java
 * Description: Class provides methods for transforming objects to messages.
 */

/**
 * @file P2MessagesCreator.java
 *
 * @brief Class provides methods for transforming objects to messages.
 */

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

import cz.vutbr.fit.knot.annotations.app.AppBean;
import cz.vutbr.fit.knot.annotations.entity.Settings;
import cz.vutbr.fit.knot.annotations.entity.User;
import cz.vutbr.fit.knot.annotations.entity.UserGroup;
import java.util.ArrayList;
import java.util.Iterator;

/**
 * Class provides methods for transforming objects to messages.
 *
 * @brief Class provides methods for transforming objects to messages
 * @author Martin Petr (xpetrm05)
 */
public class P2MessagesCreator {
  
  /**
   * Method makes string with XML line element. 
   * 
   * @param elementName name of lemeent
   * @param params paramethers of element
   * 
   * @return string with element
   */
  public static String lineXMLElement(String elementName, String params){
    StringBuilder result = new StringBuilder();
    result.append('<');
    result.append(elementName);
    result.append(' ');
    result.append(params);
    result.append("/>");
    return result.toString();
  }
  
  /**
   * Method makes string with XML block element.
   * 
   * @param elementName name of lemeent
   * @param params paramethers of element
   * @param value value of element
   * 
   * @return string with element
   */
  public static String blockXMLElement(String elementName, String params, String value){
    StringBuilder result = new StringBuilder();
    result.append('<');
    result.append(elementName);
    
    if(params != null){
      result.append(" ");
      result.append(params);
    }
    
    result.append('>');
    result.append(value);
    result.append("</");
    result.append(elementName);
    result.append('>');
    return result.toString();
  }
  
  /**
   * Method make string with XML parameter of element.
   * 
   * @param name name of parameter
   * @param value value of parameter
   * 
   * @return string with paramether
   */
  public static String XMLParam(String name, String value){
    StringBuilder result = new StringBuilder();
    result.append(name);
    result.append("=\"");
    result.append(value);
    result.append("\" ");
    return result.toString();
  }
    
  /**
   * Method create XML message "logged" message with informations about user as 
   * parameters. Here is example of message:
   * 
   * @verbatim
   * <logged uri="{user uri}"
   *   login="{user login}"
   *   name="{user name}"
   *   email="{user email address}"
   *   image="{URI of image of user}"/>
   * @endverbatim
   * 
   * @param user user that will be transform to message
   * @return string with message
   */
  public static String getXMLLoggedUser(User user){
    StringBuilder paramsString = new StringBuilder();
    
    paramsString.append(XMLParam("uri",user.getURIV2()));
    paramsString.append(XMLParam("login",user.getLogin()));
    paramsString.append(XMLParam("name",user.getName()));
    paramsString.append(XMLParam("email",user.getEmail()));
    paramsString.append(XMLParam("image",user.getImage()));
    
    return lineXMLElement("logged",paramsString.toString());
  }
  
  /**
   * Method create XML message "user" element with informations about user as 
   * parameters. Displayed parameters can be restricted. Here is example of message:
   * 
   * @verbatim
   * <user uri="{user uri}"
   *   login="{user login}"
   *   name="{user name}"
   *   email="{user email address}"
   *   image="{URI of image of user}"/>
   * 
   * or:
   * 
   * <user uri="{user uri}"
   *   login="{user login}"
   *   name="{user name}"
   *   email="{user email address}"
   *   image="{URI of image of user}">
   *    <groups>
   *      {list of groups}
   *    </groups>
   * </user>
   * @endverbatim
   * 
   * @param user user that will be transform to message
   * @param params boolean array that inform which parameter will be include in 
   *               final message if it's null all parameters will be include
   * @return string with message
   */
  public static String getXMLUser(User user, boolean params[]){
    StringBuilder paramsString = new StringBuilder();
    
    if(params == null || params[P2Constants.USER_URI_ATTR]){
      paramsString.append(XMLParam("uri",AppBean.getBaseUserUriV2() + user.getId().toString()));
    }
    
    if(params == null || params[P2Constants.USER_LOGIN_ATTR]){
      paramsString.append(XMLParam("login",user.getLogin()));
    }
    
    if(params == null || params[P2Constants.USER_NAME_ATTR]){
      paramsString.append(XMLParam("name",user.getName()));
    }
    
    if(params == null || params[P2Constants.USER_EMAIL_ATTR]){
      paramsString.append(XMLParam("email",user.getEmail()));
    }
    
    if(params == null || params[P2Constants.USER_IMAGE_ATTR]){
      paramsString.append(XMLParam("image",user.getImage()));
    }

    if(params[P2Constants.USER_GROUPS_ATTR]){
      Iterator<UserGroup> groupsList = user.getGroups().iterator();
      StringBuilder groups = new StringBuilder();
      
      while(groupsList.hasNext()){
        UserGroup currentGroup = groupsList.next();
        String groupParam = XMLParam("uri",currentGroup.getUri());
        groups.append(lineXMLElement("group",groupParam));
      }
      
      return blockXMLElement("user",paramsString.toString(),groups.toString());
    }else{
      return lineXMLElement("user",paramsString.toString());
    }
  }
  
  /**
   * The method creates a XML message with a list of users. Here is example 
   * of message:
   * 
   * @verbatim
   * <users>
   *   {list of users}
   * </users>
   * @endverbatim
   * 
   * @param users list of users
   * @param params restrictions for users parameters
   * @return message with a list of users
   */
  public static String getXMLUsersList(ArrayList<User> users, boolean params[]){
    StringBuilder result = new StringBuilder();
    Iterator<User> usersIt = users.iterator();
    
    while(usersIt.hasNext()){
      result.append(getXMLUser(usersIt.next(),params));
    }
    
    return blockXMLElement("users",null,result.toString());
  }
  
  /**
   * The method creates a XML message with a list of users groups. Here is example 
   * of message:
   * 
   * @verbatim
   * <userGroups>
   *   {list of users groups}
   * </userGroups>
   * @endverbatim
   * 
   * @param groups list of users groups
   * @param params restrictions for users parameters in groups
   * @param withUsers users in group will be included if value is true
   * @return message with a list of users groups
   */
  public static String getXMLGroupsList(ArrayList<UserGroup> groups, boolean withUsers, boolean params[]){
    StringBuilder result = new StringBuilder();
    Iterator<UserGroup> groupsIt = groups.iterator();
    
    while(groupsIt.hasNext()){
      result.append(getXMLGroup(groupsIt.next(),withUsers,params));
    }
    
    return blockXMLElement("userGroups",null,result.toString());
  }
  
  /**
   * Method create XML message "group" element with informations about users group 
   * as parameters wit or without users in group. Displayed parameters of users 
   * can be restricted. Here is example of message:
   * 
   * @verbatim
   * <group name="{group name}"
   *  uri="{URI of group}">
   *    {list of users in group}
   * </group>
   * @endverbatim
   * 
   * @param group users group 
   * @param withUsers users in group will be included if value is true
   * @param params restrictions for users parameters in groups
   * @return XML message with users group
   */
  public static String getXMLGroup(UserGroup group, boolean withUsers, boolean params[]){
    StringBuilder value = new StringBuilder();
    StringBuilder groupParams = new StringBuilder();
    
    // make parameters
    groupParams.append(XMLParam("name",group.getName()));
    groupParams.append(XMLParam("uri",group.getUri()));
    
    if(withUsers){
      // get all users in current group
      Iterator<User> usersIt = group.getUsers().iterator();
      while(usersIt.hasNext()){
        value.append(getXMLUser(usersIt.next(),params));
      }

      String elementValue = blockXMLElement("users",null,value.toString());
      return blockXMLElement("group",groupParams.toString(),elementValue);
    }else{
      return lineXMLElement("group", groupParams.toString());
    }
  }
  
  /**
   * Method create XML message "settings" element with informations about users 
   * settings. Here is example of message:
   * 
   * @verbatim
   * <settings>
   *    {list of users settings}
   * </settings>
   * @endverbatim
   * 
   * @param settings array with user settings
   * @return XML message with users settings
   */
  public static String getXMLUserSettings(ArrayList<Settings> settings){
    StringBuilder result = new StringBuilder("<settings>");
    
    Iterator<Settings> settingsIt = settings.iterator();
    while(settingsIt.hasNext()){
      result.append(settingsIt.next().toXMLString());
    }
    result.append("</settings>");
    return result.toString();
  }
}  // public class P2MessagesCreator