Home > Articles

Data Representation

  • Print
  • + Share This
This chapter is from the book

Using the XmlFormatter

To become familiar with the XmlFormatter, open the Visual Studio solution associated with this chapter that you downloaded from www.samspublishing.com. The solution contains a single project, called Serialization, for building a console application. All the code is in a single module, Program.cs, the content of which is shown in Listing 3.3. Note that there is a using statement for the System.Runtime.Serialization namespace, and also that the project references the System.Runtime.Serialization assembly.

Example 3.3. Program.cs

using System;
using System.Collections.Generic;
using System.Data;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.Text;

namespace Serialization
{
    [DataContract(Name="Calculation")]
    public class ServiceViewOfData: IUnknownSerializationData
    {
        [DataMember(Name = "Symbols")]
        private string[] symbols;
        [DataMember(Name = "Parameters")]
        private decimal[] parameters;
        [DataMember(Name = "Functions")]
        private string[] functions;
        [DataMember(Name="Value")]
        private decimal value;

        private UnknownSerializationData unknownData;

        public string[] Symbols
        {
            get
            {
                return this.symbols;
            }

            set
            {
                this.symbols = value;
            }
        }

        public decimal[] Parameters
        {
            get
            {
                return this.parameters;
            }
            set
            {
                this.parameters = value;
            }
        }

        public string[] Functions
        {
            get
            {
                return this.functions;
            }

            set
            {
                this.functions = value;
            }
        }

        public decimal Value
        {
            get
            {
                return this.value;
            }

            set
            {
                this.value = value;
            }
        }

        #region IUnknownSerializationData Members

        public UnknownSerializationData UnknownData
        {
            get
            {
                return this.unknownData;
            }

            set
            {
                this.unknownData = value;
            }
        }

        #endregion
    }
    [DataContract]
    public class Data
    {
        [DataMember]
        public string Value;
    }

    [DataContract]
    public class DerivedData : Data
    {
    }

    [DataContract(Name = "Calculation")]
    public class ClientViewOfData : IUnknownSerializationData
    {
        [DataMember(Name = "Symbols")]
        public string[] Symbols;
        [DataMember(Name = "Parameters")]
        public decimal[] Parameters;
        [DataMember(Name="Functions")]
        public string[] Functions;
        [DataMember(Name="Value")]
        public decimal Value;
        [DataMember(Name = "Reference")]
        public Guid Reference;

        private UnknownSerializationData unknownData;


        public UnknownSerializationData UnknownData
        {
            get
            {
                return this.unknownData;
            }

            set
            {
                this.unknownData = value;
            }
        }

    }


    [ServiceContract(Name = "DerivativesCalculator")]
    [KnownType(typeof(DerivedData))]
    public interface IServiceViewOfService
    {
        [OperationContract(Name="FromXSDTypes")]
        decimal CalculateDerivative(
            string[] symbols,
            decimal[] parameters,
            string[] functions);

        [OperationContract(Name="FromDataSet")]
        DataSet CalculateDerivative(DataSet input);

        [OperationContract(Name = "FromDataContract")]
        ServiceViewOfData CalculateDerivative(ServiceViewOfData input);

        [OperationContract(Name = "AlsoFromDataContract")]
        Data DoSomething(Data input);

    }

    [ServiceContract(Name="DerivativesCalculator")]
    [KnownType(typeof(DerivedData))]
    public interface IClientViewOfService
    {
        [OperationContract(Name = "FromXSDTypes")]
        decimal CalculateDerivative(
            string[] symbols,
            decimal[] parameters,
            string[] functions);

        [OperationContract(Name = "FromDataSet")]
        DataSet CalculateDerivative(DataSet input);

        [OperationContract(Name = "FromDataContract")]
        ClientViewOfData CalculateDerivative(ClientViewOfData input);

        [OperationContract(Name = "AlsoFromDataContract")]
        Data DoSomething(Data input);
    }

    public class DerivativesCalculator : IServiceViewOfService
    {
        #region IDerivativesCalculator Members

        public decimal CalculateDerivative(
            string[] symbols,
            decimal[] parameters,
            string[] functions)
        {
            return (decimal)(System.DateTime.Now.Millisecond);
        }


        public DataSet CalculateDerivative(DataSet input)
        {
            if (input.Tables.Count > 0)
            {
                if (input.Tables[0].Rows.Count > 0)
                {
                    input.Tables[0].Rows[0]["Value"] =
                        (decimal)(System.DateTime.Now.Millisecond);
                }
            }
            return input;
        }
        public ServiceViewOfData CalculateDerivative(ServiceViewOfData input)
        {
            input.Value = this.CalculateDerivative(
                input.Symbols,
                input.Parameters,
                input.Functions);
            return input;
        }

        public Data DoSomething(Data input)
        {
            return input;
        }

        #endregion
    }

    public class Program
    {
        public static void Main(string[] args)
        {
            using (ServiceHost host = new ServiceHost(
                typeof(DerivativesCalculator),
                new Uri[] {
                    new Uri("http://localhost:8000/Derivatives") }))
            {
                host.AddServiceEndpoint(
                    typeof(IServiceViewOfService),
                    new BasicHttpBinding(),
                    "Calculator");
                host.Open();

                Console.WriteLine("The service is available.");

                string address =
                    "http://localhost:8000/Derivatives/Calculator";

                ChannelFactory<IClientViewOfService> factory =
                    new ChannelFactory<IClientViewOfService>(
                        new BasicHttpBinding(),
                        new EndpointAddress(
                            new Uri(address)));
                IClientViewOfService proxy =
                    factory.CreateChannel();

                decimal result = proxy.CalculateDerivative(
                    new string[] { "MSFT" },
                    new decimal[] { 3 },
                    new string[] { "TechStockProjection" });
                Console.WriteLine(
                  "Value using XSD types is {0}.",
                  result);

                DataTable table = new DataTable("InputTable");
                table.Columns.Add("Symbol", typeof(string));
                table.Columns.Add("Parameter", typeof(decimal));
                table.Columns.Add("Function", typeof(string));
                table.Columns.Add("Value", typeof(decimal));

                table.Rows.Add("MSFT", 3, "TechStockProjection",0.00);

                DataSet input = new DataSet("Input");
                input.Tables.Add(table);


                DataSet output = proxy.CalculateDerivative(input);
                if (output != null)
                {
                    if (output.Tables.Count > 0)
                    {
                        if (output.Tables[0].Rows.Count > 0)
                        {
                            Console.WriteLine(
                                "Value using a DataSet is {0}.",
                                output.Tables[0].Rows[0]["Value"]);
                        }
                    }
                }

                ClientViewOfData calculation =
                    new ClientViewOfData();
                calculation.Symbols =
                    new string[] { "MSFT" };
                calculation.Parameters =
                    new decimal[] { 3 };
                calculation.Functions =
                    new string[] { "TechStockProjection" };
                calculation.Reference =
                    Guid.NewGuid();

                Console.WriteLine(
                    Reference is {0}., calculation.Reference);

                ClientViewOfData calculationResult =
                    proxy.CalculateDerivative(calculation);
                Console.WriteLine(
                  "Value using a Data Contract is {0}.",
                  calculationResult.Value);

                Console.WriteLine(
                    "Reference is {0}.", calculationResult.Reference);

                DerivedData derivedData = new DerivedData();
                Data outputData = proxy.DoSomething(derivedData);


                MemoryStream stream = new MemoryStream();
                XmlFormatter formatter = new XmlFormatter();
                formatter.Serialize(stream, calculation);
                Console.WriteLine(
                  UnicodeEncoding.UTF8.GetChars(stream.GetBuffer()));


                Console.WriteLine("Done.");

                ((IChannel)proxy).Close();

                host.Close();

                Console.ReadKey();
            }
        }
    }
}

In Listing 3.3, the static Main() method of the class called Program both provides a host for a Windows Communication Foundation service and uses that service as a client. The hosting of the service is accomplished with this code:

using (ServiceHost host = new ServiceHost(
  typeof(DerivativesCalculator),
  new Uri[] {
    new Uri("http://localhost:8000/Derivatives") }))
{
    host.AddServiceEndpoint(
      typeof(IServiceViewOfService),
      new BasicHttpBinding(),
      "Calculator");
    host.Open();
    [...]
    host.Close();
    [...]
}

In this code, an endpoint, with its address, binding, and contract, is added to the service programmatically, rather than through the host application's configuration, as was done in the preceding chapter. Similarly, the client code directly incorporates information about the service's endpoint, rather than referring to endpoint information in the application's configuration:

string address =
  "http://localhost:8000/Derivatives/Calculator";
ChannelFactory<IClientViewOfService> factory =
  new ChannelFactory<IClientViewOfService>(
    new BasicHttpBinding(),
    new EndpointAddress(
    new Uri(address)));
IClientViewOfService proxy =
  factory.CreateChannel();

This imperative style of programming with the Windows Communication Foundation is used here for two reasons. The first is simply to show that this style is an option. The second, and more important, reason is to make the code that is discussed here complete in itself, with no reference to outside elements such as configuration files.

The contract of the service is defined in this way:

[ServiceContract(Name = "DerivativesCalculator")]
[...]
public interface IServiceViewOfService
{
  [...]
}

The client has a separate definition of the contract of the service, but the definition used by the client and the definition used by the service are semantically identical:

[ServiceContract(Name="DerivativesCalculator")]
[...]
public interface IClientViewOfService
{
  [...]
}

In both the client's version of the contract and the service's version, there is this definition of an operation:

[OperationContract(Name="FromXSDTypes")]
decimal CalculateDerivative(
  string[] symbols,
  decimal[] parameters,
  string[] functions);

When the client uses that operation, like this,

decimal result = proxy.CalculateDerivative(
  new string[] { "MSFT" },
  new decimal[] { 3 },
  new string[] { "TechStockProjection" });
Console.WriteLine(
  "Value using XSD types is {0}.",
  result);

its attempt to do so works, which can be verified by running the application built from the solution. In this case, the inputs and outputs of the operation are .NET types that correspond quite obviously to XML Schema Datatypes. The XmlFormatter automatically serializes the inputs and outputs into XML.

The next operation defined in both the client's version of the contract and the service's version is this one:

[OperationContract(Name = "FromDataSet")]
DataSet CalculateDerivative(DataSet input);

The client uses that operation with this code:

DataTable table = new DataTable("InputTable");
table.Columns.Add("Symbol", typeof(string));
table.Columns.Add("Parameter", typeof(decimal));
table.Columns.Add("Function", typeof(string));
table.Columns.Add("Value", typeof(decimal));

table.Rows.Add("MSFT", 3, "TechStockProjection",0.00);

DataSet input = new DataSet("Input");
input.Tables.Add(table);

DataSet output = proxy.CalculateDerivative(input);
[...]
Console.WriteLine(
  "Value using a DataSet is {0}.",
 output.Tables[0].Rows[0]["Value"]);

In this case, the input and output of the operation are both .NET DataSet objects, and the .NET DataSet type does not obviously correspond to any XML Schema Datatype. Nevertheless, the XmlFormatter automatically serializes the input and output to XML, as it will for any .NET type that implements ISerializable. Of course, passing .NET DataSets around is a very bad idea if one can anticipate a non-.NET client needing to participate, and it is never wise to rule that out as a possibility.

In the service's version of the contract, this operation is included:

[OperationContract(Name = "FromDataContract")]
ServiceViewOfData CalculateDerivative(ServiceViewOfData input);

The input and output of this operation is an instance of the ServiceViewOfData class, which is defined like so:

[DataContract(Name="Calculation")]
public class ServiceViewOfData: IUnknownSerializationData
{
  [DataMember(Name = "Symbols")]
  private string[] symbols;
  [DataMember(Name = "Parameters")]
  private decimal[] parameters;
  [DataMember(Name = "Functions")]
  private string[] functions;
  [DataMember(Name="Value")]
  private decimal value;
  [...]
}

The client's version of the contract defines the corresponding operation in this way:

[OperationContract(Name = "FromDataContract")]
ClientViewOfData CalculateDerivative(ClientViewOfData input);

Here, the input and output are of the ClientViewOfData type, which is defined in this way:

[DataContract(Name = "Calculation")]
public class ClientViewOfData : IUnknownSerializationData
{
  [DataMember(Name = "Symbols")]
  public string[] Symbols;
  [DataMember(Name = "Parameters")]
  public decimal[] Parameters;
  [DataMember(Name="Functions")]
  public string[] Functions;
  [DataMember(Name="Value")]
  public decimal Value;
  [DataMember(Name = "Reference")]
  public Guid Reference;
}

The service's ServiceViewOfData class and the client's ClientViewOfData class are used to define data contracts that are compatible with one another. The data contracts are compatible because they have the same namespace and name, and because the members that have the same names in each version of the contract also have the same types. Because of the compatibility of the data contracts used in the client's version of the operation and the service's version, those operations that the client and the service define in different ways are also compatible with one another.

The client's version of the data contract includes a member that the service's version of the data contract omits: the member named Reference. However, the service's version implements the Windows Communication Foundation's IUnknownSerializationData interface, thus:

[DataContract(Name="Calculation")]
public class ServiceViewOfData: IUnknownSerializationData
{
  [...]
  private UnknownSerializationData unknownData;
  [...]
  public UnknownSerializationData UnknownData
  {
    get
    {
      return this.unknownData;
    }

    set
    {
      this.unknownData = value;
    }
  }
}

By implementing the IUnknownSerializationData interface, it sets aside some memory that the XmlFormatter can use for storing and retrieving the values of members that other versions of the same contract might include. In this case, that memory is named by the variable called unknownData. Thus, when a more advanced version of the same data contract is passed to service, with members that the service's version of the data contract does not include, the XmlFormatter is able to pass the values of those members through the service. In particular, when the client calls the service using this code,

ClientViewOfData calculation =
  new ClientViewOfData();
calculation.Symbols =
  new string[] { "MSFT" };
calculation.Parameters =
  new decimal[] { 3 };
calculation.Functions =
  new string[] { "TechStockProjection" };
calculation.Reference =
  Guid.NewGuid();

Console.WriteLine(
  "Reference is {0}.", calculation.Reference);

ClientViewOfData calculationResult =
  proxy.CalculateDerivative(calculation);
Console.WriteLine(
  "Value using a Data Contract is {0}.",
  calculationResult.Value);

Console.WriteLine(
  "Reference is {0}.", calculationResult.Reference);

not only is the XmlFormatter able to serialize the custom type, ClientViewOfData, to XML for transmission to the service, but the member called Reference that is in the client's version of the data contract, but not in the service's version, passes through the service without being lost.

Two things should be evident from this case. First, the DataContract and DataMember attributes make it very easy to provide for the serialization of one's custom data types by the Windows Communication Foundation's XmlFormatter. Second, implementing the Windows Communication Foundation's IUnknownSerializationData interface is always a good idea, because it allows different versions of the same data contract to evolve independently of one another, yet still be usable together.

The last operation defined for the service is this one, which is defined in the same way both in the code used by the service and in the code used by the client:

[OperationContract(Name = "AlsoFromDataContract")]
Data DoSomething(Data input);

The input and output of the operation are of the custom Data type, which is made serializable by the XmlFormatter through the use of the DataContract and DataMember attributes, thus:

[DataContract]
public class Data
{
  [DataMember]
  public string Value;
}

The client uses that operation with this code:

DerivedData derivedData = new DerivedData();
Data outputData = proxy.DoSomething(derivedData);

That code passes an instance of the DerivedData type to the service, a type which is derived from the Data class, in this way:

[DataContract]
public class DerivedData : Data
{
}

What will happen in this case is that the XmlFormatter, in deserializing the data received from the client on behalf of the service, will encounter the XML into which an instance of the DerivedData class had been serialized, when it will be expecting the XML into which an instance of the Data class has been serialized. That will cause the XmlFormatter to throw an exception. However, both the service's version of the endpoint's contract and the client's version have a KnownType attribute that refers to the DerivedData class:

[ServiceContract(Name = "DerivativesCalculator")]
[KnownType(typeof(DerivedData))]
public interface IServiceViewOfService
{
  [...]
}
[...]
[ServiceContract(Name="DerivativesCalculator")]
[KnownType(typeof(DerivedData))]
public interface IClientViewOfService
{
  [...]
}

That attribute prepares the XmlFormatter to accept the XML for a DerivedData object whenever it is expecting the XML for an instance of any type from which the DerivedData class derives. So, by virtue of that attribute being added to the definition of the service's contract, when the XmlFormatter encounters XML for a DerivedData object when it is expecting XML for a Data object, it is able to deserialize that XML into an instance of the DerivedData class. It follows that if one was to define an operation in this way,

[OperationContract]
void DoSomething(object[] inputArray);

then one should add to the service contract a KnownType attribute for each of the types that might actually be included in the input parameter array.

That the KnownType attribute has to be added in order for the DerivedData objects to be successfully deserialized shows that one should avoid using inheritance as a way of versioning data contracts. If a base type is expected, but a derived type is received, serialization of the derived type will fail unless the code is modified with the addition of the KnownType attribute to anticipate the derived type.

The Windows Communication Foundation uses the XmlFormatter invisibly. So these remaining lines of client code in the sample simply show that it can be used separately from the rest of the Windows Communication Foundation for serializing data to XML:

MemoryStream stream = new MemoryStream();
XmlFormatter formatter = new XmlFormatter();
formatter.Serialize(stream, calculation);
Console.WriteLine(
  UnicodeEncoding.UTF8.GetChars(stream.GetBuffer()));
  • + 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