/*
    * This file is a part of CAST project.
    * (c) Copyright 2007, AGH University of Science & Technology
    * https://caribou.iisg.agh.edu.pl/trac/cast
    *
    * Licensed under the Eclipse Public License, Version 1.0 (the "License").
    * You may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * http://www.eclipse.org/legal/epl-v10.html
   */
  /*
   * File: Attribute.java
   * Created: 2007-00-00
   * Author: awos, tmilos
   * $Id: Attribute.java 2817 2009-05-05 13:17:57Z tmilos $
   */
  
  package pl.edu.agh.cast.model.attributes;
  
  import java.beans.PropertyChangeListener;
  import java.io.Serializable;
  
  import pl.edu.agh.cast.data.model.property.IPropertyChangeProvider;
  import pl.edu.agh.cast.data.model.property.PropertyChangeProviderHelper;
  import pl.edu.agh.cast.model.ModelUtil;
  import pl.edu.agh.cast.util.Messages;
  
  import com.thoughtworks.xstream.annotations.XStreamAlias;
  import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
  import com.thoughtworks.xstream.annotations.XStreamOmitField;
  
  /**
   * Stores information about a single attribute registered in an attribute manager.
   *
   * Two {@link Attribute}s are considered equal if their names are equal.
   *
   * @author AGH CAST Team
   */
  @XStreamAlias("attribute")
  public class Attribute implements Serializable, Comparable<Attribute>, IPropertyChangeProvider {
  
  	private static final long serialVersionUID = -1988514436802189113L;
  
  	/**
  	 * ID of the <em>ShowAsLabel</em> property.
  	 */
  	public static final String PROPERTY_SHOW_AS_LABEL = "Attribute.ShowAsLabel"; //$NON-NLS-1$
  
  	/**
  	 * Default {@link AttributeMergePolicy} for this attribute.
  	 */
  	@XStreamAlias("mergePolicy")
  	@XStreamAsAttribute
  	private AttributeMergePolicy defaultMergePolicy;
  
  	/**
  	 * Attribute name.
  	 */
  	@XStreamAsAttribute
  	private String name;
  
  	/**
  	 * The name of the type (in some domain model) which defines this attribute. It might be null, if the attribute is
  	 * created, but it doesn't matter since such attributes are not localizable.
  	 */
  	@XStreamAsAttribute
  	private String ownerTypeName;
  
  	/**
  	 * The ID of the model extension in which this attribute is defined. It might be null if the attribute is created by
  	 * user or it is some predefined attribute. In the first case, the attribute is not localizable, in the second, the
  	 * localized message is taken from the Core plug-in.
  	 */
  	@XStreamAsAttribute
  	private String modelExtensionId;
  
  	/**
  	 * Whether attribute name should be localized.
  	 */
  	@XStreamAsAttribute
  	private boolean nameIsLocalizable;
  
  	@XStreamAsAttribute
  	private ValueType type;
  
  	@XStreamAsAttribute
  	private Object defaultValue;
  
  	@XStreamAsAttribute
  	private boolean permanent;
  
  	@XStreamAsAttribute
  	private boolean editable;
  
  	@XStreamAsAttribute
  	private boolean showAsLabel;
  
  	private static ModelUtil modelUtil = new ModelUtil();
  
 	/**
 	 * Constructor.
 	 *
 	 * @param name
 	 *            name of the attribute
 	 * @param nameIsLocalizable
 	 *            whether the name is localizable
 	 * @param type
 	 *            value type
 	 * @param defaultValue
 	 *            default attribute value
 	 * @param permanent
 	 *            whether the attribute is permanent
 	 * @param editable
 	 *            whether the attribute can be edited
 	 * @param showAsLabel
 	 *            whether the attribute should be displayed in label
 	 * @param ownerTypeName
 	 *            the name of the type (in some domain model) which defines this attribute - it might be null, if the
 	 *            attribute is created, but it doesn't matter since such attributes are not localizable
 	 * @param modelExtensionId
 	 *            the ID of the model extension in which this attribute is defined. It might be null if the attribute is
 	 *            created by user or it is some predefined attribute. In the first case, the attribute is not
 	 *            localizable, in the second, the localized message is taken from the Core plug-in.
 	 */
 	public Attribute(String name, boolean nameIsLocalizable, ValueType type, Object defaultValue, boolean permanent,
 	        boolean editable, boolean showAsLabel, String ownerTypeName, String modelExtensionId) {
 		this.name = name;
 		this.nameIsLocalizable = nameIsLocalizable;
 		this.type = type;
 		this.defaultValue = defaultValue;
 		this.permanent = permanent;
 		this.editable = editable;
 		this.showAsLabel = showAsLabel;
 		this.ownerTypeName = ownerTypeName;
 		this.modelExtensionId = modelExtensionId;
 		pcpHelper = new PropertyChangeProviderHelper(this);
 	}
 
 	public ValueType getType() {
 		return type;
 	}
 
 	public boolean isPermanent() {
 		return permanent;
 	}
 
 	public boolean isNameLocalizable() {
 		return nameIsLocalizable;
 	}
 
 	public boolean isEditable() {
 		return editable;
 	}
 
 	public boolean isShowAsLabel() {
 		return showAsLabel;
 	}
 
 	public String getName() {
 		return name;
 	}
 
 	public Object getDefaultValue() {
 		return defaultValue;
 	}
 
 	/**
 	 * The human readable name of the attribute. If the attribute is localizable (i.e. is a predefined attribute or is
 	 * defined in some domain model) the localized representation of the name is returned. Otherwise the raw name is
 	 * returned.
 	 *
 	 * @return The human readable name of the attribute.
 	 */
 	public String getDisplayName() {
 		/*
 		 * The lookup strategy is as follows: - if the modelExtensionId is defined, then the model extension is looked
 		 * up for the localized message - if the modelExtensionId is not defined, then the localized name is looked up
 		 * in the Core plug-in - if the localized name is not found, the raw name is returned
 		 */
 		if (nameIsLocalizable) {
 			try {
 				if (modelExtensionId != null) {
 					return modelUtil.getAttributeName(modelExtensionId, ownerTypeName, name);
 				} else {
 					return Messages.getByKey(name);
 				}
 			} catch (java.lang.IllegalArgumentException e) {
 				// its OK - the raw name will be returned
 			}
 
 		}
 		return name;
 	}
 
 	/**
 	 * Checks if given value is valid for this attribute.
 	 *
 	 * @param value
 	 *            value to check
 	 * @return validation result
 	 */
 	public boolean validateValue(Object value) {
 		return type.getValidator().isValidClass(value);
 	}
 
 	/**
 	 * Two {@link Attribute}s are considered equal if their names are equal.
 	 *
 	 * {@inheritDoc}
 	 *
 	 * @see java.lang.Object#equals(java.lang.Object)
 	 */
 	@Override
 	public boolean equals(Object obj) {
 		if (obj == this) {
 			return true;
 		}
 		if (!(obj instanceof Attribute)) {
 			return false;
 		}
 		Attribute that = (Attribute)obj;
 		return this.name.equalsIgnoreCase(that.name);
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see java.lang.Object#hashCode()
 	 */
 	@Override
 	public int hashCode() {
 		return name.toLowerCase().hashCode();
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see java.lang.Comparable#compareTo(java.lang.Object)
 	 */
 	public int compareTo(Attribute o) {
 		return this.name.compareToIgnoreCase(o.name);
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see java.lang.Object#toString()
 	 */
 	@Override
 	public String toString() {
 		return name;
 	}
 
 	/**
 	 * Sets new value of showAsLabel flag. Fires a {@link #PROPERTY_SHOW_AS_LABEL} event.
 	 *
 	 * @param showAsLabel
 	 *            new showAsLabel value
 	 */
 	public void setShowAsLabel(boolean showAsLabel) {
 		Boolean oldValue = Boolean.valueOf(this.showAsLabel);
 		this.showAsLabel = showAsLabel;
 		firePropertyChange(PROPERTY_SHOW_AS_LABEL, oldValue, Boolean.valueOf(showAsLabel));
 	}
 
 	/**
 	 * Returns a copy of this {@link Attribute} instance.
 	 *
 	 * @return copy of this instance
 	 */
 	public Attribute copy() {
 		return new Attribute(name, nameIsLocalizable, type, defaultValue, permanent, editable, showAsLabel,
 		        ownerTypeName, modelExtensionId);
 	}
 
 	/**
 	 * Property change support.
 	 */
 	@XStreamOmitField
 	private transient PropertyChangeProviderHelper pcpHelper;
 
 	protected Object readResolve() {
 		pcpHelper = new PropertyChangeProviderHelper(this);
 		return this;
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.model.property.IPropertyChangeProvider#addPropertyChangeListener(java.beans.PropertyChangeListener)
 	 */
 	public void addPropertyChangeListener(PropertyChangeListener l) {
 		pcpHelper.addPropertyChangeListener(l);
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.model.property.IPropertyChangeProvider
 	 *      #removePropertyChangeListener(java.beans.PropertyChangeListener)
 	 */
 	public void removePropertyChangeListener(PropertyChangeListener l) {
 		pcpHelper.removePropertyChangeListener(l);
 	}
 
 	protected void firePropertyChange(String property, Object oldValue, Object newValue) {
 		pcpHelper.firePropertyChange(property, oldValue, newValue);
 	}
 
 	public AttributeMergePolicy getDefaultMergePolicy() {
 		return defaultMergePolicy;
 	}
 
 	public void setDefaultMergePolicy(AttributeMergePolicy defaultMergePolicy) {
 		this.defaultMergePolicy = defaultMergePolicy;
 	}
 
 }