com.ibm.broker.config.appdev

Class ESQLModule

  • java.lang.Object
    • com.ibm.broker.config.appdev.ESQLModule
  • All Implemented Interfaces:
    java.io.Serializable


    public class ESQLModule
    extends java.lang.Object
    implements java.io.Serializable

    Each ESQLModules instance represents an ESQL module within an App Connect Enterprise ESQLFile instance.

    The ESQL modules can be used to set the ComputeNode ESQLModule property.

    You can use two methods to set the Compute Expression:

    1. Using a known ESQL file:

       
                    File esql = new File("FileBatchProcessingSample_Branch.esql");
                    ESQLFile esqlFile = new ESQLFile(esql);
                    Vector esqlModules = esqlFile.getEsqlModules();
     
                    //Create the ComputeNode
                    ComputeNode cn = new ComputeNode();
                    cn.setNodeName("New Compute Node");
                    // set ESQLModule here
                    cn.setComputeExpression(esqlModules.get(0));
                    mf.addNode(cn);
     

    2. Using an ESQLModule:

                    ESQLModule module = new ESQLModule();
                    module.setBrokerSchema("mySchema");
                    module.setEsqlMain("myEsqlMain");
     
                    //Create the ComputeNode
                    ComputeNode cn2 = new ComputeNode();
                    cn2.setNodeName("New Compute Node2");
     
                    // set ESQLModule here
                    cn2.setComputeExpression(module);
                    mf.addNode(cn2);
     
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     xxxxx.x  2010-08-10  dstorey           v7.0.0.2 Release
     
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String copyright 
    • Constructor Summary

      Constructors 
      Constructor and Description
      ESQLModule() 
    • Constructor Detail

      • ESQLModule

        public ESQLModule()
    • Method Detail

      • getComputeExpression

        public java.lang.String getComputeExpression()
        Returns the esql compute expression for this ESQL module for use in the compute part of the node
        Returns:
        String; The esql expression in its own syntax; esql://routine/"+schemaLocation+"#"+esqlMain+".Main
      • getEsqlFile

        public ESQLFile getEsqlFile()
        This returns the ESQL file which the ESQL module is from
        Returns:
        ESQLFile; the esql file.
      • setEsqlFile

        public ESQLModule setEsqlFile(ESQLFile esqlFile)
        Sets the esql file which this ESQL module has originated from
        Parameters:
        esqlFile - ESQLFile;
      • setEsqlMain

        public ESQLModule setEsqlMain(java.lang.String esqlMain)
        Sets the esql main entry point name
        Parameters:
        esqlMain - String;
      • setBrokerSchema

        public ESQLModule setBrokerSchema(java.lang.String brokerSchema)
        Sets the Broker Schema Location of this esql module
        Parameters:
        brokerSchema - String;
      • getBrokerSchema

        public java.lang.String getBrokerSchema()
        Returns:
        String; the Broker Schema Location of this ESQL module
      • getEsqlMain

        public java.lang.String getEsqlMain()
        Returns the esql main name for this module
        Returns:
        String;