source: josm/trunk/src/org/openstreetmap/josm/data/osm/OsmPrimitive.java@ 1409

// License: GPL. Copyright 2007 by Immanuel Scholz and others
package org.openstreetmap.josm.data.osm;

import static org.openstreetmap.josm.tools.I18n.tr;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Map.Entry;

import org.openstreetmap.josm.data.osm.visitor.Visitor;
import org.openstreetmap.josm.tools.DateParser;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.gui.mappaint.ElemStyle;


/**
 * An OSM primitive can be associated with a key/value pair. It can be created, deleted
 * and updated within the OSM-Server.
 *
 * Although OsmPrimitive is designed as a base class, it is not to be meant to subclass
 * it by any other than from the package {@link org.openstreetmap.josm.data.osm}. The available primitives are a fixed set that are given
 * by the server environment and not an extendible data stuff.
 *
 * @author imi
 */
abstract public class OsmPrimitive implements Comparable<OsmPrimitive> {

    /**
     * The key/value list for this primitive.
     */
    public Map<String, String> keys;

    /* mappaint data */
    public ElemStyle mappaintStyle = null;
    public Integer mappaintVisibleCode = 0;
    public Integer mappaintDrawnCode = 0;
    public Collection<String> errors;

    public void putError(String text, Boolean isError)
    {
        if(errors == null)
            errors = new ArrayList<String>();
        String s = isError ? tr("Error: {0}", text) : tr("Warning: {0}", text);
        errors.add(s);
    }
    public void clearErrors()
    {
        errors = null;
    }
    /* This should not be called from outside. Fixing the UI to add relevant
       get/set functions calling this implicitely is preferred, so we can have
       transparent cache handling in the future. */
    protected void clearCached()
    {
        mappaintVisibleCode = 0;
        mappaintDrawnCode = 0;
        mappaintStyle = null;
    }
    /* end of mappaint data */

    /**
     * Unique identifier in OSM. This is used to identify objects on the server.
     * An id of 0 means an unknown id. The object has not been uploaded yet to
     * know what id it will get.
     *
     * Do not write to this attribute except you know exactly what you are doing.
     * More specific, it is not good to set this to 0 and think the object is now
     * new to the server! To create a new object, call the default constructor of
     * the respective class.
     */
    public long id = 0;

    /**
     * <code>true</code> if the object has been modified since it was loaded from
     * the server. In this case, on next upload, this object will be updated.
     * Deleted objects are deleted from the server. If the objects are added (id=0),
     * the modified is ignored and the object is added to the server.
     */
    public boolean modified = false;

    /**
     * <code>true</code>, if the object has been deleted.
     */
    public boolean deleted = false;

    /**
     * Visibility status as specified by the server. The visible attribute was
     * introduced with the 0.4 API to be able to communicate deleted objects
     * (they will have visible=false). Currently JOSM does never deal with
     * these, so this is really for future use only.
     */
    public boolean visible = true;

    /**
     * User that last modified this primitive, as specified by the server.
     * Never changed by JOSM.
     */
    public User user = null;

    /**
     * true if this object is considered "tagged". To be "tagged", an object
     * must have one or more "non-standard" tags. "created_by" and "source"
     * are typically considered "standard" tags and do not make an object
     * "tagged".
     */
    public boolean tagged = false;

    /**
     * true if this object has direction dependent tags (e.g. oneway)
     */
    public boolean hasDirectionKeys = false;

    /**
     * If set to true, this object is currently selected.
     */
    public volatile boolean selected = false;
    
    /**
     * If set to true, this object is highlighted. Currently this is only used to
     * show which ways/nodes will connect 
     */
    public volatile boolean highlighted = false;

    /**
     * Time of last modification to this object. This is not set by JOSM but
     * read from the server and delivered back to the server unmodified. It is
     * used to check against edit conflicts.
     */
    public String timestamp = null;

    /**
     * The timestamp is only parsed when this is really necessary, and this
     * is the cache for the result.
     */
    public Date parsedTimestamp = null;

    /**
     * If set to true, this object is incomplete, which means only the id
     * and type is known (type is the objects instance class)
     */
    public boolean incomplete = false;

    /**
     * Contains the version number as returned by the API. Needed to
     * ensure update consistency
     */
    public int version = -1;

    /**
     * Contains a list of "uninteresting" keys that do not make an object
     * "tagged".
     * Initialized by checkTagged()
     */
    private static Collection<String> uninteresting = null;

    /**
     * Contains a list of direction-dependent keys that make an object
     * direction dependent.
     * Initialized by checkDirectionTagged()
     */
    private static Collection<String> directionKeys = null;

    /**
     * Implementation of the visitor scheme. Subclasses have to call the correct
     * visitor function.
     * @param visitor The visitor from which the visit() function must be called.
     */
    abstract public void visit(Visitor visitor);

    public final void delete(boolean deleted) {
        this.deleted = deleted;
        selected = false;
        modified = true;
    }

    /**
     * Returns the timestamp for this object, or the current time if none is set.
     * Internally, parses the timestamp from XML into a Date object and caches it
     * for possible repeated calls.
     */
    public Date getTimestamp() {
        if (parsedTimestamp == null) {
            try {
                parsedTimestamp = DateParser.parse(timestamp);
            } catch (ParseException ex) {
                parsedTimestamp = new Date();
            }
        }
        return parsedTimestamp;
    }

    /**
     * Equal, if the id (and class) is equal.
     *
     * An primitive is equal to its incomplete counter part.
     */
    @Override public boolean equals(Object obj) {
        if (id == 0) return obj == this;
        if (obj instanceof OsmPrimitive) { // not null too
            return ((OsmPrimitive)obj).id == id && obj.getClass() == getClass();
        }
        return false;
    }

    /**
     * Return the id plus the class type encoded as hashcode or super's hashcode if id is 0.
     *
     * An primitive has the same hashcode as its incomplete counterpart.
     */
    @Override public final int hashCode() {
        if (id == 0)
            return super.hashCode();
        final int[] ret = new int[1];
        Visitor v = new Visitor(){
            public void visit(Node n) { ret[0] = 1; }
            public void visit(Way w) { ret[0] = 2; }
            public void visit(Relation e) { ret[0] = 3; }
        };
        visit(v);
        return id == 0 ? super.hashCode() : (int)(id<<2)+ret[0];
    }

    /**
     * Set the given value to the given key
     * @param key The key, for which the value is to be set.
     * @param value The value for the key.
     */
    public final void put(String key, String value) {
        if (value == null)
            remove(key);
        else {
            if (keys == null)
                keys = new HashMap<String, String>();
            keys.put(key, value);
        }
        checkTagged();
        checkDirectionTagged();
        mappaintStyle = null;
    }
    /**
     * Remove the given key from the list.
     */
    public final void remove(String key) {
        if (keys != null) {
            keys.remove(key);
            if (keys.isEmpty())
                keys = null;
        }
        checkTagged();
        checkDirectionTagged();
        mappaintStyle = null;
    }

    public String getName() {
        return null;
    }

    public final String get(String key) {
        return keys == null ? null : keys.get(key);
    }

    public final Collection<Entry<String, String>> entrySet() {
        if (keys == null)
            return Collections.emptyList();
        return keys.entrySet();
    }

    public final Collection<String> keySet() {
        if (keys == null)
            return Collections.emptyList();
        return keys.keySet();
    }

    /**
     * Get and write all attributes from the parameter. Does not fire any listener, so
     * use this only in the data initializing phase
     */
    public void cloneFrom(OsmPrimitive osm) {
        keys = osm.keys == null ? null : new HashMap<String, String>(osm.keys);
        id = osm.id;
        modified = osm.modified;
        deleted = osm.deleted;
        selected = osm.selected;
        timestamp = osm.timestamp;
        version = osm.version;
        tagged = osm.tagged;
        incomplete = osm.incomplete;
        clearCached();
        clearErrors();
    }

    /**
     * Perform an equality compare for all non-volatile fields not only for the id
     * but for the whole object (for conflict resolving)
     * @param semanticOnly if <code>true</code>, modified flag and timestamp are not compared
     */
    public boolean realEqual(OsmPrimitive osm, boolean semanticOnly) {
        return
            id == osm.id &&
            incomplete == osm.incomplete &&
            (semanticOnly || (modified == osm.modified)) &&
            deleted == osm.deleted &&
            (semanticOnly || (timestamp == null ? osm.timestamp==null : timestamp.equals(osm.timestamp))) &&
            (semanticOnly || (version==osm.version)) &&
            (semanticOnly || (user == null ? osm.user==null : user==osm.user)) &&
            (semanticOnly || (visible == osm.visible)) &&
            (keys == null ? osm.keys==null : keys.equals(osm.keys));
    }

    public String getTimeStr() {
        return timestamp == null ? null : new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(timestamp);
    }

    /**
     * Updates the "tagged" flag. "keys" property should probably be made private
     * to make sure this gets called when keys are set.
     */
    public void checkTagged() {
        tagged = false;
        if(uninteresting == null)
            uninteresting = new HashSet<String>(Arrays.asList(Main.pref.get("tags.uninteresting",
            "source;note;converted_by;created_by").split(";")));
        if (keys != null) {
            for (Entry<String,String> e : keys.entrySet()) {
                if (!uninteresting.contains(e.getKey())) {
                    tagged = true;
                    break;
                }
            }
        }
    }
    /**
     * Updates the "hasDirectionKeys" flag. "keys" property should probably be made private
     * to make sure this gets called when keys are set.
     */
    public void checkDirectionTagged() {
        hasDirectionKeys = false;
        if(directionKeys == null)
            directionKeys = new HashSet<String>(Arrays.asList(Main.pref.get("tags.direction",
            "oneway;incline;incline_steep;aerialway").split(";")));
        if (keys != null) {
            for (Entry<String,String> e : keys.entrySet()) {
                if (directionKeys.contains(e.getKey())) {
                    hasDirectionKeys = true;
                    break;
                }
            }
        }
    }
}