IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.beans.infomining
Class CMBCatalogService

java.lang.Object
  |
  +--com.ibm.mm.beans.infomining.CMBInfoMiningBean
        |
        +--com.ibm.mm.beans.infomining.CMBConnectedMiningBean
              |
              +--com.ibm.mm.beans.infomining.CMBCatalogService
All Implemented Interfaces:
com.ibm.mm.beans.CMBConnectionReplyListener, CMBDeleteRecordRequestListener, CMBLookupRecordRequestListener, CMBStoreRecordRequestListener, java.util.EventListener, java.io.Serializable

public class CMBCatalogService
extends CMBConnectedMiningBean
implements CMBStoreRecordRequestListener, CMBLookupRecordRequestListener, CMBDeleteRecordRequestListener

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
 

See Also:
Serialized Form

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

CMBCatalogService

public CMBCatalogService()
Constructs a new CMBCatalogService.
Method Detail

setCatalogName

public void setCatalogName(java.lang.String catalogName)
Sets the name of the catalog to be used.
Parameters:
catalogName - the catalog name.
See Also:
getCatalogName()

getCatalogName

public java.lang.String getCatalogName()
Returns the current catalog name.
Returns:
the catalog name.
See Also:
setCatalogName(String)

getSchema

public CMBSchema getSchema()
                    throws CMBNoSuchCatalogException,
                           com.ibm.mm.beans.CMBNoConnectionException
Returns the catalog schema.
Returns:
the catalog schema.

setResultListSeparator

public void setResultListSeparator(char separator)
Sets the character to be used to separated category paths.
Parameters:
separator - character to be used to separate category paths
See Also:
getResultListSeparator()

getResultListSeparator

public char getResultListSeparator()
Gets the character to be used to separated category paths
Returns:
separator character to be used to separate category paths
See Also:
setResultListSeparator(char)

setCategorySeparator

public void setCategorySeparator(char separator)
Sets the character to be used to separate individual category names in a category path
Parameters:
separator - character to be used to separate individual category names in a category path
See Also:
getCategorySeparator()

getCategorySeparator

public char getCategorySeparator()
Gets the character to be used to separate individual category names in a category path
Returns:
character to be used to separate individual category names in a category path
See Also:
setCategorySeparator(char)

setKeysToBeFetched

public void setKeysToBeFetched(java.lang.String[] keysToBeFetched)
Sets the keys to be fetched when retrieving a record from the Meta Data Store.
Parameters:
keysToBeFetched - array of key names that should be fetched
See Also:
getKeysToBeFetched()

getKeysToBeFetched

public java.lang.String[] getKeysToBeFetched()
Gets the keys to be fetched when retrieving a record from the Meta Data Store
Returns:
array of key names that should be fetched
See Also:
setKeysToBeFetched(String[])

getTaxonomy

public CMBTaxonomy getTaxonomy()
                        throws CMBNoSuchCatalogException,
                               com.ibm.mm.beans.CMBNoConnectionException
Returns the catalog taxonomy.
Returns:
the taxonomy
Throws:
CMBNoSuchCatalogException - if the current catalog name is invalid

setDefaultCategoryPath

public void setDefaultCategoryPath(java.lang.String defaultCategoryPath)
Sets the category to be used if the record to be stored doesn't contain any category information.
Parameters:
defaultCategoryPath - the path of the default category.
See Also:
getDefaultCategoryPath()

getDefaultCategoryPath

public java.lang.String getDefaultCategoryPath()
Returns the current default category path.
Returns:
the default category.
See Also:
setDefaultCategoryPath(String)

recordExists

public boolean recordExists(com.ibm.mm.beans.CMBItem item)
                     throws CMBNoSuchCatalogException,
                            com.ibm.mm.beans.CMBNoConnectionException
Returns true if there is a record for the specified item in the catalog.
Parameters:
item - an item.
Returns:
true if the specified item exists in the catalog, otherwise false
Throws:
CMBNoSuchCatalogException - if the current catalog name is invalid.

getCategoriesForRecord

public CMBCategory[] getCategoriesForRecord(com.ibm.mm.beans.CMBItem item)
                                     throws CMBNoSuchCatalogException,
                                            CMBNoSuchRecordException,
                                            com.ibm.mm.beans.CMBNoConnectionException
Returns the categories to which the record of the specified item is assigned.
Returns:
the currently assigned categories
Throws:
CMBNoSuchCatalogException - if the current catalog name is invalid
CMBNoSuchRecordException - if there is no record for the specified item

onCMBStoreRecordRequest

public void onCMBStoreRecordRequest(CMBStoreRecordRequestEvent request)
This method gets called for a store record request.
Specified by:
onCMBStoreRecordRequest in interface CMBStoreRecordRequestListener
Parameters:
request - an object describing event details.

onCMBLookupRecordRequest

public void onCMBLookupRecordRequest(CMBLookupRecordRequestEvent request)
This method gets called for a lookup record request. The list of keys to be fetched when looking up the record can be specified using setKeysToBeFetched(String[]).
Specified by:
onCMBLookupRecordRequest in interface CMBLookupRecordRequestListener
Parameters:
request - an object describing event details.

onCMBDeleteRecordRequest

public void onCMBDeleteRecordRequest(CMBDeleteRecordRequestEvent request)
This method gets called for a delete record request.
Specified by:
onCMBDeleteRecordRequest in interface CMBDeleteRecordRequestListener
Parameters:
request - an object describing event details.

addCMBStoreRecordReplyListener

public 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.
Parameters:
l - the store record reply listener
See Also:
removeCMBStoreRecordReplyListener(CMBStoreRecordReplyListener)

removeCMBStoreRecordReplyListener

public 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.
Parameters:
l - the store record reply listener
See Also:
addCMBStoreRecordReplyListener(CMBStoreRecordReplyListener)

addCMBLookupRecordReplyListener

public 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.
Parameters:
l - the lookup record reply listener
See Also:
removeCMBLookupRecordReplyListener(CMBLookupRecordReplyListener)

removeCMBLookupRecordReplyListener

public 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.
Parameters:
l - the lookup record reply listener
See Also:
addCMBLookupRecordReplyListener(CMBLookupRecordReplyListener)

addCMBDeleteRecordReplyListener

public 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.
Parameters:
l - the delete record reply listener
See Also:
removeCMBDeleteRecordReplyListener(CMBDeleteRecordReplyListener)

removeCMBDeleteRecordReplyListener

public 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.
Parameters:
l - the delete record reply listener
See Also:
addCMBDeleteRecordReplyListener(CMBDeleteRecordReplyListener)


IBM Information Integrator for Content V8.2 APIs

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