Revision as of 15:57, 1 December 2011

Access a database with EGL Rich UI

Lesson 7: Create a library of reusable functions

Create a library to format money values and to associate category numbers with descriptions.Libraries contain functions, constants, and variables that you can use in multiple locations.

When you reference a declaration in the library from other logic such as a service or handler, you can include the library name as a prefix. For example, MyLibrary.myLibraryVariable is appropriate if the library name is MyLibrary and the library includes the myLibraryVariable variable. Alternatively, you can include the library name in a use statement in the other logic and avoid the need to qualify every reference. In that case, myLibraryVariable is sufficient to reference that variable.

Create a Library part

To create a Library part:

• Right-click the PaymentClient folder, then click New > Library.
• In the New EGL Library window, enter the following information:
  • In the EGL source file name field, enter the name PaymentLib.
  • In the Package field, enter the name libraries.
  • Under EGL Library Type, leave the default value of Basic selected.

The new Library part opens in the EGL editor.

• Replace the boilerplate code in the Library part with the following lines:

  package libraries;
  
  library PaymentLib {}
    
  end

• Save the file.

Create the categories array

Add the following code before the final end statement:

      categories string[] =[
  
                      "Rent",          // 1
                      "Food",          // 2
                      "Entertainment", // 3
                      "Automotive",    // 4
                      "Utilities",     // 5
                      "Clothes",       // 6
                      "Other"          // 7
              ];

The value is an array, and as is true of all arrays in EGL, the index of the first element is 1, not 0.

The array is used in logic that acts as follows:

• Places an expense category into the database in integer form, to save space.
• Places the expense category onto the web page in string form, for clarity.

Create the get functions for categories

The next functions convert between the following two formats for expense categories: integer and string.

Add the following code before the final end statement:

      function getCategoryDesc(cat int in) returns(string)
          if(cat != 0)       // the integer is not 0
              return(categories[cat]);
          else
              return("");
          end
      end

The function receives the integer format of an expense category and returns the related array element. If the input value is 0, the function returns an empty string.

Add the following code before the final end statement:

      function getCategoryNum(desc string in) returns(int)
          for(i int from 1 to categories.getSize())
              if(categories[i] == desc)
                  return(i);
              end
          end
          return(0);	// no match
      end

This function receives the string format of an expense category and returns the integer format, if possible. If no match is found for the received string, the function returns 0.

Save your changes

The complete your coding of the payment library:

1. Format the file.
2. Save and close the PaymentLib Library. If you see errors in your source file, compare your code to the file contents in Code for PaymentLib.egl after lesson 7.

Lesson checkpoint

You learned how to complete the following tasks:

• Create a Library part.
• Add functions and a variable to a library.