AU2016247060A1 - Translating xml with multiple namespace extensions - Google Patents

Abstract

Abstract The present invention provides a method and system for managing a plurality of namespace extensions in a XML 5 file. The file is parsed to identify plurality of namespace extension elements. The namespace extension elements are then grouped into a single element. 8152937_1 m 02 cni 2 2o z co 2 --------------- -----------------

Description

2016247060 18 Oct 2016 1

TRANSLATING XML WITH MULTIPLE NAMESPACE EXTENSIONS

Related Application 5 This application is a divisional application of Australian application no. 2013224753, which, in turn, is a divisional of 2011204906, the disclosure of both of which is incorporated herein by reference. Most of the disclosure of these applications is also included herein, 10 however, reference may be made to the specifications of application nos. 2013224753 and 2011204906 as accepted to gain further understanding of the invention claimed herein. 15 Field

The present invention relates to translating XML (extensible Markup Language), and particularly, but not exclusively, to translating XML with multiple namespace 20 extensions.

Background XML (extensible Markup Language) is a text-based language 25 which is capable of describing, categorizing and applying a hierarchical (tree-based) structure to any type of information. XML is designed to provide a language which describes any type of information in a simultaneously human-readable and machine-readable format. Moreover, XML 30 provides a self-documenting format which describes structure and field names in addition to holding specific values. In other words, particular instances of the XML language can be developed to categorize and describe almost any type of information. 35 A XML document is primarily composed of a number of XML 'elements' which define an element type and also contain a

8152937J 2016247060 18 Oct 2016 2 particular instance of the element. Each element may also have one or more attributes. Attributes are values that are associated with the element. Attributes may be used to further describe characteristics of an element. 5

Each instance of a XML language is generally required to conform to a particular standard, to ensure that XML documents can be easily exchanged and understood between multiple independent parties . 10

To ensure that a XML document conforms to a standard, the XML document may be validated against a XML schema. A XML schema is a set of rules to which a XML document must conform if it is to be considered 'valid' (i.e. the 15 document conforms to the standard). The set of rules are generally codified as a XML Schema Definition (XSD). The XSD is not necessarily static, but may be changed over time as extensions and additions are made to the XML language. 20

It may be necessary, in some instances, to bring together disparate XML documents (and perhaps disparate XML languages) from multiple independent parties, or to allow multiple independent parties to insert information into a 25 common XML document or instance of a XML language. If such a process is not managed correctly, the resulting merged XML document may contain two or more different elements with identical element or attribute names. Such elements, while appearing to be identical, may in fact be different. 30 In such a case, the merged XML document cannot be correctly validated by a XML schema.

Where two different XML documents utilize identical element or attribute names to describe different (non-35 compatible) data, the potential confusion caused can be ameliorated by the use of a namespace convention. When a particular element or attribute is described in a XML

8152937J 2016247060 18 Oct 2016 3 document, the element or attribute is attributed a unique namespace to ensure that it is not confused with an element or attribute from another document. Of course, such a change must also be reflected in the XML schema, so 5 that any document parsed using the schema is considered valid.

In some cases, a XML schema designer will attempt to preempt the addition of new elements by an independent 10 party. This is done by the insertion of a tag such as <xs: any namespace="##other">, where 'xs' is the XML schema namespace. This allows both the base schema and the namespace extensions to be validated at the schema level based on the base schema and the namespace extensions. 15 Existing tools can use this convention to create and use a XSD (XML Schema Definition) with a single allowed namespace extension at an allowed position in the base schema. However, problems arise where multiple namespace extensions are required in the same position (for example, 20 where different independent parties all wish to utilize the single allowed namespace extension).

In the following description, the term "XML file" is used to refer to any file that contains XML related text, and 25 is intended to include a XML document, a XML Schema

Definition, a XML schema or any other file that contains text compatible with any aspect of any XML language. The term "XML document" is used to refer to a file that contains a particular instance of XML. The term "XML 30 schema" is used to denote a description of a type of XML document, normally used to validate the XML document. The term "XML Schema" (capital 'S') is used to denote a particular XML Schema language, published by W3C as a standard in May 2001 (accessible via http://www.w3c.org). 35 The term XML Schema Definition is used to denote a particular instance of an XML schema that is compatible with XML Schema. 8152937_1 2016247060 18 Oct 2016 4

Summary

In a first aspect, the present invention provides a method 5 of processing an XML file, the method comprising the steps of examining the XML file to identify a plurality of separate elements that are unable to be correctly validated based on an XML schema; creating a single element based on the plurality of separate elements; and 10 replacing the plurality of separate elements in the XML file with the single element.

In an embodiment, the step of creating the single element may further comprise the steps of examining the separate 15 elements to identify a first element portion that is common to the separate elements; examining the separate elements to identify at least one second element portion in each of the elements that is not contained in any other of the elements; and combining the first element portion 20 and the second element portion to form the single element.

In an embodiment, the method may further comprise the step of altering the XML schema based on the single element. 25 In an embodiment, the method may further comprise the steps of determining whether the XML file is to be delivered to another computer system; and if required by the other computer system, replacing the single element in the XML file with the plurality of separate elements. 30

In a second aspect, the present invention provides a system for processing a XML file, the system comprising a form parser arranged to examine the XML file to identify a plurality of separate elements that are unable to be 35 correctly validated based on an XML schema; a grouper arranged to create a single element based on the plurality of separate elements; and a transformer arranged to

8152937J 2016247060 18 Oct 2016 5 replace the plurality of separate elements in the XML file with the single element.

In an embodiment, the grouper may be further arranged to 5 examine the separate elements to identify a first element portion that is common to the separate elements; examine the separate elements to identify at least one second element portion in each of the elements that is not contained in any other of the elements; and combine the 10 first element portion and the second element portion to form the single element.

In an embodiment, the system may further be arranged to determine whether the XML file is to be delivered to 15 another computer system; and if required by the other computer system, replace the single element in the XML file with the plurality of separate elements.

In a third aspect, the present invention provides a method 20 for managing a plurality of namespace extensions in a XML file, comprising the steps of, parsing the file to identify the plurality of namespace extension elements, and grouping the namespace extension elements into a single element. 25

The step of grouping the namespace extensions may comprise the further step of utilizing a set of rules to group the namespace extensions into the single element. 30 The set of rules may include the rule of parsing each namespace extension element, identifying a common aspect to each of the namespace extension elements, identifying a difference between each of the namespace extension elements, and concatenating each difference to the common 35 aspect. A new XML file may be created, and the single element may

8152937J 2016247060 18 Oct 2016 6 be inserted into the XML file in place of the plurality of namespace extension elements.

The XML file may be a XML schema which may be a XML Schema 5 Definition.

In a fourth aspect, the invention provides a method for managing a single namespace extension in a XML file, where the single namespace extension element contains a 10 plurality of elements, comprising the steps of, parsing the file to identify the plurality of namespace extension elements contained within the single element, and extracting the plurality of namespace extension elements into separate elements. 15

In a fifth aspect, the invention provides a system for managing a plurality of namespace extensions in a XML file, comprising a parser which parses the file to identify the plurality of namespace extension elements, 20 and a grouper which groups the namespace extension elements into a single element.

In a sixth aspect, the invention provides a system for managing a single namespace extension in a XML file, where 25 the single namespace extension element contains a plurality of elements, comprising, a parser which parses the file to identify the plurality of namespace extension elements contained within the single element, and an extractor which extracts the plurality of namespace 30 extension elements into separate elements.

In a seventh aspect, the invention provides computer program code arranged to, when loaded on a computing system, perform the method steps of one of the first 35 aspect and the second aspect of the invention.

In an eighth aspect, the invention provides a computer

8152937J 2016247060 18 Oct 2016 7 readable media incorporating computer program code in accordance with a fifth aspect of the invention.

In a ninth aspect, the inventor provides a data signal 5 comprising the program code in accordance with a fifth aspect of the invention.

Brief Description of the Drawings 10 Figure 1 is an example computing system capable of implementing an embodiment of the invention;

Figure 2 is an example network environment capable of interacting with an embodiment of the invention; 15

Figure 3 is a schematic diagram illustrating the component parts of a software application in accordance with an embodiment of the invention; and 20 Figures 4a and 4b are flow charts depicting the method steps according to an embodiment of the invention.

Detailed Description 25 The embodiment described herein provides a system, method and software application for the creation of a protocol, based on XML, which allows multiple elements to be added (by one or more independent parties) at the same position in a XML Schema Definition, although it will be understood 30 that the system, method and software application may be used to modify any type of XML file. Moreover, the embodiment provides a mechanism by which the multiple elements added to a single namespace extension in a XML Schema Definition may be correctly interpreted by a 35 receiving computer.

The methodology (and associated software application) in

8152937J 2016247060 18 Oct 2016 8 accordance with an embodiment of the invention may be executed on a computing system such as the example computing system shown in Figure 1. At Figure 1 there is shown a schematic diagram of a computing system 100 5 suitable for use with an embodiment of the present invention. The computing system 100 may be used to execute applications and/or system services in accordance with an embodiment of the present invention. The computing system 100 preferably comprises a processor 102, read only memory 10 (ROM) 104, random access memory (RAM) 106, and input/output devices such as disk drives 108, keyboard 110 (or other input peripherals such as a mouse, not shown), display 112 (or other output peripherals such as a printer, not shown) and communications link 114. The 15 computer includes programs that may be stored in ROM 104, RAM 106, or disk drives 108 and may be executed by the processor 102. The communications link 114 connects to a computer network but could be connected to a telephone line, an antenna, a gateway or any other type of 20 communications link. Disk drives 108 may include any suitable storage media, such as, for example, floppy disk drives, hard disk drives, CD ROM drives or magnetic tape drives. The computing system 100 may use a single disk drive or multiple disk drives. The computing system 100 25 may use any suitable operating system, such as Windows™ or Unix™. The computing system 100 may be a gaming server arranged to send gaming information to one or more gaming machines. The computing system 100 may be capable of executing a software application 116 (which may be in the 30 form of an API) in accordance with an embodiment of the invention.

It will be understood that the computing system described in the preceding paragraphs is illustrative only and that 35 the presently described embodiment or other embodiments which fall within the scope of the claims of the present application may be executed on any suitable computing

8152937J 2016247060 18 Oct 2016 9 system, which in turn may be realized utilizing any suitable hardware and/or software. Other computing systems that may be suitable include server computers, hand-held or portable computing devices, consumer electronics, and 5 other devices capable of receiving electronic information, including automated 'teller' machines and vending machines .

Figure 2 illustrates an example network environment 200, 10 with a server computer 202 in communication with client computers 204a, 204b, 204c, etc., via a network (or a bus) 206, in which an embodiment of the present invention may be employed. In more detail, the server 202 may be a gaming server, arranged to interconnect a number of gaming 15 machines 204a, 204b, 204c, etc., via the communications network 206, which may be a local or wide area network, such as an intranet, the Internet, etc. It will be understood that the client computers need not be gaming machines, but may be a terminal, another computing system, 20 a portable communications device, such as a mobile telephone, or any other device capable of receiving information from the server.

The server 202, and the client devices 204a, 204b, 204c, 25 etc., may communicate with each other over the communications network 206 by use of any suitable networking protocol, such as TCP/IP, GSA G2S (Gaming Standards Association Game-to-System protocol), GSA S2S (Gaming Standards Association System-to-System protocol) 30 or any other suitable protocol for the exchange of information 208. The exchange of information may include the provision of XML files, the XML files providing information to be utilized by any or all of the servers and client devices in the communications network 206. 35 Figure 3 is a schematic diagram illustrating the components of a software application in accordance with an embodiment of the present invention. The software

8152937J 2016247060 18 Oct 2016 10 application 300 is comprised of two modules or transformers 302 and 304, although it will be understood that modules 302 and 304 may exist as separate software applications. The first module includes a first parser 306 5 to parse a XML file with multiple elements, and a grouper 308 to group the multiple elements into a single element that incorporates the multiple elements of the original XML file, and the second module includes a second parser 310 to parse a XML file with a single element that 10 contains multiple incorporated elements and an extractor 312 to extract the multiple incorporated elements into a separated multiple element format.

The operation of the software application is best 15 illustrated with reference to an example. A fragment of a XML document, which describes a validation for a single allowable namespace extension, is shown below: <base: document xmlns:base="http://example.com/base"> 20 xmlns:ext="http://example. com/ext"> <base:element0> <ext:elementl /> </base:element0> </base:Document> 25 XML Fragment 1: Single namespace extension

In the XML fragment shown above, a single namespace extension of type 'ext' is provided. That is, the 30 namespace extension 'ext' allows a third party to insert an element to be added to a XML file and to be validated by the XML Schema Definition. However, if two separate users insert elements, the code fragment may include two separate and distinct namespace extensions. That is: 35 <base: document xmlns:base="http://example.com/base">

8152937J 2016247060 18 Oct 2016 11 xmlns:extl="http://example. com/extl"> xmlns:ext2="http://example. com/ext2"> <base:elementO> <extl: element1 /> 5 <ext2:element2 /> </base:elementO> </base: Document> XML Fragment 2: Multiple elements added 10

As can be seen, two elements, namely extl and ext2, have been added to XML Fragment 2. Such a code fragment cannot be correctly or usefully interpreted using current applications or methodologies, as multiple namespace 15 extensions are not allowed at the same position, according to a XML Schema Definition.

The embodiment described herein ameliorates this problem by providing a first transformer which creates a XML 20 Schema Definition which includes a single namespace extension that aggregates or incorporates all of the elements in the XML namespace extension into a single element. This is achieved through the use of the software application of Figure 3, which operates in the manner 25 shown in the flow chart at Figure 4a. The first translator, at step 400, receives a XML Schema Definition with multiple namespace extensions. The XML Schema Definition is parsed by a parser (step 402) to extract the multiple name space extensions (step 404). The extracted 30 multiple namespace extensions are rewritten by a grouper into a single element (step 406).

The manner in which the query is rewritten may follow a suitable set of predetermined rules. In the example 35 embodiment described herein, the common aspect of each of the elements in each of the namespace extensions is separated from the difference between each of the multiple

8152937J 2016247060 18 Oct 2016 12 name space extensions, and the difference between each of the extensions is concatenated as a single element to the end of the common aspect of each of the elements of each of the namespace extensions in the XML Schema Definition. 5

For example, the multiple elements listed in Fragment 2, namely xmlns:extl="http://example. com/extl" and xmlns:ext2="http://example. com/ext2", are separated into their common portion, namely the portion 10 "http://example.com/" and their different portion, namely "extl" and "ext2". The common portion then forms the primary portion of the new combined single element, with the different portions being concatenated (and separated by a dash) to form the new single element, namely 15 xmlns:ext="http://example. com/extl-ext2". It will be understood that this is only one of a large number of possible methods by which multiple elements may be combined into a single element. 20 Another example embodiment utilises the concatenation of multiple elements into a single element. For example, xmlns: extl="http://example. com/ext1" and xmlns:ext2="http://example. com/ext2" may be combined to form the element xmlns:ext=" http://example.com/extl-25 http://example.com/ext2". It will be understood that the two example embodiments described herein are provided by way of example only, and other variations in the manner in which multiple elements are combined to form a single element are within the purview of a person skilled in the 30 art.

The rewritten element is reinserted into the XML Schema Definition (step 408) or alternatively, a new XML Schema Definition may be created to contain the new values. The 35 new XML Schema Definition is termed an 'internal representation', as it is the version of the XML Schema Definition which is understandable to an older or legacy 8152937.1 2016247060 18 Oct 2016 13 computing system. For example, utilizing the methodology outlined in Figure 4, the XML Fragment 2 is transformed to XML Fragment 3, shown below: 5 <base: document xmlns:base="http://example.com/base"> xmlns:ext="http://example. com/extl-ext2"> <base:elementO> <ext:elementl /> 10 <ext:element2 /> </base:element0> </base:Document> XML Fragment 3: Multiple elements combined into a single 15 element

The transformed element allows the internal representation of the base schema to be consistent with accepted standards, and in particular, with the standard of the 20 particular XML instance. This in turn allows instances of XML languages to be extended to allow for revisions and user extensions, while retaining backwards compatibility for systems and applications that employ prior Schema Definition versions . 25

However, while the internal representation is useful in situations where an older version of a XML schema is employed, it is necessary to convert XML Code Fragment 3 to the original representation with multiple namespace 30 extensions when the XML is delivered to another computing system (termed an 'over-the-wire' representation). This is achieved by the second transformer, which, if required, utilizes the internal representation and transforms the internal representation into the original multiple 35 namespace extension format. At a first step 410, the second transformer receives a XML Schema Definition with multiple namespace extensions. The XML Schema Definition

8152937J 2016247060 18 Oct 2016 14 is parsed by a parser (step 412) to identify the single combined name space extension element (step 414). The single combined namespace extension element is rewritten by an extractor into multiple elements (step 416). 5

The manner in which the query is rewritten may follow any suitable set of predetermined rules. In the first example given above, where multiple namespace extension elements are rewritten into a single element, the common aspect of 10 each of the elements in each of the namespace extensions is separated from the difference between each of the multiple name space extensions is taken, and the difference between each of the extensions is concatenated, as a single element to the end of the common aspect of 15 each of the elements of each of the namespace extensions in the XML Schema Definition. If such a method is used to convert from multiple name space extension elements to a single namespace extension element, then the reverse methodology is applied to convert 'back'. 20

For example, the multiple elements listed in Fragment 2, namely xmlns:extl="http://example. com/extl" and xmlns:ext2="http://example. com/ext2", were originally separated into their common portion, namely the portion 25 "http://example.com/" and their different portions, namely "extl" and "ext2". The common portion then formed the primary portion of the new combined single element, with the different portions being concatenated (and separated by a dash) to form the new single element, namely 30 xmlns:ext="http://example. com/extl-ext2".

Therefore, to reverse this methodology, the new single element is broken up into corresponding parts, namely "extl" and "ext2". The query is then rewritten as two 35 separate elements, namely xmlns: extl="http://example. com/ext1" and xmlns:ext2="http://example. com/ext2". 8152937.1 2016247060 18 Oct 2016 15

The rewritten elements are reinserted into the XML Schema (step 418) or alternatively, a new XML Schema Definition may be created to contain the new values. The new XML 5 Schema Definition is termed an 'over-the-wire representation', as it is the version of the XML Schema Definition which is understandable and propagated throughout a computing network such as the one shown in Figure 2. 10

One possible software application which could be used to specify and control transformer behavior is XSLT (extensible Stylesheet Language Transformations). XSLT is a template processing application primarily designed to 15 transform one XML file into another XML file.

However, it will be understood that any suitable software application may be developed, in any suitable programming language, to develop a program which carries out the 20 method steps of the embodiment and the broader invention described herein.

Although not required, the embodiments described with reference to Figures 3 and 4 can be implemented via an 25 application programming interface (API), for use by a developer, and can be included within another software application, such as a gaming machine operating system or a gaming server operating system. Generally, as program modules include routines, programs, objects, components, 30 and data files that perform or assist in the performance of particular functions, it will be understood that a software application may be distributed across a number of routines, objects and components, but achieve the same functionality as the embodiment and the broader invention 35 claimed herein. Such variations and modifications would be within the purview of those skilled in the art.

8152937J 2016247060 18 Oct 2016 16

In the claims which follow and in the preceding description of the invention, except where the context requires otherwise due to express language or necessary implication, the word "comprise" or variations such as 5 "comprises" or "comprising" is used in an inclusive sense, i.e. to specify the presence of the stated features but not to preclude the presence or addition of further features in various embodiments of the invention. 10 It is to be understood that, if any prior art publication is referred to herein, such reference does not constitute an admission that the publication forms a part of the common general knowledge in the art, in Australia or any other country. 8152937_1

Claims (10)

1. Claims :

   1. A method of processing an XML file implemented in a application programming interface (API), the method comprising the steps of: examining, the XML file to identify a plurality of separate elements that are unable to be correctly validated based on an XML schema; creating a single element based on the plurality of separate elements; and replacing the plurality of separate elements in the XML file with the single element.
2. 2. The method as claimed in claim 1, wherein the step of creating the single element comprises the steps of: examining the separate elements to identify a first element portion that is common to the separate elements; examining the separate elements to identify at least one second element portion in each of the elements that is not contained in any other of the elements; and combining the first element portion and the second element portion to form the single element.
3. 3. The method as claimed in any one of the preceding claims, comprising the further step of altering the XML schema based on the single element.
4. 4. The method as claimed in any one of the preceding claims, comprising the further steps of: determining whether the XML file is to be delivered to another computer system; and if required by the other computer system, replacing the single element in the XML file with the plurality of separate elements .
5. 5. A system for processing an XML file, the system comprising an application programming interface (API) implementing: a form parser arranged to examine the XML file to identify a plurality of separate elements that are unable to be correctly validated based on an XML schema; a grouper arranged to create a single element based on the plurality of separate elements; and a transformer arranged to replace the plurality of separate elements in the XML file with the single element.
6. 6. A system defined by claim 5 wherein the grouper is further arranged to : examine the separate elements to identify a first element portion that is common to the separate elements; examine the separate elements to identify at least one second element portion in each of the elements that is not contained in any other of the elements; and combine the first element portion and the second element portion to form the single element.
7. 7. A system defined by any one of claims 5 to 6 arranged to: determine whether the XML file is to be delivered to another computer system; and if required by the other computer system, replace the single element in the XML file with the plurality of separate elements .
8. 8. Computer program code arranged to, when loaded on a computing system, perform the method steps of any one of claims 1 to 4.
9. 9. A non-transitory computer readable media incorporating computer program code as claimed in claim 8.
10. 10. A data signal comprising the computer program code as claimed in claim 9.