SugStringAttribute.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SugStringAttribute.java
 * Description: Class representing attribute of type String for prupose 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.modules.suggestionManager.Suggestion;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;

/**
 * @file SugStringAttribute.java
 *
 * @brief Class representing attribute of type String for prupose of suggestion. 
 * Also provides functions for other string based attributes such as ImageUri, URI, ...
 */

/**
 * Class representing attribute of type String for prupose of suggestion. 
 * Also provides functions for other string based attributes such as ImageUri, URI, ...
 * 
 * @brief Class representing attribute of type String for prupose of suggestion
 */
@Entity
@DiscriminatorValue(value="String")
@NamedQueries({
    @NamedQuery(name = "SuggestionAttribute.findByStringValue", query = "SELECT a FROM SuggestionAttribute a WHERE a.stringValue = :stringValue"),
})
public class SugStringAttribute extends SugBaseAttribute{
   /**
   * Constructor
   */
  public SugStringAttribute() {
  }

  /**
   * Constructor
   * 
   * @param name Name of the attribute
   * @param value Value of the attribute
   * @param refSuggestion Suggestion to which this attribute belongs
   */
  public SugStringAttribute(String name, String value, Suggestion refSuggestion) {
    this.name = name;
    this.simpleType = "String";
    this.stringValue = value;
    this.refSuggestion = refSuggestion;
  }

  /**
   * Constructor
   * 
   * @param name Name of the attribute
   * @param value Value of the attribute
   * @param refSuggestion Suggestion to which this attribute belongs
   * @param priority Priority of attribute
   */
  public SugStringAttribute(String name, String value, Suggestion refSuggestion, Integer priority) {
    this.name = name;
    this.simpleType = "String";
    this.stringValue = value;
    this.refSuggestion = refSuggestion;
    this.priority = priority;
  }
  
  /**
   * Checks if attribute value is empty or default value
   * 
   * @return true, if attribute value is empty
   */
  @Override
  public boolean isEmpty() {
    return stringValue == null || stringValue.equals("");
  }

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

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

  /**
   * For string based attributes parseValue is exactly the same as setValue
   * 
   * @param value value to be parsed
   */
  @Override
  public void setRawValue(String value) {
    this.stringValue = value;
  }
  
  /**
   * 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.STRING_URI;
  }
}