Managing State

PATH Documentation > WebObjects 4.5 > WebObjects Developer's Guide

Component Objects and Component State

In WebObjects, state can also be scoped to a component, such as a dynamically generated page or a reusable component within a page. Common uses for component state include storing:

A list of items that a user can choose from within a particular page
The user's selection from that list
Information that the users enters in a form
Default values for a component's attributes

Component state typically includes the data that a page displays, such as a list of choices to present to the user. Suppose a user requests the page that lists these choices. The component that represents the page must initialize itself with the choice data and then return the response page. This completes one cycle of the request-response loop. Now, suppose the user looks at the list of choices, selects the third item, and submits a new request. The same component must be present in this second cycle to identify the choice and take the appropriate action. In short, component state often needs to persist from one cycle of the request-response loop to the next.

A simple example of component state can be seen in the first page of this sample application, which lists models, prices, and types of vehicles for the user to choose from (see Figure 36).

Figure 36. Sample Application First Page

This component declares instance variables for the values displayed in the browser and for the user's selection from the browsers. Before the page can be sent to the user, the instance variables that hold the values to be displayed (model, price, type) are initialized:

// Java Main.java

NSArray models, prices, types;

NSMutableArray selectedModels, selectedPrices, selectedTypes;

String model, price, type;



public Main() {

	super();

	NSEnumerator en;



	Application woApp = (Application)application();

	en = woApp.modelsDict().objectEnumerator();

	models = new NSMutableArray();

	while (en.hasMoreElements())

		((NSMutableArray)models).addElement(en.nextElement());

	en = woApp.typesDict().elements();

	while (en.hasMoreElements()) 

		((NSMutableArray)types.addElement(en.nextElement());

	prices = woApp.prices();

}
// WebScript Cars Main.wos

id models, model, selectedModels;

id prices, price, selectedPrices;

id types, type, selectedTypes;



- init {

	id anApplication = [WOApplication application];

	[super init];

	models = [[anApplication modelsDict] allValues];

	types = [[anApplication typesDict] allValues];

	prices = [anApplication prices];

	return self;

}

(The selectedModels, selectedPrices, and selectedTypes instance variables are bound to the selections attributes of the three WOBrowsers and so will contain the user's selections when the Display Cars button is clicked.)

When a user starts a session of the above application, the Main component's initialization method is invoked, initializing the component's instance variables from data accessed through the application object. From this point on, the Main component and its instance variables become part of the state stored for that user's session of the application. When the session is released, the component is also released. However, there are other techniques that allow you to control resource allocation on a component basis, as you'll see later in this chapter.

As with the session state, a component's state is accessible to other objects within the same session. As the result of a user's action, for example, it's quite common for one component to create the component for the next page and set its state. Consider what happens in the above sample application when the user makes a selection in the first page and clicks Display Cars. The displayCars method in the Main component is invoked:

// Java Main.java

public WOComponent displayCars() 

{

	SelectedCars selectedCarsPage = 

		(SelectedCars)this.pageWithName("SelectedCars");



	... 



	selectedCarsPage.setModels(selectedModels);

	selectedCarsPage.setTypes(selectedTypes);

	selectedCarsPage.setPrices(selectedPrices);

	... 

	selectedCarsPage.fetchSelectedCars(); 



	return (WOComponent)selectedCarsPage;

}
// WebScript Cars Main.wos

- displayCars 

{

	id selectedCarsPage = [this pageWithName:@"SelectedCars"];



	... 



	[selectedCarsPage setModels:selectedModels];

	[selectedCarsPage setTypes:selectedTypes];

	[selectedCarsPage setPrices:selectedPrices];

	... 

	[selectedCarsPage fetchSelectedCars]; 



	return selectedCarsPage;

}

The new component is created by sending a pageWithName: message to a WOComponent object or a WODirectAction object. A series of messages is then sent to this new object to set its state before the object is returned as the response page.

Component state persists until the component object is deallocated, an action that can occur for various reasons, as described in the section "Controlling Component State".

Table of Contents Next Section