IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.beans.infomining
Class CMBConnectedMiningBean

java.lang.Object
  |
  +--com.ibm.mm.beans.infomining.CMBInfoMiningBean
        |
        +--com.ibm.mm.beans.infomining.CMBConnectedMiningBean
All Implemented Interfaces:
com.ibm.mm.beans.CMBConnectionReplyListener, java.util.EventListener, java.io.Serializable
Direct Known Subclasses:
CMBAdvancedSearchService, CMBCatalogService, CMBInfoMiningAdapter, CMBTextAnalysisBean, CMBWebCrawlerService

public abstract class CMBConnectedMiningBean
extends CMBInfoMiningBean
implements com.ibm.mm.beans.CMBConnectionReplyListener

The CMBConnectedMiningBean class is the abstract superclass of the information mining beans that require a connection to the server.

It provides connection handling support to subclasses.

See Also:
Serialized Form

Constructor Summary
protected CMBConnectedMiningBean()
          Creates a new CMBConnectedMiningBean.
 
Method Summary
 com.ibm.mm.beans.CMBConnection getConnection()
          Returns the current connection object of this information mining bean.
protected  boolean isConnected()
          Returns true if there is an open server connection.
 void onCMBConnectionReply(com.ibm.mm.beans.CMBConnectionReplyEvent evt)
          Invoked when connection status changed.
 void setConnection(com.ibm.mm.beans.CMBConnection connection)
          Sets the connection object for this information mining bean.
protected  void validateConnection()
          Ensures that this information mining bean has an open connection.
 
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

CMBConnectedMiningBean

protected CMBConnectedMiningBean()
Creates a new CMBConnectedMiningBean.

Class CMBConnectedMiningBean can be extended directly to create a bean that is able communicate with the server.

Method Detail

validateConnection

protected void validateConnection()
                           throws com.ibm.mm.beans.CMBNoConnectionException
Ensures that this information mining bean has an open connection.
Throws:
com.ibm.mm.beans.CMBNoConnectionException - if there is no open connection to the server.
See Also:
isConnected()

setConnection

public void setConnection(com.ibm.mm.beans.CMBConnection connection)
Sets the connection object for this information mining bean.
Parameters:
connection - the connection to be set

getConnection

public com.ibm.mm.beans.CMBConnection getConnection()
Returns the current connection object of this information mining bean.
Returns:
the current connection object, or null if the connection object has not yet been received

isConnected

protected boolean isConnected()
Returns true if there is an open server connection.
Returns:
true if there is an open server connection, otherwise false
See Also:
validateConnection()

onCMBConnectionReply

public void onCMBConnectionReply(com.ibm.mm.beans.CMBConnectionReplyEvent evt)
Invoked when connection status changed.
Specified by:
onCMBConnectionReply in interface com.ibm.mm.beans.CMBConnectionReplyListener
Parameters:
evt - event details


IBM Information Integrator for Content V8.2 APIs

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