com.ibm.broker.config.appdev

Class ESQLFile

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


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

    Each ESQLFile provides a mechanism to load ESQL files into an App Connect Enterprise ESQLFile instance.

    Each ESQLFile instance allows the retrieval of the ESQL Main modules which can be used to set the ComputeNode ESQLModule property.

     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
      ESQLFile() 
      ESQLFile(java.io.File esqlFile) 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getBrokerSchema() 
      java.util.Vector<ESQLModule> getEsqlModules()
      Allows you to retrieve the ESQL Modules present in this ESQL instance.
      java.lang.String getName()
      Retrieves the name of this ESQL instance.
      ESQLFile save(java.lang.String directoryName)
      This saves the ESQL file to the filesystem in the directory specified and in a Broker Schema subdirectory.
      ESQLFile setBrokerSchema(java.lang.String brokerSchema)
      Sets the Broker Schema Location of this esql module
      ESQLFile setName(java.lang.String esqlName)
      Allows you to set the name of this ESQL instance.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ESQLFile

        public ESQLFile()
      • ESQLFile

        public ESQLFile(java.io.File esqlFile)
                 throws java.io.IOException
        Throws:
        java.io.IOException
    • Method Detail

      • save

        public ESQLFile save(java.lang.String directoryName)
                      throws java.io.IOException
        This saves the ESQL file to the filesystem in the directory specified and in a Broker Schema subdirectory.
        Parameters:
        directoryName - String; the provided directory
        Throws:
        java.io.IOException
      • getEsqlModules

        public java.util.Vector<ESQLModule> getEsqlModules()
        Allows you to retrieve the ESQL Modules present in this ESQL instance.
        Returns:
        Vector; the ESQL Modules contained in this ESQL File
      • setName

        public ESQLFile setName(java.lang.String esqlName)
        Allows you to set the name of this ESQL instance. This will be used when saving the file.
        Parameters:
        esqlName -
      • getName

        public java.lang.String getName()
        Retrieves the name of this ESQL instance. This will be used when saving the file.
        Returns:
        String;
      • getBrokerSchema

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

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