com.ibm.eNetwork.beans.HOD Class MacroActionSQLQuery

Overview   Package     Class   Tree   Serialized   Deprecated   Index   Help   API User's Guide  
  PREV CLASS     NEXT CLASS FRAMES     NO FRAMES
SUMMARY:  INNER |  FIELD |  CONSTR |  METHOD DETAIL:   FIELD |  CONSTR |  METHOD 


java.lang.Object
  |
  +--
com.ibm.eNetwork.beans.HOD.MacroAction
        |
        +--
com.ibm.eNetwork.beans.HOD.MacroActionSQLQuery
All Implemented Interfaces:
java.awt.event.ActionListener, java.util.EventListener, com.ibm.eNetwork.HOD.common.HODConstants, com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable, com.ibm.eNetwork.beans.HOD.MacroSQLBIDIServices, java.io.Serializable, java.awt.event.WindowListener
public class MacroActionSQLQuery
extends MacroAction
implements java.awt.event.ActionListener, java.awt.event.WindowListener, com.ibm.eNetwork.beans.HOD.MacroSQLBIDIServices

This class represents an SQL query action associated with a MacroScreen object. The SQL query action is used for executing an SQL statement during the execution of macro actions. AS/400 Toolbox for Java JDBC driver (com.ibm.as400.access.AS400JDBCDriver) is supported and included. Other JDBC drivers may be used, however they are not supported. The query result may be processed in three different ways by specifying in outputtype attribute:

  1. 0 = $HMLSQLUtil$ variable, which is one of the macro's reserved variables that user has access. Various methods are provided for users to access the query result data.
  2. 1 = Save the result as a file specified in outfilename attribute with outfiletype attribute file format. If the browser has proper plug-ins installed, inbrowser attribute may be set to true to see the saved file in a browser. The file may be overwritten or appended with the query result data. However, append is valid only for the ASCII Text file or Comma Separated Values file.
  3. 2 = Diplay the result in a dialog. A macro may or may not pause while the dialog is displaying depending on holdondisplay attribute.
See Also:
Serialized Form

Field Summary
static java.lang.String BIFF3           Output file type for Microsoft Excel BIFF3 (*.xls)
static java.lang.String BIFF4           Output file type for Microsoft Excel BIFF4 (*.xls)
static java.lang.String CSV           Output file type for Comma Separated Values (*.csv)
static java.lang.String HTML           Output file type for HTML (*.html)
static java.lang.String PROP_DELIMITER            
static java.lang.String TEXT           Output file type for ASCII Text (*.txt)
static java.lang.String WK1           Output file type for XML (*.xml)

 

Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ADVMACRO, HOD_RAS_COMPID_ASSOC_PRT, HOD_RAS_COMPID_BLINKREMAP, HOD_RAS_COMPID_CODEPAGE, HOD_RAS_COMPID_COLORREMAP, HOD_RAS_COMPID_CONFIG, HOD_RAS_COMPID_DATAACCESS, HOD_RAS_COMPID_FILETRANSFER, HOD_RAS_COMPID_FTP_SCREEN, HOD_RAS_COMPID_FTP_SESSION, HOD_RAS_COMPID_FTP_TERMINAL, HOD_RAS_COMPID_FUDOMA, HOD_RAS_COMPID_HOD_API, HOD_RAS_COMPID_IMPEXP, HOD_RAS_COMPID_JNILOAD, HOD_RAS_COMPID_KEYPAD, HOD_RAS_COMPID_KEYREMAP, HOD_RAS_COMPID_MACRO, HOD_RAS_COMPID_MACROMANGR, HOD_RAS_COMPID_PRT_TERMINAL, HOD_RAS_COMPID_SCREEN, HOD_RAS_COMPID_SESSION, HOD_RAS_COMPID_SESSION_MGR, HOD_RAS_COMPID_SLP, HOD_RAS_COMPID_TERMINAL, HOD_RAS_COMPID_ZIPPRINT, HOD_RAS_FUNC_NAME, HOD_START_UP, HOD_TRANSFER_FILE_INFO, MOUSE_DOUBLE_CLICK_THRESHOLD, XFER_ASCII_GET_OPTIONS, XFER_ASCII_GET_OPTIONS_DEFAULT, XFER_ASCII_PUT_OPTIONS, XFER_ASCII_PUT_OPTIONS_DEFAULT, XFER_BINARY_GET_OPTIONS, XFER_BINARY_GET_OPTIONS_DEFAULT, XFER_BINARY_PUT_OPTIONS, XFER_BINARY_PUT_OPTIONS_DEFAULT, XFER_DEFAULT_OPTIONS, XFER_FILETYPE_DTA, XFER_FILETYPE_SAVF, XFER_FILETYPE_SRC, XFER_HOST_TYPE, XFER_HOST_TYPE_CICS, XFER_HOST_TYPE_CMS, XFER_HOST_TYPE_DEFAULT, XFER_HOST_TYPE_OS400, XFER_HOST_TYPE_TSO, XFER_PACKET_SIZE, XFER_PACKET_SIZE_DEFAULT, XFER_TIME_OUT_VALUE, XFER_TIME_OUT_VALUE_DEFAULT, XFER_TRANSFER_MODE, XFER_TRANSFER_MODE_ASCII, XFER_TRANSFER_MODE_BINARY, XFER_TRANSFER_MODE_DEFAULT

 

Constructor Summary
MacroActionSQLQuery ()           Constructs an empty instance of a SQL Query macro action.
MacroActionSQLQuery (java.lang.String argUrl, java.lang.String argDriver, java.lang.String argUserid, java.lang.String argPassword, java.lang.String argStatement, java.lang.String argOutputtype, java.lang.String argOutfilename, java.lang.String argOutfiletype, java.lang.String argOverwrite, java.lang.String argInbrowser, java.lang.String argHoldondisplay)           Constructs a functional instance of a SQL Query macro action with the given parameter.
MacroActionSQLQuery (java.lang.String argUrl, java.lang.String argDriver, java.lang.String argUserid, java.lang.String argPassword, java.lang.String argStatement, java.lang.String argOutputtype, java.lang.String argOutfilename, java.lang.String argOutfiletype, java.lang.String argOverwrite, java.lang.String argInbrowser, java.lang.String argHoldondisplay, java.lang.String argHostFileOrientation, java.lang.String argPCFileOrientation, java.lang.String argHostFileType, java.lang.String argPCFileType, java.lang.String argLamAlefExpand, java.lang.String argLamAlefCompress, java.lang.String argSymmSwap, java.lang.String argRoundTrip, java.lang.String argNumeralShape)           Constructs a functional instance of a SQL Query macro action with the given parameter.

 

Method Summary
 void execute ()           Executes the SQL Query macro action.
 java.lang.String format (int argType, boolean displayAll)           Formats the action object's contents into a readable string.
 java.lang.String getDriver ()           Returns the JDBC Driver name
 java.lang.String getDriverRaw ()           Returns the expression form of the JDBC Driver name
 boolean getHoldondisplay ()           Returns whether the macro should pause or not when the output dialog is displayed
 java.lang.String getHoldondisplayRaw ()           Returns the expression form of whether the macro should pause or not when the output dialog is displayed
 boolean getHostFileOrientation ()           Returns the Host File Orientation value
 java.lang.String getHostFileOrientationRaw ()           Returns the expression form of the Host File Orientation value
 boolean getHostFileType ()           Returns the Host File Type value
 java.lang.String getHostFileTypeRaw ()           Returns the expression form of the Host File Type value
 boolean getInbrowser ()           Returns whether the output file should be shown in a browser or not
 java.lang.String getInbrowserRaw ()           Returns the expression form of whether the output file should be shown in a browser or not
 boolean getLamAlefCompress ()           Returns the LamAlef Compress value
 java.lang.String getLamAlefCompressRaw ()           Returns the expression form of the LamAlef Compress value
 boolean getLamAlefExpand ()           Returns the LamAlef Expand value
 java.lang.String getLamAlefExpandRaw ()           Returns the expression form of the LamAlef Expand value
 java.lang.String getNumeralShape ()           Returns the Numeral Shape value
 java.lang.String getNumeralShapeRaw ()           Returns the expression form of the Numeral Shape value
 java.lang.String getOutfilename ()           Returns the output file name
 java.lang.String getOutfilenameRaw ()           Returns the expression form of the output file name
 int getOutfiletype ()           Returns the output file type 0 = ASCII Text (*.txt) 1 = Comma Separated Values (*.csv) 2 = Lotus 1-2-3 (*.wk1) 3 = Microsoft Excel BIFF3 (*.xls) 4 = Microsoft Excel BIFF4 (*.xls) 5 = XML (*.xml) 6 = HTML (*.html)
 java.lang.String getOutfiletypeRaw ()           Returns the expression form of the output file type
 int getOutputtype ()           Returns the output type. 0 = $HMLSQLUtil$ macro variable 1 = Save as a file 2 = Display in a dialog
 java.lang.String getOutputtypeRaw ()           Returns the expression form of the output type
 boolean getOverwrite ()           Returns the overwrite or append value
 java.lang.String getOverwriteRaw ()           Returns the expression form of the overwrite or append value
 java.lang.String getPassword ()           Returns the password
 java.lang.String getPasswordRaw ()           Returns the expression form of the password
 boolean getPCFileOrientation ()           Returns the PC File Orientation value
 java.lang.String getPCFileOrientationRaw ()           Returns the expression form of the PC File Orientation value
 boolean getPCFileType ()           Returns the PC File Type value
 java.lang.String getPCFileTypeRaw ()           Returns the expression form of the PC File Type value
 boolean getRoundTrip ()           Returns the Round Trip value
 java.lang.String getRoundTripRaw ()           Returns the expression form of the Round Trip value
 java.lang.String getStatement ()           Returns the SQL statement
 java.lang.String getStatementRaw ()           Returns the expression form of the SQL statement
 boolean getSymmetricSwap ()           Returns the Symmetric Swap value
 java.lang.String getSymmetricSwapRaw ()           Returns the expression form of the Symmetric Swap value
 java.lang.String getUrl ()           Returns the Database URL
 java.lang.String getUrlRaw ()           Returns the expression form of the URL
 java.lang.String getUserid ()           Returns the User ID
 java.lang.String getUseridRaw ()           Returns the expression form of the User ID
 void setDriver (com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argDriver)            
 void setDriver (java.lang.String argDriver)           Sets the JDBC Driver name
 void setHoldondisplay (boolean argHoldondisplay)           Sets whether the macro should pause or not when the output dialog is displayed
 void setHoldondisplay (java.lang.String argHoldondisplay)           Returns whether the macro should pause or not when the output dialog is displayed
 void setHostFileOrientation (boolean argHostFileOrientation)           Sets the Host File Orientation value
 void setHostFileOrientation (com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argHostFileOrientation)            
 void setHostFileOrientation (java.lang.String argHostFileOrientation)            
 void setHostFileType (boolean argHostFileType)           Sets the Host File Type value
 void setHostFileType (com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argHostFileType)            
 void setHostFileType (java.lang.String argHostFileType)            
 void setInbrowser (boolean argInbrowser)           Sets whether the output file should be shown in a browser or not.
 void setInbrowser (java.lang.String argInbrowser)           Sets whether the output file should be shown in a browser or not.
 void setLamAlefCompress (boolean argLamAlefCompress)           Sets the LamAlef Compress value
 void setLamAlefCompress (com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argLamAlefCompress)            
 void setLamAlefCompress (java.lang.String argLamAlefCompress)            
 void setLamAlefExpand (boolean argLamAlefExpand)           Sets the LamAlef Expand value
 void setLamAlefExpand (com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argLamAlefExpand)            
 void setLamAlefExpand (java.lang.String argLamAlefExpand)            
 void setNumeralShape (com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argNumeralShape)            
 void setNumeralShape (java.lang.String argNumeralShape)           Sets the Numeral Shape value
 void setOutfilename (java.lang.String argOutfilename)           Sets the output file name
 void setOutfiletype (int argOutfiletype)           Sets the output file type 0 = ASCII Text (*.txt) 1 = Comma Separated Values (*.csv) 2 = Lotus 1-2-3 (*.wk1) 3 = Microsoft Excel BIFF3 (*.xls) 4 = Microsoft Excel BIFF4 (*.xls) 5 = XML (*.xml) 6 = HTML (*.html)
 void setOutfiletype (java.lang.String argOutfiletype)           Sets the output file type
 void setOutputtype (int argOutputtype)           Sets output type 0 = $HMLSQLUtil$ macro variable 1 = Save as a file 2 = Display in a dialog
 void setOutputtype (java.lang.String argOutputtype)           Sets output type
 void setOverwrite (boolean argOverwrite)           Sets the overwrite or append value.
 void setOverwrite (java.lang.String argOverwrite)           Sets the overwrite or append value.
 void setPassword (java.lang.String argPassword)           Sets the password
 void setPCFileOrientation (boolean argPCFileOrientation)           Sets the PC File Orientation value
 void setPCFileOrientation (com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argPCFileOrientation)            
 void setPCFileOrientation (java.lang.String argPCFileOrientation)            
 void setPCFileType (boolean argPCFileType)           Sets the PC File Type value
 void setPCFileType (com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argPCFileType)            
 void setPCFileType (java.lang.String argPCFileType)            
 void setRoundTrip (boolean argRoundTrip)           Sets the Round Trip value
 void setRoundTrip (com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argRoundTrip)            
 void setRoundTrip (java.lang.String argRoundTrip)            
 void setStatement (java.lang.String argStatement)           Sets the SQL statement
 void setSymmetricSwap (boolean argSymmetricSwap)           Sets the Symmetric Swap value
 void setSymmetricSwap (com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argSymmetricSwap)            
 void setSymmetricSwap (java.lang.String argSymmetricSwap)            
 void setUrl (java.lang.String argUrl)           Sets the URL
 void setUserid (java.lang.String argUserid)           Sets the User ID

 

Methods inherited from class com.ibm.eNetwork.beans.HOD. MacroAction
clone, getHostid, getHostidRaw, halt, isFormatEqual, isMultiSessionAction, setECLSession, setHostid, setOwner, setRuntimeListeners

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface java.awt.event.ActionListener
actionPerformed

 

Methods inherited from interface java.awt.event.WindowListener
windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

 

Methods inherited from interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable
setAttributes, setError

 

Field Detail

TEXT



public static final java.lang.String 
TEXT

CSV



public static final java.lang.String 
CSV

WK1



public static final java.lang.String 
WK1

BIFF3



public static final java.lang.String 
BIFF3

BIFF4



public static final java.lang.String 
BIFF4

XML



public static final java.lang.String 
XML

HTML



public static final java.lang.String 
HTML

PROP_DELIMITER



public static final java.lang.String 
PROP_DELIMITER

Constructor Detail

MacroActionSQLQuery



public 
MacroActionSQLQuery()

MacroActionSQLQuery



public 
MacroActionSQLQuery(java.lang.String argUrl,
                           java.lang.String argDriver,
                           java.lang.String argUserid,
                           java.lang.String argPassword,
                           java.lang.String argStatement,
                           java.lang.String argOutputtype,
                           java.lang.String argOutfilename,
                           java.lang.String argOutfiletype,
                           java.lang.String argOverwrite,
                           java.lang.String argInbrowser,
                           java.lang.String argHoldondisplay,
                           java.lang.String argHostFileOrientation,
                           java.lang.String argPCFileOrientation,
                           java.lang.String argHostFileType,
                           java.lang.String argPCFileType,
                           java.lang.String argLamAlefExpand,
                           java.lang.String argLamAlefCompress,
                           java.lang.String argSymmSwap,
                           java.lang.String argRoundTrip,
                           java.lang.String argNumeralShape)

MacroActionSQLQuery



public 
MacroActionSQLQuery(java.lang.String argUrl,
                           java.lang.String argDriver,
                           java.lang.String argUserid,
                           java.lang.String argPassword,
                           java.lang.String argStatement,
                           java.lang.String argOutputtype,
                           java.lang.String argOutfilename,
                           java.lang.String argOutfiletype,
                           java.lang.String argOverwrite,
                           java.lang.String argInbrowser,
                           java.lang.String argHoldondisplay)

Method Detail

execute



public void 
execute()

getUrl



public java.lang.String 
getUrl()

getUrlRaw



public java.lang.String 
getUrlRaw()

setUrl



public void 
setUrl(java.lang.String argUrl)

getDriver



public java.lang.String 
getDriver()

getDriverRaw



public java.lang.String 
getDriverRaw()

setDriver



public void 
setDriver(java.lang.String argDriver)

getUserid



public java.lang.String 
getUserid()

getUseridRaw



public java.lang.String 
getUseridRaw()

setUserid



public void 
setUserid(java.lang.String argUserid)

getPassword



public java.lang.String 
getPassword()

getPasswordRaw



public java.lang.String 
getPasswordRaw()

setPassword



public void 
setPassword(java.lang.String argPassword)

getStatement



public java.lang.String 
getStatement()

getStatementRaw



public java.lang.String 
getStatementRaw()

setStatement



public void 
setStatement(java.lang.String argStatement)

getOutputtype



public int 
getOutputtype()

getOutputtypeRaw



public java.lang.String 
getOutputtypeRaw()

setOutputtype



public void 
setOutputtype(int argOutputtype)

setOutputtype



public void 
setOutputtype(java.lang.String argOutputtype)

getOutfilename



public java.lang.String 
getOutfilename()

getOutfilenameRaw



public java.lang.String 
getOutfilenameRaw()

setOutfilename



public void 
setOutfilename(java.lang.String argOutfilename)

getOutfiletype



public int 
getOutfiletype()

getOutfiletypeRaw



public java.lang.String 
getOutfiletypeRaw()

setOutfiletype



public void 
setOutfiletype(int argOutfiletype)

setOutfiletype



public void 
setOutfiletype(java.lang.String argOutfiletype)

getOverwrite



public boolean 
getOverwrite()

getOverwriteRaw



public java.lang.String 
getOverwriteRaw()

setOverwrite



public void 
setOverwrite(boolean argOverwrite)

setOverwrite



public void 
setOverwrite(java.lang.String argOverwrite)

getInbrowser



public boolean 
getInbrowser()

getInbrowserRaw



public java.lang.String 
getInbrowserRaw()

setInbrowser



public void 
setInbrowser(boolean argInbrowser)

setInbrowser



public void 
setInbrowser(java.lang.String argInbrowser)

getHoldondisplay



public boolean 
getHoldondisplay()

getHoldondisplayRaw



public java.lang.String 
getHoldondisplayRaw()

setHoldondisplay



public void 
setHoldondisplay(boolean argHoldondisplay)

setHoldondisplay



public void 
setHoldondisplay(java.lang.String argHoldondisplay)

getHostFileOrientation



public boolean 
getHostFileOrientation()

getHostFileOrientationRaw



public java.lang.String 
getHostFileOrientationRaw()

setHostFileOrientation



public void 
setHostFileOrientation(boolean argHostFileOrientation)

setHostFileOrientation



public void 
setHostFileOrientation(java.lang.String argHostFileOrientation)

getPCFileOrientation



public boolean 
getPCFileOrientation()

getPCFileOrientationRaw



public java.lang.String 
getPCFileOrientationRaw()

setPCFileOrientation



public void 
setPCFileOrientation(boolean argPCFileOrientation)

getHostFileType



public boolean 
getHostFileType()

getHostFileTypeRaw



public java.lang.String 
getHostFileTypeRaw()

setHostFileType



public void 
setHostFileType(boolean argHostFileType)

getPCFileType



public boolean 
getPCFileType()

getPCFileTypeRaw



public java.lang.String 
getPCFileTypeRaw()

setPCFileType



public void 
setPCFileType(boolean argPCFileType)

getLamAlefExpand



public boolean 
getLamAlefExpand()

getLamAlefExpandRaw



public java.lang.String 
getLamAlefExpandRaw()

setLamAlefExpand



public void 
setLamAlefExpand(boolean argLamAlefExpand)

getLamAlefCompress



public boolean 
getLamAlefCompress()

getLamAlefCompressRaw



public java.lang.String 
getLamAlefCompressRaw()

setLamAlefCompress



public void 
setLamAlefCompress(boolean argLamAlefCompress)

getSymmetricSwap



public boolean 
getSymmetricSwap()

getSymmetricSwapRaw



public java.lang.String 
getSymmetricSwapRaw()

setSymmetricSwap



public void 
setSymmetricSwap(boolean argSymmetricSwap)

getRoundTrip



public boolean 
getRoundTrip()

getRoundTripRaw



public java.lang.String 
getRoundTripRaw()

setRoundTrip



public void 
setRoundTrip(boolean argRoundTrip)

getNumeralShape



public java.lang.String 
getNumeralShape()

getNumeralShapeRaw



public java.lang.String 
getNumeralShapeRaw()

setNumeralShape



public void 
setNumeralShape(java.lang.String argNumeralShape)

format



public java.lang.String 
format(int argType,
                               boolean displayAll)

setDriver



public void 
setDriver(com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argDriver)

setHostFileOrientation



public void 
setHostFileOrientation(com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argHostFileOrientation)

setPCFileOrientation



public void 
setPCFileOrientation(java.lang.String argPCFileOrientation)

setPCFileOrientation



public void 
setPCFileOrientation(com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argPCFileOrientation)

setHostFileType



public void 
setHostFileType(java.lang.String argHostFileType)

setHostFileType



public void 
setHostFileType(com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argHostFileType)

setPCFileType



public void 
setPCFileType(java.lang.String argPCFileType)

setPCFileType



public void 
setPCFileType(com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argPCFileType)

setLamAlefExpand



public void 
setLamAlefExpand(java.lang.String argLamAlefExpand)

setLamAlefExpand



public void 
setLamAlefExpand(com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argLamAlefExpand)

setLamAlefCompress



public void 
setLamAlefCompress(java.lang.String argLamAlefCompress)

setLamAlefCompress



public void 
setLamAlefCompress(com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argLamAlefCompress)

setSymmetricSwap



public void 
setSymmetricSwap(java.lang.String argSymmetricSwap)

setSymmetricSwap



public void 
setSymmetricSwap(com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argSymmetricSwap)

setRoundTrip



public void 
setRoundTrip(java.lang.String argRoundTrip)

setRoundTrip



public void 
setRoundTrip(com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argRoundTrip)

setNumeralShape



public void 
setNumeralShape(com.ibm.eNetwork.ECL.macrovariable.intf.MacroEvaluableIntf argNumeralShape)

Overview   Package     Class   Tree   Serialized   Deprecated   Index   Help   API User's Guide  
  PREV CLASS     NEXT CLASS FRAMES     NO FRAMES
SUMMARY:  INNER |  FIELD |  CONSTR |  METHOD DETAIL:   FIELD |  CONSTR |  METHOD