SugPersonAttribute.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SugPersonAttribute.java
 * Description: Class representing attribute of type Person for peupose of suggestion
 */

package cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes;

import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.entity.User;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;

/**
 * @file SugPersonAttribute.java
 *
 * @brief Class representing attribute of type Person for peupose of suggestion
 */

/**
 * Class representing attribute of type Person for peupose of suggestion
 * 
 * @brief Class representing attribute of type Person for peupose of suggestion
 */
@Entity
@DiscriminatorValue("person")
@NamedQueries({
    @NamedQuery(name = "SuggestionAttribute.findByUserValue", query = "SELECT a FROM SuggestionAttribute a WHERE a.userValue = :userValue"),
})
public class SugPersonAttribute extends SugStructuredAttribute {
  /**
   * Constructor
   */
  public SugPersonAttribute() {
  }

  /**
   * Constructor of attribute of type Person
   *
   * @param name Name of attribute
   * @param person Value of attribute person (user)
   * @param refSuggestion Suggestion to which this attribute belongs
   */
  public SugPersonAttribute(String name, User person, Suggestion refSuggestion) {
    this.name = name;
    this.simpleType = "person";
    this.refSuggestion = refSuggestion;
    this.user = person;
  }

  /**
   * Gets value of the attribute
   * 
   * @return value of the attribute
   */
  @Override
  public Object getValue() {
    return this.user;
  }

  /**
   * Sets value of the attribute. Value should already be a native java value. 
   * 
   * @param person New value of the attribute
   */
  @Override
  public void setValue(Object person) {
    this.user = (User) person;
  }

  /**
   * XML of the structured attribute looks like this:
   * @verbatim
   * <a:attribute ...... >
   *     <nested>
   *         <value1>...</value1>
   *         <value2>...</value2>
   *     </nested>
   * </a:attribute>
   * @endverbatim
   * 
   * This method returns the content of the a:attribute element with all nested 
   * elements.
   * 
   * @return Returns the content of the a:attribute element with all nested elements.
   */
  @Override
  protected String getXmlBody() {
    return "<a:person id=\"" + user.getEmail() + "\"/>";
  }

  /**
   * Parses provided value and sets that value as a value of attribute
   * 
   * This method should not be used, because this type of attribute is processed 
   * in MessageProcessor.
   * 
   * @param values new value of the attribute in raw form from XML
   */
  @Override
  public void setRawValues(Object values) throws IllegalArgumentException {
    throw new UnsupportedOperationException("Server internal error.");
  }

  /**
   * XML of the structured attribute looks like this:
   * @verbatim
   * <a:attribute ...... >
   *     <nested>
   *         <value1>...</value1>
   *         <value2>...</value2>
   *     </nested>
   * </a:attribute>
   * @endverbatim
   * 
   * @return the name of the "nested" attribute , which is "Person" for this type
   */
  @Override
  public String getXmlAttributeName() {
    return "Person";
  }
  
  /**
   * Gets URI addres in ontology for this type of attribute
   * 
   * @return Return URI addres in ontology for this type of attribute.
   */
  @Override
  public String getTypeOntologyUri(){
      return Constants.PERSON_URI;
  }
}