TweetFollow Us on Twitter

Nov 01 WebObjects

Volume Number: 17 (2001)
Issue Number: 11
Column Tag: Beginning WebObjects 5 Web Applications

Part 3 - Project Builder

by Emmanuel Proulx

Project Management & Debugging

Managing the Project

About Targets

Targets are sets of configuration options. Each target represents an area of the system, which should be packaged together. By default, a project has 3 targets:

  • The project itself (Find-A-Luv), contains the two other targets:
  • Application Server: contains the files that should remain on the server (basically all files that you create, except Applets)
  • Web Server: contains the Applets that should be downloaded by the client (this target should really be called "Applet")

When compiling, always select the project target. When adding files, select the Application Server target, and then switch back to the project target afterwards.

If you add the files under the wrong target, simply un-check the file under that target (in the file browser, under the first column: the one with the bull's eye), switch to the good target, and check the file again.

Creating files

The default project comes with a handful of files; a single Web Component, and a few classes. You can create new file by going to menu File | New File, then by selecting the type of the file you want. Again, many types of files can be created: a simple empty file, a Java class, Web components, Cocoa (Java, Objective-C), Carbon (C++).

Many other types of files are available, but the ones that interest us for now are:

  • Component: This is a Web page of our application. It is not just one file; it is a set of dependant files describing the appearance and behavior of the page.
  • Java Class: This is a "utility" or "helper" class, one that is not associated with a Web component or WebObjects' frameworks.

Let's make such a helper class. We'll introduce a new Value Object class that's only goal is to store data for our Find-A-Luv example. In the file browser of the Project Builder, select the "Classes" group. In the target selection box, choose "Application Server". Go to menu File | New File. Select the "Java Class" and click on Next. Now type in the filename APerson.java. Click Finish.

NOTE: Before you choose the menu File | New File, be sure you selected the right

  • group or folder in the file browser
  • target (usually you want to add the file inside target "Application Server")

The selected group/folder and target will end up containing the file you create.

Now switch back the selected target to "Find-A-Luv". Open Person.java again and enter the following code:

Listing 2. APerson.java

This class is just a small Value Object that can contain a single person's information: name, sex, 
email address, smoking or not, and description. 

//
// APerson.java
// Project Find-A-Luv-b3
//
// Created by eproulx on Sun Sep 09 2001
//

import com.webobjects.foundation.*;
import com.webobjects.appserver.*;
import com.webobjects.eocontrol.*;

public class APerson extends Object {
 protected String name;
 protected String sex;
 protected String email;
 protected Boolean smoking;
 protected String descrip;
 
 public String toString() {
  return "Hi, my name is " + name + ". I am a " + sex + 
      " looking for my soul mate.";
 }
 
 public String name() { return name; }
 public void setName(String n) {
  name = n;
 }
 
 public String sex() { return sex; }
 public void setSex(String s) {
  sex = s;
 }
 
 public String email() { return email; }
 public void setEmail(String e) {
  email = e;
 }
 
 public Boolean smoking() { return smoking; }
 public void setSmoking(Boolean s) {
  smoking = s;
 }
 
 public String descrip() { return descrip; }
 public void setDescrip (String d) {
  descrip = d;
 }
}

NOTE: in this example, we are overriding toString(). This might seem unimportant, but you may use this to print out class information when debugging. Be sure to override toString() in all your custom classes.

I will not cover the other file types in the File | New dialog because they are out of the scope of this column.

Save the file, and compile it to make sure it's error-free.

Importing Files

To import files into your project, simply drag the file from its current location into the file browser, under the proper group or folder. If the item to import is a Web Component, drag both the ".wo" folder and its associated Java file. Then, a dialog will pop up, asking what to do with the file. Be sure you click on the checkbox, indicating you wish to COPY the file (you don't want to reference files outside the project's folder).

You can accomplish the same thing by selecting the destination group or folder first, then going to menu Project | Add Files.

Referencing files outside the project folder is not always a bad thing, but I tend to avoid this because of the complications that may arise... Displaced or modified files may break the project. If you do want to reference a file outside the project folder, be sure to set the "reference style" to the proper value.

Removing files

To remove files from a project, follow these steps:

  • Go to the file browser and select your file (or ".wo" folder if it's a Web Component).
  • Press the Delete key.
  • If you want to dissociate the file from the project, it doesn't mean you want to physically erase it. Decide if you want to keep a copy or not. Then, in the dialog that pops up, click on "Delete" to erase the file, or "Don't Delete" to keep it on the disk. Both these two choices will detach the file from the project.

WARNING: Be really careful when removing files, because the operation cannot be undone. If you select the wrong file by mistake, it can be deadly... for your code!

Renaming Files

Always rename your files from within WebObjects. Select the file in the File Browser, then open menu Project | Rename. Enter the file name directly in the file browser. It is better to do this in WebObjects instead of the operating system, because the project file and makefile are automatically updated.

Finding Text

In the Project Builder editor, as in most text editors, you can search for an expression in your code by using the Find dialog. You can also "Find and Replace" using the same dialog. It is available in menu Find | Show Single File Find.

The most common features are available in it, like scope and case restrictions. You use it as any dialog of the sort, like the ones available in word processors for example. The dialog should remain open until you are done searching; you then have to explicitly close it.

You probably have seen already the tab marked "Find" in the Project Builder. This is the Batch Find tab. It does more than the Find dialog, because it can find a string in all files of the project. Go ahead and click on the Batch Find tab. This is also accessible from the menu, under Find | Show Batch Find.

This tab offers you roughly the same options as the regular Find dialog, plus it lets you decide where to look for things. To the right of the "Replace" field, you can choose to find a given word either:

  • Textually (anywhere in the files)
  • As a Regular Expression (with wildcards),
  • As a Definition (of a class or a member of a class)

Moreover, the Options button gives you many more choices for extending or restricting the scope of the search. You may search:

  • In the opened files
  • In the current project or all opened projects
  • In the frameworks
  • All files or only specified ones

Once you're done with specifying the restrictions, click on the Find button to start searching, or the Replace button to start replacing. The lines of code where the text was found will appear at the bottom of the pane. You may click on the lines you want to edit, and the Editor will let you modify that line, as the cursor will point to the line of code you chose. (This is similar to the Build tab, when clicking on an error.)

Indexes

To speed up searching, WebObjects keeps lists of all symbols, called indexes. Indexes are required when searching a definition, or for accessing symbols using the navigation bar.

By default these are automatically maintained every time you save or build a project. To force re-indexing, open menu Project, and choose items Remove Project Index, then Index Project .

Bookmarking Code

A bookmark lets you mark a line of code in a file, for later retrieval. To bookmark a line of code, just put the cursor on that line, then open menu Navigation | Add to Bookmarks. A new item will appear in the bookmarks tab.

To go back to that line of code, simply open the bookmarks tab and click on the right item. The editor pane will display the file in question, and the cursor will point to the line that was marked.

Copying and Renaming the Project

Sometimes you have to work on a copy of your project. The usual way of doing this is to copy the project folder to a different location or a different name. This is not sufficient; you also need to rename the project.

WARNING: You simply cannot have two projects with the same name on the same computer in WebObjects, even if the folder name is different. WebObjects will get confused and behave strangely at runtime ("I thought I fixed this bug! How come when I run the page it still looks like before I fixed it?"). After making a copy, be sure to rename the project to something else.

Copying a project implies simply copying its folder and then renaming the copy.

To rename a project:

  • Make sure it is closed.
  • Go to the Operating System (Finder) and select the folder of the project. Give it a new name.
  • Navigate inside the project folder and find the ".pbproj" file. Rename this file to the same name as the folder, and keep the extension ".pbproj".
  • This file is in reality a folder. To open this folder in Mac OS X, click on it while holding the control key, and then choose "Show package contents".
  • Locate the file project.pbxproj. Open this file with a text editor. Now find all occurrences of the old name for the project, and replace them with the new name.

Debugging

If you're like me, the first thing you do after writing some code in a new module (after compiling it successfully) is to fire up the debugger. You then place a breakpoint and watch the code as it runs through the module. If you don't see the code running, you can only assume it's working properly. Never assume...

Running the Debugger

Let's prepare for debugging. The targets are configured by default with the debugging information turned on. You can verify this by going to the targets tab, selecting one and clicking on the build settings tab. In this tab, there's a box called "generate debugging symbols". I suggest you always compile with "generate debugging symbol" checked, until you are ready to deploy your application on the production server.

"Generate debugging symbols" means the compiler should store the debugging information in the produced binary files.

You are now ready to fire up your application and to watch it run. From the Project Builder click on the Cleanup button, then on the Build button. When everything is done, click on the Debug button. The Debug tab will open, as shown in Figure 1 (after closing the File Browser and shrinking the editor):


Figure 1. Debug Tab.

As you can see, the application is currently running (check out the stop sign button). Look at all the stuff inside the debug tab:

  • The console tab. This contains both the output from the application and the debugger's output. The other tab (StdIO) contains only the application's output.
  • A list of threads. As the application runs, watch as the Console going wild with messages. This is normal.
  • For each thread, you have the stack of function calls
  • The list of variables, both for the current object and variables local to the current function.

Shortly after starting the debugger, a Web browser will come up, as it does when running the application the normal way.

Note that in this example, the current debugger is the Java debugger (JDB).

PREFERENCE: you can choose which debugger to use by going to the Project Builder, and opening the fist target. Then click on the Executables tab, and choose the Debugger tab. Choose between GNU or Java debuggers.

If you know the debugger that you chose to use, and all its commands, then you can type them in the Console tab inside the Debug tab. But it is easier to rely on the debugging toolbar, as we will see shortly. It contains the most useful functions of the debugger, and you don't have to type anything.

NOTE: If you are the keyboard type, you may prefer to type in your commands anyway. For help on the commands available for the Java debugger, just type in an invalid command, and the help will appear.

For help on the GDB's available commands, I suggest you use the help command:

  • help: displays a list of command categories
  • help aCategory: displays a list of commands for the specified category
  • help aCommand: displays the help for the specified command

Breakpoints

Adding a breakpoint

Running the application in debug mode without setting breakpoints is pointless. Stop the application Now let's set some breakpoints. Open the file where you want to set a breakpoint, like Main.java for example. Notice the editor now bears a margin on the left side of the code inside the editor. I call this the "breakpoint margin". Click on that margin, adjacent to the line you want to stop at. A gray arrow icon appears there , indicating a breakpoint. Check out Figure 2.


Figure 2. Breakpoints.

Note that there is a dark arrow (enabled breakpoint) and a pale arrow (disabled breakpoint). We'll talk about disabled breakpoints momentarily.

Now, go to your Browser, and reload the Main page. While WebObjects tries to create the Main component, calling the constructor, the execution stops where your breakpoint is located. The red arrow in the margin indicates the next line to be executed, the active line.

To continue the execution thereafter, simply click on the Pause button (on the right of the Run button) that looks like this while the program is paused. As long as it doesn't bump into another breakpoint, the application will carry on.

Removing breakpoints

To remove a breakpoint, simply click and drag the breakpoint arrow out of the breakpoint margin. You can also select it from the breakpoints tab and press Delete or Backspace.

Enabling and disabling breakpoints

As stated before, an enabled breakpoint appears as a dark arrow You can deactivate and reactivate breakpoints by clicking on the arrow repeatedly. When disabled, a breakpoint does not stop the code from executing.

You can also enable and disable breakpoints from the breakpoints tab, by clicking in the "Use" column (the checkmark means the breakpoint is enabled).

Retrieving a breakpoint

You can select a breakpoint in the breakpoints tab, and the editor jump directly to the line of code where the breakpoint is located. A disabled breakpoint serves a purpose similar to a bookmark.

Stepping Through the Code

Pausing the program

Alternately, you can pause the execution without using breakpoints, by clicking on the Pause button . Note that if you do this, it will be impossible to predict on what line you will end up. The only rational usage of the pause button is to detect infinite loops. If you suspect there's an infinite loop in your code, run the application, wait a while until you're almost certain the infinite loop is started, then click on the Pause button to see the line where it stopped.

Stepping over

The next thing you do when you're debugging is to watch the code execute line by line. Like I said, while the application is paused, the red arrow indicates the next line to be executed. You can execute the active line by clicking on the Step Over button . The pointer is now placed on the next line bearing a statement. Typically, you use the Step Over button to spy on the current function only. For example, you could witness if a condition is true, during an if() statement. You could also count the number of times the program passes in a while() loop.

Stepping into

If the line of code you are pointing to is a function, you can view the inside of the function by clicking on the Step Into button instead. The Project Builder will display the code for that function if it is available. If the current line is not a function, or if the code is not available, this button executes it just like a regular Step Over.

Stepping out

Say you're stepping into a function, and then you changed your mind and wish to skip the rest of the function, and go back to the caller's code. This is precisely what the Step Out button does. After clicking on Step Out, your active line should be the one immediately after the current function call, inside the caller's code.

Inspecting Variables

The other main usage of a debugger is to spy on the program's variables. WebObjects lets you inspect the contents of the variables in the variables pane inside the debug tab. The first level of this hierarchy shows two groups:

  • Arguments contains the list of parameters for the current method, plus "this" to represent the current object.
  • When "this" is a Web component (WOComponent), there's a member variable inside it, called context. It contains many useful things:
  • The Session object.
  • The Request object.
  • The Response object.
  • Locals contains the list of stack variable.

By expanding the hierarchy, you can spy on the value of all these objects and variables.

Moreover, when a variable is of a base type (int, float, char, etc., but not a class), you can actually change its value by double-clicking on the old value, and typing in a new one.

Lastly, every time you step trough the code one time, the values that were changed by this step turn to red. This is just to catch your attention.

Stack

To finish, let's explore the stack pane of the Debug tab. Using this pane, you can navigate through the stack and visit different contexts of the application at the period it halted. The top item of the list is the context when the application was paused (hence, the top of the stack). The row below is the calling function's context, and so on... Clicking on any row will bring you to the actual line of code in the editor (if the source code is available), also with the red arrow indicating the line being executed. Plus you will be able to access the variables that are available at that level of the stack.

The stack pane is also useful to understand what sequence of events lead to the call of the present function.

Next Month

An overview of the WebObjects Builder.


Emmanuel Proulx is a Course Writer, Author and Web Developer, working in the domain of Java Application Servers. He can be reached at emmanuelproulx@yahoo.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

DaisyDisk 4.8 - $9.99
DaisyDisk allows you to visualize your disk usage and free up disk space by quickly finding and deleting big unused files. The program scans your disk and displays its content as a sector diagram... Read more
VMware Fusion 11.5.0 - Run Windows apps...
VMware Fusion and Fusion Pro - virtualization software for running Windows, Linux, and other systems on a Mac without rebooting. The latest version includes full support for Windows 10, macOS Mojave... Read more
Apple Configurator 2.10 - Configure and...
Apple Configurator makes it easy to deploy iPad, iPhone, iPod touch, and Apple TV devices in your school or business. Use Apple Configurator to quickly configure large numbers of devices connected to... Read more
Spotify 1.1.15.448. - Stream music, crea...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
MenuMeters 1.9.8 - CPU, memory, disk, an...
MenuMeters is a set of CPU, memory, disk, and network monitoring tools for Mac OS X. Although there are numerous other programs which do the same thing, none had quite the feature set I was looking... Read more
Blocks 3.5.2 - RapidWeaver plug-in; divi...
Blocks is a plugin for RapidWeaver. It allows you to place blocks of text, graphics, and even raw HTML onto your page wherever you like. Drag blocks around, resize them, and even overlap content. All... Read more
Live Home 3D Pro 3.7 - $49.99
Live Home 3D Pro is powerful yet intuitive home design software that lets you build the house of your dreams right on your Mac, iPhone or iPad. It has every feature of Live Home 3D, plus some... Read more
Ableton Live 10.1.1 - Record music using...
Ableton Live lets you create and record music on your Mac. Use digital instruments, pre-recorded sounds, and sampled loops to arrange, produce, and perform your music like never before. Ableton Live... Read more
BetterTouchTool 3.202 - Customize multi-...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom)... Read more
Fission 2.4.6 - Streamlined audio editor...
Fission can crop and trim audio, paste in or join files, or just rapidly split one long file into many. It's streamlined for fast editing. Plus, it works without the quality loss caused by other... Read more

Latest Forum Discussions

See All

Marvel Strike Force is adding Agent Coul...
Marvel Strike Force, the popular squad-based RPG, is set to receive a bunch of new content over the next few weeks. [Read more] | Read more »
Lots of premium games are going free (so...
You may have seen over the past couple weeks a that a bunch of premium games have suddenly become free. This isn’t a mistake, nor is it some last hurrah before Apple Arcade hits, and it’s important to know that these games aren’t actually becoming... | Read more »
Yoozoo Games launches Saint Seiya Awaken...
If you’re into your anime, you’ve probably seen or heard of Saint Seiya. Based on a shonen manga by Masami Kurumada, the series was massively popular in the 1980s – especially in its native Japan. Since then, it’s grown into a franchise of all... | Read more »
Five Nights at Freddy's AR: Special...
Five Nights at Freddy's AR: Special Delivery is a terrifying new nightmare from developer Illumix. Last week, FNAF fans were sent into a frenzy by a short teaser for what we now know to be Special Delivery. Those in the comments were quick to... | Read more »
Rush Rally 3's new live events are...
Last week, Rush Rally 3 got updated with live events, and it’s one of the best things to happen to racing games on mobile. Prior to this update, the game already had multiplayer, but live events are more convenient in the sense that it’s somewhat... | Read more »
Why your free-to-play racer sucks
It’s been this way for a while now, but playing Hot Wheels Infinite Loop really highlights a big issue with free-to-play mobile racing games: They suck. It doesn’t matter if you’re trying going for realism, cart racing, or arcade nonsense, they’re... | Read more »
Steam Link Spotlight - The Banner Saga 3
Steam Link Spotlight is a new feature where we take a look at PC games that play exceptionally well using the Steam Link app. Our last entry talked about Terry Cavanaugh’s incredible Dicey Dungeons. Read about how it’s a great mobile experience... | Read more »
Combo Quest (Games)
Combo Quest 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: Combo Quest is an epic, time tap role-playing adventure. In this unique masterpiece, you are a knight on a heroic quest to retrieve... | Read more »
Hero Emblems (Games)
Hero Emblems 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: ** 25% OFF for a limited time to celebrate the release ** ** Note for iPhone 6 user: If it doesn't run fullscreen on your device... | Read more »
Puzzle Blitz (Games)
Puzzle Blitz 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Puzzle Blitz is a frantic puzzle solving race against the clock! Solve as many puzzles as you can, before time runs out! You have... | Read more »

Price Scanner via MacPrices.net

Get one of Apple’s new 2019 iPhone 11 models...
Boost Mobile is offering the new 2019 Apple iPhone 11, iPhone 11 Pro, and 11 Pro Max for $100 off MSRP. Their discount reduces the cost of an iPhone 11 to $599 for the 64GB models, $899 for the 64GB... Read more
13″ 1.4GHz Silver MacBook Pros on sale for $1...
B&H Photo has new 2019 13″ 1.4GHz 4-Core Touch Bar Silver MacBook Pros on sale for $100 off Apple’s MSRP. Overnight shipping is free to many addresses in the US. These are the same MacBook Pros... Read more
4-core and 6-core 2018 Mac minis available at...
Apple has Certified Refurbished 2018 Mac minis available on their online store for $120-$170 off the cost of new models. Each mini comes with a new outer case plus a standard Apple one-year warranty... Read more
$250 prepaid Visa card with any Apple iPhone,...
Xfinity Mobile will include a free $250 prepaid Visa card with the purchase of any new iPhone, new line activation, and transfer of phone number to Xfinity Mobile. Offer is valid through October 27,... Read more
Sprint is offering the 64GB Apple iPhone 11 P...
Sprint has the new 64GB iPhone 11 Pro available for $12.50 per month for new customers with an eligible trade-in in of iPhone 7 or newer. That’s down from their standard monthly lease of $41.67. The... Read more
Final week: Apple’s 2019 Back to School Promo...
Purchase a new Mac using Apple’s Education discount, and take up to $400 off MSRP. All teachers, students, and staff of any educational institution with a .edu email address qualify for the discount... Read more
Save $30 on Apple’s AirPods at these reseller...
Amazon is offering discounts on new 2019 Apple AirPods ranging up to $30 off MSRP as part of their Labor Day sale. Shipping is free: – AirPods with Charging Case: $144.95 $15 off MSRP – AirPods with... Read more
Preorder your Apple Watch Series 5 today at A...
Amazon has Apple Watch Series 5 GPS models available for preorder and on sale today for $15 off Apple’s MSRP. Shipping is free and starts on September 20th: – 40mm Apple Watch Series 5 GPS: $384.99 $... Read more
21″ iMacs on sale for $100 off Apple’s MSRP,...
B&H Photo has new 21″ Apple iMacs on sale for $100 off MSRP with models available starting at $999. These are the same iMacs offered by Apple in their retail and online stores. Overnight shipping... Read more
2018 4 and 6-Core Mac minis on sale today for...
Apple resellers are offering new 2018 4-Core and 6-Core Mac minis for $100-$150 off MSRP for a limited time. B&H Photo has the new 2018 4-Core and 6-Core Mac minis on sale for up to $150 off... Read more

Jobs Board

*Apple* Mobile Master - Best Buy (United Sta...
**732324BR** **Job Title:** Apple Mobile Master **Job Category:** Store Associates **Location Number:** 000013-Fargo-Store **Job Description:** **What does a Best Read more
*Apple* Mobility Pro - Best Buy (United Stat...
**723452BR** **Job Title:** Apple Mobility Pro **Job Category:** Store Associates **Location Number:** 001194-Greeley-Store **Job Description:** At Best Buy, our Read more
Best Buy *Apple* Computing Master - Best Bu...
**731319BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Location Number:** 000303-Arlington Heights-Store **Job Read more
Best Buy *Apple* Computing Master - Best Bu...
**733266BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 000144-Union City-Store **Job Description:** **What does a Read more
Geek Squad *Apple* Master Consultation Agen...
**732907BR** **Job Title:** Geek Squad Apple Master Consultation Agent **Job Category:** Services/Installation/Repair **Location Number:** 000360-Williston-Store Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.