Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKEntityDefIC

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractEntityDef
        |
        +--com.ibm.mm.sdk.common.DKEntityDefIC
All Implemented Interfaces:
DKConstant, DKConstantIC, dkEntityDef, DKMessageId, DKMessageIdIC, java.io.Serializable

public class DKEntityDefIC
extends dkAbstractEntityDef
implements DKConstantIC, DKMessageIdIC, java.io.Serializable

This class defines methods to access entity information for an index class

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantIC
DK_CM_PARM_LINKS, DK_IC_DSTYPE
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdIC
DK_IC_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKEntityDefIC()
          Constructs an index class def for IC
DKEntityDefIC(dkDatastore ds)
          Constructs an index class def for IC
 
Method Summary
 void add()
          Adds this entity definition to the persistent store, i.e.
 void add(dkAttrDef attrObj)
          Adds the given attribute definition object to the this entity in the persistent store.
static DKEntityDefIC buildEntityDef(dkDatastore ds, java.lang.String name, dkResultSetCursor cursor)
          Loads the entity definition for the specified entity from the datastore and returns it to the caller.
 dkAttrDef createAttr()
          Creates new dkAttrDef and returns it to caller.
 void del()
          Deletes this entity from the persistent store, e.g.
 void del(dkAttrDef attrObj)
          Deletes the given attribute from this entity in the persistent store.
 dkAttrDef getAttr(java.lang.String attrName)
          Retrieves an attribute object from a given attribute name
 java.lang.String[] listAttrNames()
          Gets a list of attributes
 dkCollection listAttrs()
          Gets a list of attributes
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef
add, addAttr, addSubEntity, clearCache, createSubEntity, datastoreName, datastoreType, del, deleteAttr, deleteSubEntity, getDatastore, getDescription, getName, getParentEntityName, getSubEntity, getType, hasSubEntities, isSearchable, isTextSearchable, listSubEntities, listSubEntityNames, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDatastore, setDescription, setName, setParentEntityName, setTextSearchable, setType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKEntityDefIC

public DKEntityDefIC()
Constructs an index class def for IC

DKEntityDefIC

public DKEntityDefIC(dkDatastore ds)
Constructs an index class def for IC
Parameters:
ds - datastore
Method Detail

createAttr

public dkAttrDef createAttr()
                     throws DKException,
                            java.lang.Exception
Creates new dkAttrDef and returns it to caller.
Overrides:
createAttr in class dkAbstractEntityDef
Returns:
new dkAttrDef object.

getAttr

public dkAttrDef getAttr(java.lang.String attrName)
                  throws DKException,
                         java.lang.Exception
Retrieves an attribute object from a given attribute name
Overrides:
getAttr in class dkAbstractEntityDef
Parameters:
attrName - name of attribute to be retrieved
Returns:
an attribute object
Throws:
DKException - if the attribute name is not exist

listAttrs

public dkCollection listAttrs()
                       throws DKException,
                              java.lang.Exception
Gets a list of attributes
Overrides:
listAttrs in class dkAbstractEntityDef
Returns:
a dkCollection of dkAttrDef's
Throws:
DKException - if error occurs

listAttrNames

public java.lang.String[] listAttrNames()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of attributes
Overrides:
listAttrNames in class dkAbstractEntityDef
Returns:
an array of attribute names
Throws:
DKException - if error occurs

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this entity definition to the persistent store, i.e. make this entity persistent. This method is not supported and will throw an exception if called
Overrides:
add in class dkAbstractEntityDef
Throws:
DKException - if this method is called.

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes this entity from the persistent store, e.g. drop table. The in-memory copy is not changed. Method not supported in this connector.
Overrides:
del in class dkAbstractEntityDef
Throws:
DKException - if this method is called.

add

public void add(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Adds the given attribute definition object to the this entity in the persistent store. Method not supported in this connector.
Overrides:
add in class dkAbstractEntityDef
Parameters:
attrObj - an attribute object to be added to this entity object
Throws:
DKException - if this method is called.

del

public void del(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Deletes the given attribute from this entity in the persistent store. Method not supported in this connector.
Overrides:
del in class dkAbstractEntityDef
Parameters:
attrObj - an attribute object to be deleted from this entity object
Throws:
DKException - if this method is called.

buildEntityDef

public static DKEntityDefIC buildEntityDef(dkDatastore ds,
                                           java.lang.String name,
                                           dkResultSetCursor cursor)
                                    throws DKException,
                                           java.lang.Exception
Loads the entity definition for the specified entity from the datastore and returns it to the caller.
Parameters:
ds - IC Datastore this entity is from.
name - Name of the entity to create
desc - Description of entity
cursor - Result set cursor to load the attribute information from. Column 1 must be the attribute name and column 2 must be the attribute description.
Returns:
the entity def object.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.