Microsoft Cloud Authors: Janakiram MSV, Yeshim Deniz, David H Deans, Andreas Grabner, Stackify Blog

Related Topics: Microsoft Cloud

Microsoft Cloud: Article

An Exploration of the ObjectSpaces Framework

Accessing data through application business domain objects

With the release of the alpha bits of ADO.NET 2.0 and Visual Studio 2005, Microsoft is experimenting with a framework that provides .NET programmers with a new way to access and work with relational data. Traditionally, passing and persisting data to the data storage layer has been very data-centric, as it consisted of thinking of data in terms of tables, rows, and columns. This conflicts with the object-centric paradigm of the business logic layer where data is defined in terms of objects and properties. As a result, a lot of custom code is written and maintained to couple the data-centric database storage layer to the object-centric business layer. ObjectSpaces enables you to work with the data through the business- level objects that make up the application domain. The classes that make up the ObjectSpaces architecture allow you to abstract out the complexity of the data-centric syntax of the storage medium from the object-oriented developer. This article introduces the ObjectSpaces framework and demonstrates the fundamentals of implementing ObjectSpaces in a .NET application.

ObjectSpaces: An Introduction
A valid question you may be asking is, "What is the ObjectSpaces framework and what problem is it trying to solve?" Quite simply, ObjectSpaces is technology built on top of ADO.NET, to provide data-access support. With the addition of ObjectSpaces, ADO.NET supports three main forms of data access technology. The most obvious and utilized data-access technology is the DataSet/DataReader. The strength of DataSets and DataReaders are that they incorporate a relational model common to most relational back-end databases and fully expose the database functionality. They also provide the highest performance compared to the other data-access technologies.

Another data-access technology is SQLXML. The strength of SQLXML is its ability to decouple the data from the database schema. When data needs to be exposed as XML structures, such as Web services and B2B applications, SQLXML is generally the data access of choice. It also provides the ability to map the same data to different schemas for content publishing to various vertical industry standards.

ObjectSpaces is similar to SQLXML in that it decouples the data structure from the database schema. The difference is that ObjectSpaces exposes the schema based on the business-level objects in the application as opposed to XML structures. ObjectSpaces is the way to go if the application has a strong business object layer and the data needs exposure through an object model instead of a relational model.

As you can see, each of these data access technologies exposes a different set of functionalities to solve various problems. It is important that you understand the strengths and weaknesses of each of the data-access technologies. Armed with this knowledge, you will make better decisions on how to design your data-access strategies.

ObjectSpaces is an object-relational mapping (O/RM) framework embedded in ADO.NET. Although O/RM technologies are not new and several third parties offer .NET add-ins, Microsoft is including ObjectSpaces as part of the .NET Framework. O/RM essentially couples the application's object model with the underlying data storage engine. To accomplish this, the O/RM engine uses a mapping file to make the necessary translations.

The ObjectSpaces engine uses an XML mapping file that translates from an object query/update call into the SQL query/update call. By moving the mapping schema into a separate file, objects can be persisted and retrieved from the data storage without writing provider-specific code. Object-oriented programmers can work with the object data using familiar object-oriented syntax.

Mapping Object Relationships
For O/RM to work, the O/RM engine needs a mapping file that defines the schema of the data base, the schema of the objects, and how the schema is mapped between the two. To demonstrate the creation of a mapping file we will create a simple object type – product – and map it to the products table in the Northwind database. Listing 1 (the listings are online at www.sys-con.com/dotnet/sourcec.cfm) defines the product class. Listing 2 shows the XML mapping file used to define the mapping between the product class and the products table.

The database definition schema is defined within the <m:Data Source> </m:DataSource > tags. The object schema is defined within the <m:DataTarget> </m:DataTarget> tags. Notice that object schema tags contain the prefix "osd:" as a namespace alias. (One little caveat of which to be careful: when exposing your data through properties of the class instead of public fields, you need to specify the property as an alias attribute of the field <osd:member> node.)

The mapping schema is defined within the <m:Mappings> </m:Mappings> tags. As you probably realized, creating even the simplest of mapping files is not a trivial exercise and when creating one by hand, using note pad is not practical. Fortunately, Microsoft will provide a mapping utility that will greatly simplify this process. Figure 1 shows the current incarnation of the mapping utility, which allows you to drag and drop data tables and classes onto the design surface and visually create the mappings.

ObjectSpaces supports complex mappings such as one-one, one-many, and many-many. As an example of a one-many mapping, a Supplier class is defined that is related to the Product class. To link the parent Supplier class with the child Product class, a property of a type that implements the IList interface is defined. The child class links back to the parent class through a property of type parent in the child class.

Listing 3 contains the definitions of the Supplier and Product classes. To support this relationship, the mapping file is updated to include an <osd:ObjectRela tionship> node that includes a schema defining the relationship between the two objects. The updated schema also reflects the definition relating the Supplier table and the Products table from the Northwind Database. Listing 4 shows the updated nodes added to the mapping files.

Retrieving Objects
To use ObjectSpaces, the application needs to reference the System.Data.ObjectSpaces and System.Data.SqlXml assemblies. The ObjectSpace class acts as the broker between the database model and the object model. An ObjectSet is then instantiated through the GetObjectSet method of an ObjectSpace. The ObjectSet represents a collection of objects returned from the GetObjectSet method. The GetObjectSet method takes a parameter of type string, which defines the query used to retrieve the object data (more about this later). Listing 5 demonstrates retrieving and populating a collection of Product objects and displaying their ProductName properties in a list. Figure 2 shows the resulting list. The ObjectSet provides functionality similar to the DataSet. For example, it enables data binding to Windows Forms controls and tracking values for optimistic concurrency checking.

Along with the features provided with the ObjectSet, the results of an object query can be returned through an ObjectReader. The ObjectReader is analogous to the DataReader. It provides a forward-only, low-overhead stream of objects. It is useful when you need to read the data out of the Objects but do not need the overhead of persisting the entire object model. Listing 6 demonstrates retrieving the ProductName property of the Product objects and loading them into a list box using an ObjectReader.

Spans and Delay Loading
Spans and delay loading provide more control over the way the object model is loaded. A span identifies the related objects that are returned along with the objects retrieved by the query. For example, when retrieving the Supplier objects, you can use a span to retrieve the associated products. Listing 7 uses a span to retrieve both the Suppliers and their related Products. Each Supplier's CompanyName property is loaded into a TreeView control as a parent node and the associated Products' ProductNames are loaded as the corresponding child nodes. (Remember that the relationship between these objects must also be modeled in the mapping file.) Figure 3 shows the resulting TreeView display.

For performance reasons, there are times when you do not want to load the related objects immediately. ObjectSpaces supports on-demand loading of the related objects using delayed loading. To implement delayed loading, ObjectSpaces provides two classes that provide a wrapper for the classes in the relationship. The ObjectList class provides delayed loading for a one-many relationship and the ObjectHolder class provides delayed loading for a one-one relationship. Listing 8 shows the Supplier class altered to take advantage of delayed loading. Notice the Products field and the Products property are of type ObjectList. Listing 9 shows the loading of a second list box depending on the value selected in the first list box by delayed loading. Figure 4 shows the resulting list boxes.

Querying Objects with OPath
One of the most interesting aspects of the ObjectSpaces framework is the development of an object query language. OPath allows object-oriented programmers the ability to use familiar object-oriented syntax to query the object model. It includes a rich feature set of literals, operators, predicates, and functions. Using OPath, programmers can construct complex queries using the syntax with which they are most comfortable working, while giving the ObjectSpaces engine the arduous task of converting it to the database querying syntax. In the previous examples, an empty string was passed in with the instantiation of the ObjectQuery object. This results in pulling back the entire object set. Listing 10 demonstrates restricting the result set using an OPath query. Listing 11 contains the ensuing SQL generated by the ObjectSpaces engine. Although I can only scratch the surface of the OPath query language in this article, look for a future article devoted to this topic as the language matures.

With the ObjectSpaces framework, Microsoft is providing an intriguing technology to .NET programmers. The classes that make up the ObjectSpaces architecture provide the ability to abstract out the complexity of the data centric syntax of the storage medium. Object-oriented developers can work with the data using familiar OOP syntax and the object centric model of the business layer. ObjectSpaces is evolving to offer a rich feature set including object/relational mapping, delayed loading, data binding, transactional support, and an optimistic concurrency model.

The possibilities of this technology are fascinating and I hope that this article gave you a feel for the direction in which Microsoft is moving with the ObjectSpaces framework. Unfortunately, we will have to wait a little longer for the full release of this framework. Microsoft has recently announced that the release of the ObjectSpaces framework is now aligned with the WinFS/Longhorn release timeframe. On the upside, this indicates that ObjectSpaces is an integral part of Microsoft's future and will only get better and more mature over time.

More Stories By Dan Clark

Dan is a Microsoft Certified Trainer, Microsoft Certified Solution Developer, and a Microsoft Certified Database Administrator. For the past seven years he has been developing applications and training others how to develop applications using Microsoft technologies. Dan has been developing and training Microsoft's .NET technologies since the early betas. He has recently authored the book "An Introduction to Object-Oriented Programming with Visual Basic .NET," published by Apress.

Comments (4) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.

Most Recent Comments
Zeeshan Shakeel 08/13/07 09:05:27 AM EDT

interesting article, fantastic effort, welldone Dan
take care

Santosh Benjamin 11/22/04 09:51:38 AM EST

Sorry i missed that part of the conclusion. I agree that its good for the maturity of the framework, but i think they will also lose some momentum in this space to open source technologies such as NHibernate etc. Anyway, all we can do is wait and see. Perhaps it will turn out to be a killer app!!

Dan Clark 07/07/04 02:34:03 PM EDT

Santosh - You are correct that ObjectSpaces has been stripped from ADO 2.0, as I mentioned in the conclusion. The good news is that it will resurface in the near future.

Santosh Benjamin 07/07/04 10:29:08 AM EDT

Interesting article. As far as i know though, ObjectSpaces is not in ADO.NET 2.0 and has been moved to the Longhorn/Orcas timeframe. See the following articles

@ThingsExpo Stories
DevOps at Cloud Expo – being held October 31 - November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA – announces that its Call for Papers is open. Born out of proven success in agile development, cloud computing, and process automation, DevOps is a macro trend you cannot afford to miss. From showcase success stories from early adopters and web-scale businesses, DevOps is expanding to organizations of all sizes, including the world's largest enterprises – and delivering real r...
While some developers care passionately about how data centers and clouds are architected, for most, it is only the end result that matters. To the majority of companies, technology exists to solve a business problem, and only delivers value when it is solving that problem. 2017 brings the mainstream adoption of containers for production workloads. In his session at 21st Cloud Expo, Ben McCormack, VP of Operations at Evernote, will discuss how data centers of the future will be managed, how th...
SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...
SYS-CON Events announced today that Mobile Create USA will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Mobile Create USA Inc. is an MVNO-based business model that uses portable communication devices and cellular-based infrastructure in the development, sales, operation and mobile communications systems incorporating GPS capabi...
SYS-CON Events announced today that MIRAI Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MIRAI Inc. are IT consultants from the public sector whose mission is to solve social issues by technology and innovation and to create a meaningful future for people.
SYS-CON Events announced today that Keisoku Research Consultant Co. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Keisoku Research Consultant, Co. offers research and consulting in a wide range of civil engineering-related fields from information construction to preservation of cultural properties. For more information, vi...
SYS-CON Events announced today that Interface Corporation will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Interface Corporation is a company developing, manufacturing and marketing high quality and wide variety of industrial computers and interface modules such as PCIs and PCI express. For more information, visit http://www.i...
SYS-CON Events announced today that Fusic will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Fusic Co. provides mocks as virtual IoT devices. You can customize mocks, and get any amount of data at any time in your test. For more information, visit https://fusic.co.jp/english/.
SYS-CON Events announced today that TMC has been named “Media Sponsor” of SYS-CON's 21st International Cloud Expo and Big Data at Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Global buyers rely on TMC’s content-driven marketplaces to make purchase decisions and navigate markets. Learn how we can help you reach your marketing goals.
SYS-CON Events announced today that Enroute Lab will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Enroute Lab is an industrial design, research and development company of unmanned robotic vehicle system. For more information, please visit http://elab.co.jp/.
There is huge complexity in implementing a successful digital business that requires efficient on-premise and cloud back-end infrastructure, IT and Internet of Things (IoT) data, analytics, Machine Learning, Artificial Intelligence (AI) and Digital Applications. In the data center alone, there are physical and virtual infrastructures, multiple operating systems, multiple applications and new and emerging business and technological paradigms such as cloud computing and XaaS. And then there are pe...
SYS-CON Events announced today that Daiya Industry will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Daiya Industry specializes in orthotic support systems and assistive devices with pneumatic artificial muscles in order to contribute to an extended healthy life expectancy. For more information, please visit https://www.daiyak...
Real IoT production deployments running at scale are collecting sensor data from hundreds / thousands / millions of devices. The goal is to take business-critical actions on the real-time data and find insights from stored datasets. In his session at @ThingsExpo, John Walicki, Watson IoT Developer Advocate at IBM Cloud, will provide a fast-paced developer journey that follows the IoT sensor data from generation, to edge gateway, to edge analytics, to encryption, to the IBM Bluemix cloud, to Wa...
In his session at @ThingsExpo, Greg Gorman is the Director, IoT Developer Ecosystem, Watson IoT, will provide a short tutorial on Node-RED, a Node.js-based programming tool for wiring together hardware devices, APIs and online services in new and interesting ways. It provides a browser-based editor that makes it easy to wire together flows using a wide range of nodes in the palette that can be deployed to its runtime in a single-click. There is a large library of contributed nodes that help so...
With major technology companies and startups seriously embracing Cloud strategies, now is the perfect time to attend 21st Cloud Expo October 31 - November 2, 2017, at the Santa Clara Convention Center, CA, and June 12-14, 2018, at the Javits Center in New York City, NY, and learn what is going on, contribute to the discussions, and ensure that your enterprise is on the right path to Digital Transformation.
SYS-CON Events announced today that App2Cloud will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct. 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. App2Cloud is an online Platform, specializing in migrating legacy applications to any Cloud Providers (AWS, Azure, Google Cloud).
Agile has finally jumped the technology shark, expanding outside the software world. Enterprises are now increasingly adopting Agile practices across their organizations in order to successfully navigate the disruptive waters that threaten to drown them. In our quest for establishing change as a core competency in our organizations, this business-centric notion of Agile is an essential component of Agile Digital Transformation. In the years since the publication of the Agile Manifesto, the conn...
WebRTC is great technology to build your own communication tools. It will be even more exciting experience it with advanced devices, such as a 360 Camera, 360 microphone, and a depth sensor camera. In his session at @ThingsExpo, Masashi Ganeko, a manager at INFOCOM Corporation, will introduce two experimental projects from his team and what they learned from them. "Shotoku Tamago" uses the robot audition software HARK to track speakers in 360 video of a remote party. "Virtual Teleport" uses a mu...
Internet of @ThingsExpo, taking place October 31 - November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 21st Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devic...
Mobile device usage has increased exponentially during the past several years, as consumers rely on handhelds for everything from news and weather to banking and purchases. What can we expect in the next few years? The way in which we interact with our devices will fundamentally change, as businesses leverage Artificial Intelligence. We already see this taking shape as businesses leverage AI for cost savings and customer responsiveness. This trend will continue, as AI is used for more sophistica...