opennlp.tools.util
Class CountedSet

java.lang.Object
  extended by opennlp.tools.util.CountedSet
All Implemented Interfaces:
java.lang.Iterable, java.util.Collection, java.util.Set

public class CountedSet
extends java.lang.Object
implements java.util.Set

Set which counts the number of times a values are added to it. This value can be accessed with the #getCount method.


Constructor Summary
CountedSet()
          Creates a new counted set.
CountedSet(int size)
          Creates a new counted set of the specified initial size.
 
Method Summary
 boolean add(java.lang.Object o)
           
 boolean addAll(java.util.Collection c)
           
 void clear()
           
 boolean contains(java.lang.Object o)
           
 boolean containsAll(java.util.Collection c)
           
 int getCount(java.lang.Object o)
          Return the count of the specified object.
 boolean isEmpty()
           
 java.util.Iterator iterator()
           
 boolean remove(java.lang.Object o)
           
 boolean removeAll(java.util.Collection c)
           
 boolean retainAll(java.util.Collection c)
           
 void setCount(java.lang.Object o, int c)
          Assigns the specified object the specified count in the set.
 int size()
           
 void subtract(java.lang.Object o)
          Reduces the count associated with this object by 1.
 java.lang.Object[] toArray()
           
 java.lang.Object[] toArray(java.lang.Object[] arg0)
           
 void write(java.lang.String fileName, int countCutoff)
           
 void write(java.lang.String fileName, int countCutoff, java.lang.String delim)
           
 void write(java.lang.String fileName, int countCutoff, java.lang.String delim, java.lang.String encoding)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Set
equals, hashCode
 

Constructor Detail

CountedSet

public CountedSet()
Creates a new counted set.


CountedSet

public CountedSet(int size)
Creates a new counted set of the specified initial size.

Parameters:
size - The initial size of this set.
Method Detail

add

public boolean add(java.lang.Object o)
Specified by:
add in interface java.util.Collection
Specified by:
add in interface java.util.Set

subtract

public void subtract(java.lang.Object o)
Reduces the count associated with this object by 1. If this causes the count to become 0, then the object is removed form the set.

Parameters:
o - The object whose count is being reduced.

setCount

public void setCount(java.lang.Object o,
                     int c)
Assigns the specified object the specified count in the set.

Parameters:
o - The object to be added or updated in the set.
c - The count of the specified object.

getCount

public int getCount(java.lang.Object o)
Return the count of the specified object.

Parameters:
o - the object whose count needs to be determined.
Returns:
the count of the specified object.

write

public void write(java.lang.String fileName,
                  int countCutoff)

write

public void write(java.lang.String fileName,
                  int countCutoff,
                  java.lang.String delim)

write

public void write(java.lang.String fileName,
                  int countCutoff,
                  java.lang.String delim,
                  java.lang.String encoding)

addAll

public boolean addAll(java.util.Collection c)
Specified by:
addAll in interface java.util.Collection
Specified by:
addAll in interface java.util.Set

clear

public void clear()
Specified by:
clear in interface java.util.Collection
Specified by:
clear in interface java.util.Set

contains

public boolean contains(java.lang.Object o)
Specified by:
contains in interface java.util.Collection
Specified by:
contains in interface java.util.Set

containsAll

public boolean containsAll(java.util.Collection c)
Specified by:
containsAll in interface java.util.Collection
Specified by:
containsAll in interface java.util.Set

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Collection
Specified by:
isEmpty in interface java.util.Set

iterator

public java.util.Iterator iterator()
Specified by:
iterator in interface java.lang.Iterable
Specified by:
iterator in interface java.util.Collection
Specified by:
iterator in interface java.util.Set

remove

public boolean remove(java.lang.Object o)
Specified by:
remove in interface java.util.Collection
Specified by:
remove in interface java.util.Set

removeAll

public boolean removeAll(java.util.Collection c)
Specified by:
removeAll in interface java.util.Collection
Specified by:
removeAll in interface java.util.Set

retainAll

public boolean retainAll(java.util.Collection c)
Specified by:
retainAll in interface java.util.Collection
Specified by:
retainAll in interface java.util.Set

size

public int size()
Specified by:
size in interface java.util.Collection
Specified by:
size in interface java.util.Set

toArray

public java.lang.Object[] toArray()
Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.Set

toArray

public java.lang.Object[] toArray(java.lang.Object[] arg0)
Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.Set


Copyright 2008 Jason Baldridge, Gann Bierner, and Thomas Morton. All Rights Reserved.