TweetFollow Us on Twitter

EOKeyValueCoding Volume Number: 16 (2000)
Issue Number: 12
Column Tag: WebObjects

EOKeyValueCoding

By Sam Krishna and Patrick Taylor

Throughout this series we've asserted that programming in WebObjects is a richer, more mature experience than any competing web application development environment. A major reason for this superior programming experience can be laid at the feet of EOKeyValueCoding.

EOKeyValueCoding is simultaneously a powerful protocol (in Objective C) and interface (in Java). When the EOControl framework is imported, all Objective C classes that inherit from NSObject receive EOKeyValueCoding behavior. (The EOControl framework is imported automatically into WebObjects apps and frameworks. You do not have to explicitly import it in to your WebObjects app or framework project.) In Java, when the developer creates a subclass of EOEnterpriseObject, EOCustomObject, EOGenericRecord or WOComponent, then EOKeyValueCoding is available.

What is remarkable about EOKeyValueCoding is how universally powerful it is. With this protocol/interface, the WebObjects and EOF frameworks know how to access custom instance variables (ivars) from within your subclass. Using the methods valueForKey() and takeValueForKey() (in Objective C valueForKey: and takeValue:forKey:) WOF and EOF can access your ivars through standard API. In addition, EOKeyValueCoding provides the bridge within EOF for effective entity-relationship mapping.

In valueForKey(), this standard method allows a lookup of an ivar from both WOF and EOF classes. Consider a WOComponent subclass that needs to fill in the value of a String object in the dynamic WOString element. The WOString is bound to lastName of an EnterpriseObject (EO) which represent the employees of a corporation.

Order of Access

  1. The component subclass searches for a public accessor method based on the key name. With a key of "lastName", valueForKey() looks for a method named getLastName() or lastName(). In Objective C, it looks for a method named getLastName or -lastName.
  2. If a public accessor method isn't found, the component subclass searches for a private accessor method based on key. Note that traditionally in the Apple frameworks, a private method is distinguished by a preceding underbar. In this case, valueForKey() looks for a method named _getLastName() or _lastName(). In Objective C, it looks for a method named _getLastName or -_lastName.
  3. If an accessor method isn't found and the class method accessInstanceVariablesDirectly returns true (in Java) or YES (in Objective C), valueForKey() searches for an ivar based on the key name and returns its value directly. For the key "lastName", this would be _lastName or lastName.
  4. If neither an accessor method or an ivar is found, the default implementation invokes handleQueryWithUnboundKey() in Java or handleQueryWithUnboundKey: in Objective C. The default implementation of this method will raise an NSException.

Sometimes exceptions are raised because although ivars have changed or been deleted for some reason the component subclass or the frameworks still expect the ivar to exist unchanged. In these situations after 10-15 minutes of proverbial pounding sand, we would override handleQueryWithUnboundKey() and check to see if the disputed ivar is being looked up, and if so, return nil or null.

EOKeyValueCoding API to Access Instance Variables

For another example, suppose that you have an EO using a BigDecimal or NSDecimalNumber with "someDecimal" as one of its ivars.

Java

(BigDecimal)myEO.valueForKey("someDecimal");
note: you must always downcast your objects when using valueForKey() in Java

Objective C

[myEO valueForKey:@"someDecimal"];
Here is the operational order for takeValueForKey() (takeValue:forKey: in Objective C)
  1. The EOKeyValueCoding methods search for a public accessor method of the form setKey (setKey: in Objective C)
  2. If a public accessor method isn't found, EOKeyValueCoding searches for a private accessor method of the form _setKey (Objective C _setKey:) invoking it if such a method exists
  3. If an accessor method isn't found and the class method accessInstanceVariablesDirectly returns true or YES, takeValueForKey() searches for an ivar based on the expected key name and sets the value directly in Java. In Objective C, the old value is autoreleased and the new one is retained. For the key "lastName", this would be _lastName or lastName.
  4. If neither an accessor method or an ivar is found, the default implementation invokes handleTakeValueForUnboundKey in Java and handleTakeValue:forUnboundKey: in Objective C.

It is important that while this method has been very well debugged, sometimes phantom keys can be looked up long after they "died". It is prudent to override handleTakeValueForUnboundKey in this situation to check if the phantom key is being looked up and, if so, do nothing.

What are Protocols and Interfaces?

Objective-C protocols and Java interfaces represent essentially the same object-oriented concept: the ability to declare methods that are independent of a particular class and can be implemented by classes in any heirarchy. Any Objective-C class that declares itself to conform to a particular protocol or Java class that implements a particular interface must, by default, implement the methods declared by that protocol/interface. The approaches taken are different with the Objective C approach being arguably more flexible.

Confused? Don't worry — maybe an analogy can make things clearer. Imagine you're writing a nature simulation program which requires that various "animals" have a swimming behavior. Since entirely different kinds of animals can share behaviors even if they come from entirely different species, phyla or families, not every swimming creature inherits from the same class (whales, trout, dogs and humans are all "swimmers" even though they inherit from different classes of "animal": whales do not inherit from trout because whales are mammals while trout are fish, dogs do not inherit from humans because dogs are canines while humans are primates, etc).

In your swimming simulation, you need to have your objects implement a specific type of behavior, but not necessarily the same way. You also want to show what happens when certain types of animals are not able to swim in water (like most species of birds, for example). So, if you are writing an Objective C program, you declare a 'Swimming' protocol. Correspondingly, if you are writing a Java program, you declare a 'Swimming' interface.

The Objective-C protocol declaration may look like this:

@protocol Swimming

- (void)treadWater;
- (void)swimFreestyle;
- (void)breathe;
....

@end

The Java interface declaration may look like this:

public interface Swimming {
    public void treadWater();
    public void swimFreestyle();
    public void breathe();
    ....
}

In the swimming simulation, dogs, humans, whales, trout and ducks implement the Swimming protocol or interface method declarations and would swim in ways unique to those species. A hummingbird, on the other hand, would probably not implement the Swimming protocol or interface, and therefore drown if left in water for a prolonged period of time.

To set the ivar 'someDecimal' to a BigDecimal object of value '1', you would:

Java

myEO.takeValueForKey(new BigDecimal("1"), "someDecimal);

Objective C

[myEO takeValue:[NSDecimalNumber decimalNumberWithString:@"1"] forKey:@"someDecimal"]

What happens when your code accesses ivars that no longer exist?

This is an interesting situation. Most often, this occurs when a developer has removed an ivar from his EO without deleting all references to it from the code. EOF's default behavior is to invoke handleQueryWithUnboundKey in Java and handleQueryWithUnboundKey: in Objective C which throws an exception. Developers can override this if they desire some other behavior or have it fail gracefully (not at all recommended but if it is absolutely necessary ... ).

Corollary behavior occurs when using takeValueForKey (Objective C takeValue:forKey:)on an ivar that doesn't exist. EOF automatically invokes the method handleTakeValueForUnboundKey (Objective C handleTakeValue:forUnboundKey:). There are methods used as private API within EOF that are publicly exposed. storedValueForKey and takeStoredValueForKey in Java (storedValueForKey: and takeStoredValue:forKey: in Objective C) are used to access and/or initialize the receiver's values as they are stored in the database.

Making Life Easier

There are some methods in EOKeyValueCoding that make life considerably easier to get things done. And in the case of Objective C, it provides a very convenient way to implement the NSCoding protocol within a class.

valueForKeyPath (Objective C valueForKeyPath:) allows you to return the value at the end of a relationship path's property. For example, if you wanted to find the name of anEmployee's department, you would:

Java

(String)anEmployee.valueForKeyPath("department.name");

Objective C

[anEmployee valueForKeyPath:@"department.name"];

The relationship from anEmployee to its department was traversed and the department's name accessed. Having done this, you can use another method takeValueForKeyPath (Objective C takeValue:forKeyPath:) to set the name of a relationship's property. To change the name of anEmployee's department:

Java

anEmployee.takeValueForKeyPath("Data Processing","department.name");

ObjectiveC

[anEmployee takeValue:@"Data Processing: forKeyPath:@"department.name"];

valuesForKeys (Objective C valuesForKeys:) returns an NSDictionary of the key-value pairs of an object. It's corollary method takeValuesFromDictionary (Objective C takeValuesFromDictionary:) sets the ivars of an object to the values of the NSDictionary passed as an argument.

What are Ivars/Instance Variables?

Instance variables (also known as ivars) are the specific variables of data for an object instance. What does that mean?

Let's say you have an Employee class which generically defines what an employee looks like. An Employee has a first name, a last name, and a Social Security number. In Objective C, an Employee would look like this:

@interface Employee : NSObject
{
    NSString *firstName;
    NSString *lastName;
    NSString *ssn;
}
....
@end

And in Java, an Employee would look like this:

public class Employee extends Object {
    protected String firstName;
    protected String lastName;
    protected String ssn;
    ....
}

Employee objects, like the employees that represent the CEO and the vice-president, would have a firstName, lastName, and an ssn instance variable. For the CEO, her instance variables might look like this: firstName = "Jane", lastName = "Smith", ssn = "555-12-1234". For the vice-president, his instance variables may look like this: firstName = "John", lastName = "Brown", ssn = "555-12-9876". For the CEO Employee object, its variables contain unique data, and likewise for the vice-president Employee object as well.

EOKeyValueCoding provides a consistent API for the frameworks to access the ivars for the retrieval and modification of data. Whenever a firstName is displayed on a web page in a WebObjects app, it is retrieved through EOKeyValueCoding's APIs. The corresponding modification of ivars occurs through EOKeyValueCoding's APIs on all objects. This consistency allows developers to create applications and frameworks faster because they don't have to think about how the ivars need to be accessed.

These methods can be used to quickly implement the NSCoding protocol in Objective C. The NSCoding protocol can be used to make an object archivable to disk. It consists of two methods encodeWithCoder: and initWithCoder:. Imagining a situation where a developer wished to implement an Employee class that didn't use EOF. Some form of persistence needs to be created for the Employee objects by implementing the NSCoder protocol.

Implementing persistence

Employee.h
#import <Foundation/Foundation.h>
@interface Employee : NSObject <NSCoding>
{
    NSString *firstName;
    NSString *lastName;
    NSString *ssn;
    NSString *streetAddressOne;
    NSString *streetAddressTwo;
    NSString *city;
    NSString *state;
    NSString *zipCode;
    NSDecimalNumber *salary;
}

//  Skip the accessors....

//  EOKeyValueCoding-based methods
- (NSDictionary *)objectAsDictionary;
- (NSArray *)attributeNames;

//  NSCoding methods (which we declare for this example...)
- (id)initWithCoder:(NSCoder *)coder;
- (void)encodeWithCoder:(NSCoder *)coder;

@end

Employee.m
#import "Employee.h"
#import <EOControl/EOKeyValueCoding.h>

@implementation Employee

//  EOKeyValueCoding-based methods
- (NSArray *)attributeNames
{
    //  Return the ivar 'keys' in an NSArray
    return [NSArray arrayWithObjects:
         @"firstName",
         @"lastName",
         @"ssn",
         @"streetAddressOne",
         @"streetAddressTwo",
         @"city",
         @"state",
         @"zipCode",
         @"salary",
        nil];
}

- (NSDictionary *)objectAsDictionary
{
    //  Return the object as an NSDictionary, using the -attributeNames
    //  method to define the keys of the object
    return [self valuesForKeys:[self attributeNames]];
}

- (NSString *)description
{
    //  Inherited from NSObject
    //  Represent the object as an NSDictionary
    return [[self objectAsDictionary] description];
}

//  NSCoding methods
- (void)encodeWithCoder:(NSCoder *)coder
{
    //  NSDictionary already conforms to the NSCoding protocol,  as
    //  well as NSString and NSDecimalNumber
    [super encodeWithCoder:coder];
    [coder encodeObject:[self objectAsDictionary]];
    
    return;
}

- (id)initWithCoder:(NSCoder *)coder
{
    NSDictionary *newSelf;
    
    self = [super initWithCoder:coder];
    newSelf = [coder decodeObject];
    
    //  Since we've already archived ourselves as an NSDictionary,
    //  we can probably take our values from the decoded NSDictionary
    [self takeValuesFromDictionary:newSelf];
    
    return self;
}

@end

This is a simpler (and faster) way of implementing NSCoder, particularly as the number of ivars increasses. In our example, the traditional approach would have required 10-12 additional lines of code for dealing with all of the ivars individually. Instead of all that, the object is archived as an NSDictionary and the EOKeyValueCoding protocol takes care of the rest.

Conclusion

EOKeyValueCoding provides a consistent and convenient API to access and manipulate all of your ivars within your objects. It also provides a uniform way to represent all objects as NSDictionaries to WebObjects and EOF. This helps make object-oriented programming within WebObjects much simpler which is beneficial regardless of your level of expertise.

Unsurprisingly, EOKeyValueCoding is too useful to be kept to EOF and WebObjects alone. Apple recognized its potential by migrating it for JavaClient as NSKeyValueCoding. Even more significant, NSKeyValueCoding appears to be moving into Foundation for use with Cocoa programming. Other than some source code #import changes, all the API stays consistent which now means that persistence within classes will become much simpler.


Please feel free to contact the authors with questions or comments on the articles at webobjectseof@mac.com. We may not be able to reply personally to all emails but every one will be read.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

How to win big in Slots Deluxe
Cheating while gambling is illegal and morally wrong, and in some parts of the world it leads to men with names like Vinnie "Six Knuckles" Manchenzo beating you to a pulp in a dark alley. [Read more] | Read more »
How to take over the world in Dictator 2
Running a country isn't easy - especially when you're a dictator who wants to take over the world and crush everyone in your path while you do it. [Read more] | Read more »
Tips and tricks to get a higher score in...
Tank.iois - you guessed it! - another multiplayer arena battler likeAgar.io and Slither.io. It does differentiate itself by putting you in a tiny tank though, so it's not exactly the same. To help you get that all-important high score, we've got a... | Read more »
How to unlock characters in One Tap Tenn...
As the title suggests, One Tap Tennis requires only a single tap to play its particular brand of tennis, and rewards you with a ton of unlockable characters if you perform well. Fortunately for you, we at 148Apps have got a few tips and tricks to... | Read more »
Grab it now: Game Craft’s Legend of War...
The real time strategy game is now available for you to sink your teeth into, through the App Store and Google Play. Combining elements of skill, strategy and empire building, Legend of War is a real gamers’ game. [Read more] | Read more »
Skateboard Party 3 ft. Greg Lutzka (Gam...
Skateboard Party 3 ft. Greg Lutzka 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Skateboard Party is back! This third edition of the popular sports franchise features professional skater... | Read more »
Cubious (Games)
Cubious 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: Cubious – How smart are you? How high is your IQube? Solve the impossible puzzles to find out, and help a lost little cube find his... | Read more »
Goat Simulator Waste of Space (Games)
Goat Simulator Waste of Space 1.1 Device: iOS Universal Category: Games Price: $4.99, Version: 1.1 (iTunes) Description: ** IMPORTANT - SUPPORTED DEVICESiPhone 4S, iPad 2, iPod Touch 5 or better.** | Read more »
Wildfulness - Unwind in nature and calm...
Wildfulness - Unwind in nature and calm your mind with nature sounds and illustrations 1.0 Device: iOS Universal Category: Healthcare & Fitness Price: $1.99, Version: 1.0 (iTunes) Description: Spending time in nature helps you to... | Read more »
Dr. Panda Racers (Education)
Dr. Panda Racers 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: STEP ON THE GAS, RACE AND WIN!Fasten your seat belts and get ready to race! Speed your way to the finish line while doing... | Read more »

Price Scanner via MacPrices.net

Enterprise Workers Pick Technology Over Perks...
New Adobe study shows surprising attitudes about office jobs and where the future of work is heading. Adobe has released survey findings revealing that a surprising 70 percent of U.S. office workers... Read more
Goal Zero and OtterBox Partner to Expand iPh...
Goal Zero, specialists in portable power, have announced a partnership with OtterBox, brand smartphone case protection, to offer the Slide and Slide Plus Batteries as modules compatible with the new... Read more
15-inch Retina MacBook Pros on sale for up to...
B&H Photo has 15″ Retina MacBook Pros on sale for up to $210 off MSRP. Shipping is free, and B&H charges NY tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799 $200 off MSRP - 15″ 2.5GHz Retina... Read more
Clearance 2015 13-inch MacBook Airs available...
B&H Photo has clearance 2015 13″ MacBook Airs available for $250 off original MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/4GB/128GB MacBook Air (MJVE2LL/A): $799... Read more
Apple refurbished Apple TVs available for up...
Apple has Certified Refurbished 32GB and 64GB Apple TVs available for up to $30 off the cost of new models. Apple’s standard one-year warranty is included with each model, and shipping is free: -... Read more
21-inch iMacs on sale for up to $120 off MSRP
B&H Photo has 21″ iMacs on sale for up to $120 off MSRP including free shipping plus NY sales tax only: - 21″ 3.1GHz iMac 4K: $1379.99 $120 off MSRP - 21″ 2.8GHz iMac: $1189 $110 off MSRP - 21″ 1... Read more
Kanex Introduces GoPower USB-C Rechargeable B...
Kanex has announced its GoPower USB-C portable battery for the USB-C MacBook, featuring the new industry standard connector and cable used for connectivity and power. Providing users with a new... Read more
Convertible and Detachable Devices Winning Ov...
According to the latest figures published by International Data Corporation (IDC), Western European shipments of ultraslim convertibles and detachables posted positive growth (44.7%) to account for... Read more
New MacBook Pros And Will MacBook Air Be Upgr...
With my mid-2013 13-inch MacBook Air closing on its third anniversary come November, I’m in system upgrade mode. Actually the Haswell CPU equipped Air is still doing a fine job, but my good wife is... Read more
Apple’s Education discount saves up to $300 o...
Purchase a new Mac or iPad using Apple’s Education Store and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free, and... Read more

Jobs Board

*Apple* Project Engineer - Smart Source Inc...
SmartSource is in need of an Apple Project Engineer for a 12 month contract opportunity in Pittsburg, PA. Role: Apple Project Engineer Location: Pittsburg, PA Read more
Automotive Sales Consultant - Apple Ford Linc...
…you. The best candidates are smart, technologically savvy and are customer focused. Apple Ford Lincoln Apple Valley is different, because: $30,000 annual salary Read more
Service Assistant - *Apple* Chevrolet *App...
Apple Automotive is one of the fastest growing dealer...and it shows. Consider making the switch to the Apple Automotive Group today! At Apple Automotive, we Read more
Editor, *Apple* News - APPLE (United States...
Job Summary The Apple News team is looking for a passionate and knowledgeable editor with experience covering entertainment/pop culture and experience running social Read more
*Apple* Nissan Service Technicians - Apple A...
Apple Automotive is one of the fastest growing dealer...and it shows. Consider making the switch to the Apple Automotive Group today! At Apple Automotive , Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.