SugDurationAttribute.java

Go to the documentation of this file.

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

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

import cz.vutbr.fit.knot.annotations.app.Constants;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.xml.datatype.DatatypeFactory;
import javax.xml.datatype.Duration;

/**
 * @file SugDurationAttribute.java
 *
 * @brief Class representing attribute of type Duration for prupose of suggestion
 */

/**
 * Class representing attribute of type Duration
 * 
 * @brief Class representing attribute of type Duration for prupose of suggestion
 */
@Entity
@DiscriminatorValue("Duration")
public class SugDurationAttribute extends SugBaseAttribute {
  
  /**
   * Gets value of the attribute
   * 
   * @return object of type Duration
   */
  @Override
  public Object getValue() {
    try {
      return (Object) DatatypeFactory.newInstance().newDuration(this.stringValue);
    } catch (Exception e) {
      return null;
    }
  }
    
  /**
   * Returns string representation of duration according to RFC 3339
   * 
   * @return string representation of duration according to RFC 3339
   */
  @Override
  public String getStringValue() {
    return this.stringValue;
  }

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

  /**
   * Parses provided value and sets that value as a value of attribute
   * 
   * @param value new value of the attribute in raw form from XML
   */
  @Override
  public void setRawValue(String value) throws IllegalArgumentException {
    try {
      Duration d = DatatypeFactory.newInstance().newDuration(value);
      this.stringValue = d.toString();
    } catch (Exception e) {
      throw new IllegalArgumentException("Value " + value 
        + " is not a valid Duration value according to http://www.w3.org/TR/xmlschema-2/#duration");
    }
  }

  /**
   * 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 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.DURATION_URI;
  }
}