IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.sdk.common.infomining
Class DKIKFRecord

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.infomining.DKIKFRecord
All Implemented Interfaces:
java.io.Serializable

public abstract class DKIKFRecord
extends java.lang.Object
implements java.io.Serializable

A record contains the meta data for a document.

See Also:
Serialized Form

Constructor Summary
protected DKIKFRecord()
          Use create(String,DKIKFSchema) to create a record object.
 
Method Summary
static DKIKFRecord create(java.lang.String pid, DKIKFSchema schema)
          Creates a new record according to the specified schema.
abstract  java.lang.String getPID()
          Returns the PID of this record.
abstract  java.lang.Object getValue(java.lang.String key)
          Returns the value associated with the specified key.
abstract  java.util.Set keySet()
          Returns a set view of the keys contained in this record.
abstract  void setValue(java.lang.String key, java.lang.Object value)
          Associates the specified value with the specified key in this record.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKIKFRecord

protected DKIKFRecord()
Use create(String,DKIKFSchema) to create a record object.
Method Detail

create

public static DKIKFRecord create(java.lang.String pid,
                                 DKIKFSchema schema)
Creates a new record according to the specified schema. To create or update the appropriate record in a catalog use DKIKFCatalog.createRecord(DKIKFRecord, DKIKFCategory[]).
Parameters:
pid - the PID of the record
schema - the record is created according to this schema
Returns:
the new record

getPID

public abstract java.lang.String getPID()
Returns the PID of this record.
Returns:
the record PID

keySet

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

setValue

public abstract void setValue(java.lang.String key,
                              java.lang.Object value)
Associates the specified value with the specified key in this record. The type of the value is expected to be the same as defined in the catalog schema used to create the record.
Parameters:
key - key with which the specified value is to be associated
value - value to be associated with the specified key
Throws:
DKIKFNoSuchKeyException - if the specified key does not exist in the record

getValue

public abstract java.lang.Object getValue(java.lang.String key)
Returns the value associated with the specified key.
Parameters:
key - key whose associated value is to be returned.
Returns:
the value to which this record maps the specified key
Throws:
DKIKFNoSuchKeyException - if the specified key does not exist in the record

IBM Information Integrator for Content V8.2 APIs

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