[XML-DEV Mailing List Archive Home] [By Thread] [By Date] [Recent Entries] [Reply To This Message]

XML design: don't use duplicate keys in XML objects

  • From: "Costello, Roger L." <costello@mitre.org>
  • To: "xml-dev@lists.xml.org" <xml-dev@lists.xml.org>
  • Date: Thu, 30 Apr 2015 13:30:27 +0000

XML design: don't use duplicate keys in XML objects

Hi Folks,

 

An XML object is an element whose content is a collection of heterogeneous data items. For example, this Book element contains a collection of heterogeneous data items and therefore is an XML object:

 

<Book>
   
<Title>The First and Last Freedom</Title>
   
<Author>J. Krishnamurti</Author>
   
<Date>1954</Date>
   
<ISBN>0-06-064831-7</ISBN>
   
<Publisher>Harper &amp; Row</Publisher>
</Book>

 

The fact that it is an object becomes more apparent with this graphic:

 

Recommendation: Don’t create XML objects with duplicate keys. For example, this Book object has duplicate Author keys:

 

<Book>
   
<Title>Parsing Techniques</Title>
   
<Author>Dick Grune</Author>
   
<Author>Ceriel Jacobs</Author>
   
<Date>2007</Date>
   
<ISBN>978-0387202488</ISBN>
   
<Publisher>Springer</Publisher>
</Book>

 

https://doctoralschool.files.wordpress.com/2011/07/stop-dont-do-it-stay-away-3.jpg

 

Instead, create a single Authors element whose content is an array:

 

<Book>
   
<Title>Parsing Techniques</Title>
   
<Authors><Author>Dick Grune</Author><Author>Ceriel Jacobs</Author></Authors>
   
<Date>2007</Date>
   
<ISBN>978-0387202488</ISBN>
   
<Publisher>Springer</Publisher>
</Book>

 

Now the Book object contains a collection of unique keys. The value of the Authors key is an array of Author elements.

 

Why follow this recommendation? Here’s why:

 

1. It enables XML objects to evolve, using the Must-Ignore policy, as I described in yesterday’s message.

 

2. It enables conversion between XML and programming language objects and databases.

 

3. It is consistent with rfc 7493 (http://www.rfc-editor.org/rfc/rfc7493.txt) which recommends that no JSON object have duplicate keys.

 

/Roger

 



[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index]


PURCHASE STYLUS STUDIO ONLINE TODAY!

Purchasing Stylus Studio from our online shop is Easy, Secure and Value Priced!

Buy Stylus Studio Now

Download The World's Best XML IDE!

Accelerate XML development with our award-winning XML IDE - Download a free trial today!

Don't miss another message! Subscribe to this list today.
Email
First Name
Last Name
Company
Subscribe in XML format
RSS 2.0
Atom 0.3
 

Stylus Studio has published XML-DEV in RSS and ATOM formats, enabling users to easily subcribe to the list from their preferred news reader application.


Stylus Studio Sponsored Links are added links designed to provide related and additional information to the visitors of this website. they were not included by the author in the initial post. To view the content without the Sponsor Links please click here.

Site Map | Privacy Policy | Terms of Use | Trademarks
Free Stylus Studio XML Training:
W3C Member
Stylus Studio® and DataDirect XQuery ™are products from DataDirect Technologies, is a registered trademark of Progress Software Corporation, in the U.S. and other countries. © 2004-2013 All Rights Reserved.