Adding the interface PropertiesExtractor.

[ifi-stolz-refaktor.git] / software / no.uio.ifi.refaktor / src / no / uio / ifi / refaktor / prefix / PrefixSet.java

package no.uio.ifi.refaktor.prefix;

import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Set;

/**
 * A set for collecting prefixes (see {@link Prefix}}).
 * 
 * It is based on a regular Set<Prefix>, but is used to
 * add some more functionality to the basic set, like 
 * incrementing a counter in a prefix each time an equal
 * prefix is registered with the set. In addition
 * it can produce the set that is this set, minus the 
 * prefixes from another set that are enclosed by the 
 * prefixes in this set.
 */
public class PrefixSet implements Iterable<Prefix> {

	private final Set<Prefix> prefixes = new HashSet<Prefix>();

	public PrefixSet() {
	}

	private PrefixSet(PrefixSet initialElements) {
		prefixes.addAll(initialElements.prefixes);
	}

	public boolean add(Prefix prefix) {
		return prefixes.add(prefix);
	}

	private void remove(Prefix prefix) {
		prefixes.remove(prefix);
	}

	public boolean contains(Prefix prefix) {
		return prefixes.contains(prefix);
	}

	@Override
	public Iterator<Prefix> iterator() {
		return prefixes.iterator();
	}

	public boolean isEmpty() {
		return prefixes.isEmpty();
	}

	public LinkedList<Prefix> toList() {
		return new LinkedList<Prefix>(prefixes);
	}

	public void register(Prefix prefix) {
		if (contains(prefix)) {
			incrementCountFor(prefix);
		} else {
			add(prefix);
		}
	}

	private void incrementCountFor(Prefix prefix) {
		get(prefix).incrementCount();
	}

	public Prefix get(Prefix prefix) {
		for (Prefix p: this) {
			if (p.equals(prefix))
				return p;
		}
		return null;
	}

	public void registerAllSubPrefixesOf(Prefix prefix) {
		for (Prefix p: prefix.getSubPrefixes())
			register(p);
	}

	@Override
	public String toString() {
		String str = "";
		for (Prefix p: this) {
			str += p.toString() + " (" + p.getCount() + ")\n";
		}
		return str;
	}

	/**
	 * Creates a set of prefixes that are the prefixes of this set,
	 * minus the prefixes that are enclosing the prefixes of the 
	 * other set. A prefix is enclosing another if the other prefix
	 * is a sub-prefix of the first prefix.
	 * 
	 * @param other The set of prefixes that are to be checked against this one.
	 * @return The set of prefixes that are not enclosing the ones in the other set.
	 */
	public PrefixSet minusEnclosedPrefixesFrom(PrefixSet other) {
		PrefixSet prefixSet = shallowCopy();
		removeEnclosingPrefixesFromPrefixSet(prefixSet, other);
		return prefixSet;
	}

	private PrefixSet shallowCopy() {
		return new PrefixSet(this);
	}

	private void removeEnclosingPrefixesFromPrefixSet(PrefixSet prefixSet, PrefixSet other) {
		for (Prefix p: other) {
			for (Prefix prefix: this) {
				if (prefix.hasSubPrefix(p))
					prefixSet.remove(prefix);
			}
		}
	}

	public void clear() {
		prefixes.clear();
	}
}