// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.data.osm;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.Map.Entry;
/**
* TagCollection is a collection of tags which can be used to manipulate
* tags managed by {@see OsmPrimitive}s.
*
* A TagCollection can be created:
* <ul>
* <li>from the tags managed by a specific {@see OsmPrimitive} with {@see #from(OsmPrimitive)}</li>
* <li>from the union of all tags managed by a collection of {@see OsmPrimitive}s with {@see #unionOfAllPrimitives(Collection)}</li>
* <li>from the union of all tags managed by a {@see DataSet} with {@see #unionOfAllPrimitives(DataSet)}</li>
* <li>from the intersection of all tags managed by a collection of primitives with {@see #commonToAllPrimitives(Collection)}</li>
* </ul>
*
* It provides methods to query the collection, like {@see #size()}, {@see #hasTagsFor(String)}, etc.
*
* Basic set operations allow to create the union, the intersection and the difference
* of tag collections, see {@see #union(TagCollection)}, {@see #intersect(TagCollection)},
* and {@see #minus(TagCollection)}.
*
*
*/
public class TagCollection implements Iterable<Tag> {
/**
* Creates a tag collection from the tags managed by a specific
* {@see OsmPrimitive}. If <code>primitive</code> is null, replies
* an empty tag collection.
*
* @param primitive the primitive
* @return a tag collection with the tags managed by a specific
* {@see OsmPrimitive}
*/
public static TagCollection from(Tagged primitive) {
TagCollection tags = new TagCollection();
for (String key: primitive.keySet()) {
tags.add(new Tag(key, primitive.get(key)));
}
return tags;
}
/**
* Creates a tag collection from a map of key/value-pairs. Replies
* an empty tag collection if {@code tags} is null.
*
* @param tags the key/value-pairs
* @return the tag collection
*/
public static TagCollection from(Map<String,String> tags) {
TagCollection ret = new TagCollection();
if (tags == null) return ret;
for (Entry<String,String> entry: tags.entrySet()) {
String key = entry.getKey() == null? "" : entry.getKey();
String value = entry.getValue() == null ? "" : entry.getValue();
ret.add(new Tag(key,value));
}
return ret;
}
/**
* Creates a tag collection from the union of the tags managed by
* a collection of primitives. Replies an empty tag collection,
* if <code>primitives</code> is null.
*
* @param primitives the primitives
* @return a tag collection with the union of the tags managed by
* a collection of primitives
*/
public static TagCollection unionOfAllPrimitives(Collection<? extends Tagged> primitives) {
TagCollection tags = new TagCollection();
if (primitives == null) return tags;
for (Tagged primitive: primitives) {
if (primitive == null) {
continue;
}
tags.add(TagCollection.from(primitive));
}
return tags;
}
/**
* Replies a tag collection with the tags which are common to all primitives in in
* <code>primitives</code>. Replies an empty tag collection of <code>primitives</code>
* is null.
*
* @param primitives the primitives
* @return a tag collection with the tags which are common to all primitives
*/
public static TagCollection commonToAllPrimitives(Collection<? extends Tagged> primitives) {
TagCollection tags = new TagCollection();
if (primitives == null || primitives.isEmpty()) return tags;
// initialize with the first
//
tags.add(TagCollection.from(primitives.iterator().next()));
// intersect with the others
//
for (Tagged primitive: primitives) {
if (primitive == null) {
continue;
}
tags.add(tags.intersect(TagCollection.from(primitive)));
}
return tags;
}
/**
* Replies a tag collection with the union of the tags which are common to all primitives in
* the dataset <code>ds</code>. Returns an empty tag collection of <code>ds</code> is null.
*
* @param ds the dataset
* @return a tag collection with the union of the tags which are common to all primitives in
* the dataset <code>ds</code>
*/
public static TagCollection unionOfAllPrimitives(DataSet ds) {
TagCollection tags = new TagCollection();
if (ds == null) return tags;
tags.add(TagCollection.unionOfAllPrimitives(ds.getNodes()));
tags.add(TagCollection.unionOfAllPrimitives(ds.getWays()));
tags.add(TagCollection.unionOfAllPrimitives(ds.getRelations()));
return tags;
}
private final HashSet<Tag> tags = new HashSet<Tag>();
/**
* Creates an empty tag collection
*/
public TagCollection() {
}
/**
* Creates a clone of the tag collection <code>other</code>. Creats an empty
* tag collection if <code>other</code> is null.
*
* @param other the other collection
*/
public TagCollection(TagCollection other) {
if (other != null) {
tags.addAll(other.tags);
}
}
/**
* Replies the number of tags in this tag collection
*
* @return the number of tags in this tag collection
*/
public int size() {
return tags.size();
}
/**
* Replies true if this tag collection is empty
*
* @return true if this tag collection is empty; false, otherwise
*/
public boolean isEmpty() {
return size() == 0;
}
/**
* Adds a tag to the tag collection. If <code>tag</code> is null, nothing is added.
*
* @param tag the tag to add
*/
public void add(Tag tag){
if (tag == null) return;
if (tags.contains(tag)) return;
tags.add(tag);
}
/**
* Adds a collection of tags to the tag collection. If <code>tags</code> is null, nothing
* is added. null values in the collection are ignored.
*
* @param tags the collection of tags
*/
public void add(Collection<Tag> tags) {
if (tags == null) return;
for (Tag tag: tags){
add(tag);
}
}
/**
* Adds the tags of another tag collection to this collection. Adds nothing, if
* <code>tags</code> is null.
*
* @param tags the other tag collection
*/
public void add(TagCollection tags) {
if (tags == null) return;
this.tags.addAll(tags.tags);
}
/**
* Removes a specific tag from the tag collection. Does nothing if <code>tag</code> is
* null.
*
* @param tag the tag to be removed
*/
public void remove(Tag tag) {
if (tag == null) return;
tags.remove(tag);
}
/**
* Removes a collection of tags from the tag collection. Does nothing if <code>tags</code> is
* null.
*
* @param tags the tags to be removed
*/
public void remove(Collection<Tag> tags) {
if (tags == null) return;
this.tags.removeAll(tags);
}
/**
* Removes all tags in the tag collection <code>tags</code> from the current tag collection.
* Does nothing if <code>tags</code> is null.
*
* @param tags the tag collection to be removed.
*/
public void remove(TagCollection tags) {
if (tags == null) return;
this.tags.removeAll(tags.tags);
}
/**
* Removes all tags whose keys are equal to <code>key</code>. Does nothing if <code>key</code>
* is null.
*
* @param key the key to be removed
*/
public void removeByKey(String key) {
if (key == null) return;
Iterator<Tag> it = tags.iterator();
while(it.hasNext()) {
if (it.next().matchesKey(key)) {
it.remove();
}
}
}
/**
* Removes all tags whose key is in the collection <code>keys</code>. Does nothing if
* <code>keys</code> is null.
*
* @param keys the collection of keys to be removed
*/
public void removeByKey(Collection<String> keys) {
if (keys == null) return;
for (String key: keys) {
removeByKey(key);
}
}
/**
* Replies true if the this tag collection contains <code>tag</code>.
*
* @param tag the tag to look up
* @return true if the this tag collection contains <code>tag</code>; false, otherwise
*/
public boolean contains(Tag tag) {
return tags.contains(tag);
}
/**
* Replies true if this tag collection contains at least one tag with key <code>key</code>.
*
* @param key the key to look up
* @return true if this tag collection contains at least one tag with key <code>key</code>; false, otherwise
*/
public boolean containsKey(String key) {
if (key == null) return false;
for (Tag tag: tags) {
if (tag.matchesKey(key)) return true;
}
return false;
}
/**
* Replies true if this tag collection contains all tags in <code>tags</code>. Replies
* false, if tags is null.
*
* @param tags the tags to look up
* @return true if this tag collection contains all tags in <code>tags</code>. Replies
* false, if tags is null.
*/
public boolean containsAll(Collection<Tag> tags) {
if (tags == null) return false;
return this.tags.containsAll(tags);
}
/**
* Replies true if this tag collection at least one tag for every key in <code>keys</code>.
* Replies false, if <code>keys</code> is null. null values in <code>keys</code> are ignored.
*
* @param keys the keys to lookup
* @return true if this tag collection at least one tag for every key in <code>keys</code>.
*/
public boolean containsAllKeys(Collection<String> keys) {
if (keys == null) return false;
for (String key: keys) {
if (key == null) {
continue;
}
if (! containsKey(key)) return false;
}
return true;
}
/**
* Replies the number of tags with key <code>key</code>
*
* @param key the key to look up
* @return the number of tags with key <code>key</code>. 0, if key is null.
*/
public int getNumTagsFor(String key) {
if (key == null) return 0;
int count = 0;
for (Tag tag: tags) {
if (tag.matchesKey(key)) {
count++;
}
}
return count;
}
/**
* Replies true if there is at least one tag for the given key.
*
* @param key the key to look up
* @return true if there is at least one tag for the given key. false, if key is null.
*/
public boolean hasTagsFor(String key) {
return getNumTagsFor(key) > 0;
}
/**
* Replies true it there is at least one tag with a non empty value for key.
* Replies false if key is null.
*
* @param key the key
* @return true it there is at least one tag with a non empty value for key.
*/
public boolean hasValuesFor(String key) {
if (key == null) return false;
Set<String> values = getTagsFor(key).getValues();
values.remove("");
return !values.isEmpty();
}
/**
* Replies true if there is exactly one tag for <code>key</code> and
* if the value of this tag is not empty. Replies false if key is
* null.
*
* @param key the key
* @return true if there is exactly one tag for <code>key</code> and
* if the value of this tag is not empty
*/
public boolean hasUniqueNonEmptyValue(String key) {
if (key == null) return false;
Set<String> values = getTagsFor(key).getValues();
return values.size() == 1 && ! values.contains("");
}
/**
* Replies true if there is a tag with an empty value for <code>key</code>.
* Replies false, if key is null.
*
* @param key the key
* @return true if there is a tag with an empty value for <code>key</code>
*/
public boolean hasEmptyValue(String key) {
if (key == null) return false;
Set<String> values = getTagsFor(key).getValues();
return values.contains("");
}
/**
* Replies true if there is exactly one tag for <code>key</code> and if
* the value for this tag is empty. Replies false if key is null.
*
* @param key the key
* @return true if there is exactly one tag for <code>key</code> and if
* the value for this tag is empty
*/
public boolean hasUniqueEmptyValue(String key) {
if (key == null) return false;
Set<String> values = getTagsFor(key).getValues();
return values.size() == 1 && values.contains("");
}
/**
* Replies a tag collection with the tags for a given key. Replies an empty collection
* if key is null.
*
* @param key the key to look up
* @return a tag collection with the tags for a given key. Replies an empty collection
* if key is null.
*/
public TagCollection getTagsFor(String key) {
TagCollection ret = new TagCollection();
if (key == null)
return ret;
for (Tag tag: tags) {
if (tag.matchesKey(key)) {
ret.add(tag);
}
}
return ret;
}
/**
* Replies a tag collection with all tags whose key is equal to one of the keys in
* <code>keys</code>. Replies an empty collection if keys is null.
*
* @param keys the keys to look up
* @return a tag collection with all tags whose key is equal to one of the keys in
* <code>keys</code>
*/
public TagCollection getTagsFor(Collection<String> keys) {
TagCollection ret = new TagCollection();
if (keys == null)
return ret;
for(String key : keys) {
if (key != null) {
ret.add(getTagsFor(key));
}
}
return ret;
}
/**
* Replies the tags of this tag collection as set
*
* @return the tags of this tag collection as set
*/
public Set<Tag> asSet() {
return new HashSet<Tag>(tags);
}
/**
* Replies the tags of this tag collection as list.
* Note that the order of the list is not preserved between method invocations.
*
* @return the tags of this tag collection as list.
*/
public List<Tag> asList() {
return new ArrayList<Tag>(tags);
}
/**
* Replies an iterator to iterate over the tags in this collection
*
* @return the iterator
*/
public Iterator<Tag> iterator() {
return tags.iterator();
}
/**
* Replies the set of keys of this tag collection.
*
* @return the set of keys of this tag collection
*/
public Set<String> getKeys() {
HashSet<String> ret = new HashSet<String>();
for (Tag tag: tags) {
ret.add(tag.getKey());
}
return ret;
}
/**
* Replies the set of keys which have at least 2 matching tags.
*
* @return the set of keys which have at least 2 matching tags.
*/
public Set<String> getKeysWithMultipleValues() {
HashMap<String, Integer> counters = new HashMap<String, Integer>();
for (Tag tag: tags) {
Integer v = counters.get(tag.getKey());
counters.put(tag.getKey(),(v==null) ? 1 : v+1);
}
Set<String> ret = new HashSet<String>();
for (Entry<String, Integer> e : counters.entrySet()) {
if (e.getValue() > 1) {
ret.add(e.getKey());
}
}
return ret;
}
/**
* Sets a unique tag for the key of this tag. All other tags with the same key are
* removed from the collection. Does nothing if tag is null.
*
* @param tag the tag to set
*/
public void setUniqueForKey(Tag tag) {
if (tag == null) return;
removeByKey(tag.getKey());
add(tag);
}
/**
* Sets a unique tag for the key of this tag. All other tags with the same key are
* removed from the collection. Assume the empty string for key and value if either
* key or value is null.
*
* @param key the key
* @param value the value
*/
public void setUniqueForKey(String key, String value) {
Tag tag = new Tag(key, value);
setUniqueForKey(tag);
}
/**
* Replies the set of values in this tag collection
*
* @return the set of values
*/
public Set<String> getValues() {
HashSet<String> ret = new HashSet<String>();
for (Tag tag: tags) {
ret.add(tag.getValue());
}
return ret;
}
/**
* Replies the set of values for a given key. Replies an empty collection if there
* are no values for the given key.
*
* @param key the key to look up
* @return the set of values for a given key. Replies an empty collection if there
* are no values for the given key
*/
public Set<String> getValues(String key) {
HashSet<String> ret = new HashSet<String>();
if (key == null) return ret;
for (Tag tag: tags) {
if (tag.matchesKey(key)) {
ret.add(tag.getValue());
}
}
return ret;
}
/**
* Replies true if for every key there is one tag only, i.e. exactly one value.
*
* @return
*/
public boolean isApplicableToPrimitive() {
return size() == getKeys().size();
}
/**
* Applies this tag collection to an {@see OsmPrimitive}. Does nothing if
* primitive is null
*
* @param primitive the primitive
* @throws IllegalStateException thrown if this tag collection can't be applied
* because there are keys with multiple values
*/
public void applyTo(Tagged primitive) throws IllegalStateException {
if (primitive == null) return;
if (! isApplicableToPrimitive())
throw new IllegalStateException(tr("Tag collection cannot be applied to a primitive because there are keys with multiple values."));
for (Tag tag: tags) {
if (tag.getValue() == null || tag.getValue().equals("")) {
primitive.remove(tag.getKey());
} else {
primitive.put(tag.getKey(), tag.getValue());
}
}
}
/**
* Applies this tag collection to a collection of {@see OsmPrimitive}s. Does nothing if
* primitives is null
*
* @param primitives the collection of primitives
* @throws IllegalStateException thrown if this tag collection can't be applied
* because there are keys with multiple values
*/
public void applyTo(Collection<? extends Tagged> primitives) throws IllegalStateException{
if (primitives == null) return;
if (! isApplicableToPrimitive())
throw new IllegalStateException(tr("Tag collection cannot be applied to a primitive because there are keys with multiple values."));
for (Tagged primitive: primitives) {
applyTo(primitive);
}
}
/**
* Replaces the tags of an {@see OsmPrimitive} by the tags in this collection . Does nothing if
* primitive is null
*
* @param primitive the primitive
* @throws IllegalStateException thrown if this tag collection can't be applied
* because there are keys with multiple values
*/
public void replaceTagsOf(Tagged primitive) throws IllegalStateException {
if (primitive == null) return;
if (! isApplicableToPrimitive())
throw new IllegalStateException(tr("Tag collection cannot be applied to a primitive because there are keys with multiple values."));
primitive.removeAll();
for (Tag tag: tags) {
primitive.put(tag.getKey(), tag.getValue());
}
}
/**
* Replaces the tags of a collection of{@see OsmPrimitive}s by the tags in this collection.
* Does nothing if primitives is null
*
* @param primitive the collection of primitives
* @throws IllegalStateException thrown if this tag collection can't be applied
* because there are keys with multiple values
*/
public void replaceTagsOf(Collection<? extends Tagged> primitives) throws IllegalStateException {
if (primitives == null) return;
if (! isApplicableToPrimitive())
throw new IllegalStateException(tr("Tag collection cannot be applied to a primitive because there are keys with multiple values."));
for (Tagged primitive: primitives) {
replaceTagsOf(primitive);
}
}
/**
* Builds the intersection of this tag collection and another tag collection
*
* @param other the other tag collection. If null, replies an empty tag collection.
* @return the intersection of this tag collection and another tag collection
*/
public TagCollection intersect(TagCollection other) {
if (other == null) {
other = new TagCollection();
}
TagCollection ret = new TagCollection(this);
for (Tag tag: tags) {
if (other.contains(tag)) {
ret.add(tag);
}
}
return ret;
}
/**
* Replies the difference of this tag collection and another tag collection
*
* @param other the other tag collection. May be null.
* @return the difference of this tag collection and another tag collection
*/
public TagCollection minus(TagCollection other) {
TagCollection ret = new TagCollection(this);
if (other != null) {
ret.remove(other);
}
return ret;
}
/**
* Replies the union of this tag collection and another tag collection
*
* @param other the other tag collection. May be null.
* @return the union of this tag collection and another tag collection
*/
public TagCollection union(TagCollection other) {
TagCollection ret = new TagCollection(this);
if (other != null) {
ret.add(other);
}
return ret;
}
public TagCollection emptyTagsForKeysMissingIn(TagCollection other) {
TagCollection ret = new TagCollection();
for(String key: this.minus(other).getKeys()) {
ret.add(new Tag(key));
}
return ret;
}
/**
* Replies the concatenation of all tag values (concatenated by a semicolon)
*
* @return the concatenation of all tag values
*/
public String getJoinedValues(String key) {
StringBuffer buffer = new StringBuffer();
List<String> values = new ArrayList<String>(getValues(key));
values.remove("");
Collections.sort(values);
Iterator<String> iter = values.iterator();
while (iter.hasNext()) {
buffer.append(iter.next());
if (iter.hasNext()) {
buffer.append(";");
}
}
return buffer.toString();
}
@Override
public String toString() {
return tags.toString();
}
}