cic.wordnet.pairs
Class KeyArray

java.lang.Object
  extended by cic.wordnet.pairs.KeyArray
All Implemented Interfaces:
java.lang.Comparable<java.lang.Object>

public class KeyArray
extends java.lang.Object
implements java.lang.Comparable<java.lang.Object>

Class for mapping between a String and a ArrayList<String>. Used in WordNet class to store lemma/synsets and lemma/glosses mappings.

Author:
Francisco Viveros-Jiménez

Field Summary
(package private)  java.util.ArrayList<java.lang.String> array
          ArrayList associated to a key
(package private)  java.lang.String key
          Key value for searching.
 
Constructor Summary
KeyArray(java.lang.String key)
          Wrapper for creating a dull object for using ArrayList.indexOf(new KeyArray(key)).
KeyArray(java.lang.String key, java.util.ArrayList<java.lang.String> array)
          Creates a KeyArray object.
KeyArray(java.lang.String key, java.lang.String element)
          Creates a KeyArray object.
 
Method Summary
 void addElement(java.lang.String element)
          Adds an element to the array.
 void addElementWD(java.lang.String element)
          Adds an element to the array avoiding storing duplicate values.
 int compareTo(java.lang.Object object)
          compareTo allows comparisons against other KeyArray object or a String.
 boolean equals(java.lang.Object object)
          equals allows comparisons against other KeyArray object or a String.
 java.util.ArrayList<java.lang.String> getArray()
           
 java.lang.String getKey()
           
 java.lang.String toString()
          Returns "(key:array.toString())"
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

key

java.lang.String key
Key value for searching.


array

java.util.ArrayList<java.lang.String> array
ArrayList associated to a key

Constructor Detail

KeyArray

public KeyArray(java.lang.String key)
Wrapper for creating a dull object for using ArrayList.indexOf(new KeyArray(key)).

Parameters:
key - The key to search for.

KeyArray

public KeyArray(java.lang.String key,
                java.util.ArrayList<java.lang.String> array)
Creates a KeyArray object.

Parameters:
key - Key value for searching.
array - ArrayList associated to a key.

KeyArray

public KeyArray(java.lang.String key,
                java.lang.String element)
Creates a KeyArray object.

Parameters:
key - Key value for searching.
element - First element of the array.
Method Detail

getKey

public java.lang.String getKey()
Returns:
key.

getArray

public java.util.ArrayList<java.lang.String> getArray()
Returns:
array.

addElement

public void addElement(java.lang.String element)
Adds an element to the array.

Parameters:
element - The element to be added.

addElementWD

public void addElementWD(java.lang.String element)
Adds an element to the array avoiding storing duplicate values.

Parameters:
element - The element to add to.

equals

public boolean equals(java.lang.Object object)
equals allows comparisons against other KeyArray object or a String. The key field its used to perform both comparisons.

Overrides:
equals in class java.lang.Object

compareTo

public int compareTo(java.lang.Object object)
compareTo allows comparisons against other KeyArray object or a String. The key field its used to perform both comparisons.

Specified by:
compareTo in interface java.lang.Comparable<java.lang.Object>

toString

public java.lang.String toString()
Returns "(key:array.toString())"

Overrides:
toString in class java.lang.Object