SugGeoPointAttribute.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SugGeoPointAttribute.java
 * Description: Class representing attribute of type GeoPoint and class representing GeoPoint
 */

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

import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.entity.attribute.GeoPointAttribute.GeoPoint;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Map;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;

/**
 * @file SugGeoPointAttribute.java
 *
 * @brief Class representing attribute of type GeoPoint and class representing GeoPoint
 */

/**
 * Class representing attribute of type GeoPoint
 *
 * @brief Class representing attribute of type GeoPoint
 */
@Entity
@DiscriminatorValue("GeoPoint")
@NamedQueries({
    @NamedQuery(name = "SuggestionAttribute.findByGeoLat", query = "SELECT a FROM SuggestionAttribute a WHERE a.geoLat = :geoLat"),
    @NamedQuery(name = "SuggestionAttribute.findByGeoLong", query = "SELECT a FROM SuggestionAttribute a WHERE a.geoLong = :geoLong")
})
public class SugGeoPointAttribute extends SugStructuredAttribute {
  /**
   * Constructor
   */
  public SugGeoPointAttribute() {
  }

  /**
   * Constructor for GeoPointAttribute
   *
   * @param name Name of attribute
   * @param geoLat Latitude
   * @param geoLong Longitude
   * @param refSuggestion Suggestion to which this attribute belongs
   */
  public SugGeoPointAttribute(String name, BigDecimal geoLat, BigDecimal geoLong, Suggestion refSuggestion) {
    this.name = name;
    this.simpleType = "GeoPoint";
    this.geoLat = geoLat;
    this.geoLong = geoLong;
    this.refSuggestion = refSuggestion;
  }
  
  /**
   * Constructor for GeoPointAttribute
   *
   * @param name Name of attribute
   * @param geoLat Latitude
   * @param geoLong Longitude
   * @param refSuggestion Suggestion to which this attribute belongs
   * @param priority Priority of attribute
   */
  public SugGeoPointAttribute(String name, BigDecimal geoLat, BigDecimal geoLong, Suggestion refSuggestion, Integer priority) {
    this.name = name;
    this.simpleType = "GeoPoint";
    this.geoLat = geoLat;
    this.geoLong = geoLong;
    this.refSuggestion = refSuggestion;
    this.priority = priority;
  }

  /**
   * Gets value of the attribute
   *
   * @return value of the attribute
   */
  @Override
  public Object getValue() {
    return new GeoPoint(geoLat, geoLong);
  }

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

  /**
   * 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() {
    if (geoLat == null || geoLong == null) {
      return "";
    }
    return "<geo:Point>"
            + "<geo:lat>" + geoLat.toPlainString() + "</geo:lat> "
            + "<geo:long>" + geoLong.toPlainString() + "</geo:long>"
            + "</geo:Point>";
  }

  /**
   * Parses provided values and sets that values as a values of the attribute
   *
   * @param values New values of the attribute in raw forms from XML
   */
  @Override
  public void setRawValues(Object values) throws IllegalArgumentException {
    @SuppressWarnings("unchecked") ArrayList<Object> valuesArray =  (ArrayList<Object>)values;
    @SuppressWarnings("unchecked") Map<String,String> tag = (Map<String,String>)valuesArray.get(0);

    String latitude = tag.get("geo:lat");
    String longitude = tag.get("geo:long");

    try {
      this.geoLat = new BigDecimal(latitude);
      this.geoLong = new BigDecimal(longitude);
    } catch (NumberFormatException e) {
      throw new IllegalArgumentException("Latitude or Longitude is not valid Decimal value.");
    }
  }

  /**
   * 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 "geo:Point" for this type
   */
  @Override
  public String getXmlAttributeName() {
    return "geo:Point";
  }

  /**
   * Sets latitude and longitude values passed as strings
   *
   * @param latitude Latitude value in string form
   * @param longitude Longitude value in string form
   *
   */
  public void setStringValue(String latitude, String longitude) throws IllegalArgumentException {
    if (latitude == null && longitude == null) {
      return;
    }

    if (latitude == null || longitude == null) {
      throw new IllegalArgumentException("Latitude or Longitude value is null");
    }

    try {
      this.geoLat = new BigDecimal(latitude);
      this.geoLong = new BigDecimal(longitude);
    } catch (NumberFormatException e) {
      throw new IllegalArgumentException("Latitude or Longitude is not valid Decimal value.");
    }
  }

  /**
   * Parses provided string value and sets that value as a values of the attribute
   *
   * This method can be used for parse value from string received in JSON object
   *
   * @param GPointEncoded New values of the attribute in String
   */
  public void setStringValue(String GPointEncoded) throws IllegalArgumentException {
    // empty value of the attribute
    if (GPointEncoded.equals("null")) {
      this.geoLat = null;
      this.geoLong = null;
    } else {
      // points value not null
      String[] Points = GPointEncoded.split(" ");
      if (Points.length == 2) {
        try {
          this.geoLat = new BigDecimal(Points[0]);
          this.geoLong = new BigDecimal(Points[1]);
        } catch (NumberFormatException e) {
          throw new IllegalArgumentException("Latitude or Longitude is not valid Decimal value.");
        }
      } else {
        throw new IllegalArgumentException("Too many words in String.");
      }
    }
  }

  /**
   * Encode values of the attribute to one string
   *
   * This method can be used for generating value for JSON object
   *
   * @return Encoded values of the attribute in one string
   */
  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    if (this.geoLat != null) {
      sb.append(this.geoLat.toString());
    }
    sb.append(' ');
    if (this.geoLong != null) {
      sb.append(this.geoLong.toString());
    }
    return sb.toString();
  }

  /**
   * 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.GEO_POINT_URI;
  }
}  // public class SugGeoPointAttribute