Oracle Application Server DMS API Reference
10g Release 3 (10.1.3)

B25989-01


oracle.dms.table
Class Key

java.lang.Object
  extended byoracle.dms.table.Key

All Implemented Interfaces:
oracle.dms.table.KeyColumns, java.io.Serializable

public class Key
extends java.lang.Object
implements oracle.dms.table.KeyColumns

Table class uses Key instances to uniquely identify Rows. A Key instance contains a set of the key column names and values.

Since:
Oracle Application Server 10g (10.1.3)
See Also:
Serialized Form

Constructor Summary
Key(java.util.Map keyMap)
          Creates an object.

 

Method Summary
 boolean containsKey(java.lang.String name)
          Returns true if this Table contains the given key column.
 java.util.Enumeration enumerateKeys(boolean sorted)
          Enumerates the names of the key columns in this Table as Strings.
 java.lang.String[] getKeys()
          Gets the names of the key columns in this Table as an array.
 java.lang.Object getKeyValue(java.lang.String key)
          Gets the value of the given key column.
 int keyCount()
          Gets the number of the key columns in this Table.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

Key

public Key(java.util.Map keyMap)
Creates an object.
Parameters:
keyMap - key column values hashed by key column names.
Since:
Oracle Application Server 10g (10.1.3)

Method Detail

getKeyValue

public java.lang.Object getKeyValue(java.lang.String key)
Gets the value of the given key column.
Parameters:
key - the name of the key column.
Returns:
the value of the given key column.
Since:
Oracle Application Server 10g (10.1.3)

keyCount

public int keyCount()
Gets the number of the key columns in this Table.
Specified by:
keyCount in interface oracle.dms.table.KeyColumns
Returns:
the number of the key columns in this Table.

getKeys

public java.lang.String[] getKeys()
Gets the names of the key columns in this Table as an array.
Specified by:
getKeys in interface oracle.dms.table.KeyColumns
Returns:
the names of the key columns in this Table as an array.
See Also:
KeyColumns.enumerateKeys(boolean sorted)

containsKey

public boolean containsKey(java.lang.String name)
Returns true if this Table contains the given key column.
Specified by:
containsKey in interface oracle.dms.table.KeyColumns
Parameters:
name - the name of the key column.
Returns:
true if this Table contains the given key column.

enumerateKeys

public java.util.Enumeration enumerateKeys(boolean sorted)
Enumerates the names of the key columns in this Table as Strings.
Specified by:
enumerateKeys in interface oracle.dms.table.KeyColumns
Parameters:
sorted - true enumerates the names of the key columns in the acsending order.
Returns:
Enumeration object for enumerating the names of the key columns in this Table as Strings.
See Also:
KeyColumns.getKeys()

Oracle Application Server DMS API Reference
10g Release 3 (10.1.3)

B25989-01


Copyright © 2004, 2006, Oracle. All Rights Reserved.