AU2011204906B2 - 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 namespacs extension elements. The namespace extenuivn elements are then grouped into a single element. 2750150_1 ( SHMIit P2M74.AU.1 r J LL--- r

Description

AUSTRALIA Patents Act 1990 COMPLETE SPECIFICATION Standard Patent Applicant(s): Aristocrat Technologiea Australia Pty Limited Invention Title: TRANSLATING XMt WITH MULTIPLE NAMESPACE EXTENSIONS The following statement is a full description of this invention, including ths best method for performing it known to me/us: 2 TRANSLATING KML WITH MULTIPLE NAMESPACE EXTENSIONS Field s The present invention relates to translating XML (extensible Markup Language), and particularly, but not exclusively, to translating XML with multiple namespace extensions. 10 Background XML (extensible Markup Language) is a text-based language which is capable of describing, categorizing and applying a hierarchical (tree-based) structure to any type of 1S 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 provides a self-documenting format which describes structure and field names in addition to holding specific 20 values. In other words, particular instances of the XML language can be developed to categorize and describe almost any type of information. A XML document is primarily composed of a number of XML 25 'elements' which define an element type and also contain a 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. 30 Each instance of a ML 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. 35 To ensure that a XML document conforms to a standard, the XML document may be validated against a XML schema. A XML V50106_1 (aa y P2647,u,1 3 schema is a set of rules to which a XXL document must conform if it i. to be considered 'valid' (i.e. the document conforms to the standard). The set of rules are generally codified as a XML Schema Definition (XSD). The s XSD is not necessarily static, but may be changed over time as extensions and additions are made to the fML language. It may be necessary, in some instances, to bring together 10 disparate ZML documents (and perhaps disparate XML languages) from multiple independent parties, or to allow multiple independent parties to insert information into a common XML document or instance of a XML language. If such a process is not managed correctly, the resulting merged is 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. In such a case, the merged XML document cannot be correctly validated by a XXL schema. 20 Where two different XML documents utilize identical element or attribute names to describe different (non compatible) data, the potential confusion caused can be ameliorated by the use of a namespace convention. When a 25 particular element or attribute is described in a XML document, the element or attribute is attributed a unique nameupace 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 XKL schema, so 30 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 35 party. This is done by the insertion of a tag such as <xs:any namespace."##cther">, where 'xs' is the XML schema namespace. This allows both the base schema and the 275015OI ('MRUlsr) P25474AU.1 4 namespace extensions to be validated at the schema level based on the base schema and the namespace extensions. Existing tools can use this convention to create and use a XSD (:ML Schema Definition) with a single allowed s 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, where different independent parties all wish to utilize the single allowed namespace extension). 10 In the following description, the term "XML file" is used to refer to any file that contains EML related text, and is intended to include a XML document, a XML Schema Definition, a XML schema or any other file that contain 15 text compatible with any aspect of any XML language. The term "IXML document" is used to refer to a file that contains a particular instance of XML. The term "XML schema" is used to denote a description of a type of XML document, normally used to validate the X.L document. The 20 term "XML Schema" (capital '5') is used to denote a particular XML Schema language, published by W3C as a standard in May 2001 (accessible via http://www.w3c.org). The term XML Schema Definition is used to denote a particular instance of an KML schema that is compatible 25 with XML Schema. Summary In a first aspect, the present invention provides a method 30 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 schemal creating a single element based on the plurality of separate elements; and 3S replacing the plurality of separate elements in the KML file with the single element. 31073 _1 (GHMatars) P2574.A.

5 In an embodiment, the step of creating the single element may further comprise the steps of examining the separate elements to identify a first element portion that is common to the separate elements; examining the separate 5 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. 10 In an embodiment, the method may further comprise the step of altering the XML schema based on the single element. In an embodiment, the method may further comprise the steps of determining whether the X=L file is to be 15 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. in a second aspect, the present invention provides a 20 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 correctly validated based on an ML schema; a grouper arranged to create a single element based on the plurality 25 of separate elements; and a transformer arranged to replace the plurality of separate elements in the XML file with the mingle element. In an embodiment, the grouper may be further arranged to 30 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 3S first element portion and the second element portion to form the single element. 31Q7350_1 (OHratters) P25474AA

I

6 In an embodiment, the system may further be 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 s file with the plurality of separate elements. In a third aspect, the present invention provides a method for managing a plurality of namespace extensions in a XML file, comprising the steps of, parsing the file to 1c identify the plurality of nameupace extension elements, and grouping the namespace extension elements into a single element. The step of grouping the nameupace extensionu may comprise 15 the further step of utilizing a set of rules to group the nameupace extension, into the single element. The set of rules may include the rule of parsing each namespace extension element, identifying a common aspect 20 to each of the namespace extension elements, identifying a difference between each of the namespace extension elements, and concatenating each difference to the common aspect. 25 A new XML file may be created, and the single element may 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 30 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 plurality 35 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 $10730a HMult; P474U1 6a plurality of namespace extension elements into separate elements. In a fourth aspect, the invention provides a method for 5 managing a single namespace extension in a XML file, where the single namespace extension element contains 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 10 plurality of namespace extension elements into separate elements. In a fifth aspect, the invention provides a system for managing a plurality of namespace extensions in a XXL 15 file, comprising a parser which parses the file to identify the plurality of namespace extension elements, and a grouper which groups the nanespace extension elements into a single element. 2C In a sixth aspect, the invention provides a system for managing a single namespace extension in a KML file, where the single namespace extension element contains a plurality of elements, comprising, a parser which parses the file to identify the plurality of namespace extension 25 elements contained within the single element, and an extractor which extracts the plurality of nameupace extension elements into separate elements. In a seventh aspect, the invention provides computer 30 program code arranged to, when loaded on a computing system, perform the method steps of one of the first aspect and the second aspect of the invention. In an eighth aspect, the invention provides a computer 35 readable media incorporating computer program code in accordance a fifth aspect of the invention. _1 3&DL SMatters) P25474 AU.i 6b In a ninth aspect, the inventor provides a data signal comprising the program code in accordance with a fifth aspect of the invention. 5 Brief Description of the Drawings Figure 1 is an example computing system capable of implementing an embodiment of the invention; 10 Figure 2 is an example network environment capable of interacting with an embodiment of the inventions Figure 3 is a schematic diagram illustrating the component parts of a software application in accordance with an is embodiment of the invention; and Figures 4a and 4b are flow charts depicting the method steps according to an embodiment of the invention. 20 Detailed Description 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 310T7W_1 HMIars) P25474 AU.1 7 (by one or more independent parties) at the same position in a XML Schema Definition, although it will be understood that the system, method and software application may be used to modify any type of XML file. Moreover, the 5 embodiment provides a mechanism by which the multiple elements added to a single namespace extension in a KML Schema Definition may be correctly interpreted by a receiving computer. 10 The methodology (and associated software application) in 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 is 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 20 (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 25 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 3D 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 35 may use any suitable operating system, much as Windowa"m or Unixm. The computing system 100 may be a gaming server arranged to send gaming information to one or more gaming 2750154J (GHMtters) P26474.AU.1 8 machines. The computing system 100 may be capable of executing a software application 116 (which may be in the form of an API) in accordance with an embodiment of the invention. 5 It will be understood that the computing system described in the preceding paragraphs is illustrative only and that the presently described embodiment or other embodiments which fall within the scope of the claims of the present 10 application may be executed on any suitable computing 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 is other devices capable of receiving electronic information, including automated 'teller' machines and vending machines. Figure 2 illustrates an example network environment 200, 20 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 25 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, 30 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, 3j 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 276015_1 (GHMaiLtv) P28474.AL,1 9 Standards Association Game-to-System protocol), GSA 825 (Gaming Standards Association System-to-System protocol) or any other suitable protocol for the exchange of information 208. The exchange of information may include 5 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. Figure 3 is a schematic diagram illustrating the components of a software application in accordance with an 10 embodiment of the present invention. The software 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 firut parser 306 15 to parse a XML file with multiple elements, and a grouper 309 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 20 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 25 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: <baseadocument xmlnsbaue="http*//example .com/base"' 30 xmlnes:ext="http://example.com/ext"> <base:elementO ' <ext:elementl /> </base:elemento0 c/base:Document> 35 XML Fragment 1: Single namespace extension 270151k_ (5HMmttsrs) PH4A 10 In the XKML fragment shown above, a single namespace extension of type "ext' is provided. That is, the nameipace extension 'ext' allows a third party to insert an element to be added to a XML file and to be validated 5 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: cbase:document 10 xmln:base-"http://example.com/base"> xmlns:exti="http://example.com/exti"> xmlnssext2="httpa//example.com/ext2" <base:element> <extlselmmentl /> 15 <ext2:element2 /> </baeselementO> </basesDocument> XML Fragment 2: Multiple elements added 20 As can be seen, two elements, namely ext1 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 25 extensions are not allowed at the same position, according to a fML Schema Definition. The embodiment described herein ameliorates this problem by providing a first transformer which creates a XML 30 Schema Definition which includes a single namespace extension that aggregates or incorporates all of the elements in the Z)L namespace extension into a single element. This is achieved through the use of the software application of Figure 3, which operates in the manner 35 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 275012fl GNMaIIers) P3S47%AUI 11 Definition is parsed by a parser (step 402) to extract the multiple name space extensions (8tep 404). The extracted multiple namespace extensions are rewritten by a grouper into a single -element (step 406). 5 The manner in which the query is rewritten may follow a suitable set of predetermined rules. In the example embodiment described herein, the common aspect of each of the elements in each of the nhmespace extensions is 10 separated from the difference between each of the multiple 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. 15 For example, the multiple elements listed in Fragment 2, namely xmlnssextl."http://example.com/extl" and xmilnstext2-"http://example.com/ext20, are separated into their common portion, namely the portion 20 "http://example.com/" and their different portion, namely "ext1" 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 25 xminusext="https//example.com/ext-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. 30 Another example embodiment utilizes the concatenation of multiple elements into a single element. For example, xmlne:extl="https//example.com/ext1" and xmlne:ext2."http//example.com/ext2" may be combined to form the element mlns:ext." http://example.com/extl as http://example.com/ext2". :t will be understood that the two example embodiments described herein are provided by way of example only, and other variations in the manner in 275C1155_1GHMlir) 2M4 AU I 12 which multiple elements are combined to form a single element are within the purview of a person skilled in the art. s The rewritten element is reinserted into the XML Schema Definition (step 400) or alternatively, a new XML Schema Definition may be created to contain the new values. The new XML Schema Definition is termed an 'internal representation', as it is the version of the XML Schema 10 Definition which is understandable to an older or legacy computing system. For example, utilizing the methodology outlined in Figure 4, the fML Fragment 2 is transformed to XML Fragment 3, shown below: 15 <basesdocument xmlns:baee-"http://example.com/base"> xmlns:ext."http://example.com/extl-ext2"> <base:elementoy <extuelement /> 20 cextselement2 /p </baseselementO; </base:Document> XML Fragment 3: Multiple elements combined into a single 25 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 30 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. 3Z However, while the internal representation is useful in situations where an older version of a KML schema is 275C1N._ (OHMutturp) P25474.AU.1 13 employed, it is necessary to convert XML Code Fragment 3 to the original representation with multiple namespace extensions when the DML is delivered to another computing system (termed an 'over-the-wire' representation). This is 5 achieved by the second transformer, which, if required, utilizes the internal representation and transforms the internal representation into the original multiple namespace extension format. At a first step 410, the second transformer receives a XML Schema Definition with 10 multiple namnepace extensions. The XML Schema Definition is parsed by a parser (step 412) to identify the mingle combined name space extension element (step 414). The single combined namespace extension element is rewritten by an extractor into multiple element. (step 416). 15 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 20 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 25 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'. 30 For example, the multiple elements listed in Fragment 2, namely xmlns:extl."http://example.com/extl" and xmlns:ext2w"http://example.com/ext2", were originally separated into their common portion, namely the portion 3S "http://example.com/" and their different portions, namely "extl" and "ext2". The common portion then formed the primary portion of the new combined mingle element, with 27515a.1 3-'Mtmm) P2H74AU.1 14 the different portions being concatenated (and separated by a dash) to form the new single element, namely xmlno:ext="http://example.com/extl-ext2". 5 Therefore, to reverse this methodology, the new single element is broken up into corresponding parts, namely "ext1" and "ext2". The query is then rewritten as two separate elements, namely xmlns:extlw"http://example.com/extl" and 10 xmlns:ext2."http://example.com/ext2". The rewritten elements are reinserted into the XML Schema (step 418) or alternatively, a new KML Schema Definition may be created to contain the new values. The new XML 15 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. 20 One possible software application which could be used to specify and control transformer behavior is ZSLT (extensible Stylesheet Language Transformations). XSLT is a template processing application primarily designed to 25 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 30 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 35 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 275015_ (1-MMaBers) P25474,AU.1 15 a gaming server operating system. Generally, as program modules include routines, programs, objected, components, and data file. that perform or assist in the performance of particular functions, it will be understood that a 5 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 claimed herein. Such variations and modifications would be within the purview of those skilled in the art. 10 276O1601 (GHnMial) P28474 AU.1

Claims (9)

1. A method of processing an XML file, the method comprising the steps of: s examining the XXL file to identify a plurality of separate elements that are unable to be correctly validated based on an XXL schema; creating a single element bamed on the plurality of separate elemental and 10 replacing the plurality of separate elements in the XML file with the single element,

2. The method as claimed in claim 1, wherein the step of creating the single element comprises the steps 15 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 20 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. 25

3. The method as claimed in any one of the preceding claims, comprising the further step of altering the XXL schema based on the single element. 30

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, 35 replacing the single element in the XML file with the plurality of separate elements. 31Q7350.1 GMatem)P2H74AWU 17

5. A system for processing an XML file, the system comprising: a form parser arranged to examine the XML file to identify a plurality of separate elements that are 5 unable to be correctly validated based on an XML achemap a grouper arranged to create a single element based on the plurality of separate elements; and a transformer arranged to replace the plurality 10 of separate elements in the XML file with the single element.

6. A system defined by Claim 5 wherein the grouper is further arranged to: 1S 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 20 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. 25

7. A system defined by any one of Claims 5 to 6 arranged to: determine whether the ECL file in to be delivered to another computer system; and if required by the other computer system, replace 30 the single element in the XML file with the plurality of separate element.

8. A method substantially as herein described with reference to the accompanying figures. 35

9. A system substantially as herein described with reference to the accompanying figures. 2107ML J(GHMattn)rP2474,AU,1