Warning: join(): Invalid arguments passed in /home/troyb/troybrant.net/blog/wp-content/themes/hybrid-hacked/hybrid-hacked/library/functions/breadcrumbs.php on line 79

Simple XML to NSDictionary Converter

For the past year or so, I’ve been very lucky. All the data I’ve had to deal with has been packaged in JSON, not XML. And what a glorious year it’s been. Instead of writing complex, single-use XML-parsing code, I’ve had the joy of using Stig Brautaset’s excellent JSON-framework to parse JSON. The framework is dead simple to use. Have some JSON? Throw some JSON at the framework, and viola! You get back an NSDictionary or an NSArray. Just one line of code, and you’re done. Simple, elegant, and completely opposite to the experience of parsing XML.

What’s the problem parsing XML? Well, first you have to set up your NSXMLParser. Then, make sure you’re set as the delegate. Then, override the necessary delegate methods (there are 14 relevant NSXMLParserDelegate methods, so choose wisely!). Then, initialize your NSMutableString to record the strings from the text nodes. Then, initialize your model objects from the XML as elements are pushed and popped in the didStart and didEnd methods. And don’t forget to update your objects with data in the attributes dictionary. And so on, and so on.

XML files, especially small XML files, should be as easy to parse as JSON.

Last week, when faced with the depressing task of writing my first XML parser this year, I wrote a general-purpose XML to NSDictionary parser instead. Throw some XML at it, and it spits out an NSDictionary.

How does it work? Here are the key ideas:

  1. XML elements map to key names in the dictionary
  2. Each element corresponds to a child dictionary
  3. Attribute key-value pairs are added to the element’s child dictionary
  4. Strings from text nodes are assigned to the child dictionary’s “text” key
  5. If an element name is encountered multiple times, the value of the element is set to an array of children dictionaries

This conversion is not without its flaws, but it should work pretty well for most XML files.

The Code

The parser consists of a single class, XMLReader. You can either pass it an XML string or an XML data object, and it will return the NSDictionary version of the XML. If the XML is malformed or the parser fails for any other reason, the NSError pointer you pass in will be populated with an NSError object.

Here’s the header file:

//
// XMLReader.h
//

#import <Foundation/Foundation.h>

@interface XMLReader : NSObject
{
    NSMutableArray *dictionaryStack;
    NSMutableString *textInProgress;
    NSError **errorPointer;
}

+ (NSDictionary *)dictionaryForXMLData:(NSData *)data error:(NSError **)errorPointer;
+ (NSDictionary *)dictionaryForXMLString:(NSString *)string error:(NSError **)errorPointer;

@end

And the implementation:

//
// XMLReader.m
//

#import "XMLReader.h"

NSString *const kXMLReaderTextNodeKey = @"text";

@interface XMLReader (Internal)

- (id)initWithError:(NSError **)error;
- (NSDictionary *)objectWithData:(NSData *)data;

@end

@implementation XMLReader

#pragma mark -
#pragma mark Public methods

+ (NSDictionary *)dictionaryForXMLData:(NSData *)data error:(NSError **)error
{
    XMLReader *reader = [[XMLReader alloc] initWithError:error];
    NSDictionary *rootDictionary = [reader objectWithData:data];
    [reader release];
    return rootDictionary;
}

+ (NSDictionary *)dictionaryForXMLString:(NSString *)string error:(NSError **)error
{
    NSData *data = [string dataUsingEncoding:NSUTF8StringEncoding];
    return [XMLReader dictionaryForXMLData:data error:error];
}

#pragma mark -
#pragma mark Parsing

- (id)initWithError:(NSError **)error
{
    if (self = [super init])
    {
        errorPointer = error;
    }
    return self;
}

- (void)dealloc
{
    [dictionaryStack release];
    [textInProgress release];
    [super dealloc];
}

- (NSDictionary *)objectWithData:(NSData *)data
{
    // Clear out any old data
    [dictionaryStack release];
    [textInProgress release];
    
    dictionaryStack = [[NSMutableArray alloc] init];
    textInProgress = [[NSMutableString alloc] init];
    
    // Initialize the stack with a fresh dictionary
    [dictionaryStack addObject:[NSMutableDictionary dictionary]];
    
    // Parse the XML
    NSXMLParser *parser = [[NSXMLParser alloc] initWithData:data];
    parser.delegate = self;
    BOOL success = [parser parse];
    
    // Return the stack’s root dictionary on success
    if (success)
    {
        NSDictionary *resultDict = [dictionaryStack objectAtIndex:0];
        return resultDict;
    }
    
    return nil;
}

#pragma mark -
#pragma mark NSXMLParserDelegate methods

- (void)parser:(NSXMLParser *)parser didStartElement:(NSString *)elementName namespaceURI:(NSString *)namespaceURI qualifiedName:(NSString *)qName attributes:(NSDictionary *)attributeDict
{
    // Get the dictionary for the current level in the stack
    NSMutableDictionary *parentDict = [dictionaryStack lastObject];
    
    // Create the child dictionary for the new element, and initilaize it with the attributes
    NSMutableDictionary *childDict = [NSMutableDictionary dictionary];
    [childDict addEntriesFromDictionary:attributeDict];
    
    // If there’s already an item for this key, it means we need to create an array
    id existingValue = [parentDict objectForKey:elementName];
    if (existingValue)
    {
        NSMutableArray *array = nil;
        if ([existingValue isKindOfClass:[NSMutableArray class]])
        {
            // The array exists, so use it
            array = (NSMutableArray *) existingValue;
        }
        else
        {
            // Create an array if it doesn’t exist
            array = [NSMutableArray array];
            [array addObject:existingValue];
            
            // Replace the child dictionary with an array of children dictionaries
            [parentDict setObject:array forKey:elementName];
        }
        
        // Add the new child dictionary to the array
        [array addObject:childDict];
    }
    else
    {
        // No existing value, so update the dictionary
        [parentDict setObject:childDict forKey:elementName];
    }
    
    // Update the stack
    [dictionaryStack addObject:childDict];
}

- (void)parser:(NSXMLParser *)parser didEndElement:(NSString *)elementName namespaceURI:(NSString *)namespaceURI qualifiedName:(NSString *)qName
{
    // Update the parent dict with text info
    NSMutableDictionary *dictInProgress = [dictionaryStack lastObject];
    
    // Set the text property
    if ([textInProgress length] > 0)
    {
        // Get rid of leading + trailing whitespace
        [dictInProgress setObject:textInProgress forKey:kXMLReaderTextNodeKey];
        
        // Reset the text
        [textInProgress release];
        textInProgress = [[NSMutableString alloc] init];
    }
    
    // Pop the current dict
    [dictionaryStack removeLastObject];
}

- (void)parser:(NSXMLParser *)parser foundCharacters:(NSString *)string
{
    // Build the text value
    [textInProgress appendString:string];
}

- (void)parser:(NSXMLParser *)parser parseErrorOccurred:(NSError *)parseError
{
    // Set the error pointer to the parser’s error object
    *errorPointer = parseError;
}

@end

The code works by keeping a stack of dictionaries, one for each level of the XML file. Each time a new tag is encountered, a child dictionary is pushed onto the stack. Each time a tag is closed, the dictionary is popped off the stack.

Arrays of elements are detected when the same key appears twice in the dictionary. For instance, if the XML is “<book><page>1</page><page>2</page></book>”, the first time the “page” element is encountered, a child dictionary will be set as the value for the “page” key. The next time the “page” element is encountered, we detect that there’s already a value for the “page” key, so we put both pages in an array and set the value of the “page” key to the array.

Note: One side effect of detecting arrays in this fashion is that the value for a key (say “page” in the example above), can sometimes be set to an NSArray but other times be set to an NSDictionary. For example, if the book contains a single page, “page” will be set to an NSDictionary. If the book contains 2 or more pages, “page” will be set to an NSArray. You will need to account for this when reading from the dictionary produced by dictionaryFromXMLString:error: and dictionaryFromXMLData:error:.

When the parser comes across a text node in the XML, it inserts a key into the dictionary named “text” and sets the value to the parsed string.

Note: Make sure the XML you’re parsing doesn’t contain a field named “text”! You can change it to a non-conflicting name by editing the kXMLReaderTextNodeKey constant at the top of XMLReader.m.

Using the Code

The conversion is best illustrated by an example. The snippet below defines an XML string that is converted into a dictionary using XMLReader:

//
// XML string from http://labs.adobe.com/technologies/spry/samples/data_region/NestedXMLDataSample.html
//
NSString *testXMLString = @"<items><item id=\"0001\" type=\"donut\"><name>Cake</name><ppu>0.55</ppu><batters><batter id=\"1001\">Regular</batter><batter id=\"1002\">Chocolate</batter><batter id=\"1003\">Blueberry</batter></batters><topping id=\"5001\">None</topping><topping id=\"5002\">Glazed</topping><topping id=\"5005\">Sugar</topping></item></items>";

// Parse the XML into a dictionary
NSError *parseError = nil;
NSDictionary *xmlDictionary = [XMLReader dictionaryForXMLString:testXMLString error:&parseError];

// Print the dictionary
NSLog(@"%@", xmlDictionary);

//
// testXMLString =
//    <items>
//        <item id=”0001″ type=”donut”>
//            <name>Cake</name>
//            <ppu>0.55</ppu>
//            <batters>
//                <batter id=”1001″>Regular</batter>
//                <batter id=”1002″>Chocolate</batter>
//                <batter id=”1003″>Blueberry</batter>
//            </batters>
//            <topping id=”5001″>None</topping>
//            <topping id=”5002″>Glazed</topping>
//            <topping id=”5005″>Sugar</topping>
//        </item>
//    </items>
//
// is converted into
//
// xmlDictionary = {
//    items = {
//        item = {
//            id = 0001;
//            type = donut;
//            name = {
//                text = Cake;
//            };
//            ppu = {
//                text = 0.55;
//            };
//            batters = {
//                batter = (
//                    {
//                        id = 1001;
//                        text = Regular;
//                    },
//                    {
//                        id = 1002;
//                        text = Chocolate;
//                    },
//                    {
//                        id = 1003;
//                        text = Blueberry;
//                    }
//                );
//            };
//            topping = (
//                {
//                    id = 5001;
//                    text = None;
//                },
//                {
//                    id = 5002;
//                    text = Glazed;
//                },
//                {
//                    id = 5005;
//                    text = Sugar;
//                }
//            );
//        };
//     };
// }
//

The mapping between XML and NSDictionary is shown in the comments above. Notice how the “batter” and “topping” keys are set to arrays since there were multiple “batter” and “topping” keys in the XML. Also, note how the attributes for elements are available in the element’s child dictionary. For instance, the “id” and “type” attributes for item “item” are keys in the “item” dictionary.

Download

You can download the XMLReader files here:

XMLReader.zip

Done and Done

XMLReader isn’t perfect by any stretch of the imagination, but hopefully it helps save you some pain and misery next time you need to parse an XML file in Objective-C.

61 Responses to “Simple XML to NSDictionary Converter”

  1. I used to parse a XML to JSON and works perfect. Some small modifications to adapt it to my purposes, but in general is working fine!

    Great job!

  2. Aaron fitted the Panther protection screens to every doors and window of the
    church as well as not even an attempted break in since.

  3. This blog is outdated. Please update. Thank you!
    Donghua

  4. Hello,
    i am from india , thanx a lot for xml converter , it saved my lot of time . I am quite new to this ios stuff as i have just 1.5 year of work experience . I would like to contribute(not monetary but otherwise) in whatever way possible in .

  5. The errorPointer member variable needs to be declared thusly for ARC:

    NSError * __autoreleasing *errorPointer;

  6. A good way to be sure that your activity connection is sensible would be to explain it to another person. You’re possibly around the right track
    if you describe they obtain it and so what you assume the text is.
    Paul’s cathedral designed Aged Agonyis household|the property of Outdated Agony was created by Wren, who was the seventeenth-century designer There is a Clockwork Orange placed at the change
    of the pattern once the Age of Males is now decadent and it is currently reverting to bestiality.

    Religion continues to be lost. Money may be the only great.

    Men live and Technology has made a fresh kind of slavery huddled in towns where they protect themselves from
    another out-of concern. Paul’s cathedral|Wren, who was simply the seventeenth-century architect
    A life experience level can be had through Wilson State College often within eight (7) working days.
    Paul’s cathedral created Aged Unhappinessis home|the property of Old Misery was created by Wren, who was the seventeenth-century architect A significant number of specialist authors, who work with our
    company, permit us to cope within the smallest time with full academic documents and
    the most sophisticated. The pace of process writing will not affect the grade of the completed work-in any
    way! Paul’s cathedral|Christopher Wren, who had been the seventeenth-century architect A
    five- section essay is actually a five- essay.
    It’s three sentences, a as well as a realization. You also
    have supporting facts. You also got to truly have a statement in your intro.
    Then you need to have a finish. Should you choosenot the followers will
    not know if you should be closing the five- essay. They would think
    you are still creating. Thus continue reading.
    Paul’s cathedral created the household of Outdated Unhappiness|Wren, who had been A basic essay outline must be
    broken in an introduction, 3 body sentences, along with a summary.
    The Release of the article outline must focus on the data the audience will have to understand your thesis statement.
    Paul’s cathedral created the property of Old
    Agony|Wren, who was An individual record that is good
    should obviously describe why you need to take-up regulation. That is
    why entrance documents that are excellent usually focus
    on the consumer’s determination in its dialogue. Be described as a storyteller and
    walk the audience throughout your personal activities which
    encouraged one to desire to develop into a lawyer. Paul’s cathedral|Christopher Wren, who was simply the seventeenth century architect A Find the meaning for every of the next phrases.
    Use a dictionary to assist you. Paul’s cathedral|Christopher Wren, who
    was the seventeenth-century builder A conclusion which brings together the factors, reasons etc that have been discussed however body and finds a standard finish.

    it should link back again to the launch and remedy the question although no new material must be introduced by a conclusion.

  7. Of Paul’s cathedral created Previous Misery’s household|the property of Outdated Unhappiness was designed by Wren, who was the seventeenth-century designer This may take time and
    effort, using many of receiving information, as being a rapid means see the internet.
    It is not. Paul’s cathedral|Wren, who had been the seventeenth century designer Assign a separate project planner to supervise newsletter approach
    end and your manufacturing routine to end. Having someone handle
    the important points of output allows their key liability
    is focused on by the head honchos like proposal
    administrators: creating a winning proposition method.
    Also it allows your manufacturing team change, style,
    and structure the file without disruption. Paul’s cathedral created Old
    Miseryis residence|the home of Previous
    Agony was designed by Christopher Wren, who had been the seventeenth century
    designer A listing of good reasons for the commitment towards the object may help spring from your channels plans that might not have been effectively deemed in times past.
    It’ll help give a format for individual
    progress and modification. Paul’s cathedral|Wren, who had been the seventeenth-century designer
    of St. Paul’s cathedral created the home of Aged Unhappiness|Christopher Wren, who was A European background outline might be useful in lots of
    various circumstances, nonetheless it has got the finest consequence in situations where you discover and must quickly
    review huge amounts of information easily. However,
    leaving a lot of specifics that aren’t main but are merely an action under out from obtaining a standard knowledge of this issue will
    avoid you. For this reason, it’s best to-use traces in conjunction with different resources.
    Outlines are extremely great at developing bare-bones of an argument, therefore let’s take a look at
    what this undertaking is many properly accomplished by types of outlines.
    Paul’s cathedral designed the residence of Old Misery|Christopher
    Wren, who was Of Paul’s cathedral|Christopher Wren, who was the seventeenth-century builder A structure that is concise
    and clear could make your dissertation easy-to produce.

    Offering your ideas plainly, making a robust material target, and delivering a
    great deal of support produce the dissertation easier to understand.
    The 5-sentence article we will discuss helps you to manage your tips into a structure that is written. By preparing
    the tips of your paper into this structure you will
    enhance your essay framework, your reader’s fascination and understanding,
    and so your marks. Paul’s cathedral|Wren, who had been the seventeenth century architect An Extended accountant with knowledge of your sector maybe ready to incorporate price
    and save your valuable organization income. They’ll even be existing on any regulations that could be unique to your business.

  8. Whether you meet somebody online, in a social group, or start chatting with them at the bus quit, it’s important to usually keep safety in mind. Even when you’ve been launched by buddies, you should be careful about revealing personal details too rapidly.

    Toll-totally free line or business line. Nothings even worse than the exact same line your individual and business calls. You really feel extremely disorganized and unprofessional. In addition, the majority of individuals on your web site or marketing supplies for your individual home or mobile telephone number to promote. Determined to consider a get virtual sms number system. GotVMail central ring and data entry work at home agents are popular choices.

    Setting up Skype(tm) at house to sound like a professional is easier than you believe. Most laptops have a built in webcam now that is Okay and the anti echo function in skype isn’t to poor even in a hotel space. The probably work much better than your mobile telephone. For the workplace don’t cheap out and get a method then will operate as well as many higher greenback conference systems.

    With an IP PBX you can provide much better customer service and much better productivity: Since the telephone system is now computer-primarily based you can integrate telephone features with company programs. For instance: Bring up the customer document of the caller automatically when you receive his/her contact, significantly improving customer services and cutting cost by reducing time invested on each caller. Outbound calls can be positioned directly from Outlook, getting rid of the need for the consumer to type in the telephone quantity.

    In most cases, nevertheless, you can anticipate to invest about $1 for each moment every time you answer your phone in Spain. If you are on a two-week vacation and speak for 30 minutes ever day, your provider will strike you with a $420 bill when you come back. Ouch!

    You will conserve tons of cash. Why spend $40 to $60 a month with a conventional phone services when you can spend much less than $10 per thirty day period with a high quality VOIP supplier when you buy one yr up entrance and get the second year totally free? Save hundreds of bucks each year and talk till your coronary heart is content.

    http://emblemministries.net/smf/index.php?topic=146992.0

  9. Whether you meet somebody online, in a social group, or start chatting with them at the bus quit, it’s important to usually keep safety in mind. Even when you’ve been launched by buddies, you should be careful about revealing personal details too rapidly.

  10. You will conserve tons of cash. Why spend $40 to $60 a month with a conventional phone services when you can spend much less than $10 per thirty day period with a high quality VOIP supplier when you buy one yr up entrance and get the second year totally free? Save hundreds of bucks each year and talk till your coronary heart is content.

Leave a Reply