com.altair.hwm.beans.hm
Class HMTCLProcInfo

java.lang.Object
  com.altair.hwm.beans.hm.HMTCLProcInfo

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class HMTCLProcInfo
extends java.lang.Object
implements java.io.Externalizable

Title: HMTCLProcInfo

Description: The TCL procedures are stored as a Hashtable of procedure name to the procedure definition(stored as a string) in this class which also contains the main proc name

Company: Altair Engineering Inc.

See Also:

Serialized Form

Field Summary

static java.lang.String

VERSION The version ID for this component

Constructor Summary

HMTCLProcInfo()

Method Summary

void	AddProcDefinition(java.lang.String[] arrstrProcDefn) Sets the procedure's defn as an array of 3 strings index 0 is the name of the procedure index 1 is the ',' separated arguments of the procedure index 2 is the rest of the procedure's body
java.lang.String	GetMainProcName() Gets the main proc's name
java.lang.String[]	GetProcDefinition(java.lang.String strProcName) Gets the procedure's defn
java.util.Hashtable	GetProcedures() Returns all the proc definitions as a Hashtable from proc name to its definition
void	readExternal(java.io.ObjectInput objInput) Loads the data for this bean
void	RemoveProcDefinition(java.lang.String strProcName) Remove the procedure's defn
void	SetMainProcName(java.lang.String strMainProcName) Sets the main proc's name
void	SetProcedures(java.util.Hashtable hashtableProcDefns) Sets all the proc definitions as a Hashtable from proc name to its definition
void	writeExternal(java.io.ObjectOutput objOutput) Saves the data for this bean

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final java.lang.String VERSION

The version ID for this component

See Also:

Constant Field Values

Constructor Detail

HMTCLProcInfo

public HMTCLProcInfo()

Method Detail

AddProcDefinition

public void AddProcDefinition(java.lang.String[] arrstrProcDefn)
                       throws java.lang.Exception

Sets the procedure's defn as an array of 3 strings index 0 is the name of the procedure index 1 is the ',' separated arguments of the procedure index 2 is the rest of the procedure's body

Parameters:

arrstrProcDefn - The array of 3 strings defining the procedure

Throws:

java.lang.Exception

RemoveProcDefinition

public void RemoveProcDefinition(java.lang.String strProcName)

Remove the procedure's defn

Parameters:

strName - The name of the procedure to remove from the table of procedures

GetProcDefinition

public java.lang.String[] GetProcDefinition(java.lang.String strProcName)

Gets the procedure's defn

Parameters:

strName - The name of the procedure to retrieve from the table of procedures

Returns:

String[] Returns the procedure definition as an array of 3 strings: index 0 is the name of the procedure index 1 is the ',' separated arguments of the procedure index 2 is the rest of the procedure's body or null if the procedure definition does not exist.

SetMainProcName

public void SetMainProcName(java.lang.String strMainProcName)

Sets the main proc's name

Parameters:

strMainProc - The main procedure's name

GetMainProcName

public java.lang.String GetMainProcName()

Gets the main proc's name

Returns:

String The main procedure's name

GetProcedures

public java.util.Hashtable GetProcedures()

Returns all the proc definitions as a Hashtable from proc name to its definition

Returns:

Hashtable Maps proc's name to its definition

SetProcedures

public void SetProcedures(java.util.Hashtable hashtableProcDefns)

Sets all the proc definitions as a Hashtable from proc name to its definition

Parameters:

hashtableProcDefns - Maps proc's name to its definition

writeExternal

public void writeExternal(java.io.ObjectOutput objOutput)
                   throws java.io.IOException

Saves the data for this bean

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

objOutput - The ObjectOutput stream used to save data

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput objInput)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Loads the data for this bean

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

objInput - The ObjectInput stream used to load data

Throws:

IOException, - ClassNotFoundException

java.io.IOException

java.lang.ClassNotFoundException