WO2002101579A1 - System & method of mapping between software objects & structured language element-based documents - Google Patents

System & method of mapping between software objects & structured language element-based documents Download PDF

Info

Publication number
WO2002101579A1
WO2002101579A1 PCT/US2001/049577 US0149577W WO02101579A1 WO 2002101579 A1 WO2002101579 A1 WO 2002101579A1 US 0149577 W US0149577 W US 0149577W WO 02101579 A1 WO02101579 A1 WO 02101579A1
Authority
WO
WIPO (PCT)
Prior art keywords
document
structured language
xml
mapping
language elements
Prior art date
Application number
PCT/US2001/049577
Other languages
French (fr)
Inventor
Michael Beisiegel
John H. Green
Jay W. Warfield
Original Assignee
International Business Machines Corporation
Priority date (The priority date is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the date listed.)
Filing date
Publication date
Application filed by International Business Machines Corporation filed Critical International Business Machines Corporation
Priority to US10/479,671 priority Critical patent/US20040168124A1/en
Priority to EP01993317A priority patent/EP1399841A1/en
Priority to HU0400135A priority patent/HUP0400135A2/en
Priority to JP2003504271A priority patent/JP2004530225A/en
Priority to KR1020037014561A priority patent/KR100583517B1/en
Publication of WO2002101579A1 publication Critical patent/WO2002101579A1/en

Links

Classifications

    • GPHYSICS
    • G06COMPUTING; CALCULATING OR COUNTING
    • G06FELECTRIC DIGITAL DATA PROCESSING
    • G06F8/00Arrangements for software engineering
    • G06F8/30Creation or generation of source code
    • GPHYSICS
    • G06COMPUTING; CALCULATING OR COUNTING
    • G06FELECTRIC DIGITAL DATA PROCESSING
    • G06F40/00Handling natural language data
    • G06F40/10Text processing
    • G06F40/103Formatting, i.e. changing of presentation of documents
    • GPHYSICS
    • G06COMPUTING; CALCULATING OR COUNTING
    • G06FELECTRIC DIGITAL DATA PROCESSING
    • G06F40/00Handling natural language data
    • G06F40/10Text processing
    • G06F40/12Use of codes for handling textual entities
    • G06F40/14Tree-structured documents
    • G06F40/143Markup, e.g. Standard Generalized Markup Language [SGML] or Document Type Definition [DTD]
    • GPHYSICS
    • G06COMPUTING; CALCULATING OR COUNTING
    • G06FELECTRIC DIGITAL DATA PROCESSING
    • G06F40/00Handling natural language data
    • G06F40/10Text processing
    • G06F40/12Use of codes for handling textual entities
    • G06F40/151Transformation
    • G06F40/154Tree transformation for tree-structured or markup documents, e.g. XSLT, XSL-FO or stylesheets
    • GPHYSICS
    • G06COMPUTING; CALCULATING OR COUNTING
    • G06FELECTRIC DIGITAL DATA PROCESSING
    • G06F40/00Handling natural language data
    • G06F40/20Natural language analysis
    • G06F40/205Parsing
    • G06F40/226Validation

Definitions

  • the present invention relates to the field of converting or mapping between a software object and a structured language element document, and in particular to mapping between various software objects such as JavaTM objects and Extensible Markup Language (XML) documents.
  • software objects such as JavaTM objects and Extensible Markup Language (XML) documents.
  • Extensible Markup Language is a pared down version of Standard Generalized Markup Language (SGML) that is designed especially for Web documents. It enables designers to create their own customized tags to provide functionality not available with HTML. For example, XML supports links that point to multiple documents, as opposed to HTML links, which can reference just one destination each.
  • SGML Standard Generalized Markup Language
  • XML is a form of self-describing data (also termed structured language elements in the present description), it is used to encode rich data models. Therefore, XML is useful as a data exchange medium between dissimilar systems. Data can be exposed or published as XML from many kinds of systems: legacy COBOL programs, databases, C++ programs and the like. A business problem that is commonly encountered involves resolving how to map information from an XML document to other data formats and vice versa. For example, once information has been exchanged between entities in an XML document, it may be necessary to map its information into a Java object that can be used when making a database or transactional request.
  • U.S. Patent 6,125,391 issued September 26, 2000 to Meltzer et al. discloses an example of an XML/Java conversion tool.
  • Meltzer et al. parse the XML document and raise events.
  • a parser walks through an XML document and builds a tree representation in memory that can be queried and another parser walks an XML document and raises events with information about the document (e.g., start document event, start element vent with the name of the element, content of the element, end element event, end document event, etc.).
  • start document event start element vent with the name of the element, content of the element, end element event, end document event, etc.
  • Meltzer et al. generates code that contains accessors for each element.
  • the accessor for an element contains a loop, looping for each character.
  • the loop contains a switch statement that performs an action based on what the character is.
  • the action is to build a StringBuffer containing the element fragment of the XML document.
  • the Meltzer et al. solution does not provide supporting infrastructure for working with the code that transforms Java to XML. All the code in Meltzer et al. is generated and is not conducive for a user to edit.
  • mapping framework to support mapping between software objects and structured language element based documents (e.g. XML) that can be efficiently implemented using standard tools.
  • mapping between a document e.g. an XML document
  • a software object e.g. a Java object
  • the framework uses a handler that masks how a property is obtained for mapping. This results in mapping code that has a common appearance for both directions of mapping.
  • a mapping between elements of an XML document and the properties of a Java object is contained in a mapper.
  • a mapper maps from the XML document to a software object through the use of a parser (such as Document Object Model (DOM) or Simple Application Programming Interface (API) for XML (SAX)).
  • a parser such as Document Object Model (DOM) or Simple Application Programming Interface (API) for XML (SAX)
  • JSP JavaServer PagesTM
  • Using JSP based templates enables tags of the document to be written in the JSP, with callbacks to get element and attribute values.
  • JSP is well documented with editor support to permit efficient template creation. Further, content can be directed to a buffer, or directly to a response stream of a servlet.
  • a computer-implemented method for converting a data structure representing a software object to structured language elements of a document comprising: (a) generating a structured language element template document; (b) reading properties from the software object, the properties being associated with the structured language elements of the document; (c) using the properties, obtaining constructs defined by the structured language elements based on the association between the properties and the structured language elements; and (d) populating the structured language element template document with the constructs.
  • a computer- implemented method for converting structured language elements of a document to a data structure representing a software object comprising: (a) reading each of the structured language elements of the document; (b) determining a property, selected from a set of available properties defined by the data structure of the software object, associated with structured language elements of the document; and (c) populating the properties of the data structure representing the software object with structured language element values from the document.
  • a system for converting a software object containing properties to a document defined by structured language elements comprising: (a) a document template; (b) a handler interface for providing a representation of the structured language elements of the document based on call backs made by the document template; (c) a mapping module, in communication with the handler interface, for converting properties of the software objects to structured language elements recognized by the document; and (d) an output target class, in communication with the mapping module, for writing the structured language elements generated in step (c) to the document.
  • a system for converting a document containing structured language elements to a software object comprising: (a) a parser for obtaining events representative of features of the document; (b) an input source class for reading the document; (c) a content handler class, in communication with the input source class, for implementing a buffer for the events obtained by the parser; and (d) a mapping module, in communication with the content handler class, for converting the events obtained by the parser to properties for the software object.
  • a method of converting a software object having properties to a document represented by structured language elements comprising: (a) supplying the software object to an instance of an invoked mapping interface; (b) compiling and executing a template using an instance of an invoked container; and (c) writing the document to a specified output stream using the compiled template.
  • a method of converting a document containing structured language elements to a software object comprising: (a) supplying the document to an instance of an invoked mapping interface; (b) registering the mapping interface as a content handler; (c) parsing the document using an instance of an invoked parser; and (d) populating the software object with properties associated with structured language elements parsed from the document through call backs made to the mapping interface.
  • a computer program product for converting a data structure representing a software object to structured language elements of a document
  • the computer program product comprising computer readable program code devices for: (a) generating a structured language element template document; (b) reading properties from the software object, the properties being associated with the structured language elements of the document; (c) using the properties, obtaining constructs defined by the structured language elements based on the association between the properties and the structured language elements; and (d) populating the structured language element template document with the constructs.
  • a computer program product for converting structured language elements of a document to a data structure representing a software object
  • the computer program product comprising computer readable program code devices for: (a) reading each of the structured language elements of the document; (b) determining a property, selected from a set of available properties defined by the data structure of the software object, associated with structured language elements of the document; and (c) populating the properties of the data structure representing the software object with structured language element values from the document.
  • Fig. 1 is a block diagram of a computer system that may be used to implement a method and apparatus for embodying the invention
  • Fig. 2 is a block diagram illustration the framework for mapping between XML and Java objects and vice versa;
  • Fig. 3 is a flow chart illustrating a method of mapping an XML document to a software object using the framework of Fig. 2;
  • Fig. 4 is a flow chart illustrating a method of mapping a software object to an XML document using the framework of Fig. 2.
  • Fig. 1 Detailed Description of Embodiments of the Present Invention Fig. 1 and the associated description represent an example of a suitable computing environment in which the invention may be implemented. While the invention will be described in the general context of computer-executable instructions of a computer program that runs on a personal computer, the invention can also be implemented in combination with other program modules.
  • program modules include routines, programs, components, data structures and the like that perform particular tasks or implement particular abstract data types.
  • the present invention can also be implemented using other computer system configurations, including hand- held devices, multiprocessor systems, microprocessor-based or programmable consumer electronics, minicomputers, mainframe computers and the like.
  • the invention can also be practiced in distributed computing environments where tasks are performed by remote processing devices that are linked through a communications network.
  • program modules may be located in both local and remote memory storage devices.
  • an exemplary system 10 includes a conventional personal computer 20, including a processing unit 22, a system memory 24, and a system bus 26 that couples various system components including the system memory 24 to the processing unit 22.
  • the system bus 26 includes several types of bus structures including a memory bus or memory controller, a peripheral bus, and a local bus using any of a variety of conventional bus architectures (e.g., PCI, VESA, ISA, EISA etc.)
  • the system memory 24 includes read only memory (ROM) 28 and random access memory (RAM) 30.
  • ROM read only memory
  • RAM random access memory
  • a basic input/output system (BIOS) 32 containing the basic routines that help to transfer information between elements within the computer 20, such as during start-up, is stored in the ROM 28.
  • the computer 20 also includes a hard disk drive 34, magnetic disk drive 36 (to read from and write to a removable disk 38), and an optical disk drive 40 (for reading a CD- ROM disk 42 or to read from or write to other optical media).
  • the drives 34, 36 and 40 are connected to the system bus 26 by interfaces 44, 46 and 48, respectively.
  • the drives 34, 36 and 40 and their associated computer-readable media (38, 42) provide nonvolatile storage of data, data structures, and computer-executable instructions for the computer 20.
  • the storage media of Fig. 1 are merely examples and it is known by those skilled in the art to include other types of media that are readable by a computer (e.g., magnetic cassettes, flash memory cards, digital video disks, etc.).
  • a number of program modules may be stored in the drives 34, 36 and 40 and the RAM 30, including an operating system 50, one or more application programs 52, other program modules 54 and program data 56.
  • a user may enter commands and information into the computer 20 through a keyboard 58 and an input device 60 (e.g., mouse, microphone, joystick, game pad, satellite dish, scanner etc.)
  • input device 60 e.g., mouse, microphone, joystick, game pad, satellite dish, scanner etc.
  • These devices (58 and 60) are connected to the processing unit 22 through a port interface 62 (e.g., serial port, parallel port, game port, universal serial bus (USB) etc.) that is coupled to the bus 26.
  • a monitor 64 or other type of display device is also connected to the bus 26 through an interface 66 (e.g., video adapter).
  • the computer 20 may operate in a networked environment using logical connections to one or more remote computers, such as remote computer 68.
  • the remote computer 68 may be a server, a router, a peer device or other common network node, and typically includes many or all of the elements described in relation to the computer 20, although for simplicity only a memory storage device 70 is shown.
  • the logical connections shown in Fig. 1 include a local area network (LAN) 72 and a wide area network (WAN) 74.
  • LAN local area network
  • WAN wide area network
  • the computer 20 When used in a LAN networking environment, the computer 20 is connected to the LAN 72 through a network interface or adapter 76. When used in the WAN networking environment, the computer 20 typically includes a modem 78 or other means for establishing communications over the WAN 74, such as the Internet.
  • the modem 54 which may be internal or external, is connected to the bus 26 through the port interface 62.
  • program modules depicted relative to the computer 20, or portions thereof, may be stored in the remote memory storage device 70.
  • Discussion of the method of the present invention is based in terms of conversion/mapping from XML to Java objects and from Java objects to XML.
  • Other data formats are also supported.
  • COBOL many legacy business applications are written in COBOL, C and PL1. These applications are composed of programs that reside in Enterprise Information Systems (EIS) such as CICSTM (general purpose online transaction processing software) or IMSTM (Information Management System).
  • EIS Enterprise Information Systems
  • CICSTM general purpose online transaction processing software
  • IMSTM Information Management System
  • the present invention can be used to perform these maps, where a XML-to-object X mapping handler (discussed below) would populate a COBOL structure from the XML document and an object-X-to-XML mapping handler (discussed below) would extract the data from a COBOL structure and be used by a template to populate the XML document.
  • a XML-to-object X mapping handler discussed below
  • an object-X-to-XML mapping handler discussed below
  • mapping methods of the present invention utilize the following high level process: (a) a lexer groups characters into words or tokens that are recognized by a particular system (termed tokenizing); (b) a parser analyses groups of tokens in order to recognize legal language constructs; and (c) a code generator takes a set of legal language constructs and generates executable code.
  • the functions defined by (a)-(c) can be intermixed. For example, for XML to Java object mapping, every character in a XML document is analyzed in order to recognize legal XML tokens such as start tags, properties, end tags and "CD ATA" sections. Then, the tokens must be verified that they form legal XML constructs.
  • XML parsers handle the lexical analysis and parsing tasks.
  • Two example parsing standards are the SAX and DOM APIs (SAX - Simple Application Programming Interface (API) for XML; DOM - Document Object Model).
  • SAX is event-based.
  • XML parsers that implement SAX generate events that correspond to different features found in the parsed XML document.
  • the DOM API is an object-model-based API.
  • XML parsers that implement DOM create a generic object model in memory that represents the contents of the XML document. Once the XML parser has completed parsing, the memory contains a tree of DOM objects that offers information about both the structure and contents of the XML document.
  • Fig. 2 illustrates a schematic representation of a framework 100 according to an embodiment of the present invention.
  • the framework 100 is shown instantiated in an integration component 102 such as a Servlet that can be executed in the system 10 of Fig. 1.
  • the integration component 102 includes a parser 104 implemented using DOM or SAX, for example, that interacts with an XML-OBJECT mapping module 106.
  • SAX will be discussed as an example of the parser 104 in describing the implementation embodiments of the present invention.
  • the XML-OBJECT mapping module 106 receives an input XML document 108 and generates an output Java object 110.
  • the integration component 102 further includes an XML document template module 112 (e.g. based on JavaServer PagesTM - JSP technology) that communicates with an OBJECT-XML mapping module 114.
  • the OBJECT-XML mapping module 114 receives an input Java object 116 and generates an output XML document 118.
  • the XML-OBJECT mapping module 106 includes the following components:
  • a buffered content handler class 106-2 (XML2xBufferedContentHandler) for implementing a buffer for SAX events generated by the parser 104;
  • mapping interface 106-3 (XML2xMapping) for executing the mapping and for setting input an output target streams
  • mapping class 106-4 (XML2xMappingImpl) that provides methods for mapping from the input XML document 108 to the output Java object 110.
  • class and “interface” have specific meanings in Java.
  • a Java class (abstract, inner or final) is a collection of data members and methods that define a particular object and a Java interface is used to impose certain functionality on a class that implement them (i.e. interfaces specify what classes must do). Interfaces are also used to provide constants that can be used by the classes that implement the interface. Interfaces contain constant variables and method declarations, but the implementation of the methods is left to the classes that implement the interface.
  • a class can implement any number of interfaces.
  • Table M106-1 summarizes the main functions (i.e., not exhaustive) of the input source class 106- 1 (XML2xInputSource).
  • XML2xInputSource is used so that an XML document can be read from a byte stream, a character stream or the XML2xBufferedContentHandler 106-2. TABLE Ml 06-1
  • FUNCTION DESCRIPTION availableO returns the number of bytes that can be read from an input stream without blocking- getBufferedHandler 0 Gets the SAX event buffered handler. getBvteStream 0 Returns a byte stream getCharacterStream 0 Returns a character stream reader- read 0 Reads the next byte of data from this input stream- skip 0 Skips bytes of input from this input stream.
  • Table M106-2 summarizes the main functions (i.e., not exhaustive) of the buffered content handler class 106-2 (XML2xBufferedContentHandler).
  • the handler class 106-2 also includes a content handler to buffer SAX events from the parser 104. This allows events to be replayed.
  • An example where this feature is useful is where different mapping handlers are used for different portions of an XML document.
  • An implementation example is the Simple Object Access Protocol (SOAP).
  • SOAP Simple Object Access Protocol
  • SOAP is a lightweight protocol for exchange of information in a decentralized, distributed environment. It is an XML based protocol that consists of three parts: (1) an envelope that defines a framework for describing what is in a message and how to process it; (2) a set of encoding rules for expressing instances of application-defined data types; and (3) a convention for representing remote procedure calls and responses.
  • a SOAP message is an XML document that consists of a mandatory SOAP envelope, an optional SOAP header, and a mandatory SOAP body. In this situation, it is possible to use a different mapping handler for the envelope and the body.
  • Table Ml 06-3 summarizes the main functions (i.e., not exhaustive) of the mapping interface 106- 3 (XML2xMapping). XML2xMapping executes the mapping and allows configuration of the InputStream.
  • executeQ Performs the mapping that will create the format from the input XML document 108.
  • a full example of executeQ is provided below. setlnputStreamQ Sets the input stream - i.e., specifies the source of the
  • Input XML document 108 that is to be mapped.
  • Table Ml 06-4 summarizes the main functions (i.e., not exhaustive) of the mapping class 106-4 (XML2xMappingImpl). As discussed above in relation to the definitions of class and interface, the XML2xMappingImpl class is not used directly, but is sub-classed with content added to appropriate methods depending on document type definitions for the input XML document 108 to be mapped from the output Java object 110 it is mapping to. TABLE Ml 06-4
  • EndElementf Receives notification of the end of an element.
  • the parser 104 will invoke this method at the end of every element in the input XML document 108.
  • There is a corresponding startElementQ event for every endElement - event even when the element is empty- executeO Performs the mapping that will create the format from the input XML document 108
  • setDocumentLocatorO Receives an object for locating the orgin of SAX document events.
  • setlnputStreamQ Sets the input stream. Specifies the source for the XML document that is to be mapped.
  • startElementQ Receives notification of the beginning of an element.
  • the parser 104 invokes this method at the beginning of every element in the input XML document 108. There is a corresponding endElementQ event for every startElementQ event - even when the element is empty- All of the element's content is reported, in order, before the corresponding endElementQ event.
  • a method 300 is illustrated showing the general steps that are performed to map the XML document 108 to the software object 110 (e.g., a Java Bean):
  • mapping interface 106-4 e.g., XML2XMapping
  • mapping interface 106-4 invokes the mapping interface 106-4 at step 304 and supply. the input XML document 108 at step 306;
  • mapping interface 106-4 obtains an instance of an event parser (e.g., the parser 104) at step 308 and registers the mapping interface 106-4 as a content handler (e.g., buffered content handler class 106-2) at step 310;
  • an event parser e.g., the parser 104
  • a content handler e.g., buffered content handler class 106-2
  • step (e) as step (d) is performed, call backs occur to the mapping interface 106-4 invoking various methods at step 314 (e.g., startDocument, startElement, characters, endElement, endDocument, etc.);
  • mapping interface 106-4 creates the software object 110 at step 316;
  • mapping interface 106-4 sets the element into the software object 110 at step 318.
  • the SAX API includes many specifications known in the art.
  • the present invention is concerned with creating a class that implements a "ContentHandler" interface, which is a callback interface used by XML parsers to notify a program of SAX events as they are found in the XML document.
  • the interface is used with the
  • the SAX API also provides a "DefaultHandler” implementation class for the "ContentHandler” interface.
  • customer java the output customer Java Bean 110; and
  • CustomerSymbols.java contains integer constants and a hashmap. The hashmap is used to map the names of tags to integer constants for use in XML2CustomerMapping.java.
  • a program (execute java), with reductions for conciseness, used to execute mapping from XML to Java (and from Java to XML as detailed in Example II below).
  • XML2CustomerMapping inMapping new XML2CustomerMapping ( )
  • Customer2XMLMapping outEventBasedMapping new Customer2XMLMapping ( ) ;
  • a customer Java Bean (customer .java) is detailed below.
  • a Java Bean is a reusable component that adheres to a standard design architecture known in the art.
  • a Bean is a class object that may or may not be visible at run time.
  • JavaBeans provide a component architecture, a standard framework for developing components.
  • mapping from XML to Java is efficient because the parser 104 processes events for all start, element and end tags, which improves tracking of the events.
  • CustID to populate the Customer object
  • endElement for Customer to insert the Customer object into the vector
  • endElement for Customers to create an array of Customers from the vector and set it into the Java object being working with.
  • a stack is maintained by the parser 104 for recursive XML structures (i.e., XML elements that represent lists of lists). For each startElement an object is created. The stack can be used to keep state as required. Once a child element is created it can be set into its parent object.
  • the OBJECT-XML mapping module 114 includes the following components:
  • a handler interface 114-1 (X2XMLHandler) for managing parsing events
  • mapping interface 114-2 (X2XMLMapping) for executing the mapping and setting an output target stream;
  • mapping class 114-3 (X2XMLMappingImpl) that provides methods for mapping from the input Java object 116 to the output XML document 118; and (d) an output target class 114-4 (X2XMLOutputTarget) to implement the output XML document 118.
  • Table Ml 14-1 summarizes the main functions (i.e., not exhaustive) of the handler interface 114-1 (X2XMLHandler).
  • the mapping module 114 implements the interface 114-1 and registers an instance with a JSP container.
  • the document template 112 malces call backs to the mapping module 114 for basic document related events like the start and end of elements and to get an element value.
  • getElementValueQ Returns the value of an element. This is used when working with simple types that are not scoped by start and end element tags.
  • EndElementQ Receives notification of the end of an element. This is used for maintaining state when working with a complex type.
  • getElementAttributeQ Returns the specified attribute's value. This is used when working with a complex type that is scoped by start and end element tags.
  • This is used in the XML document template (JSP) 112 for controlling whether name and value are generated for an optional attribute in the XML document 118. This is used when working with a complex type that is scoped by start and end element tabs.
  • startElementQ Receives notification of the beginning of an element.
  • a container is an entity that provides life cycle management, security, deployment and runtime services to components.
  • a servlet container is a container that provides network services over which requests and responses are sent, decodes requests, and formats responses.
  • a JSP container is a container that provides the same services as a servlet container and an engine that interprets and processes JSP pages into a servlet.
  • X2XMLHandler 114-1 provides a mirror (although not identical) image of parsing events to that produced by the parser 104. In effect, the structure provided by the parser 104 is mirrored in the path from X2XML.
  • the handler 106-2 When the parser 104 is implemented using SAX the events are received by the handler 106-2 (i.e., effectively a callback mechanism) that processes them.
  • the handler 106-2 is used to populate a Java class.
  • the handler 114-1 processes the callback by obtaining the requested data and maintaining the state of parsing.
  • handler interface 114-1 is similar in terms of the various functions performed by the XML-OBJECT mapping module 106 there are certain differences.
  • An element name is generated or hand coded, and is not taken from a schema with "namespace" support.
  • the element name can be made unique for each element. Therefore, only a name parameter is required on the startElement and endElement methods.
  • mapping is performed by the XML-OBJECT mapping module 106
  • the input source class 106-1 i.e., an XMLReader
  • the element name is paired with a unique number. This number is used in a switch statement to control the processing of the elements.
  • processing is optimized and coding assistance is improved by defining the element name as an integer constant. Therefore, callbacks to these methods use integer constants instead of strings.
  • the order of events in the handler interface 114-1 mirrors the order of information in the object 116 themselves.
  • the XML document template 112 (written using JavaServer Pages technology), uses the coding style detailed below. JSP technology separates the user interface from content generation enabling changing to the overall page layout without altering the underlying dynamic content. JavaServer Pages is an extension of the Java Servlet technology, which is well known to those skilled in the art.
  • XML document template 112 - JSP coding style example Callbacks are coded for the start and end tags of the document 118 and for complex types. This allows the handler 114-1 to maintain state.
  • the start and end tags are also coded directly so that they will be directed to the targeted output stream.
  • callbacks do not have to be coded, but start and end tags should still be coded so that they will be directed to the target output stream.
  • isOptionalElementPresent() is used in a conditional clause within the template 112 to control whether the optional element is generated.
  • isOptionalAttributePresent(int attributeName) is used in a complex type and a isOptionalAttributePresent(int elementName, int attributeName) in a simple type. If the element type is a repeating simple type then determine if it contains an optional attribute using a isOptionalAttributePresent(int index, int elementName, int attributeName) method.
  • getElementRepetitions method is used to return the number of repeating elements. This is used to construct a loop in the template 112 to process each element.
  • the template 112 should contain the start and end tags and call a getElementValue(int index, int elementName) to obtain the value.
  • the template 112 should invoke the startElement(int index, int elementName) and endElement(int index, int elementName) methods.
  • Table Ml 14-2 summarizes the main functions (i.e., not exhaustive) of the mapping interface 114- 2 (X2XMLMapping).
  • the mapping interface 114-2 executes the mapping function (between Java and XML) and establishes an output target stream.
  • the mapping interface 114-2 extends the handler interface 114-1, which provides the document template 112 call back methods necessary for generating the output XML document 118.
  • executeQ Performs the mapping that will create the output XML document 118.
  • setOutputStreamQ Sets the output stream to which the output XML document 118 will be generated.
  • Table Ml 14-3 summarizes the main fimctions (i.e., not exhaustive) of the mapping class 114-3 (X2XMLMappingImpl).
  • the mapping class 114-3 provides the methods for mapping from the input Java object 116 to the output XML document 118.
  • the X2XMLMappingImpl class 114-3 is not used directly, but is sub-classed with content added to appropriate methods depending on document type definitions for the output XML document 118 to be mapped to and the input Java object 116 it is mapping from.
  • executeQ Performs the mapping that will create the output XML document 118.
  • setOutputStreamQ Sets the output stream to which the output XML document 118 will be generated.
  • Table Ml 14-4 summarizes the main functions (i.e., not exhaustive) of the output target class 114-4 (X2XMLOutputTarget).
  • X2XMLOutputTarget class 114-4 allows the XML document 118 to be written to a byte stream or a character stream. Class 114-4 provides optimizations, such as allowing the byte stream to be targeted to the output stream of a servlet. Therefore, the XML document 118 is not buffered before being written out.
  • the X2XMLMappingImpl class 114-3 implements the X2XMLMapping interface 114-2.
  • the X2XMLMapping interface 114-2 extends the X2XMLHandler interface 114-1. Therefore, the X2XMLMappingImpl class 114-3 implements the methods defined in the X2XMLHandler interface 114-1.
  • a method 400 is illustrated showing the general steps that are performed to map the software object 116 (e.g., a Java Bean) to the XML document 118:
  • the software object 116 e.g., a Java Bean
  • mapping interface 114-2 e.g., X2XMLMapping
  • mapping interface 114-2 invokes the JSP container using the JSP XML template 112 that will create the XML document 118 at step 410;
  • JSP XML template 112 calls back to the mapping interface 114-2 to maintain state of processing and to add data to the output XML document 118 (data is retrieved from the software object 116;
  • the compiled JSP XML template 112 can optionally call, at step 418, an isOptionalElementPresent method or an isOptionalAttributePresent method to determine if certain portions of the XML document should be generated;
  • (k) the state of processing is maintained by a stack at step 422; this is useful when generating complex types within an XML document where an array occurs, recursion occurs or a complex type is contained within another complex type.
  • Mapping from Java to XML uses the XML document template 112, which is coded with similar standards imposed by the parser 104, which processes events (at least for complex objects). For example, for complex types, start and end tags must be coded (not required for primitive types).
  • An example II "JAVA-XML CUSTOMER" detailed below, generates an output customer XML document from a input customer java object.
  • a program (Custom.er2XMLMapping.java), with some reductions of conciseness, to construct the XML document from the input Java object.
  • the handler 114-1 determines the array size (i.e., how many loops are to be executed) and returns in the getElementRepitions method.
  • the handler 114-1 sets a reference to that particular customer object in the array.
  • the handler 114-1 uses a stack. As the object recurses, the handler 114-1 pushes onto the stack with a startElement, and pops with the endElement.
  • the working object is the object on top of the stack.
  • advantages of an exemplary embodiment of the present include: (a) providing a common framework for mapping from an XML document to a Java object and from a Java object to an XML document, wherein the framework uses a handler that masks how a property is obtained for mapping;

Abstract

Method and system that provides common framework for mapping between document (e.g. an XML document) and software object (e.g. a Java object). Framework uses handler that masks how property is obtained for mapping. Results in mapping code have a common appearance for both directions of mapping. Mapping between elements of XML document and properties of Java object is contained in mapper. Mapper maps from XML document (108) to object (110) using parser (104) (such as DOM or SAX). Mapping in other direction (Java to XML) requires that elements of XML document (118) be built in particular order to ensure validity of resulting XML document (118). Present invention builds XML template document using JSP for example. Using JSP based templates enables tags of document be written in the JSP with callbacks to get element and attribute values. Content can be directed to buffer, or directly to response stream of servlet.

Description

SYSTEM AND METHOD OF MAPPING BETWEEN SOFTWARE OBJECTS AND STRUCTURED LANGUAGE ELEMENT BASED DOCUMENTS
Field of the Invention
The present invention relates to the field of converting or mapping between a software object and a structured language element document, and in particular to mapping between various software objects such as Java™ objects and Extensible Markup Language (XML) documents.
Background of the Invention
Extensible Markup Language (XML) is a pared down version of Standard Generalized Markup Language (SGML) that is designed especially for Web documents. It enables designers to create their own customized tags to provide functionality not available with HTML. For example, XML supports links that point to multiple documents, as opposed to HTML links, which can reference just one destination each.
Because XML is a form of self-describing data (also termed structured language elements in the present description), it is used to encode rich data models. Therefore, XML is useful as a data exchange medium between dissimilar systems. Data can be exposed or published as XML from many kinds of systems: legacy COBOL programs, databases, C++ programs and the like. A business problem that is commonly encountered involves resolving how to map information from an XML document to other data formats and vice versa. For example, once information has been exchanged between entities in an XML document, it may be necessary to map its information into a Java object that can be used when making a database or transactional request.
U.S. Patent 6,125,391 issued September 26, 2000 to Meltzer et al. discloses an example of an XML/Java conversion tool. For converting from XML to Java, Meltzer et al. parse the XML document and raise events. In particular, a parser walks through an XML document and builds a tree representation in memory that can be queried and another parser walks an XML document and raises events with information about the document (e.g., start document event, start element vent with the name of the element, content of the element, end element event, end document event, etc.). For converting from Java to XML, Meltzer et al. generates code that contains accessors for each element. The accessor for an element contains a loop, looping for each character. The loop contains a switch statement that performs an action based on what the character is. The action is to build a StringBuffer containing the element fragment of the XML document. The Meltzer et al. solution does not provide supporting infrastructure for working with the code that transforms Java to XML. All the code in Meltzer et al. is generated and is not conducive for a user to edit.
Consequently, there is a need for a mapping framework to support mapping between software objects and structured language element based documents (e.g. XML) that can be efficiently implemented using standard tools.
Summary of the Invention
The disadvantages of the prior art summarized above are overcome according to an exemplary method and system of the present invention that provides a common framework for mapping between a document (e.g. an XML document) and a software object (e.g. a Java object). The framework uses a handler that masks how a property is obtained for mapping. This results in mapping code that has a common appearance for both directions of mapping. A mapping between elements of an XML document and the properties of a Java object is contained in a mapper. A mapper maps from the XML document to a software object through the use of a parser (such as Document Object Model (DOM) or Simple Application Programming Interface (API) for XML (SAX)).
Mapping in the other direction (Java to XML) requires that the elements of the XML document be built in a particular order to ensure validity of the resulting XML document. To ensure this validity, an exemplary embodiment of the present invention builds an XML template document using JavaServer Pages™ (JSP), for example. Using JSP based templates enables tags of the document to be written in the JSP, with callbacks to get element and attribute values. JSP is well documented with editor support to permit efficient template creation. Further, content can be directed to a buffer, or directly to a response stream of a servlet. In accordance with one aspect of the present invention there is provided a computer-implemented method for converting a data structure representing a software object to structured language elements of a document, the method comprising: (a) generating a structured language element template document; (b) reading properties from the software object, the properties being associated with the structured language elements of the document; (c) using the properties, obtaining constructs defined by the structured language elements based on the association between the properties and the structured language elements; and (d) populating the structured language element template document with the constructs.
In accordance with another aspect of the present invention there is provided a computer- implemented method for converting structured language elements of a document to a data structure representing a software object, the method comprising: (a) reading each of the structured language elements of the document; (b) determining a property, selected from a set of available properties defined by the data structure of the software object, associated with structured language elements of the document; and (c) populating the properties of the data structure representing the software object with structured language element values from the document.
In accordance with another aspect of the present invention there is provided a system for converting a software object containing properties to a document defined by structured language elements, the system comprising: (a) a document template; (b) a handler interface for providing a representation of the structured language elements of the document based on call backs made by the document template; (c) a mapping module, in communication with the handler interface, for converting properties of the software objects to structured language elements recognized by the document; and (d) an output target class, in communication with the mapping module, for writing the structured language elements generated in step (c) to the document.
In accordance with another aspect of the present invention there is provided a system for converting a document containing structured language elements to a software object, the system comprising: (a) a parser for obtaining events representative of features of the document; (b) an input source class for reading the document; (c) a content handler class, in communication with the input source class, for implementing a buffer for the events obtained by the parser; and (d) a mapping module, in communication with the content handler class, for converting the events obtained by the parser to properties for the software object. In accordance with another aspect of the present invention there is provided a method of converting a software object having properties to a document represented by structured language elements, the method comprising: (a) supplying the software object to an instance of an invoked mapping interface; (b) compiling and executing a template using an instance of an invoked container; and (c) writing the document to a specified output stream using the compiled template.
In accordance with another aspect of the present invention there is provided a method of converting a document containing structured language elements to a software object, the method comprising: (a) supplying the document to an instance of an invoked mapping interface; (b) registering the mapping interface as a content handler; (c) parsing the document using an instance of an invoked parser; and (d) populating the software object with properties associated with structured language elements parsed from the document through call backs made to the mapping interface.
In accordance with another aspect of the present invention there is provided a computer program product for converting a data structure representing a software object to structured language elements of a document, the computer program product comprising computer readable program code devices for: (a) generating a structured language element template document; (b) reading properties from the software object, the properties being associated with the structured language elements of the document; (c) using the properties, obtaining constructs defined by the structured language elements based on the association between the properties and the structured language elements; and (d) populating the structured language element template document with the constructs.
In accordance with another aspect of the present invention there is provided a computer program product for converting structured language elements of a document to a data structure representing a software object, the computer program product comprising computer readable program code devices for: (a) reading each of the structured language elements of the document; (b) determining a property, selected from a set of available properties defined by the data structure of the software object, associated with structured language elements of the document; and (c) populating the properties of the data structure representing the software object with structured language element values from the document.
Other aspects and features of the present invention will become apparent to those ordinarily skilled in the art upon review of the following description of specific embodiments of the invention in conjunction with the accompanying figures.
Brief Description of the Drawings
Further features and advantages of the present invention will be described in the detailed description, taken in combination with the appended drawings, in which:
Fig. 1 is a block diagram of a computer system that may be used to implement a method and apparatus for embodying the invention;
Fig. 2 is a block diagram illustration the framework for mapping between XML and Java objects and vice versa;
Fig. 3 is a flow chart illustrating a method of mapping an XML document to a software object using the framework of Fig. 2; and
Fig. 4 is a flow chart illustrating a method of mapping a software object to an XML document using the framework of Fig. 2.
Detailed Description of Embodiments of the Present Invention Fig. 1 and the associated description represent an example of a suitable computing environment in which the invention may be implemented. While the invention will be described in the general context of computer-executable instructions of a computer program that runs on a personal computer, the invention can also be implemented in combination with other program modules.
Generally, program modules include routines, programs, components, data structures and the like that perform particular tasks or implement particular abstract data types. Further, the present invention can also be implemented using other computer system configurations, including hand- held devices, multiprocessor systems, microprocessor-based or programmable consumer electronics, minicomputers, mainframe computers and the like. The invention can also be practiced in distributed computing environments where tasks are performed by remote processing devices that are linked through a communications network. In a distributed computing environment, program modules may be located in both local and remote memory storage devices.
With reference to Fig. 1, an exemplary system 10 includes a conventional personal computer 20, including a processing unit 22, a system memory 24, and a system bus 26 that couples various system components including the system memory 24 to the processing unit 22. The system bus 26 includes several types of bus structures including a memory bus or memory controller, a peripheral bus, and a local bus using any of a variety of conventional bus architectures (e.g., PCI, VESA, ISA, EISA etc.)
The system memory 24 includes read only memory (ROM) 28 and random access memory (RAM) 30. A basic input/output system (BIOS) 32, containing the basic routines that help to transfer information between elements within the computer 20, such as during start-up, is stored in the ROM 28. The computer 20 also includes a hard disk drive 34, magnetic disk drive 36 (to read from and write to a removable disk 38), and an optical disk drive 40 (for reading a CD- ROM disk 42 or to read from or write to other optical media). The drives 34, 36 and 40 are connected to the system bus 26 by interfaces 44, 46 and 48, respectively.
The drives 34, 36 and 40 and their associated computer-readable media (38, 42) provide nonvolatile storage of data, data structures, and computer-executable instructions for the computer 20. The storage media of Fig. 1 are merely examples and it is known by those skilled in the art to include other types of media that are readable by a computer (e.g., magnetic cassettes, flash memory cards, digital video disks, etc.).
A number of program modules may be stored in the drives 34, 36 and 40 and the RAM 30, including an operating system 50, one or more application programs 52, other program modules 54 and program data 56. A user may enter commands and information into the computer 20 through a keyboard 58 and an input device 60 (e.g., mouse, microphone, joystick, game pad, satellite dish, scanner etc.) These devices (58 and 60) are connected to the processing unit 22 through a port interface 62 (e.g., serial port, parallel port, game port, universal serial bus (USB) etc.) that is coupled to the bus 26. A monitor 64 or other type of display device is also connected to the bus 26 through an interface 66 (e.g., video adapter). The computer 20 may operate in a networked environment using logical connections to one or more remote computers, such as remote computer 68. The remote computer 68 may be a server, a router, a peer device or other common network node, and typically includes many or all of the elements described in relation to the computer 20, although for simplicity only a memory storage device 70 is shown. The logical connections shown in Fig. 1 include a local area network (LAN) 72 and a wide area network (WAN) 74. Such networking environments are commonly used in offices, enterprise-wide computer networks, intranets and the Internet.
When used in a LAN networking environment, the computer 20 is connected to the LAN 72 through a network interface or adapter 76. When used in the WAN networking environment, the computer 20 typically includes a modem 78 or other means for establishing communications over the WAN 74, such as the Internet. The modem 54, which may be internal or external, is connected to the bus 26 through the port interface 62. In a networked environment, program modules depicted relative to the computer 20, or portions thereof, may be stored in the remote memory storage device 70.
Discussion of the method of the present invention is based in terms of conversion/mapping from XML to Java objects and from Java objects to XML. Other data formats are also supported. For example, many legacy business applications are written in COBOL, C and PL1. These applications are composed of programs that reside in Enterprise Information Systems (EIS) such as CICS™ (general purpose online transaction processing software) or IMS™ (Information Management System). A COBOL program uses COBOL structures for their input and output. There is a need to map from XML to COBOL and from COBOL to XML. The present invention can be used to perform these maps, where a XML-to-object X mapping handler (discussed below) would populate a COBOL structure from the XML document and an object-X-to-XML mapping handler (discussed below) would extract the data from a COBOL structure and be used by a template to populate the XML document.
By way of background, the mapping methods of the present invention utilize the following high level process: (a) a lexer groups characters into words or tokens that are recognized by a particular system (termed tokenizing); (b) a parser analyses groups of tokens in order to recognize legal language constructs; and (c) a code generator takes a set of legal language constructs and generates executable code. The functions defined by (a)-(c) can be intermixed. For example, for XML to Java object mapping, every character in a XML document is analyzed in order to recognize legal XML tokens such as start tags, properties, end tags and "CD ATA" sections. Then, the tokens must be verified that they form legal XML constructs. At a most basic level, it is verified that all of the tagging has matching opening and closing tags and the properties are properly structured in the opening tag. If Document Type Definitions (DTD) or XML schema are available, then it is possible to ensure that the XML constructs found during parsing are legal in terms of the DTD or XML schema as well as being well-formed XML. Finally, the data contained in the XML document is used to accomplish something useful (i.e. map it into a Java object).
Some of the tasks identified above can be performed, at least in-part, by readily available XML parsers. XML parsers handle the lexical analysis and parsing tasks. Two example parsing standards are the SAX and DOM APIs (SAX - Simple Application Programming Interface (API) for XML; DOM - Document Object Model).
SAX is event-based. XML parsers that implement SAX generate events that correspond to different features found in the parsed XML document. The DOM API is an object-model-based API. XML parsers that implement DOM create a generic object model in memory that represents the contents of the XML document. Once the XML parser has completed parsing, the memory contains a tree of DOM objects that offers information about both the structure and contents of the XML document.
Fig. 2 illustrates a schematic representation of a framework 100 according to an embodiment of the present invention. The framework 100 is shown instantiated in an integration component 102 such as a Servlet that can be executed in the system 10 of Fig. 1. The integration component 102 includes a parser 104 implemented using DOM or SAX, for example, that interacts with an XML-OBJECT mapping module 106. For clarity, SAX will be discussed as an example of the parser 104 in describing the implementation embodiments of the present invention.
The XML-OBJECT mapping module 106 receives an input XML document 108 and generates an output Java object 110. The integration component 102 further includes an XML document template module 112 (e.g. based on JavaServer Pages™ - JSP technology) that communicates with an OBJECT-XML mapping module 114. The OBJECT-XML mapping module 114 receives an input Java object 116 and generates an output XML document 118.
XML TO SOFTWARE OBJECT MAPPING
With reference to Fig. 2, the XML-OBJECT mapping module 106 includes the following components:
(a) an input source class 106-1 (XML2xInputSource) for implementing the input XML document 108;
(b) a buffered content handler class 106-2 (XML2xBufferedContentHandler) for implementing a buffer for SAX events generated by the parser 104;
(c) a mapping interface 106-3 (XML2xMapping) for executing the mapping and for setting input an output target streams; and
(d) a mapping class 106-4 (XML2xMappingImpl) that provides methods for mapping from the input XML document 108 to the output Java object 110.
Further details of the various interfaces and classes are discussed below. The terms "class" and "interface" have specific meanings in Java. A Java class (abstract, inner or final) is a collection of data members and methods that define a particular object and a Java interface is used to impose certain functionality on a class that implement them (i.e. interfaces specify what classes must do). Interfaces are also used to provide constants that can be used by the classes that implement the interface. Interfaces contain constant variables and method declarations, but the implementation of the methods is left to the classes that implement the interface. A class can implement any number of interfaces.
Table M106-1 summarizes the main functions (i.e., not exhaustive) of the input source class 106- 1 (XML2xInputSource).
XML2xInputSource is used so that an XML document can be read from a byte stream, a character stream or the XML2xBufferedContentHandler 106-2. TABLE Ml 06-1
FUNCTION DESCRIPTION availableO returns the number of bytes that can be read from an input stream without blocking- getBufferedHandler 0 Gets the SAX event buffered handler. getBvteStream 0 Returns a byte stream getCharacterStream 0 Returns a character stream reader- read 0 Reads the next byte of data from this input stream- skip 0 Skips bytes of input from this input stream.
Table M106-2 summarizes the main functions (i.e., not exhaustive) of the buffered content handler class 106-2 (XML2xBufferedContentHandler). The handler class 106-2 also includes a content handler to buffer SAX events from the parser 104. This allows events to be replayed. An example where this feature is useful is where different mapping handlers are used for different portions of an XML document. An implementation example is the Simple Object Access Protocol (SOAP).
TABLE Ml 06-2
FUNCTION DESCRIPTION
characters (charf] ch, int start, int length); Method comment where ch are characters from the XML document 108; start is the start position in the array; length is the number of characers to read from the array parse 0 Executes SAX events in the buffer SOAP is a lightweight protocol for exchange of information in a decentralized, distributed environment. It is an XML based protocol that consists of three parts: (1) an envelope that defines a framework for describing what is in a message and how to process it; (2) a set of encoding rules for expressing instances of application-defined data types; and (3) a convention for representing remote procedure calls and responses. A SOAP message is an XML document that consists of a mandatory SOAP envelope, an optional SOAP header, and a mandatory SOAP body. In this situation, it is possible to use a different mapping handler for the envelope and the body.
Table Ml 06-3 summarizes the main functions (i.e., not exhaustive) of the mapping interface 106- 3 (XML2xMapping). XML2xMapping executes the mapping and allows configuration of the InputStream.
TABLE Ml 06-3
FUNCTIONS DESCRIPTION executeQ Performs the mapping that will create the format from the input XML document 108. A full example of executeQ is provided below. setlnputStreamQ Sets the input stream - i.e., specifies the source of the
Input XML document 108 that is to be mapped.
Table Ml 06-4 summarizes the main functions (i.e., not exhaustive) of the mapping class 106-4 (XML2xMappingImpl). As discussed above in relation to the definitions of class and interface, the XML2xMappingImpl class is not used directly, but is sub-classed with content added to appropriate methods depending on document type definitions for the input XML document 108 to be mapped from the output Java object 110 it is mapping to. TABLE Ml 06-4
FUNCTION DESCRIPTION
EndElementf) Receives notification of the end of an element. The parser 104 will invoke this method at the end of every element in the input XML document 108. There is a corresponding startElementQ event for every endElement - event even when the element is empty- executeO Performs the mapping that will create the format from the input XML document 108 setDocumentLocatorO Receives an object for locating the orgin of SAX document events. setlnputStreamQ Sets the input stream. Specifies the source for the XML document that is to be mapped. startElementQ Receives notification of the beginning of an element.
The parser 104 invokes this method at the beginning of every element in the input XML document 108. There is a corresponding endElementQ event for every startElementQ event - even when the element is empty- All of the element's content is reported, in order, before the corresponding endElementQ event.
With reference to Fig. 3, a method 300 is illustrated showing the general steps that are performed to map the XML document 108 to the software object 110 (e.g., a Java Bean):
(a) obtain an instance of the mapping interface 106-4 (e.g., XML2XMapping) for implementing the mapping from XML to object X at step 302;
(b) invoke the mapping interface 106-4 at step 304 and supply. the input XML document 108 at step 306; (c) the mapping interface 106-4 obtains an instance of an event parser (e.g., the parser 104) at step 308 and registers the mapping interface 106-4 as a content handler (e.g., buffered content handler class 106-2) at step 310;
(d) invoke the parser 104 on the XML document 108 (i.e., begin parsing the document) at step 312;
(e) as step (d) is performed, call backs occur to the mapping interface 106-4 invoking various methods at step 314 (e.g., startDocument, startElement, characters, endElement, endDocument, etc.);
(f) in the startDocument and/or startElement methods the mapping interface 106-4 creates the software object 110 at step 316; and
(g) in the endElement method the mapping interface 106-4 sets the element into the software object 110 at step 318.
The SAX API, discussed above, includes many specifications known in the art. The present invention is concerned with creating a class that implements a "ContentHandler" interface, which is a callback interface used by XML parsers to notify a program of SAX events as they are found in the XML document. The interface is used with the
XML2xBufferedContentHandler class 106-2 and the XML2xInputSource class 106-1. The SAX API also provides a "DefaultHandler" implementation class for the "ContentHandler" interface. An example I "XML- JAVA CUSTOMER", detailed below, extends the "DefaultHandler" to generate a customer Java Bean from a customer XML document.
EXAMPLE I XML- JAVA CUSTOMER
The following components (detailed below) are part of example I: (A) customer.xml: the input XML document 108 sample;
(B) XML2Custom.erMapping.java: the handler class 106-2 that the parser 104 calls back to. It contains the instructions to construct the customer object and establish its values;
(C) execute .java: the program of the mapping class/interface 106-3, 106-4 used to execute mapping from XML to Java and from Java to XML (for Example II below);
(D) customer java: the output customer Java Bean 110; and (E) CustomerSymbols.java: contains integer constants and a hashmap. The hashmap is used to map the names of tags to integer constants for use in XML2CustomerMapping.java.
A. Input XML document (customer.xml) is provided below.
//START customer.xml <?xml version=" 1 . 0" ?> <customer>
<FirstName>Jane</FirstName>
<LastName>Doe</LastName>
<CustId>xyz . 123</Custld> </customer> //END customer.xml
B. A program (XML2CustomerMapping.java), with some reductions for conciseness, to construct the customer object and to set values into it (i.e. a handler that the event parser calls back to) is provided below.
//START XML2CustomerMapping.java public class XML2CustomerMapping extends com. xxx . xml2xmapping. XML2xMappingIm.pl { private StringBuffer fieldCurrentQualifiedElementName = new StringBuffer ("") ; private Customer fieldCustomer; private Stack elementStack;
* XMLCustomerlnfo2RecordCustomerInfoMapper constructor comment . public XML2CustomerMapping ( ) { super ( ) ; elementStack = new Stack ();
}
* characters method comment. public void characters (char [ ] ch, int start, int length) throws org.xml. sax. SAXException { switch (this. fieldCurrentElementSymbol) { case CustomerSymbols . CUSTOMER_FIRSTNAME : case CustomerSymbols . CUSTOMER_LASTNAME : case CustomerSymbols. CUSTOMER_ID:
( (StringBuffer) elementStack. lastElement ( ) ) . append (ch, start, leng th ) ; break; }
}
* endElement method comment . public void endElement (String namespaceURI, String localName, String rawName) throws org. xml . sax. SAXException { String symbolName; if (namespaceURI . equals ("") ) symbolName = rawName; else symbolName = namespaceURI + "_" + localName; this . fieldCurrentElementSymbol = CustomerSymbols . getSymbol (symbolName) ; // Get the value String value = ( (StringBuffer) elementStack. pop ( ) ) . toStringO ; switch (this . fieldCurrentElementSymbol) { case CustomerSymbols. CUSTOMER_FIRSTNAME: { this . fieldCustomer . setFirstName (value) ; break;
} case CustomerSymbols. CUSTOMER_LASTNAME: { this . fieldCustomer . setLastName (value) ; break; } case CustomerSymbols. CUSTOMER_ID: { this . fieldCustomer . setld (value) ; break; } } this . fieldCurrentElementSymbol = 0; } * Θreturn com. xxx. connector .mapping. ml . test . Customer public Customer getCustomer ( ) { return this . fieldCustomer;
}
* startElement method comment. public void startElement (String namespaceURI, String localName, String rawName, org. xml . sax.Attributes atts) throws org. xml . sax. SAXException { String symbolName; if (namespaceURI . equals ("") ) symbolName = rawName; else symbolName = namespaceURI + "_" + localName; this . fieldCurrentElementSymbol = CustomerSymbols . getSymbol (symbolName) ; elementStack. pus (new StringBuffer ( ) ) ; switch (this . fieldCurrentElementSymbol) { case CustomerSymbols. CUSTOMER: { this . f ieldCustomer = new Customer ( ) ; break; } } } } //END XML2CustomerMapping.java
C. A program (execute java), with reductions for conciseness, used to execute mapping from XML to Java (and from Java to XML as detailed in Example II below).
//START execute.java package com. xxx. xml2xmapping. sample . customer; import java.io.*; import org. xml . sax. *; public class Execute {
* Execute constructor comment, public Execute ( ) { super ( ) ; } * Starts the application.
* Θparam args an array of command-line arguments public static void main (java . lang. String [ ] args) { int numlterations = 1;
XML2CustomerMapping inMapping = new XML2CustomerMapping ( ) ; Customer2XMLMapping outEventBasedMapping = new Customer2XMLMapping ( ) ;
// Create the XML2Customer handler and the Customer2XML handler XML2CustomerMapping in Mapping = new XML2CustomerMapping ( ) ; Customer2XMLMapping outE entBasedMapping=new Customer2XMLMapping ( ) ; // read in the customer.xml file
ByteArraylnputStream inStream = null; try {
FilelnputStream filelnputStream = new FileInputStream( "customer. xml") ; byte[] bytes = new byte [filelnputStream. available ()] ; filelnputStream. read (bytes, 0, filelnputStream. available ( ) ) ; inStream = new ByteArraylnputStream (bytes) ; } catch (Exception e) { e . printStackTrace ( ) ; }
ByteArrayOutputStream outStream = new ByteArrayOutputStream( ) ; try { long ts = System. currentTimeMillis () ; for (int i=0; i<numIterations; i++) { // inbound mapping
// map from XML document to customer Java Bean inStream. reset ( ) ; inMapping. setInputStream (inStream) ; inMapping . execute ( ) ;
// some execution, here a connector would be called // get the customer object and print its contents Customer aCustomer = inMapping. getCustomer () ; System. out . println ( "First name from XML document is "+aCustomer . getFirstName ( ) ) ;
System. out .println ("Last name from XML document is "+aCustomer . getLastName ( ) ) ;
System. out .println ("Customer id from XML document is "+aCustomer . getl ( ) ) ;
// Change the values on the customer object aCustomer . setFirstName ("James") ; aCustomer . setLastName ( "Bond" ) ; aCustomer. setld( "007") ;
// outbound mapping
// map from Java to XML outEventBasedMapping. setCustomer (aCustomer) ;
//outEventBasedMapping. setOutputStream (outStream) ; outEventBasedMapping. setOutputStream (System. out) ; outEventBasedMapping . execute ( ) ;
} long te = System. currentTimeMillis () ;
System. out .println ( "Average time "+(te- ts) /numIterations+"ms . ") ;
} catch (Exception e) { e . printStackTrace ( ) ;
} } } //END execute .java
D. A customer Java Bean (customer .java) is detailed below. A Java Bean is a reusable component that adheres to a standard design architecture known in the art. A Bean is a class object that may or may not be visible at run time. JavaBeans provide a component architecture, a standard framework for developing components.
//START customer.java package com . xxx . xml2xmapping . sample . customer ; public class Customer { private J ava . lang . String f ieldFirstName = new String ( ) ; private java. lang. String fieldLastName = new String (); private java. lang. String fieldld = new String ();
* Customer constructor comment, public Customer () { super ( ) ; }
* Gets the firstName property (java . lang. String) value.
* Θreturn The firstName property value.
* @see #setFirstName public java. lang. String getFirstName ( ) { return fieldFirstName; }
* Gets the id property (java. lang. String) value.
* Θreturn The id property value.
* @see #setld public java. lang. String getld() { return fieldld; }
* Gets the lastName property (java. lang. String) value.
* Θreturn The lastName property value.
* @see #setLastName public java. lang. String getLastName ( ) { return fieldLastName; }
* Sets the firstName property (java . lang. String) value.
* Θparam firstName The new value for the property.
* Θsee #getFirstName public void setFirstName (java. lang. String firstName) { fieldFirstName = firstName;
}
* Sets the id property (java . lang. String) value.
* Θparam id The new value for the property.
* Θsee #getld public void setld (java. lang. String id) { fieldld = id;
} /** * Sets the lastName property (java. lang. String) value.
* Θparam lastName The new value for the property.
* Θsee #getLastName public void setLastName ( j ava . lang . String lastName ) { f ieldLastName = lastName ; } } //END customer .java
As shown in Example I, mapping from XML to Java is efficient because the parser 104 processes events for all start, element and end tags, which improves tracking of the events.
As a further example, consider expanding the single customer XML document to an array of customers. To generate an array of customer java beans follow this procedure:
(i) use the startElement for Customers to create a vector;
(ii) in the startElement for each Customer create a Customer object; and
(iii) use the startElement, getElement, endElement events for FirstName, LastName, and
CustID to populate the Customer object, endElement for Customer to insert the Customer object into the vector, and endElement for Customers to create an array of Customers from the vector and set it into the Java object being working with.
A stack is maintained by the parser 104 for recursive XML structures (i.e., XML elements that represent lists of lists). For each startElement an object is created. The stack can be used to keep state as required. Once a child element is created it can be set into its parent object.
SOFTWARE OBJECT TO XML MAPPING
With reference to Fig. 2, the OBJECT-XML mapping module 114 includes the following components:
(a) a handler interface 114-1 (X2XMLHandler) for managing parsing events;
(b) a mapping interface 114-2 (X2XMLMapping) for executing the mapping and setting an output target stream;
(c) a mapping class 114-3 (X2XMLMappingImpl) that provides methods for mapping from the input Java object 116 to the output XML document 118; and (d) an output target class 114-4 (X2XMLOutputTarget) to implement the output XML document 118.
Table Ml 14-1 summarizes the main functions (i.e., not exhaustive) of the handler interface 114-1 (X2XMLHandler). The mapping module 114 implements the interface 114-1 and registers an instance with a JSP container. The document template 112 malces call backs to the mapping module 114 for basic document related events like the start and end of elements and to get an element value.
TABLE Ml 14-1
FUNCTION DESCRIPTION
getElementValueQ Returns the value of an element. This is used when working with simple types that are not scoped by start and end element tags. endElementQ Receives notification of the end of an element. This is used for maintaining state when working with a complex type. getElementAttributeQ Returns the specified attribute's value. This is used when working with a complex type that is scoped by start and end element tags. getElementRepetitionsQ For a repeating element, his returns the number of repetitions. isOptionalAttributePresentQ Returns true if the optional attribute is present. otherwise returns false. This is used in the XML document template (JSP) 112 for controlling whether name and value are generated for an optional attribute in the XML document 118. This is used when working with a complex type that is scoped by start and end element tabs. startElementQ Receives notification of the beginning of an element.
This is used for maintaining state when working with complex types. In general, a container is an entity that provides life cycle management, security, deployment and runtime services to components. There are many specific types of containers (Web, JSP, servlet, applet etc.) that provide component-specific services. A servlet container is a container that provides network services over which requests and responses are sent, decodes requests, and formats responses. A JSP container is a container that provides the same services as a servlet container and an engine that interprets and processes JSP pages into a servlet.
X2XMLHandler 114-1 provides a mirror (although not identical) image of parsing events to that produced by the parser 104. In effect, the structure provided by the parser 104 is mirrored in the path from X2XML.
When the parser 104 is implemented using SAX the events are received by the handler 106-2 (i.e., effectively a callback mechanism) that processes them. In this example, the handler 106-2 is used to populate a Java class.
When the template 112 is invoked, it calls back to the X2XMLHandler interface 114-1. The handler 114-1 processes the callback by obtaining the requested data and maintaining the state of parsing.
While the handler interface 114-1 is similar in terms of the various functions performed by the XML-OBJECT mapping module 106 there are certain differences. An element name is generated or hand coded, and is not taken from a schema with "namespace" support. The element name can be made unique for each element. Therefore, only a name parameter is required on the startElement and endElement methods.
When mapping is performed by the XML-OBJECT mapping module 106, the input source class 106-1 (i.e., an XMLReader) returns the name of the element as a string. In the mapping class/interface 106-3, 106-4 the element name is paired with a unique number. This number is used in a switch statement to control the processing of the elements. In the OBJECT-XML module 114, processing is optimized and coding assistance is improved by defining the element name as an integer constant. Therefore, callbacks to these methods use integer constants instead of strings.
The order of events in the handler interface 114-1 mirrors the order of information in the object 116 themselves.
The XML document template 112 (written using JavaServer Pages technology), uses the coding style detailed below. JSP technology separates the user interface from content generation enabling changing to the overall page layout without altering the underlying dynamic content. JavaServer Pages is an extension of the Java Servlet technology, which is well known to those skilled in the art.
XML document template 112 - JSP coding style example Callbacks are coded for the start and end tags of the document 118 and for complex types. This allows the handler 114-1 to maintain state. In the JSP XML document template 112, the start and end tags are also coded directly so that they will be directed to the targeted output stream. When working with a simple type, callbacks do not have to be coded, but start and end tags should still be coded so that they will be directed to the target output stream.
If a complex or simple type is optional then isOptionalElementPresent() is used in a conditional clause within the template 112 to control whether the optional element is generated.
If an attribute is optional then isOptionalAttributePresent(int attributeName) is used in a complex type and a isOptionalAttributePresent(int elementName, int attributeName) in a simple type. If the element type is a repeating simple type then determine if it contains an optional attribute using a isOptionalAttributePresent(int index, int elementName, int attributeName) method.
For repeating elements, getElementRepetitions method is used to return the number of repeating elements. This is used to construct a loop in the template 112 to process each element. For simple types, the template 112 should contain the start and end tags and call a getElementValue(int index, int elementName) to obtain the value. For complex types, since state must be maintained the template 112 should invoke the startElement(int index, int elementName) and endElement(int index, int elementName) methods.
Table Ml 14-2 summarizes the main functions (i.e., not exhaustive) of the mapping interface 114- 2 (X2XMLMapping). The mapping interface 114-2 executes the mapping function (between Java and XML) and establishes an output target stream. The mapping interface 114-2 extends the handler interface 114-1, which provides the document template 112 call back methods necessary for generating the output XML document 118.
TABLE Ml 14-2
FUNCTION DESCRIPTION
executeQ Performs the mapping that will create the output XML document 118.
setOutputStreamQ Sets the output stream to which the output XML document 118 will be generated.
Table Ml 14-3 summarizes the main fimctions (i.e., not exhaustive) of the mapping class 114-3 (X2XMLMappingImpl). The mapping class 114-3 provides the methods for mapping from the input Java object 116 to the output XML document 118. As discussed above in relation to the definitions of class and interface, the X2XMLMappingImpl class 114-3 is not used directly, but is sub-classed with content added to appropriate methods depending on document type definitions for the output XML document 118 to be mapped to and the input Java object 116 it is mapping from. TABLE Ml 14-3
FUNCTION DESCRIPTION
executeQ Performs the mapping that will create the output XML document 118.
setOutputStreamQ Sets the output stream to which the output XML document 118 will be generated.
Table Ml 14-4 summarizes the main functions (i.e., not exhaustive) of the output target class 114-4 (X2XMLOutputTarget).
X2XMLOutputTarget class 114-4 allows the XML document 118 to be written to a byte stream or a character stream. Class 114-4 provides optimizations, such as allowing the byte stream to be targeted to the output stream of a servlet. Therefore, the XML document 118 is not buffered before being written out.
TABLE Ml 14-4
FUNCTION DESCRIPTION
closeQ Closes output stream and releases any system resources associated with the stream. flushQ Flushes output stream and forces any buffered output bytes to be written out writeQ Writes bytes from a specified byte array to the output stream In summary, the X2XMLMappingImpl class 114-3 implements the X2XMLMapping interface 114-2. The X2XMLMapping interface 114-2 extends the X2XMLHandler interface 114-1. Therefore, the X2XMLMappingImpl class 114-3 implements the methods defined in the X2XMLHandler interface 114-1.
With reference to Fig. A, a method 400 is illustrated showing the general steps that are performed to map the software object 116 (e.g., a Java Bean) to the XML document 118:
(a) obtain an instance of the mapping interface 114-2 (e.g., X2XMLMapping) for implementing the mapping from input object X 116 to the output XML document 118 at step 402;
(b) set the software object 116 and an output stream for the XML document 118 in the mapping interface 114-3 at step 404;
(c) invoke the mapping interface 114-2 at step 406;
(d) create a JSP container at step 408;
(e) the mapping interface 114-2 invokes the JSP container using the JSP XML template 112 that will create the XML document 118 at step 410;
(f) the JSP container compiles and executes the JSP XML template 112 at step 412;
(g) the compiled JSP XML template 112 starts writing, at step 414, the XML document 118 to the specified output stream (from step 404);
(h) when appropriate for element/attribute data and for start/end tags, at step 416, the compiled
JSP XML template 112 calls back to the mapping interface 114-2 to maintain state of processing and to add data to the output XML document 118 (data is retrieved from the software object 116;
(i) the compiled JSP XML template 112 can optionally call, at step 418, an isOptionalElementPresent method or an isOptionalAttributePresent method to determine if certain portions of the XML document should be generated;
(j) the JSP XML template 112 calls back to a getElementRepetitions method to determine how many times it should loop over generation of certain portions of the XML document at step
420; and
(k) the state of processing is maintained by a stack at step 422; this is useful when generating complex types within an XML document where an array occurs, recursion occurs or a complex type is contained within another complex type. Mapping from Java to XML uses the XML document template 112, which is coded with similar standards imposed by the parser 104, which processes events (at least for complex objects). For example, for complex types, start and end tags must be coded (not required for primitive types). An example II "JAVA-XML CUSTOMER", detailed below, generates an output customer XML document from a input customer java object.
EXAMPLE II JAVA-XML CUSTOMER
The following components (detailed below) are part of example II:
(A) Customer2XMLMapping.java: the handler class 114-1 that the JSP 112 calls to obtain values from the input customer Java object 116 to populate the output XML document 118;
(B) customer .jsp: the JSP template 112 used to generate the output XML document 118;
(C) CustomerSymbols.java: contains constants and a hashmap. The hashmap is used to map the names of the tags to integer constants. The JSP template 112 uses the integer constants; and
(D) execute.java: the program of the mapping class/interface 114-2, 114-3 used to execute mapping from Java to XML and from XML to Java (as provided above as item C for Example I)-
A. A program (Custom.er2XMLMapping.java), with some reductions of conciseness, to construct the XML document from the input Java object.
//START Customer2XMLMapping.java package com . xxx . xml2xmapping . sample . customer ; import j ava . util . * ; import com . ibm . ml2xmapping . util . * ; public class Customer2XMLMapping extends com. xx . xml2xmapping . X2XMLMappingImpl { private Customer f ieldCustomer;
* Customer2XMLMapping constructor comment .
* / public Customer2XMLMapping ( ) { super ( ) ; fieldPageName="customer . j sp" ;
} /**
* getElementRepetitions method comment.
*/ public int getElementRepetitions (int name) { switch (name) {
} return 0;
} **
* getElementValue method comment.
*/ public String getElementValue (int name) { switch (name) { case CustomerSymbols. CUSTOMER_FIRSTNAME: { return this . fieldCustomer . getFirstName ( ) ;
} case CustomerSymbols. CUSTOMER_LASTNAME: { return this . fieldCustomer . getLastName ( ) ;
} case CustomerSymbols. CUSTOMER_ID: { return this . fieldCustomer . getld ( ) ; } } return ""; }
* getElementValue method comment. public String getElementValue (int index, int name) { switch (name) { }
return "";
}
* Θparam aCustomer com. xxx. xml2xmapping. sample . customer. Customer public void setCustomer (Customer aCustomer) { this . f ieldCustomer = aCustomer; } } //END Customer2XMLmapping.java
B. A document template (Customer .jsp), with some reductions for conciseness, in JSP for module 112.
// START Customer.jsp
<%Θ page import="com . ibm . ml2xmapping . * " %>
<%Θ page import="com . ibm . xml.2xmapping . sample . customer . CustomerSymbols "
% >
<%X2XMLHandler handler =
(X2XMLHandler) request . getAttribute ( "com. ibm. xml2xmapping. X2XMLH andler" ) ; handler. set riter (out) ; %>
<?xml version="1.0"?>
<customer>
<FirstNameX%=handler. getElementValue (CustomerSymbols. CUSTOMER^
FI RSTNAME) %></FirstName>
<LastNameX%=handler. getElementValue (CustomerSymbols . CUSTOMER_L
AS TNAME) %></LastName>
<CustIdX%=handler. getElementValue (CustomerSymbols . CUSTOMER_ID)
%> </CustId>
</customer>
//END Customer.jsp
C. A program (CustomerSymbols.java), with some reductions for conciseness, of a hashmap and constants used by customer.jsp.
// START CustomerSymbols.java package com . xxx . xml2xmapping . sample . customer; import j ava . util . HashMap ; public class CustomerSymbols { public static final int CUSTOMER = 1; public static final int CUSTOMER_FIRSTNAME = 2; public static final int CUSTOMER_LASTNAME = 3; public static final int CUSTOMER_ID = 4; private static CustomerSymbols fieldlnstance; private HashMap fieldName2SymbolDictionary; private static Object anObject = new Object ();
* CustomerlnfoElementSymbols constructor comment, private CustomerSymbols ( ) { super ( ) ; this . fieldName2SymbolDictionary = new HashMap (); this . fieldName2SymbolDictionary.put ("customer", new Integer (CustomerSymbols. CUSTOMER) ) ; this . fieldName2SymbolDictionary.put ( "FirstName", new Integer (CustomerSymbols. CUSTOMER__FIRSTNAME) ) ; this . fieldName2SymbolDictionary. put ("LastName", new Integer (CustomerSymbols. CUSTOMER_LASTNAME) ) ; this . fieldName2SymbolDictionary .put ("Custld", new Integer (CustomerSymbols. CUSTOMER_ID) ) ;
}
* Θreturn int
* Θparam elementName java . lang. String public static int getSymbol (String elementName) { if (CustomerSymbols . fieldlnstance == null) { synchronized (anObject) { if (CustomerSymbols . fieldlnstance == null) { CustomerSymbols . fieldlnstance = new CustomerSymbols () ;
} } } return ( ( Integer ) CustomerSymbols . fieldlnstance . f ieldName2SymbolDiction ar y . get ( elementName ) ) . int Value ( ) ; } } // END CustomerSymbols.java To generate the XML document for the array of customers situation discussed in conjunction with Example I a sample of the revised customer.jsp is provided below: for ( int i=0 ; i<handler . getElementRepetitions (CustomerSymbols . CUSTOMERS) ; i++)
{
<%handler. startElement (i, CustomerSymbols . CUSTOMER) ;%>
<customer>
<FirstName>
<%=handler . getElementValue (CustomerSymbols . CUSTOMER_FIRSTNAM
E) %></FirstName>
<LastName>
<%=handler . getElementValue (CustomerSymbols . CUSTOMER_LASTNAME
) %></LastName>
<CustIdX%=handler . getElementValue (CustomerSymbols . CUSTOMER_
ID) %></CustId>
</customer>
<%=handler . endElement (i, CustomerSymbols . CUSTOMER) ; %>
<%}%>
The handler 114-1 determines the array size (i.e., how many loops are to be executed) and returns in the getElementRepitions method. When the customer.jsp calls startElement with the index and name, the handler 114-1 sets a reference to that particular customer object in the array.
To handle recursion, the handler 114-1 uses a stack. As the object recurses, the handler 114-1 pushes onto the stack with a startElement, and pops with the endElement. The working object is the object on top of the stack.
If an object is optional then the isOptionalElement() or isOptionalAttributeQ methods are used to determine if the object exists. The processing in the customer.jsp is revised to add a conditional statement that uses a returned boolean for one of the isOptionalxxx methods. In summary, advantages of an exemplary embodiment of the present include: (a) providing a common framework for mapping from an XML document to a Java object and from a Java object to an XML document, wherein the framework uses a handler that masks how a property is obtained for mapping;
(b) use of readily available tools (e.g. SAX parser, JSP) to instantiate the mapping methods (XML/Java) of the present invention; and
(c) providing interfaces and classes (in Java environment) that simplify the structure of the mapping process of the present invention and makes the mapping process similar for both mapping directions.

Claims

CLAIMS:
1. A computer-implemented method for converting a data structure representing a software object to structured language elements of a document, the method comprising:
(a) generating a structured language element template document;
(b) reading properties from the software object, the properties being associated with the structured language elements of the document;
(c) using the properties, obtaining constructs defined by the structured language elements based on the association between the properties and the structured language elements; and
(d) populating the structured language element template document with the constructs.
2. The computer-implemented method of claim 1, wherein step (c) includes direct call back to the software object to obtain properties that represent the constructs that define structure and content of the document.
3. The computer-implemented method of claim 1, wherein step (c) includes creating an object model that represents structure and content of the document.
4. The computer-implemented method of claim 1 , wherein the structured language elements represent Extensible Markup Language (XML) constructs.
5. The computer-implemented method of claim 1, wherein step (c) includes constructing a loop in the template document to process repeating structures language elements.
6. A computer-implemented method for converting structured language elements of a document to a data structure representing a software object, the method comprising:
(a) reading each of the structured language elements of the document;
(b) determining a property, selected from a set of available properties defined by the data structure of the software object, associated with structured language elements of the document; and (c) populating the properties of the data structure representing the software object with structured language element values from the document.
7. The computer-implemented method of claim 6, wherein step (a) includes generating events that represent structure and content of the document.
8. The computer-implemented method of claim 6, wherein step (a) includes calling back to a handler with events that represent structure and content of the document.
9. The computer-implemented method of claim 6, wherein step (a) includes creating an object model that represents structure and content of the document.
10. The computer-implemented method of claim 6, wherein the structured language elements represent Extensible Markup Language (XML) constructs and step (a) further includes enforcing Document Type Definition (DTD) and XML schema standards.
11. The computer-implemented method of claim 10, further comprising maintaining a stack for recursive XML constructs.
12. A system for converting a software object (116) containing properties to a document (118) defined by structured language elements, the system comprising:
(a) a document template (112);
(b) a handler interface (114-l)for providing a representation of the structured language elements of the document (118) based on call backs made by the document template (112);
(c) a mapping module(l 14-2, 114-3), in communication with the handler interface
(114-1), for converting properties of the software objects (116)to structured language elements recognized by the document (118); and
(d) an output target class (114-4), in communication with the mapping module (114-2, 114-3), for writing the structured language elements generated in step (c) to the document (118).
13. The system of claim 12, wherein the mapping module includes a mapping interface
(114-2) for executing the conversion of the properties to the structured language elements and for setting an output target stream of the document (118) and a mapping class (114-3) for providing methods used by the mapping interface (114-2).
14. The system of claim 13, wherein the output target stream is defined as a buffer.
15. The system of claim 13, wherein the output target stream is defined as a response stream of a servlet.
16. The system of claim 12, wherein the structured language elements represent Extensible Markup Language (XML) constructs.
17. The system of claim 16, wherein the document template is created using JavaServer Pages (JSP).
18. A system for converting a document (108) containing structured language elements to a software object (110), the system comprising:
(a) a parser (104) for obtaining events representative of features of the document (108);
(b) an input source class (106-1) for reading the document (108);
(c) a content handler class (106-2), in communication with the input source class (106-1), for implementing a buffer for the events obtained by the parser (104); and
(d) a mapping module (106-3, 106-4), in communication with the content handler class (106-2), for converting the events obtained by the parser (104) to properties for the software object (110).
19. The system of claim 18, wherein the mapping module includes a mapping interface (106-4) for executing the conversion of the events to the properties and for setting an output target stream of the software object (110) and a mapping class (106-3) for providing methods used by the mapping interface (106-4).
20. The system of claim 19, wherein the structured language elements represent Extensible Markup Language (XML) constructs.
21. A method of converting a software object having properties to a document represented by structured language elements, the method comprising:
(a) supplying the software object to an instance of an invoked mapping interface;
(b) compiling and executing a template using an instance of an invoked container; and
(c) writing the document to a specified output stream using the compiled template.
22. The method of claim 21, further comprising calling back to the mapping interface to maintain state of processing.
23. The method of claim 21 , further comprising calling an isOptionalElementPresent method through the compiled template to determine if selected portions of the document are to be generated.
24. The method of claim 21 , further comprising calling an isOptionalAttributePresent method through the compiled template to determine if selected portions of the document are to be generated.
25. The method of claim 21, further comprising maintaining a state of processing using a stack when generating complex types within the document, said complex types selected from the group consisting of: an array, recursion and a complex type being contained within another complex type.
26. The method of claim 25, wherein the state of the stack is maintained by call backs from the compiled template to the mapping interface to indicate when the complex types start and end.
27. The method of claim 21 , further comprising calling a getElementRepetitions method to determine how many times the template loops over selected portions of the document.
28. The method of claim 21 , wherein the structured language elements represent Extensible Markup Language (XML) constructs and the template is created using JavaServer Pages (JSP).
29. A method of converting a document containing structured language elements to a software object, the method comprising:
(a) supplying the document to an instance of an invoked mapping interface;
(b) registering the mapping interface as a content handler;
(c) parsing the document using an instance of an invoked parser; and
(d) populating the software object with properties associated with structured language elements parsed from the document through call backs made to the mapping interface.
30. The method of claim 29, wherein step (d) includes call backs to invoke methods selected from the group consisting of: startDocument, startElement, characters, endElement, and endDocument.
31. The method of claim 30, wherein the startDocument and startElement methods executed by the mapping interface creates the software object.
32. The method of claim 29, wherein the endElement method executed by the mapping interface sets the properties into the software object.
33. The method of claim 29, wherein the structured language elements represent Extensible
Markup Language (XML) constructs.
34. A computer program product for converting a data structure representing a software object to structured language elements of a document, the computer program product comprising computer readable program code devices for:
(a) generating a structured language element template document;
(b) reading properties from the software object, the properties being associated with the structured language elements of the document;
(c) using the properties, obtaining constructs defined by the structured language elements based on the association between the properties and the structured language elements; and
(d) populating the structured language element template document with the constructs.
35. The computer program product of claim 34, wherein step (c) includes direct call back to the software object to obtain events that represent the constructs that define structure and content of the document.
36. The computer program product of claim 34, wherein step (c) includes creating an object model that represents structure and content of the document.
37. The computer program product of claim 34, wherein the structured language elements represent Extensible Markup Language (XML) constructs.
38. The computer program product of claim 34, wherein step (c) includes constructing a loop in the template document to process repeating structures language elements.
39. A computer program product for converting structured language elements of a document to a data structure representing a software object, the computer program product comprising computer readable program code devices for:
(a) reading each of the structured language elements of the document;
(b) determining a property, selected from a set of available properties defined by the data structure of the software object, associated with structured language elements of the document; and
(c) populating the properties of the data structure representing the software object with structured language element values from the document.
40. The computer program product of claim 39, wherein step (a) includes generating events that represent structure and content of the document.
41. The computer program product of claim 39, wherein step (a) includes calling back to a handler with events that represent structure and content of the document.
42. The computer program product of claim 39, wherein step (a) includes creating an object model that represents structure and content of the document.
43. The computer program product of claim 39, wherein the structured language elements represent Extensible Markup Language (XML) constructs and step (a) further includes enforcing Document Type Definition (DTD) and XML schema standards.
44. The computer program product of claim 43, further comprising maintaining a stack for recursive XML constructs.
PCT/US2001/049577 2001-06-07 2001-12-28 System & method of mapping between software objects & structured language element-based documents WO2002101579A1 (en)

Priority Applications (5)

Application Number Priority Date Filing Date Title
US10/479,671 US20040168124A1 (en) 2001-06-07 2001-12-28 System and method of mapping between software objects & structured language element-based documents
EP01993317A EP1399841A1 (en) 2001-06-07 2001-12-28 System & method of mapping between software objects & structured language element-based documents
HU0400135A HUP0400135A2 (en) 2001-06-07 2001-12-28 System & method of mapping between software objects & structured language element-based documents
JP2003504271A JP2004530225A (en) 2001-06-07 2001-12-28 System and method for mapping between software objects and document-based structured language elements
KR1020037014561A KR100583517B1 (en) 2001-06-07 2001-12-28 System and method of mapping between software objects and structured language element based documents

Applications Claiming Priority (2)

Application Number Priority Date Filing Date Title
CA002349905A CA2349905A1 (en) 2001-06-07 2001-06-07 System and method of mapping between software objects and structured language element based documents
CA2,349,905 2001-06-07

Publications (1)

Publication Number Publication Date
WO2002101579A1 true WO2002101579A1 (en) 2002-12-19

Family

ID=4169222

Family Applications (1)

Application Number Title Priority Date Filing Date
PCT/US2001/049577 WO2002101579A1 (en) 2001-06-07 2001-12-28 System & method of mapping between software objects & structured language element-based documents

Country Status (11)

Country Link
EP (1) EP1399841A1 (en)
JP (1) JP2004530225A (en)
KR (1) KR100583517B1 (en)
CN (1) CN1313953C (en)
CA (1) CA2349905A1 (en)
CZ (1) CZ20033330A3 (en)
HU (1) HUP0400135A2 (en)
PL (1) PL367225A1 (en)
RU (1) RU2287181C2 (en)
TW (1) TW573278B (en)
WO (1) WO2002101579A1 (en)

Cited By (14)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
JP2003091419A (en) * 2001-09-19 2003-03-28 Just Syst Corp Information processor and its program
KR100653610B1 (en) 2004-09-15 2006-12-04 (주)웹플러스 On-line flash editing system with reinforced function of editing navigation bar
US7194485B2 (en) 2003-11-21 2007-03-20 International Business Machines Corporation Mapping XML schema components to qualified java components
CN1306400C (en) * 2004-05-20 2007-03-21 北京大学 Binary system software member and its manufacturing method
US7212410B2 (en) 2004-01-16 2007-05-01 Finisar Corporation Actuator for small form-factor pluggable transceiver
US7290012B2 (en) 2004-01-16 2007-10-30 International Business Machines Corporation Apparatus, system, and method for passing data between an extensible markup language document and a hierarchical database
EP1939735A1 (en) * 2006-11-30 2008-07-02 NCR Corporation System and method for interpreting a specification language file to implement a business system
US7418456B2 (en) 2004-01-16 2008-08-26 International Business Machines Corporation Method for defining a metadata schema to facilitate passing data between an extensible markup language document and a hierarchical database
CN101826113A (en) * 2010-05-14 2010-09-08 珠海世纪鼎利通信科技股份有限公司 High-efficiency and unified method for storing wireless measurement data
US7861250B2 (en) 2003-04-25 2010-12-28 Microsoft Corporation Runtime polymorphism
US7904417B2 (en) 2006-02-27 2011-03-08 Microsoft Corporation Recursive metadata templating
CN104636265A (en) * 2015-01-21 2015-05-20 广东电网有限责任公司电力科学研究院 Access method for efficient memory model organization of CIMXML document
CN110795168A (en) * 2018-08-02 2020-02-14 武汉斗鱼网络科技有限公司 Method for acquiring data and related device
CN113505269A (en) * 2021-07-02 2021-10-15 卡斯柯信号(成都)有限公司 Binary file detection method and device based on XML

Families Citing this family (26)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US7120864B2 (en) 2004-01-27 2006-10-10 International Business Machines Corporation Eliminating superfluous namespace declarations and undeclaring default namespaces in XML serialization processing
CN100336023C (en) * 2004-08-24 2007-09-05 英业达股份有限公司 Method for realizing software call through keyword associated mechanism
US7694284B2 (en) * 2004-11-30 2010-04-06 International Business Machines Corporation Shareable, bidirectional mechanism for conversion between object model and XML
US20060123345A1 (en) * 2004-12-06 2006-06-08 International Business Machines Corporation Platform-independent markup language-based gui format
KR100836736B1 (en) * 2006-09-27 2008-06-10 한국전자통신연구원 Apparatus for Parser Framework using Markup Language and Method thereof
US8381093B2 (en) 2006-12-06 2013-02-19 Microsoft Corporation Editing web pages via a web browser
US8880564B2 (en) * 2007-10-11 2014-11-04 Microsoft Corporation Generic model editing framework
CN101355560B (en) * 2008-09-12 2011-12-14 深圳市联软科技有限公司 Method and system for transmitting data
US9250938B2 (en) 2008-10-15 2016-02-02 Microsoft Technology Licensing, Llc Caching runtime generated code
US8347208B2 (en) * 2009-03-04 2013-01-01 Microsoft Corporation Content rendering on a computer
JP5249092B2 (en) * 2009-03-09 2013-07-31 Necシステムテクノロジー株式会社 Information processing apparatus, multidimensional array expansion processing method, and program
US20100235806A1 (en) * 2009-03-13 2010-09-16 Microsoft Corporation Rich Web Site Authoring And Design
US10089119B2 (en) 2009-12-18 2018-10-02 Microsoft Technology Licensing, Llc API namespace virtualization
US8776094B2 (en) 2011-08-11 2014-07-08 Microsoft Corporation Runtime system
US8695021B2 (en) 2011-08-31 2014-04-08 Microsoft Corporation Projecting native application programming interfaces of an operating system into other programming languages
KR101535703B1 (en) 2012-09-28 2015-07-09 삼성에스디에스 주식회사 Apparatus and method for converting Value Object
US9075618B2 (en) * 2012-11-02 2015-07-07 Microsoft Technology Licensing, Llc Cross-platform data visualizations using common descriptions
RU2527201C1 (en) * 2013-01-24 2014-08-27 Общество с ограниченной ответственностью "Системное моделирование и анализ" Data conversion method, data conversion device and data conversion system
KR102095703B1 (en) * 2013-06-20 2020-04-01 에스케이플래닛 주식회사 An apparatus, method and recording medium for Markup parsing
US10635504B2 (en) 2014-10-16 2020-04-28 Microsoft Technology Licensing, Llc API versioning independent of product releases
CN106407679B (en) * 2016-09-13 2019-03-26 上海市徐汇区中心医院 Mobile interchange cross-platform cross equipment remote diagnosis system
KR102255806B1 (en) * 2017-07-03 2021-05-26 (주)더리스 Integrated management method and system of online shopping mall based on API
CN108519964B (en) * 2018-03-09 2022-03-04 中国工程物理研究院计算机应用研究所 Method for converting XML Schema document into Java code
CN110795169B (en) * 2018-08-02 2022-11-11 武汉斗鱼网络科技有限公司 Method and related device for acquiring data
CN113742008A (en) * 2021-09-13 2021-12-03 挂号网(杭州)科技有限公司 Interface calling method and device, electronic equipment and storage medium
JP7315253B2 (en) * 2021-09-29 2023-07-26 株式会社スカイディスク System, server and method

Citations (4)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US6226675B1 (en) * 1998-10-16 2001-05-01 Commerce One, Inc. Participant server which process documents for commerce in trading partner networks
US6327628B1 (en) * 2000-05-19 2001-12-04 Epicentric, Inc. Portal server that provides a customizable user Interface for access to computer networks
US6343265B1 (en) * 1998-07-28 2002-01-29 International Business Machines Corporation System and method for mapping a design model to a common repository with context preservation
US6347307B1 (en) * 1999-06-14 2002-02-12 Integral Development Corp. System and method for conducting web-based financial transactions in capital markets

Family Cites Families (2)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US5926189A (en) * 1996-03-29 1999-07-20 Apple Computer, Inc. Method and apparatus for typographic glyph construction including a glyph server
US6125391A (en) * 1998-10-16 2000-09-26 Commerce One, Inc. Market makers using documents for commerce in trading partner networks

Patent Citations (4)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US6343265B1 (en) * 1998-07-28 2002-01-29 International Business Machines Corporation System and method for mapping a design model to a common repository with context preservation
US6226675B1 (en) * 1998-10-16 2001-05-01 Commerce One, Inc. Participant server which process documents for commerce in trading partner networks
US6347307B1 (en) * 1999-06-14 2002-02-12 Integral Development Corp. System and method for conducting web-based financial transactions in capital markets
US6327628B1 (en) * 2000-05-19 2001-12-04 Epicentric, Inc. Portal server that provides a customizable user Interface for access to computer networks

Cited By (17)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
JP2003091419A (en) * 2001-09-19 2003-03-28 Just Syst Corp Information processor and its program
US7861250B2 (en) 2003-04-25 2010-12-28 Microsoft Corporation Runtime polymorphism
US7194485B2 (en) 2003-11-21 2007-03-20 International Business Machines Corporation Mapping XML schema components to qualified java components
US7912874B2 (en) 2004-01-16 2011-03-22 International Business Machines Corporation Apparatus and system for defining a metadata schema to facilitate passing data between an extensible markup language document and a hierarchical database
US7822786B2 (en) 2004-01-16 2010-10-26 International Business Machines Corporation Apparatus, system, and method for defining a metadata schema to facilitate passing data between an extensible markup language document and a hierarchical database
US7290012B2 (en) 2004-01-16 2007-10-30 International Business Machines Corporation Apparatus, system, and method for passing data between an extensible markup language document and a hierarchical database
US7212410B2 (en) 2004-01-16 2007-05-01 Finisar Corporation Actuator for small form-factor pluggable transceiver
US7418456B2 (en) 2004-01-16 2008-08-26 International Business Machines Corporation Method for defining a metadata schema to facilitate passing data between an extensible markup language document and a hierarchical database
CN1306400C (en) * 2004-05-20 2007-03-21 北京大学 Binary system software member and its manufacturing method
KR100653610B1 (en) 2004-09-15 2006-12-04 (주)웹플러스 On-line flash editing system with reinforced function of editing navigation bar
US7904417B2 (en) 2006-02-27 2011-03-08 Microsoft Corporation Recursive metadata templating
EP1939735A1 (en) * 2006-11-30 2008-07-02 NCR Corporation System and method for interpreting a specification language file to implement a business system
US8578350B2 (en) 2006-11-30 2013-11-05 Ncr Corporation System and method for interpreting a specification language file to implement a business system
CN101826113A (en) * 2010-05-14 2010-09-08 珠海世纪鼎利通信科技股份有限公司 High-efficiency and unified method for storing wireless measurement data
CN104636265A (en) * 2015-01-21 2015-05-20 广东电网有限责任公司电力科学研究院 Access method for efficient memory model organization of CIMXML document
CN110795168A (en) * 2018-08-02 2020-02-14 武汉斗鱼网络科技有限公司 Method for acquiring data and related device
CN113505269A (en) * 2021-07-02 2021-10-15 卡斯柯信号(成都)有限公司 Binary file detection method and device based on XML

Also Published As

Publication number Publication date
CN1313953C (en) 2007-05-02
PL367225A1 (en) 2005-02-21
EP1399841A1 (en) 2004-03-24
CA2349905A1 (en) 2002-12-07
TW573278B (en) 2004-01-21
CN1513145A (en) 2004-07-14
JP2004530225A (en) 2004-09-30
KR100583517B1 (en) 2006-05-24
KR20040007545A (en) 2004-01-24
CZ20033330A3 (en) 2004-03-17
RU2003137567A (en) 2005-05-27
RU2287181C2 (en) 2006-11-10
HUP0400135A2 (en) 2004-08-30

Similar Documents

Publication Publication Date Title
US20040168124A1 (en) System and method of mapping between software objects &amp; structured language element-based documents
KR100583517B1 (en) System and method of mapping between software objects and structured language element based documents
Garlan et al. Acme: An architecture description interchange language
CA2479310C (en) Dynamic generation of schema information for data description languages
US7500224B2 (en) Code blueprints
US7694284B2 (en) Shareable, bidirectional mechanism for conversion between object model and XML
US7480894B2 (en) Method and system for retaining formal data model descriptions between server-side and browser-side javascript objects
US7155705B1 (en) Techniques for binding an application with a data exchange format based on tags in comments
US5966535A (en) Method and apparatus for generating program code for world wide web service applications
Syme et al. Expert F♯
US7941461B2 (en) System and method for developing and enabling model-driven XML transformation framework for e-business
US6925631B2 (en) Method, computer system and computer program product for processing extensible markup language streams
US7162687B2 (en) JSP tag libraries and web services
US20020099738A1 (en) Automated web access for back-end enterprise systems
US20100088676A1 (en) Comparing and merging structured documents syntactically and semantically
Khare et al. xADL: enabling architecture-centric tool integration with XML
US20030135825A1 (en) Dynamically generated mark-up based graphical user interfaced with an extensible application framework with links to enterprise resources
Syme et al. Expert F♯ 2.0
Rose et al. Virtual XML: A toolbox and use cases for the XML world view
Steel et al. Generating human-usable textual notations for information models
Apte Java connector architecture: building custom connectors and adapters
Manola Some Web Object Model Construction Technologies
Emir et al. Scalable programming abstractions for XML services
Galvin et al. Enhancing the role of interfaces in software architecture description languages (adls)
Wong XMI-based transformation of UML interaction diagrams to activity diagrams

Legal Events

Date Code Title Description
AK Designated states

Kind code of ref document: A1

Designated state(s): AT AU BR CH CN CZ DE ES GB HU IL IN JP KR MX PL RU SE SG US VN

AL Designated countries for regional patents

Kind code of ref document: A1

Designated state(s): AT BE CH CY DE DK ES FI FR GB GR IE IT LU MC NL PT SE TR

121 Ep: the epo has been informed by wipo that ep was designated in this application
DFPE Request for preliminary examination filed prior to expiration of 19th month from priority date (pct application filed before 20040101)
WWE Wipo information: entry into national phase

Ref document number: 1020037014561

Country of ref document: KR

WWE Wipo information: entry into national phase

Ref document number: 10479671

Country of ref document: US

Ref document number: 2001993317

Country of ref document: EP

WWE Wipo information: entry into national phase

Ref document number: 2003504271

Country of ref document: JP

Ref document number: PV2003-3330

Country of ref document: CZ

WWE Wipo information: entry into national phase

Ref document number: 018233392

Country of ref document: CN

WWP Wipo information: published in national office

Ref document number: PV2003-3330

Country of ref document: CZ

WWP Wipo information: published in national office

Ref document number: 2001993317

Country of ref document: EP

REG Reference to national code

Ref country code: DE

Ref legal event code: 8642

WWW Wipo information: withdrawn in national office

Ref document number: 2001993317

Country of ref document: EP