|
IBM Information Integrator for Content V8.2 APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.beans.infomining.CMBInfoMiningBean | +--com.ibm.mm.beans.infomining.CMBConnectedMiningBean | +--com.ibm.mm.beans.infomining.CMBCatalogService
The CMBCatalogService is a non-visual bean that can be used to store, lookup and delete information mining results for an item and to retrieve structural information about the catalog.
Properties and Events Overview: pre-conditions open server connection properties (default) catalogName ("") categorySeparator ('/') defaultCategoryPath ("") resultListSeparator (',') traceEnabled (false) bound properties none constrained properties none event target for CMBConnectionReplyEvent CMBStoreRecordRequestEvent CMBLookupRecordRequestEvent CMBDeleteRecordRequestEvent event source for CMBExceptionEvent CMBTraceEvent CMBStoreRecordReplyEvent CMBLookupRecordReplyEvent CMBDeleteRecordReplyEvent
Constructor Summary | |
CMBCatalogService()
Constructs a new CMBCatalogService. |
Method Summary | |
void |
addCMBDeleteRecordReplyListener(CMBDeleteRecordReplyListener l)
Adds the specified delete record reply listener so that delete record reply events can be received from this information mining bean. |
void |
addCMBLookupRecordReplyListener(CMBLookupRecordReplyListener l)
Adds the specified lookup record reply listener so that lookup record reply events can be received from this information mining bean. |
void |
addCMBStoreRecordReplyListener(CMBStoreRecordReplyListener l)
Adds the specified store record reply listener so that store record reply events can be received from this information mining bean. |
java.lang.String |
getCatalogName()
Returns the current catalog name. |
CMBCategory[] |
getCategoriesForRecord(com.ibm.mm.beans.CMBItem item)
Returns the categories to which the record of the specified item is assigned. |
char |
getCategorySeparator()
Gets the character to be used to separate individual category names in a category path |
java.lang.String |
getDefaultCategoryPath()
Returns the current default category path. |
java.lang.String[] |
getKeysToBeFetched()
Gets the keys to be fetched when retrieving a record from the Meta Data Store |
char |
getResultListSeparator()
Gets the character to be used to separated category paths |
CMBSchema |
getSchema()
Returns the catalog schema. |
CMBTaxonomy |
getTaxonomy()
Returns the catalog taxonomy. |
void |
onCMBDeleteRecordRequest(CMBDeleteRecordRequestEvent request)
This method gets called for a delete record request. |
void |
onCMBLookupRecordRequest(CMBLookupRecordRequestEvent request)
This method gets called for a lookup record request. |
void |
onCMBStoreRecordRequest(CMBStoreRecordRequestEvent request)
This method gets called for a store record request. |
boolean |
recordExists(com.ibm.mm.beans.CMBItem item)
Returns true if there is a record for the specified item in the catalog. |
void |
removeCMBDeleteRecordReplyListener(CMBDeleteRecordReplyListener l)
Removes the specified delete record reply listener so that it no longer receives delete record reply events from this information mining bean. |
void |
removeCMBLookupRecordReplyListener(CMBLookupRecordReplyListener l)
Removes the specified lookup record reply listener so that it no longer receives lookup record reply events from this information mining bean. |
void |
removeCMBStoreRecordReplyListener(CMBStoreRecordReplyListener l)
Removes the specified store record reply listener so that it no longer receives store record reply events from this information mining bean. |
void |
setCatalogName(java.lang.String catalogName)
Sets the name of the catalog to be used. |
void |
setCategorySeparator(char separator)
Sets the character to be used to separate individual category names in a category path |
void |
setDefaultCategoryPath(java.lang.String defaultCategoryPath)
Sets the category to be used if the record to be stored doesn't contain any category information. |
void |
setKeysToBeFetched(java.lang.String[] keysToBeFetched)
Sets the keys to be fetched when retrieving a record from the Meta Data Store. |
void |
setResultListSeparator(char separator)
Sets the character to be used to separated category paths. |
Methods inherited from class com.ibm.mm.beans.infomining.CMBConnectedMiningBean |
getConnection, isConnected, onCMBConnectionReply, setConnection, validateConnection |
Methods inherited from class com.ibm.mm.beans.infomining.CMBInfoMiningBean |
addCMBExceptionListener, addCMBTraceListener, isTraceEnabled, removeCMBExceptionListener, removeCMBTraceListener, setTraceEnabled |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CMBCatalogService()
Method Detail |
public void setCatalogName(java.lang.String catalogName)
catalogName
- the catalog name.getCatalogName()
public java.lang.String getCatalogName()
setCatalogName(String)
public CMBSchema getSchema() throws CMBNoSuchCatalogException, com.ibm.mm.beans.CMBNoConnectionException
public void setResultListSeparator(char separator)
separator
- character to be used to separate category pathsgetResultListSeparator()
public char getResultListSeparator()
setResultListSeparator(char)
public void setCategorySeparator(char separator)
separator
- character to be used to separate individual category names in a category pathgetCategorySeparator()
public char getCategorySeparator()
setCategorySeparator(char)
public void setKeysToBeFetched(java.lang.String[] keysToBeFetched)
keysToBeFetched
- array of key names that should be fetchedgetKeysToBeFetched()
public java.lang.String[] getKeysToBeFetched()
setKeysToBeFetched(String[])
public CMBTaxonomy getTaxonomy() throws CMBNoSuchCatalogException, com.ibm.mm.beans.CMBNoConnectionException
CMBNoSuchCatalogException
- if the current catalog name is invalidpublic void setDefaultCategoryPath(java.lang.String defaultCategoryPath)
defaultCategoryPath
- the path of the default category.getDefaultCategoryPath()
public java.lang.String getDefaultCategoryPath()
setDefaultCategoryPath(String)
public boolean recordExists(com.ibm.mm.beans.CMBItem item) throws CMBNoSuchCatalogException, com.ibm.mm.beans.CMBNoConnectionException
true
if there is a record for the specified item in the catalog.item
- an item.true
if the specified item exists in the catalog,
otherwise false
CMBNoSuchCatalogException
- if the current catalog name is invalid.public CMBCategory[] getCategoriesForRecord(com.ibm.mm.beans.CMBItem item) throws CMBNoSuchCatalogException, CMBNoSuchRecordException, com.ibm.mm.beans.CMBNoConnectionException
CMBNoSuchCatalogException
- if the current catalog name is invalidCMBNoSuchRecordException
- if there is no record for the specified itempublic void onCMBStoreRecordRequest(CMBStoreRecordRequestEvent request)
onCMBStoreRecordRequest
in interface CMBStoreRecordRequestListener
request
- an object describing event details.public void onCMBLookupRecordRequest(CMBLookupRecordRequestEvent request)
setKeysToBeFetched(String[])
.onCMBLookupRecordRequest
in interface CMBLookupRecordRequestListener
request
- an object describing event details.public void onCMBDeleteRecordRequest(CMBDeleteRecordRequestEvent request)
onCMBDeleteRecordRequest
in interface CMBDeleteRecordRequestListener
request
- an object describing event details.public void addCMBStoreRecordReplyListener(CMBStoreRecordReplyListener l)
l
- the store record reply listenerremoveCMBStoreRecordReplyListener(CMBStoreRecordReplyListener)
public void removeCMBStoreRecordReplyListener(CMBStoreRecordReplyListener l)
l
- the store record reply listeneraddCMBStoreRecordReplyListener(CMBStoreRecordReplyListener)
public void addCMBLookupRecordReplyListener(CMBLookupRecordReplyListener l)
l
- the lookup record reply listenerremoveCMBLookupRecordReplyListener(CMBLookupRecordReplyListener)
public void removeCMBLookupRecordReplyListener(CMBLookupRecordReplyListener l)
l
- the lookup record reply listeneraddCMBLookupRecordReplyListener(CMBLookupRecordReplyListener)
public void addCMBDeleteRecordReplyListener(CMBDeleteRecordReplyListener l)
l
- the delete record reply listenerremoveCMBDeleteRecordReplyListener(CMBDeleteRecordReplyListener)
public void removeCMBDeleteRecordReplyListener(CMBDeleteRecordReplyListener l)
l
- the delete record reply listeneraddCMBDeleteRecordReplyListener(CMBDeleteRecordReplyListener)
|
IBM Information Integrator for Content V8.2 APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |