com.ibm.mm.sdk.common.infomining
Class DKIKFSchema
java.lang.Object
|
+--com.ibm.mm.sdk.common.infomining.DKIKFSchema
- All Implemented Interfaces:
- java.io.Serializable
- public abstract class DKIKFSchema
- extends java.lang.Object
- implements java.io.Serializable
A schema defines the set of meta data that can be stored in a
record
.
- See Also:
- Serialized Form
Method Summary |
abstract int |
getDBStringSize(java.lang.String key)
Returns the size that is available in the database to store a string for the
specified key. |
abstract int |
getDBStringType(java.lang.String key)
Returns the type that is used in the database to store a string for the
specified key. |
abstract java.lang.Class |
getType(java.lang.String key)
Returns the type associated with the specified key. |
abstract boolean |
isStringSearchable(java.lang.String key)
Returns true if the values stored for the key are text searchable. |
abstract java.util.Set |
keySet()
Returns a set view of the keys contained in this schema. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DB_STRING_TYPE_VARCHAR
public static final int DB_STRING_TYPE_VARCHAR
- The database type VARCHAR; to be used for a String value.
- See Also:
getDBStringType(String)
DB_STRING_TYPE_CLOB
public static final int DB_STRING_TYPE_CLOB
- The database type CLOB; to be used for a String value.
- See Also:
getDBStringType(String)
DKIKFSchema
protected DKIKFSchema()
- Objects can be obtained from
DKIKFCatalog.getSchema()
.
keySet
public abstract java.util.Set keySet()
- Returns a set view of the keys contained in this schema.
- Returns:
- a set of keys
getType
public abstract java.lang.Class getType(java.lang.String key)
- Returns the type associated with the specified key.
- Parameters:
key
- key whose associated type is to be returned- Returns:
- the type to which this schema maps the specified key
- Throws:
DKIKFNoSuchKeyException
- if the specified key does not exist in this schema
getDBStringSize
public abstract int getDBStringSize(java.lang.String key)
- Returns the size that is available in the database to store a string for the
specified key. The type associated with the key has to be
String
.
- Parameters:
key
- key whose associated database string size is to be returned- Returns:
- the database string size to which this schema maps the specified key
- Throws:
DKIKFNoSuchKeyException
- if the specified key does not exist in this schemaDKIKFInvalidTypeException
- if the specified key is not associated with type String
- See Also:
getDBStringType(String)
getDBStringType
public abstract int getDBStringType(java.lang.String key)
- Returns the type that is used in the database to store a string for the
specified key. The type associated with the key has to be
String
.
- Parameters:
key
- key whose associated database string type is to be returned- Returns:
- the database string type to which this schema maps the specified key
- Throws:
DKIKFNoSuchKeyException
- if the specified key does not exist in this schemaDKIKFInvalidTypeException
- if the specified key is not associated with type String
isStringSearchable
public abstract boolean isStringSearchable(java.lang.String key)
- Returns true if the values stored for the key are text searchable.
The type associated with the key has to be
String
.
- Parameters:
key
- key whose associated searchable-value is to be returned- Returns:
true
if the values stored for the key are text searchable; false
otherwise- Throws:
DKIKFNoSuchKeyException
- if the specified key does not exist in this schemaDKIKFInvalidTypeException
- if the specified key is not associated with type String
© Copyright International Business Machines Corporation 1996, 2003 IBM Corp. All rights reserved.