org.rimudb
Class KeyList

java.lang.Object
  extended by org.rimudb.KeyList
All Implemented Interfaces:
java.io.Serializable

Deprecated. Use WhereList instead.

@Deprecated
public class KeyList
extends java.lang.Object
implements java.io.Serializable

This class represents a list of KeyColumns.

See Also:
Serialized Form

Constructor Summary
KeyList()
          Deprecated. Construct a KeyList
KeyList(KeyList keylist)
          Deprecated. Construct a KeyList from another KeyList.
KeyList(WhereList whereList)
          Deprecated.  
 
Method Summary
 void add(KeyColumn keyColumn)
          Deprecated. Add a new KeyColumn to the end of the KeyList
 void add(java.lang.String name, java.lang.Object value)
          Deprecated. Add a new KeyColumn to the end of the KeyList
 boolean contains(java.lang.String propertyName)
          Deprecated. Return true if the propertyName exists in the keyList
 boolean containsNull()
          Deprecated. Return true if the keylist contains a null value
 boolean equals(java.lang.Object obj)
          Deprecated.  
 boolean equalsPartial(java.lang.Object obj)
          Deprecated. Return true if the partial keylist contains identical keys to the partial part of this keylist.
protected  java.util.List<KeyColumn> getInternalKeyList()
          Deprecated. Return the internal key list.
 java.lang.String getName(int index)
          Deprecated. Return the key name at 'index'
 java.lang.String getUniquePropertyID()
          Deprecated. Return a unique ID.
 java.lang.Object getValue(int index)
          Deprecated. Return the key value at 'index'.
 java.math.BigDecimal getValueAsBigDecimal(int index)
          Deprecated. Convenience method to get the value at a specific index as a BigDecimal.
 java.sql.Date getValueAsDate(int index)
          Deprecated. Convenience method to get the value at a specific index as a java.sql.Date.
 double getValueAsDouble(int index)
          Deprecated. Convenience method to get the value at a specific index as a double.
 float getValueAsFloat(int index)
          Deprecated. Convenience method to get the value at a specific index as a float.
 int getValueAsInt(int index)
          Deprecated. Convenience method to get the value at a specific index as an int.
 long getValueAsLong(int index)
          Deprecated. Convenience method to get the value at a specific index as a long.
 short getValueAsShort(int index)
          Deprecated. Convenience method to get the value at a specific index as a short.
 java.lang.String getValueAsString(int index)
          Deprecated. Convenience method to get the value at a specific index as a String.
 java.sql.Timestamp getValueAsTimestamp(int index)
          Deprecated. Convenience method to get the value at a specific index as a Timestamp.
 java.lang.Object getValueByName(java.lang.String propertyName)
          Deprecated.  
 int hashCode()
          Deprecated.  
 int size()
          Deprecated. Return the number of keys in the list.
 java.lang.String toDefinitionString()
          Deprecated. Return a string representing the full key with trimmed values.
 java.lang.String toString()
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

KeyList

public KeyList()
Deprecated. 
Construct a KeyList


KeyList

public KeyList(KeyList keylist)
Deprecated. 
Construct a KeyList from another KeyList.

Parameters:
keylist - KeyList

KeyList

public KeyList(WhereList whereList)
Deprecated. 
Method Detail

getInternalKeyList

protected java.util.List<KeyColumn> getInternalKeyList()
Deprecated. 
Return the internal key list.

Returns:
List

equalsPartial

public boolean equalsPartial(java.lang.Object obj)
Deprecated. 
Return true if the partial keylist contains identical keys to the partial part of this keylist. The keylists are compared to find the keylist with the smallest number of keys. This number of keys are compared between each keylist. This allows the keylist of a child record to be compared with the keylist of parent to see if the primary keys match.

Parameters:
obj - Object
Returns:
boolean

size

public int size()
Deprecated. 
Return the number of keys in the list.

Returns:
int

getName

public java.lang.String getName(int index)
Deprecated. 
Return the key name at 'index'

Parameters:
index - int
Returns:
String

getValue

public java.lang.Object getValue(int index)
Deprecated. 
Return the key value at 'index'.

Parameters:
index - int
Returns:
Object

getValueAsInt

public int getValueAsInt(int index)
Deprecated. 
Convenience method to get the value at a specific index as an int.

Parameters:
index - int
Returns:
int

getValueAsLong

public long getValueAsLong(int index)
Deprecated. 
Convenience method to get the value at a specific index as a long.

Parameters:
index - int
Returns:
long

getValueAsString

public java.lang.String getValueAsString(int index)
Deprecated. 
Convenience method to get the value at a specific index as a String.

Parameters:
index - int
Returns:
String

getValueAsTimestamp

public java.sql.Timestamp getValueAsTimestamp(int index)
Deprecated. 
Convenience method to get the value at a specific index as a Timestamp.

Parameters:
index - int
Returns:
Timestamp

getValueAsDate

public java.sql.Date getValueAsDate(int index)
Deprecated. 
Convenience method to get the value at a specific index as a java.sql.Date.

Parameters:
index - int
Returns:
Date

getValueAsBigDecimal

public java.math.BigDecimal getValueAsBigDecimal(int index)
Deprecated. 
Convenience method to get the value at a specific index as a BigDecimal.

Parameters:
index - int
Returns:
BigDecimal

getValueAsDouble

public double getValueAsDouble(int index)
Deprecated. 
Convenience method to get the value at a specific index as a double.

Parameters:
index - int
Returns:
double

getValueAsFloat

public float getValueAsFloat(int index)
Deprecated. 
Convenience method to get the value at a specific index as a float.

Parameters:
index - int
Returns:
float

getValueAsShort

public short getValueAsShort(int index)
Deprecated. 
Convenience method to get the value at a specific index as a short.

Parameters:
index - int
Returns:
short

toDefinitionString

public java.lang.String toDefinitionString()
Deprecated. 
Return a string representing the full key with trimmed values. The results of this method are not suitable for display to a user. This is normally used as a unique String representation of the key.

Returns:
String

toString

public java.lang.String toString()
Deprecated. 
Overrides:
toString in class java.lang.Object

containsNull

public boolean containsNull()
Deprecated. 
Return true if the keylist contains a null value

Returns:
boolean

add

public void add(java.lang.String name,
                java.lang.Object value)
Deprecated. 
Add a new KeyColumn to the end of the KeyList

Parameters:
name -
value -

add

public void add(KeyColumn keyColumn)
Deprecated. 
Add a new KeyColumn to the end of the KeyList

Parameters:
keyColumn - KeyColumn

equals

public boolean equals(java.lang.Object obj)
Deprecated. 
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Deprecated. 
Overrides:
hashCode in class java.lang.Object

getUniquePropertyID

public java.lang.String getUniquePropertyID()
Deprecated. 
Return a unique ID. This ID is intended to be used for caching SQL statements. The property names are part of the uniqueID, but the values are not.

Returns:
String

contains

public boolean contains(java.lang.String propertyName)
Deprecated. 
Return true if the propertyName exists in the keyList

Parameters:
propertyName -
Returns:
boolean

getValueByName

public java.lang.Object getValueByName(java.lang.String propertyName)
Deprecated. 
Parameters:
propertyName -
Returns:
Object The value for the propertyName


Copyright © 2008-2011 Simon Ritchie. All Rights Reserved.