DurationAttribute.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz, Jan Planer xplane01@stud.fit.vutbr.cz
 * File: DurationAttribute.java
 * Description: Class representing attribute of type Duration
 */

package cz.vutbr.fit.knot.annotations.entity.attribute;

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;
import org.joda.time.Period;
import org.joda.time.format.ISOPeriodFormat;
import org.joda.time.format.PeriodFormatter;
import org.joda.time.format.PeriodFormatterBuilder;

/**
 * @file DurationAttribute.java
 *
 * @brief Class representing attribute of type Duration
 */

/**
 * Class representing attribute of type Duration
 * 
 * @brief Class representing attribute of type Duration
 */
@Entity
@DiscriminatorValue("Duration")
public class DurationAttribute extends BaseAttribute {

  /**
   * Gets value of the attribute
   * 
   * @return object of type Duration
   */
  @Override
  public Object getValue() {
    try {
      // XML Schema - we extended so it is commented out
      // return (Object) DatatypeFactory.newInstance().newDuration(this.stringValue);
      
      // RFC 3339
      PeriodFormatter pf = new PeriodFormatterBuilder().append(ISOPeriodFormat.standard()).toFormatter();
      Period p = pf.parsePeriod(this.stringValue);
      return (Object) p;
    } 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 {
    if(value == null){
        return;
    }
    
    /*
     * This is a strict variant for XML Scchema but we need to extend to RFC 3339
     * 
    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");
    }*/
    
    /*
     * Parse and set using format RFC 3339
     */
    try {
      PeriodFormatter pf = new PeriodFormatterBuilder().append(ISOPeriodFormat.standard()).toFormatter();
      Period p = pf.parsePeriod(value);
      this.stringValue = p.toString();
    } catch (Exception e) {
      throw new IllegalArgumentException("Value " + value 
        + " is not a valid Duration value according to RFC 3339");
    }
    
  }  // setRawValue()

  /**
   * 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;
  }
}  // class DurationAttribute