com.coyotegulch.jisp
Class StringKey

java.lang.Object
  extended by com.coyotegulch.jisp.KeyObject
      extended by com.coyotegulch.jisp.StringKey
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable

public class StringKey
extends KeyObject

StringKey defines a 16-character fixed-length text key.

See Also:
KeyObject, ObjectIndex, Serialized Form

Field Summary
protected static int KEY_LENGTH
           
 
Fields inherited from class com.coyotegulch.jisp.KeyObject
KEY_EQUAL, KEY_ERROR, KEY_LESS, KEY_MORE
 
Constructor Summary
StringKey()
          Creates a blank (null) StringKey.
StringKey(java.lang.String key_value)
          Creates a new StringKey using key_value.
 
Method Summary
 int compareTo(KeyObject key)
          Compares the invoking StringKey to key, returning one of the KEY_* constants based on the relationship of the two keys.
 int hashCode()
          Returns a hash code value for the object, which is, in effect, the the sum of the characters in the string key value.
 KeyObject makeNullKey()
          Returns a "null" (i.e., blank) StringKey, to be used as a space-holder in certain kinds of ObjectIndexes.
 void readExternal(java.io.ObjectInput in)
          StringKey implements the readExternal method to restore its contents.
 java.lang.String toString()
          Returns the String representation of a StringKey.
 void writeExternal(java.io.ObjectOutput out)
          StringKey implements the writeExternal method to save its contents.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

KEY_LENGTH

protected static final int KEY_LENGTH
See Also:
Constant Field Values
Constructor Detail

StringKey

public StringKey(java.lang.String key_value)
Creates a new StringKey using key_value.

Parameters:
key_value - The text of the newly-created key.

StringKey

public StringKey()
Creates a blank (null) StringKey.

Method Detail

compareTo

public int compareTo(KeyObject key)
Compares the invoking StringKey to key, returning one of the KEY_* constants based on the relationship of the two keys.

Specified by:
compareTo in class KeyObject
Parameters:
key - The StringKey value to be compared against the invoking key.
Returns:
one of the KEY_* constants based on the relationship of the two keys.

makeNullKey

public KeyObject makeNullKey()
Returns a "null" (i.e., blank) StringKey, to be used as a space-holder in certain kinds of ObjectIndexes.

Specified by:
makeNullKey in class KeyObject
Returns:
a "null" (i.e., blank) StringKey constant.
See Also:
BTreeIndex

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
StringKey implements the writeExternal method to save its contents.

Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
StringKey implements the readExternal method to restore its contents.

Throws:
java.io.IOException
java.lang.ClassNotFoundException

toString

public java.lang.String toString()
Returns the String representation of a StringKey.

Overrides:
toString in class KeyObject
Returns:
String representation of a StringKey.

hashCode

public int hashCode()
Returns a hash code value for the object, which is, in effect, the the sum of the characters in the string key value.

Overrides:
hashCode in class java.lang.Object
Returns:
hash code value for this object.
See Also:
Object, HashIndex