IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.beans.infomining
Class CMBSchema

java.lang.Object
  |
  +--com.ibm.mm.beans.infomining.CMBSchema

public class CMBSchema
extends java.lang.Object

A schema defines the set of meta data that can be stored for a document.


Field Summary
static int DB_STRING_TYPE_CLOB
          The database type CLOB; to be used for a String value.
static int DB_STRING_TYPE_VARCHAR
          The database type VARCHAR; to be used for a String value.
 
Method Summary
 int getDBStringSize(java.lang.String key)
          Returns the size that is available in the database to store a string for the specified key.
 int getDBStringType(java.lang.String key)
          Returns the type that is used in the database to store a string for the specified key.
 java.lang.Class getType(java.lang.String key)
          Returns the type associated with the specified key.
 boolean isStringSearchable(java.lang.String key)
          Returns true if the values stored for the key are text searchable.
 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
 

Field Detail

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)
Method Detail

keySet

public java.util.Set keySet()
Returns a set view of the keys contained in this schema.
Returns:
a set of keys

getType

public java.lang.Class getType(java.lang.String key)
                        throws CMBNoSuchKeyException
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:
CMBNoSuchKeyException - if the specified key does not exist in this schema

getDBStringType

public int getDBStringType(java.lang.String key)
                    throws CMBNoSuchKeyException,
                           CMBInvalidTypeException
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:
CMBNoSuchKeyException - if the specified key does not exist in this schema
CMBInvalidTypeException - if the specified key is not associated with type String

getDBStringSize

public int getDBStringSize(java.lang.String key)
                    throws CMBNoSuchKeyException,
                           CMBInvalidTypeException
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:
CMBNoSuchKeyException - if the specified key does not exist in this schema
CMBInvalidTypeException - if the specified key is not associated with type String
See Also:
getDBStringType(String)

isStringSearchable

public boolean isStringSearchable(java.lang.String key)
                           throws CMBNoSuchKeyException,
                                  CMBInvalidTypeException
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:
CMBNoSuchKeyException - if the specified key does not exist in this schema
CMBInvalidTypeException - if the specified key is not associated with type String


IBM Information Integrator for Content V8.2 APIs

© Copyright International Business Machines Corporation 1996, 2003 IBM Corp. All rights reserved.