AgentDE
Class IAD_Connect

java.lang.Object
  |
  +--AgentDE.IAD_Connect
Direct Known Subclasses:
CWEB_GetWebDocument, IA_ConnectAglet, IA_ConnectCIP, IA_ConnectJDBC, IA_ConnectLocal, IA_ConnectLocal2, IA_ConnectNativeDemo, IA_ConnectNetwork, IA_ConnectRHermes, IA_ConnectRoutePlanner, IA_ConnectStub, IA_ConnectSystem, IA_ConnectTCPIP, IA_ConnectTPdatabase

public abstract class IAD_Connect
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Overview -- IMPACT Asset connection base class from which all connection modules (i.e. IA_ConnectRHermes, IA_ConnectLocal, IA_ConnectAglet) extend.
This class defines abstract methods (which extension classes must define) as well as data elements and methods shared by all extension classes.

See Also:
Serialized Form

Field Summary
 IAD_Connect altIacNode
           
 boolean bConnectStartsDataFlow
           
 IAD_ConnectParameter[] connParamArray
           
private  long lElapsedTime
           
private  long lStartTime
           
private  long lStopTime
           
static int nALIAS_VALUE
           
 java.lang.String szAlias
           
static java.lang.String szALIAS_LABEL
           
static java.lang.String szALT_ALIAS_LABEL
           
 java.lang.String szAltAlias
           
static java.lang.String szDATASOURCE_LABEL
           
private static java.lang.String szHEAD
           
static java.lang.String szPASSWORD_LABEL
           
static java.lang.String szPORT_LABEL
           
 java.lang.String szType
           
static java.lang.String szURL_LABEL
           
static java.lang.String szUSERID_LABEL
           
private  java.util.Vector vDataMethods
           
private  java.util.Vector vDataSources
           
private  java.util.Vector vDataTypes
           
 
Constructor Summary
IAD_Connect()
           
 
Method Summary
 boolean addDataMethod(IAD_Function_DataCC tgtIAFuncDataMethod)
          Adds an IMPACT code-call method definition (IAD_Function_DataCC) object to the local store vector
(Called within connect module extension classes to document connection centric code-call methods).
 boolean addDataSource(java.lang.Object tgtObject)
          Adds a data source reference object to the local store vector
(Called within connect module extension classes to document connection centric data sources).
 boolean addDataType(IAD_Type tgtType)
          Adds an IMPACT type definition (IAD_Type) object to the local store vector.
(Called within connect module extension classes to document connection centric type definitions).
 void clearDataMethods()
          Flushes the IMPACT code-call definition store vector.
 void clearDataSources()
          Flushes the data source reference store vector.
 void clearDataTypes()
          Flushes the IMPACT type definition store vector.
abstract  java.lang.Object clone()
           
 boolean commit(IA_Global gRef, int nDepth)
           
abstract  boolean connect(IA_Global gRef, int nDepth)
           
 boolean connectionStartsDataFlow()
           
abstract  boolean disconnect(IA_Global gRef, int nDepth)
           
abstract  java.util.Vector executeCC(IAD_CCAtom tgtCCAtom, IA_Global gRef, int nDepth, java.lang.String szPrefix)
           
 IAD_Function_DataCC findMethod(java.lang.String szTgtKey, IA_Global gRef, int nDepth)
          Searches the IMPACT code-call method definition (IAD_Function_DataCC) local store vector for the target code-call reference key (szTgtKey).
 IAD_Type findType(java.lang.String szTgtKey, IA_Global gRef, int nDepth)
          Searches the IMPACT type definition (IAD_Type) local store vector for the target type reference key (szTgtKey).
 java.lang.String getAlias()
           
 IAD_Connect getAlternateConnection()
           
 IAD_ConnectParameter[] getConParamArray()
           
 java.util.Vector getDataMethods(IA_Global gRef, int nDepth)
          Returns the IMPACT code-call method store vector
(Called by Connect module clients to discover connection code-call methods).
 java.util.Vector getDataSources(IA_Global gRef, int nDepth)
          Returns the data source reference store vector
(Called by Connect module clients to discover connection centric data sources).
 java.util.Vector getDataTypes(IA_Global gRef, int nDepth)
          Returns the IMPACT type definition store vector
(Called by Connect module clients to discover connection centric type definitions).
(package private)  java.lang.String getExportString()
           
 java.lang.String getSzDataMethodList()
          Renders a listing of the connection centric IMPACT code-call methods.
abstract  java.lang.String getSzDescription()
           
 java.lang.String getSzType()
           
abstract  void getTiming(boolean bEchoDebug)
           
 java.lang.String getVerboseTypeString(java.lang.String szSrcType)
           
 void initTransients(IA_Global gRef, int nDepth)
           
abstract  boolean isConnected()
           
 void logStartTime(IA_Global gRef)
           
 void logStopTime(IA_Global gRef)
           
 boolean rollback(IA_Global gRef, int nDepth)
           
abstract  void saveParameters(IA_Global gRef, int nDepth)
           
 void setAlias(java.lang.String szSrc)
           
 void setAlternateConnection(IAD_Connect srcAltIacNode)
           
 void setBaseDataMembersFrom(IAD_Connect srcConnection)
           
 java.lang.String toString()
           
abstract  boolean validates(IA_Global gRef, int nDepth)
           
 
Methods inherited from class java.lang.Object
, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

szHEAD

private static final transient java.lang.String szHEAD

nALIAS_VALUE

public static final transient int nALIAS_VALUE

szALIAS_LABEL

public static final transient java.lang.String szALIAS_LABEL

szALT_ALIAS_LABEL

public static final transient java.lang.String szALT_ALIAS_LABEL

szURL_LABEL

public static final transient java.lang.String szURL_LABEL

szPORT_LABEL

public static final transient java.lang.String szPORT_LABEL

szDATASOURCE_LABEL

public static final transient java.lang.String szDATASOURCE_LABEL

szUSERID_LABEL

public static final transient java.lang.String szUSERID_LABEL

szPASSWORD_LABEL

public static final transient java.lang.String szPASSWORD_LABEL

connParamArray

public IAD_ConnectParameter[] connParamArray

vDataTypes

private java.util.Vector vDataTypes

vDataSources

private java.util.Vector vDataSources

vDataMethods

private java.util.Vector vDataMethods

szAlias

public java.lang.String szAlias

szAltAlias

public java.lang.String szAltAlias

szType

public java.lang.String szType

altIacNode

public IAD_Connect altIacNode

bConnectStartsDataFlow

public boolean bConnectStartsDataFlow

lStartTime

private long lStartTime

lStopTime

private long lStopTime

lElapsedTime

private long lElapsedTime
Constructor Detail

IAD_Connect

public IAD_Connect()
Method Detail

setBaseDataMembersFrom

public final void setBaseDataMembersFrom(IAD_Connect srcConnection)

addDataType

public final boolean addDataType(IAD_Type tgtType)
Adds an IMPACT type definition (IAD_Type) object to the local store vector.
(Called within connect module extension classes to document connection centric type definitions).
Returns:
(boolean) Success == True,
Failure == False.

getDataTypes

public final java.util.Vector getDataTypes(IA_Global gRef,
                                           int nDepth)
Returns the IMPACT type definition store vector
(Called by Connect module clients to discover connection centric type definitions).
Returns:
(Vector) Connect modules IMPACT type definition list.

clearDataTypes

public final void clearDataTypes()
Flushes the IMPACT type definition store vector.

addDataSource

public final boolean addDataSource(java.lang.Object tgtObject)
Adds a data source reference object to the local store vector
(Called within connect module extension classes to document connection centric data sources).
Returns:
(boolean) Success == True,
Failure == False.

getDataSources

public final java.util.Vector getDataSources(IA_Global gRef,
                                             int nDepth)
Returns the data source reference store vector
(Called by Connect module clients to discover connection centric data sources).
Returns:
(Vector) Connect modules data source reference list.

clearDataSources

public final void clearDataSources()
Flushes the data source reference store vector.

addDataMethod

public final boolean addDataMethod(IAD_Function_DataCC tgtIAFuncDataMethod)
Adds an IMPACT code-call method definition (IAD_Function_DataCC) object to the local store vector
(Called within connect module extension classes to document connection centric code-call methods).
Returns:
(boolean) Success == True,
Failure == False.

getDataMethods

public final java.util.Vector getDataMethods(IA_Global gRef,
                                             int nDepth)
Returns the IMPACT code-call method store vector
(Called by Connect module clients to discover connection code-call methods).
Returns:
(Vector) Connect modules code-call reference (IAD_Function_DataCC) list.

clearDataMethods

public final void clearDataMethods()
Flushes the IMPACT code-call definition store vector.

getSzDataMethodList

public final java.lang.String getSzDataMethodList()
Renders a listing of the connection centric IMPACT code-call methods.
Returns:
IMPACT code-call method (IAD_Function_DataCC) list.

findType

public final IAD_Type findType(java.lang.String szTgtKey,
                               IA_Global gRef,
                               int nDepth)
Searches the IMPACT type definition (IAD_Type) local store vector for the target type reference key (szTgtKey).
Returns:
Success == instantiated IAD_Type object,
Failure == null.

findMethod

public final IAD_Function_DataCC findMethod(java.lang.String szTgtKey,
                                            IA_Global gRef,
                                            int nDepth)
Searches the IMPACT code-call method definition (IAD_Function_DataCC) local store vector for the target code-call reference key (szTgtKey).
Returns:
Success == instantiated IAD_Function_DataCC object,
Failure == null.

getConParamArray

public final IAD_ConnectParameter[] getConParamArray()

toString

public final java.lang.String toString()
Overrides:
toString in class java.lang.Object

setAlias

public final void setAlias(java.lang.String szSrc)

getAlias

public final java.lang.String getAlias()

setAlternateConnection

public final void setAlternateConnection(IAD_Connect srcAltIacNode)

getAlternateConnection

public final IAD_Connect getAlternateConnection()

getSzType

public final java.lang.String getSzType()

getVerboseTypeString

public final java.lang.String getVerboseTypeString(java.lang.String szSrcType)

connectionStartsDataFlow

public final boolean connectionStartsDataFlow()

clone

public abstract java.lang.Object clone()
Overrides:
clone in class java.lang.Object

getSzDescription

public abstract java.lang.String getSzDescription()

connect

public abstract boolean connect(IA_Global gRef,
                                int nDepth)

validates

public abstract boolean validates(IA_Global gRef,
                                  int nDepth)

saveParameters

public abstract void saveParameters(IA_Global gRef,
                                    int nDepth)

isConnected

public abstract boolean isConnected()

disconnect

public abstract boolean disconnect(IA_Global gRef,
                                   int nDepth)

executeCC

public abstract java.util.Vector executeCC(IAD_CCAtom tgtCCAtom,
                                           IA_Global gRef,
                                           int nDepth,
                                           java.lang.String szPrefix)

getTiming

public abstract void getTiming(boolean bEchoDebug)

getExportString

final java.lang.String getExportString()

logStartTime

public final void logStartTime(IA_Global gRef)

logStopTime

public final void logStopTime(IA_Global gRef)

commit

public boolean commit(IA_Global gRef,
                      int nDepth)

rollback

public boolean rollback(IA_Global gRef,
                        int nDepth)

initTransients

public void initTransients(IA_Global gRef,
                           int nDepth)