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

beaTunes 4.6.12 - Organize your music co...
beaTunes is a full-featured music player and organizational tool for music collections. How well organized is your music Library? Are your artists always spelled the same way? Any R.E.M. vs REM?... Read more
Tinderbox 7.0.1 - Store and organize you...
Tinderbox is a personal content management assistant. It stores your notes, ideas, and plans. It can help you organize and understand them. And Tinderbox helps you share ideas through Web journals... Read more
FotoMagico 5.4 - Powerful slideshow crea...
FotoMagico lets you create professional slideshows from your photos and music with just a few, simple mouse clicks. It sports a very clean and intuitive yet powerful user interface. High image... Read more
Direct Mail 4.3.9 - Create and send grea...
Direct Mail is an easy-to-use, fully-featured email marketing app purpose-built for OS X. It lets you create and send great looking email campaigns. Start your newsletter by selecting from a gallery... Read more
Tinderbox 7.0.1 - Store and organize you...
Tinderbox is a personal content management assistant. It stores your notes, ideas, and plans. It can help you organize and understand them. And Tinderbox helps you share ideas through Web journals... Read more
Direct Mail 4.3.9 - Create and send grea...
Direct Mail is an easy-to-use, fully-featured email marketing app purpose-built for OS X. It lets you create and send great looking email campaigns. Start your newsletter by selecting from a gallery... Read more
FotoMagico 5.4 - Powerful slideshow crea...
FotoMagico lets you create professional slideshows from your photos and music with just a few, simple mouse clicks. It sports a very clean and intuitive yet powerful user interface. High image... Read more
beaTunes 4.6.12 - Organize your music co...
beaTunes is a full-featured music player and organizational tool for music collections. How well organized is your music Library? Are your artists always spelled the same way? Any R.E.M. vs REM?... Read more
Spotify 1.0.49.125. - 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
Eye Candy 7.2.0.50 - 30 professional Pho...
Eye Candy renders realistic effects that are difficult or impossible to achieve in Photoshop alone, such as Fire, Chrome, and the new Lightning. Effects like Animal Fur, Smoke, and Reptile Skin are... Read more

Rollercoaster Tycoon Touch Guide: How to...
| Read more »
Rabbids Crazy Rush Guide: How to unlock...
The Rabbids are back in a new endless running adventure, Rabbids Crazy Rush. It's more ridiculous cartoon craziness as you help the little furballs gather enough fuel (soda) to get to the moon. Sure, it's a silly idea, but everyone has dreams --... | Read more »
Tavern Guardians (Games)
Tavern Guardians 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Tavern Guardians is a Hack-and-Slash action game played in the style of a match-three. You can experience high pace action... | Read more »
Slay your way to glory in idle RPG Endle...
It’s a golden age for idle games on the mobile market, and those addictive little clickers have a new best friend. South Korean developer Ekkorr released Endless Frontier last year, and players have been idling away the hours in the company of its... | Read more »
Tiny Striker: World Football Guide - How...
| Read more »
Good news everyone! Futurama: Worlds of...
Futurama is finding a new home on mobile in TinyCo and Fox Interactive's new game, Futurama: Worlds of Tomorrow. They're really doing it up, bringing on board Futurama creator Matt Groening along with the original cast and writers. TinyCo wants... | Read more »
MUL.MASH.TAB.BA.GAL.GAL (Games)
MUL.MASH.TAB.BA.GAL.GAL 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: ENDLESS UPGRADES. CONSTANT DANGER. ANCIENT WISDOM. BOUNCY BALLS. Launch Sale, 40% OFF for a very limited time!!! MUL.... | Read more »
Dungeon Rushers (Games)
Dungeon Rushers 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Dungeon Rushers is a 2D tactical RPG combining dungeon crawler’s gameplay and turn based fights. Manage your team, loot dusty... | Read more »
Blasty Bubs is a colorful Pinball and Br...
QuickByte Games has another arcade treat in the works -- this time it's a mishmash of brick breaking and Pinball mechanics. It's called Blasty Bubs, and it's a top down brickbreaker that has you slinging balls around a board. [Read more] | Read more »
Corsola and Heracross are the new region...
Generation 2 finally launched in Pokémon GO, unleashing a brand new batch of Pokémon into the wild. Even before the update went live people were speculating on how to catch elusive Pokémon like the legendary "dogs", Unknown, and whether or not... | Read more »

Price Scanner via MacPrices.net

13-inch 2.0GHz Apple MacBook Pros on sale for...
B&H has the non-Touch Bar 13″ 2.0GHz MacBook Pros in stock today and on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.0GHz MacBook Pro Space Gray (... Read more
15-inch Touch Bar MacBook Pros on sale for up...
B&H Photo has the new 2016 15″ Apple Touch Bar MacBook Pros in stock today and on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.7GHz Touch Bar... Read more
12-inch Retina MacBooks on sale for $1150, $1...
B&H has 12″ 1.1GHz Retina MacBooks on sale for $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 12″ 1.1GHz Space Gray Retina MacBook: $1149 $150 off MSRP - 12″ 1.1GHz... Read more
Apple restocks refurbished 11-inch MacBook Ai...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models recently discontinued by Apple), available for up to $170 off original MSRP. An Apple one-year warranty is included with each... Read more
Apple Park Opens to Employees in April With T...
Apple has announced that Apple Park, the company’s new 175-acre campus, will be ready for employees to begin occupying in April. The process of moving more than 12,000 people will take over six... Read more
Manhattan Neighbors for Safer Telecommunicati...
A new education and advocacy group focused on cell phone and wireless risks, Manhattan Neighbors for Safer Telecommunications, launched today at http://www.ManhattanNeighbors.org. Manhattan... Read more
Portable Dual DisplayPort Monitor Dock Enable...
IOGEAR has announced the launch of its USB-C Dual DisplayPort Monitor Portable Dock (GUC3CMST). The dock enables users to easily connect two DisplayPort monitors to a USB-C or Thunderbolt 3 laptop to... Read more
13-inch 2.7GHz Retina MacBook Pro on sale for...
Amazon.com has restocked the 13″ 2.7GHz/128GB Retina MacBook Pro (MF839LL/A) for $200 off MSRP including free shipping: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1099 $200 off MSRP This model tends to... Read more
Apple’s New iPad Ads Don’t Address Pro Users’...
Apple launched a new tranche of iPad Pro TV ads last week addressing actual queries and challenges from the Twitterverse, albeit using actors for the visuals. That’s great. As an iPad fan and heavy... Read more
Free Verbum Catholic Bible Study App For iOS
The Verbum mobile app runs on Logos’ powerful Bible software and is an advanced resource for mobile Catholic study. The Verbum app surrounds the Bible with the Tradition. Verbum comes with 15 free... Read more

Jobs Board

*Apple* Retail - Multiple Positions- Chicago...
SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Manager *Apple* Systems Administration - Pu...
Req ID 3315BR Position Title Manager, Apple Systems Administration Job Description The Manager of Apple Systems Administration oversees the administration and Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Manager *Apple* Systems Administration - Pu...
Req ID 3315BR Position Title Manager, Apple Systems Administration Job Description The Manager of Apple Systems Administration oversees the administration and Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.