Home > Articles > Web Services > XML

  • Print
  • + Share This
Like this article? We recommend

Like this article? We recommend

Undo Stack

The general approach is to make a snapshot object that represents the state of the application. After the user performs some action that you want to be undoable, the application creates a snapshot representing its new state, and saves the snapshot in a collection.

To undo an action, the application pulls the previous snapshot out of the collection and applies it, resetting the application's state to whatever it was when the snapshot was taken. To undo the next action, the application applies the snapshot before that one, and so on until it has moved back to the beginning of the snapshot collection.

To redo an action, the program moves forward to the next snapshot (the one most recently undone) and applies it. It can continue moving forward through the collection until it reaches the most recent snapshot.

If the user undoes some actions and then performs a new action, the program removes all of the snapshots after the one that was most recently applied. It then adds a snapshot representing the new action to the collection.

The program adds and removes snapshots from the same end of the collection, so the items added first are the last ones you can remove. This kind of data structure is called a first-in-last-out (FILO) list, and is analogous to a stack of plates on a table: You can add a plate to the top and remove a plate from the top, but you cannot add or remove a plate from the middle or bottom. Because of this similarity, a FILO list is often called a stack.

Sometimes, you may want to bend the definition of the stack slightly and allow the program to remove items from the bottom of the stack. For a complex application, a snapshot may take up a lot of memory. In that case, you might not want to keep every snapshot in the undo stack forever. For example, you might decide to keep only the 10 most recent snapshots. Whenever the program added an 11th snapshot, it would delete the oldest one from the collection. A more flexible approach might add up the sizes of the snapshots and only start deleting the oldest ones when the total memory used was more than a few megabytes.

A Kodak Moment

The general approach of building an undo stack is relatively simple. You make a collection, add snapshots to it, and move back and forth through the collection to undo and redo actions.

The tricky part is taking the snapshot. The snapshot must contain all the information you need to restore the application to a particular state. Depending on the application, a snapshot might need to include a huge variety of information. For example:

  • In a simple text file editor, a snapshot can simply be a string containing the current text.

  • In a word processor, a snapshot can include a whole swarm of objects representing paragraphs, words, margins, figures, text styles, footnotes, and other pieces of the document.

  • In a drawing program, a snapshot includes information about the size, position, orientation, color, line style, fill style, and other drawing attributes of all of the currently displayed graphical objects.

Given the diversity of information you might need to store for a particular application, you might think this article can give you little help in building snapshots. Actually the XML serialization tools provided by VB.NET make building snapshots easier than you might think.

A serialization is a streamed, often textual representation of an object. When you serialize an object, you convert it into a serialization. When you deserialize a serialization, you convert it back into an object. Some of the more whimsically minded programmers call this dehydration and rehydration.

For example, suppose you have a Person object that has variables FirstName, LastName, and Age. If you have a particular object with FirstName = Andrew, LastName = Anderson, and Age = 25, then one possible serialization is the following:

Andrew,Anderson,25

If you know that the fields in this serialization are LastName, FirstName, and Age, you can pull this string apart to build a new Person object containing the original values.

An XML-based serialization uses a sequence of XML (extensible markup language) tags to represent an object. In this example, the serialization might be the following:

<Person>
  <LastName>Andrew</LastName>
  <LastName>Anderson</LastName>
  <Age>25</Age>
</Person>

XML is a standard data representation language, so there is some reason to believe this serialization is more readable than the previous one. The real clincher for using this version, however, is that VB.NET's XmlSerializer object can automatically serialize and deserialize objects for you.

XmlSerializer

The XmlSerializer class automatically serializes and deserializes objects without you needing to tell it all about the objects. The serializer uses VB.NET's reflection tools to learn about the object all by itself. That means you can use an XmlSerializer to create a textual representation of any kind of object quickly and easily.

The following code serializes a Person object named customer and displays the result in a message box.

Dim customer As Person
Dim xml_serializer As XmlSerializer
Dim string_writer As New StringWriter()

' Initialize the customer object somehow.
...

' Create the XmlSerializer.
xml_serializer As New XmlSerializer(GetType(Person))

' Make the serialization, writing it into the StringWriter.
xml_serializer.Serialize(string_writer, customer)

' Display the results.
MsgBox(string_writer.ToString)

The following code deserializes a serialization string to re-create a Person object.

Dim customer As Person
Dim serialization As String
Dim string_reader As StringReader
Dim xml_serializer As New XmlSerializer(GetType(Bouncer))

' Load the serialization string somehow.
...

' Make a StringReader holding the serialization.
string_reader = New StringReader(serialization)

' Create the new Person object from the serialization.
customer = xml_serializer.Deserialize(string_reader)

Notice that this code contains no information about the structure of the Person class. The XmlSerializer figures out what information it needs to save in the serialization and how to recover that information without any help from you.

In fact, the XmlSerializer will even climb down into any sub-objects the main object might contain. For instance, suppose the Person object contains an array of Assignment objects representing projects to which the person is assigned. The XmlSerializer will dig through the array and pull out the information it needs to serialize all of the Assignment objects that are present. XmlSerializer can climb as deeply into an object hierarchy as it needs to serialize all of the objects attached to the Person object, with a few constraints.

First, XmlSerializer cannot serialize disconnected objects. If you have two Person objects that are not connected in any way, XmlSerializer does not include both objects in the serialization of either one. For an example that's more relevant to an undo/redo discussion, if your drawing application uses a bunch of drawing objects (line, circle, polygon), the XmlSerializer cannot serialize them all if they are not connected.

An easy way to solve this problem is to create a new object that simply contains references to all the objects you want to serialize. This object can be from a new class you build, or it can be a simple array.

The second restriction on XmlSerializer is that it cannot serialize an object graph that contains a loop. If a Person object contains a reference to another object, and that object contains a reference to the original Person object, the XmlSerializer gets confused.

VB.NET provides other serialization classes that can solve this problem. The SoapFormatter and BinaryFormatter classes can both serialize and deserialize complex networks that include loops. These classes also sometimes provide better error messages than XmlSerializer, and they are a bit more robust in other ways, so the example program described shortly uses the SoapFormatter. For more information on using all of these classes, see my book Visual Basic.NET and XML (Wiley, 2002, http://www.vb-helper.com/xml.htm.

Now that you know what XML serialization can do, you've probably figured out the rest of the undo/redo puzzle. If you store all of the application's information in a single object, possibly referring to other objects, you can serialize that object fairly easily. You can then use the serialization for your snapshot.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020