AttributeManager.java

Go to the documentation of this file.

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

/**
 * @file AttributeManager.java
 *
 * @brief Attribute manager provides a way how to create new attributes.
 */

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

import cz.vutbr.fit.knot.annotations.entity.AnnotType;
import cz.vutbr.fit.knot.annotations.entity.Annotation;
import java.util.HashMap;

/**
 * Class attribute manager provides a way how to create new attributes.
 *
 * @brief Class attribute manager provides a way how to create new attributes.
 */
public class AttributeManager {

  /**
   * Constructor
   */
  public static BaseAttribute 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",    AnyAnnotationAttribute.class);
    mapping.put("AnnotationLink",   LinkedAnnotationAttribute.class);
    mapping.put("annotationLink",   LinkedAnnotationAttribute.class);    
    mapping.put("Boolean",          BooleanAttribute.class);
    mapping.put("Date",             DateAttribute.class);
    mapping.put("DateTime",         DateTimeAttribute.class);
    mapping.put("Decimal",          DecimalAttribute.class);
    mapping.put("GeoPoint",         GeoPointAttribute.class);
    mapping.put("geoPoint",         GeoPointAttribute.class);
    mapping.put("Image",            ImageAttribute.class);
    mapping.put("Integer",          IntegerAttribute.class);
    mapping.put("NestedAnnotation", NestedAnnotationAttribute.class);
    mapping.put("nestedAnnotation", NestedAnnotationAttribute.class);    
    mapping.put("Person",           PersonAttribute.class);
    mapping.put("person",           PersonAttribute.class);
    mapping.put("String",           StringAttribute.class);
    mapping.put("Time",             TimeAttribute.class);
    mapping.put("URI",              UriAttribute.class);
    mapping.put("Duration",         DurationAttribute.class);
    mapping.put("Binary",           BinaryAttribute.class);
    mapping.put("Text",             TextAttribute.class);
    mapping.put("Entity",           EntityAttribute.class);
    mapping.put("entity",           EntityAttribute.class);
    mapping.put("http://www.w3.org/2001/XMLSchema#string", StringAttribute.class);
    mapping.put("http://knot.fit.vutbr.cz/annotations/knotOAExtension#entity", EntityAttribute.class);
    mapping.put("http://knot.fit.vutbr.cz/annotations/knotOAExtension#text", TextAttribute.class);
    mapping.put("http://www.w3.org/2001/XMLSchema#base64binary", BinaryAttribute.class);
    mapping.put("http://www.w3.org/2001/XMLSchema#duration", DurationAttribute.class);
    mapping.put("http://www.w3.org/2001/XMLSchema#time", TimeAttribute.class);
    mapping.put("http://www.w3.org/2001/XMLSchema#anyUri", UriAttribute.class);
    mapping.put("http://www.w3.org/2003/01/geo/wgs84_pos#Point", GeoPointAttribute.class);
    mapping.put("http://knot.fit.vutbr.cz/annotations/knotOAExtension#imageUri", ImageAttribute.class);
    mapping.put("http://www.w3.org/2001/XMLSchema#integer", IntegerAttribute.class);
    mapping.put("http://knot.fit.vutbr.cz/annotations/knotOAExtension#anyAnnotation", AnyAnnotationAttribute.class);   
    mapping.put("http://www.w3.org/2001/XMLSchema#boolean", BooleanAttribute.class);
    mapping.put("http://www.w3.org/2001/XMLSchema#date", DateAttribute.class);
    mapping.put("http://www.w3.org/2001/XMLSchema#dateTime", DateTimeAttribute.class);
    mapping.put("http://www.w3.org/2001/XMLSchema#decimal", DecimalAttribute.class);
    
  }
    
    
  /**
   * Creates a new instance according to type
   * 
   * @param type Type of new instance
   * @return Returns a new instance of appropriate class
   */
  private static BaseAttribute createObject(String type) throws ClassNotFoundException {
    type = type.substring(0, 1).toUpperCase() + type.substring(1);
    try {
      BaseAttribute ret = (BaseAttribute) 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 refAnnotation Annotation to which this attribute belongs
   * @return Returns new empty attribute
   */
  public static BaseAttribute createAttribute(String name, String simpleType, Annotation refAnnotation) throws ClassNotFoundException {
    BaseAttribute ret = createObject(simpleType);
    ret.setName(name);
    ret.setRefAnnotation(refAnnotation);
    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 refAnnotation Annotation to which this attribute belongs
   * @return Returns new attribute
   */
  public static BaseAttribute createAttribute(String name, String simpleType, Object value, Annotation refAnnotation) throws ClassNotFoundException {
    BaseAttribute ret = createAttribute(name, simpleType, refAnnotation);
    ret.setValue(value);
    ret.setRefAnnotation(refAnnotation);
    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 refAnnotation Annotation to which this attribute belongs
   * @return Returns new attribute of structured type
   */
  public static BaseAttribute createAttribute(String name, String simpleType, AnnotType attributeType, Object value, Annotation refAnnotation) throws ClassNotFoundException {
    BaseAttribute ret = AttributeManager.createAttribute(name, simpleType, value, refAnnotation);
    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(BaseAttribute 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 BaseAttribute changeAttributeInstance(BaseAttribute attr){ 
    try{
      BaseAttribute ret = createObject(attr.getSimpleType());
      ret.updateFromBaseAttributeAll(attr);
      return ret;
    }
    catch(ClassNotFoundException ex){
      return attr;
    }
  }

}  // class AttributeManager