SugAttributeManager.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Jan Planer xplane01@stud.fit.vutbr.cz
 * File: SugAttributeManager.java
 * Description: Attribute manager provides a way how to create new attributes.
 *              This is handful for example at xml parsing for prupose of suggestion
 */

/**
 * @file SugAttributeManager.java
 *
 * @brief Suggestion attribute manager provides a way how to create new attributes.
 */

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

import cz.vutbr.fit.knot.annotations.entity.AnnotType;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion;
import java.util.HashMap;

/**
 * Attribute manager provides a way how to create new attributes for prupose of 
 * suggestion.
 *
 * @brief Attribute manager provides a way how to create new attributes for 
 * prupose of suggestion. 
 */
public class SugAttributeManager {
  /**
   * Constructor
   */
  public static SugBaseAttribute createAttribute() { return null; }
    
  /**
   * Mapping of types of attributes to classes
   */
  private static final HashMap<String,Class> mapping = new HashMap<String,Class>();
  static {
    mapping.put("AnyAnnotation",    SugAnyAttribute.class);    
    mapping.put("SuggestionLink",   SugLinkedAttribute.class);
    mapping.put("suggestionLink",   SugLinkedAttribute.class);
    mapping.put("AnnotationLink",   SugLinkedAttribute.class);
    mapping.put("annotationLink",   SugLinkedAttribute.class);
    mapping.put("LinkedAnnotation", SugLinkedAttribute.class);
    mapping.put("linkedAnnotation", SugLinkedAttribute.class);
    mapping.put("Boolean",          SugBooleanAttribute.class);
    mapping.put("Date",             SugDateAttribute.class);
    mapping.put("DateTime",         SugDateTimeAttribute.class);
    mapping.put("Decimal",          SugDecimalAttribute.class);
    mapping.put("GeoPoint",         SugGeoPointAttribute.class);
    mapping.put("geoPoint",         SugGeoPointAttribute.class);
    mapping.put("Image",            SugImageAttribute.class);
    mapping.put("Integer",          SugIntegerAttribute.class);
    mapping.put("NestedAnnotation", SugNestedAttribute.class);
    mapping.put("nestedAnnotation", SugNestedAttribute.class);  
    mapping.put("NestedSuggestion", SugNestedAttribute.class);
    mapping.put("nestedSuggestion", SugNestedAttribute.class); 
    mapping.put("Person",           SugPersonAttribute.class);
    mapping.put("person",           SugPersonAttribute.class);
    mapping.put("String",           SugStringAttribute.class);
    mapping.put("Time",             SugTimeAttribute.class);
    mapping.put("URI",              SugUriAttribute.class);
    mapping.put("Duration",         SugDurationAttribute.class);
    mapping.put("Binary",           SugBinaryAttribute.class);
    mapping.put("Text",             SugTextAttribute.class);
    mapping.put("Entity",           SugEntityAttribute.class);
    mapping.put("entity",           SugEntityAttribute.class);
  }
    
    
  /**
   * Creates a new instance according to type
   * 
   * @param type Type of new instance
   * @return Returns a new instance of appropriate class
   */
  private static SugBaseAttribute createObject(String type) throws ClassNotFoundException {
    if(type.equalsIgnoreCase("NestedAnnotation")){
      type = "NestedSuggestion";
    }
    if(type.equalsIgnoreCase("AnnotationLink")){
      type = "SuggestionLink";
    }
    type = type.substring(0, 1).toUpperCase() + type.substring(1);
    try {
      SugBaseAttribute ret = (SugBaseAttribute) mapping.get(type).newInstance();
      ret.setSimpleType(type);
      return ret;
    } catch (Exception e) {
      throw new ClassNotFoundException("Class representing attribute " + type + " not found");
    }
  }

  /**
   * Creates new empty attribute
   *
   * @param name Name of attribute
   * @param simpleType Name of simple type of attribute
   * @param refSuggestion Suggestion to which this attribute belongs
   * @return Returns new empty attribute
   */
  public static SugBaseAttribute createAttribute(String name, String simpleType, Suggestion refSuggestion) throws ClassNotFoundException {
    SugBaseAttribute ret = createObject(simpleType);
    ret.setName(name);
    ret.setRefSuggestion(refSuggestion);
    return ret;
  }

  /**
   * Creates new attribute
   *
   * @param name Name of attribute
   * @param simpleType Name of simple type of attribute
   * @param value Value of attribute according to its type. For example, if 
   *              type is Date then value is expected to be a date.
   * @param refSuggestion Suggestion to which this attribute belongs
   * @return Returns new attribute
   */
  public static SugBaseAttribute createAttribute(String name, String simpleType, Object value, Suggestion refSuggestion) throws ClassNotFoundException {
    SugBaseAttribute ret = createAttribute(name, simpleType, refSuggestion);
    ret.setValue(value);
    ret.setRefSuggestion(refSuggestion);
    return ret;
  }

    
  /**
   * Creates a new Attribute with structured type. (For example with nested 
   * annotation)
   *
   * @param name Name of attribute
   * @param simpleType Name of simple type of attribute
   * @param attributeType Structured type of attribute (type of annotation)
   * @param value Nested value. Usually nested annotation
   * @param refSuggestion Suggestion to which this attribute belongs
   * @return Returns new attribute of structured type
   */
  public static SugBaseAttribute createAttribute(String name, String simpleType, AnnotType attributeType, Object value, Suggestion refSuggestion) throws ClassNotFoundException {
    SugBaseAttribute ret = SugAttributeManager.createAttribute(name, simpleType, value, refSuggestion);
    ret.setAttributeType(attributeType);
    return ret;
  }
  
  /**
   * Returns true if String type is correct type of attribute
   * 
   * @param type Type of attribute
   * @return True if it can be created, false if not
   */
  public static boolean containsType(String type){
    return mapping.containsKey(type);
  }
  
  /**
   * Returns true if attr has the right class instance of it's simpletype
   * 
   * @param attr Attribute for check
   * @return True if simpletype matches the class instance, false otherwise
   */
  public static boolean hasAttributeRightInstance(SugBaseAttribute attr){
    if(mapping.get(attr.getSimpleType()).isInstance(attr)){
      return true;
    }
    else{
      return false;
    }
  }
  
  /**
   * Cast the right Attribute class
   * Attention! If simpletype is some bad string, then method returns the same attribute as
   * inserted in parameters!
   * 
   * @param attr querried nested attribute
   * @return Right class instance
   */
  public static SugBaseAttribute changeAttributeInstance(SugBaseAttribute attr){ 
    try{
      SugBaseAttribute ret = createObject(attr.getSimpleType());
      ret.updateFromBaseAttributeAll(attr);
      return ret;
    }
    catch(ClassNotFoundException ex){
      return attr;
    }
  }

}  // public class SugAttributeManager