US 7,039,859 B1Grant
Generating visual editors from schema descriptions
Issue Date:2006-05-02
•69 Claims
•8 Drawing Sheets
Abstract
A visual editor is automatically generated from an eXtensible Markup Language (XML) schema and then used to edit the data contained in corresponding XML documents. The entities within an XML schema are mapped to components of the visual editor, such as forms, widgets, etc., that are generated as class specifications. These class specifications can be customized through the use of a customization specification file, as desired. The class specifications are then instantiated as objects in a Java Virtual Machine to perform the functions of the visual editor.
Metadata
Assignee
- International Business Machines Corporation
Inventor
- Neelakantan Sundaresan
Application Information
Application Number:US 09/191,281
Filing Date:1998-11-12
Priority Date:1998-11-12
Art Unit:2176
Classifications
IPC:
G06F15/00
Patent Drawings (8 sheets)
Description
CROSS-REFERENCE TO RELATED APPLICATIONS
[0001] This application is related to the following co-pending and commonly-assigned patent applications:
[0002] Application Ser. No. 09/166,018, now U.S. Pat. No. 6,487,566, entitled “A PATTERN MATCHING AND REPLACEMENT LANGUAGE FOR TRANSFORMING DOCUMENTS,” filed on Oct. 5, 1998, by Neelakantan Sundaresan;
[0003] Application Ser. No. 09/166,043, now U.S. Pat. No. 6,569,207, entitled “CONVERTING SCHEMAS TO COMPONENT MODELS,” filed on Oct. 5, 1998, by Neelakantan Sundaresan; and
[0004] Application Ser. No. 09/166,042, now U.S. Pat. No. 6,480,865, entitled “A FACILITY FOR ADDING DYNAMISM TO AN EXTENSIBLE MARKUP LANGUAGE,” filed on Oct. 5, 1998, by Susan B. Lee and Neelakantan Sundaresan;
[0005] All of which applications are incorporated by reference herein.
BACKGROUND OF THE INVENTION
[0006] 1. Field of the Invention
[0007] This invention relates in general to generating visual editors, and in particular, to generating visual editors from eXtensible Markup Language (XML) schemas.
[0008] 2. Description of Related Art
[0009] Extensible Markup Language (XML) is poised to be the next big revolution for the World Wide Web (WWW). With the realization that the Web is not about just browsing any more, XML has emerged as an enabling technology to carry the Web to the next generation of electronic commerce, Web-based workflow, and integration of databases with Web applications.
[0010] XML describes a class of data objects called XML documents and partially describes the behavior of computer programs that process them. XML is a restricted form of SGML, the Standard Generalized Markup Language, defined in ISO 8879. The specification for XML can be found at the URL: http://www.w3.org/TR/REC-xml.
[0011] XML documents are made up of storage units called entities, which contain either parsed or unparsed data. Parsed data is made up of characters, some of which form character data, and some of which form markup. Markup encodes a description of the document's storage layout and logical structure. XML provides a mechanism to impose constraints on the storage layout and logical structure.
[0012] An XML schema specifies constraints on the structures and types of elements in an XML document. The basic schema for XML is the DTD Document Type Definition). Other XML schema definitions are also being developed, such as DCD (Document Content Definition), XSchema, etc. Information concerning DTD and DCD can be found at the URL: http://www.w3.org/.
[0013] The main difference between DTD and DCD is that DTD uses a different syntax from XML, while DCD specifies an XML schema language in XML itself. (XSchema is similar to DCD in this respect). In spite of the differences in the syntax, the goals and constraint semantics for all these XML schema languages are the same. Their commonality is that they all describe XML Schema. This means that they assume the common XML structure, and provide a description language to say how these elements are laid out and are related to each other.
[0014] There are about five basic constraints that the XML schema languages describe:
-
- [0015] 1. The attributes that an element should/may contain:
- [0016] a. the types of the attribute values (mainly string types), and
- [0017] b. the mandatory or optional nature of occurrences of these attributes.
- [0018] 2. The type and the order in which elements can be contained inside another element (also known as the content model of the element):
- [0019] a. the sub-element should be of a certain name or type or that a sub-element could be of any type,
- [0020] b. a regular expression system to express how these elements occur, wherein this regular expression system can be expressed by the following operators:
- [0021] i. |: A|B (either element of type A or of type B can occur),
- [0022] ii.,: A, B (element of type B follows one of type A),
- [0023] iii. *: A* (zero or more occurrence of element of type A),
- [0024] iv. +: A+ (One or more occurrence of element of type A),
- [0025] v. ?: A? (zero or one occurrence of element of type A),
- [0026] vi. ( ): ( . . . ) (grouping of expressions in this system).
- [0015] 1. The attributes that an element should/may contain:
[0027] Note that this system includes some convenience operators. For example, A+ is the same as A, A*.
[0028] A software module called an XML processor is used to read XML documents and provide access to their content and structure. It is assumed that an XML processor is doing its work on behalf of another module, called the application. The XML specification located at the URL noted above describes the required behavior of an XML processor in terms of how it must read XML data and the information it must provide to the application.
[0029] As XML becomes more extensively used in Web applications, large numbers of XML documents will be created, communicated between applications, and stored into and retrieved from repositories. The volume of XML documents will likely be larger than the current volume of HTML (HyperText Markup Language) documents, because XML documents can be seamlessly integrated with applications.
[0030] Unlike HTML documents, which are read only by Web browsers, XML documents can be read and processed by any number of different applications. Moreover, since XML is extensible, there may many different schemas for XML documents for different domains and different applications within a domain, unlike HTML, which has a single schema.
[0031] There is a need in the art then for editors that provide users with a facility to create and/or edit XML documents. Of course, the construction of editors is well known in the art. Consider, for example, U.S. Pat. No. 5,640,566, entitled “Method of forming an editor”, U.S. Pat. No. 5,493,678, entitled “Method in a structure editor”, U.S. Pat. No. 5,185,867, entitled “Method and apparatus for automatically generating software specifications”, and U.S. Pat. No. 5,617,578, entitled “Computer-based workstation for generation of logic diagrams from natural language text structured by the insertion of script symbols”. However, none of the references teach or suggest a visual editor that simplifies a user's interaction with XML documents, or an automatic tool for the generation of visual editors for use with specific XML schemas and that are generated from such XML schemas.
SUMMARY OF THE INVENTION
[0032] To overcome the limitations in the prior art described above, and to overcome other limitations that will become apparent upon reading and understanding the present specification, the present invention discloses a visual editor that is automatically generated from an extensible Markup Language (XML) schema and then used to edit the data contained in corresponding XML documents. The entities within an XML schema are mapped to components of the visual editor, such as forms, widgets, etc., that are generated as class specifications. These class specifications can be customized through the use of a customization specification file, as desired. The class specifications are then instantiated as objects in a Java Virtual Machine to perform the functions of the visual editor.
BRIEF DESCRIPTION OF THE DRAWINGS
[0033] Referring now to the drawings in which like reference numbers represent corresponding parts throughout:
[0034] FIG. 1 schematically illustrates an exemplary hardware environment that could be used with the preferred embodiment of the present invention;
[0035] FIG. 2 illustrates the operation of the Editor Maker according to the preferred embodiment of the present invention;
[0036] FIG. 3 illustrates a panel widget as it would be displayed by the browser on the client computer according to the preferred embodiment of the present invention;
[0037] FIG. 4 illustrates three pairs of widgets (label widget, text editor widget) for three attributes as they would be displayed by the browser on the client computer according to the preferred embodiment of the present invention;
[0038] FIG. 5 illustrates two widgets (a list widget and a choice widget) as they would be displayed by the browser on the client computer according to the preferred embodiment of the present invention;
[0039] FIG. 6 illustrates a panel widget as it would be displayed by the browser on the client computer according to the preferred embodiment of the present invention; and
[0040] FIG. 7 illustrates a panel widget as it would be displayed by the browser on the client computer according to the preferred embodiment of the present invention.
DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENT
[0041] In the following description of the preferred embodiment, reference is made to the accompanying drawings which form a part hereof, and in which is shown by way of illustration a specific embodiment in which the invention may be practiced. It is to be understood that other embodiments may be utilized and structural and functional changes may be made without departing from the scope of the present invention.
Overview
[0042] The preferred embodiment of the present invention describes a system for automatically generating visual editors for XML documents from XML schemas for the XML documents. Because most XML schemas are described as Document Type Definitions (DTDs), the preferred embodiment of the present invention concentrates on DTD-based XML schemas, although alternative embodiments describe how to convert schemas based on Document Content Definitions (DCDs), XSchema, etc. For the components of the visual editors, the preferred embodiment of the present invention focuses on Java objects, since Java is commonly used in the context of the Web, although an alternative embodiment could use other programming languages.
Hardware Environment
[0043] FIG. 1 schematically illustrates an exemplary hardware environment that could be used with the preferred embodiment of the present invention, and more particularly, illustrates a typical distributed computer system using the Internet 100 to connect client systems 102 executing Web browsers 104 to server systems 106 executing Web daemons 108. A typical combination of resources may include clients 102 that are personal computers or workstations, and servers 106 that are personal computers, workstations, minicomputers, or mainframes. These systems are coupled to one another over a network 100, which may include networks such as LANs, WANs, SNA networks, as well as the Internet.
[0044] Either or both of the Web browser 104 and Web daemon 108 may include a Java Virtual Machine (JVM) 110 that executes Java objects, applets, scripts, etc., associated with various Web content. The server system 106 may further include one or more Editor Makers 112 that use XML schemas and documents 114 to create Java class specifications that are instantiated as Java objects 116 that comprise components of a visual editor 118 for XML documents.
[0045] In general, the Editor Maker 112, XML schemas and documents 114, class specifications and objects 116, and visual editors 118 comprise data and/or logic which, when read and executed by a computer, cause the computer to perform the steps for performing and/or using the present invention. Generally, the data and/or logic are embodied in and/or readable from a device, carrier or media, such as memory, data storage devices, and/or remote devices coupled to the computer via data communications devices.
[0046] However, those skilled in the art will recognize that the exemplary environment illustrated in FIG. 1 is not intended to limit the present invention. Indeed, those skilled in the art will recognize that other alternative hardware environments may be used without departing from the scope of the present invention.
[0047] Thus, the present invention may be implemented as a method, apparatus, or article of manufacture using standard programming and/or engineering techniques to produce software, hardware, firmware, or any combination thereof. In addition, the term “article of manufacture” as used herein is intended to encompass logic and/or data embodied in or accessible from any device, carrier, or media.
Operation of the Editor Maker
[0048] FIG. 2 illustrates the operation of the Editor Maker 112 according to the preferred embodiment of the present invention. The Editor Maker 112 maps an XML schema 116 (e.g., a dtd file named “foo.dtd” with a root element “bar”) to components of a visual editor 118, such as forms, widgets, etc., that are generated as visual editor 118 class specifications 200 (e.g., BarEditor.java) the comprise the components of the visual editor 118, content implementation class specifications 202 (e.g., Bar.java) that comprise components of the of XML schemas and documents, and handler class specifications 204 (e.g., BarHandler.java) that comprise initiators for the visual editor 118. These class specifications 200, 202, 204 can be customized through the use of a customization specification file 206, as desired. The class specification 200, 202, 204 are then instantiated as objects in a Java Virtual Machine 110 (either on the server 104 or the client 102) 118.
[0049] In operating the visual editor 118, users would not need to know the specifics of the structure of the XML document or the XML schema. Instead, users would simply operate the visual editor 118 to fill in forms, interact with widgets and other components of the visual editor 118, and the visual editor 118 would, in turn, would create and/or edit the XML documents.
[0050] Elements
[0051] At the simplest level, the Editor Maker 112 associates a panel widget with an element. For example, the Editor Maker 112 generates a panel editor widget for an element definition of the form:
-
- [0052] <!ELEMENT A . . . >
[0053] For each element Bi occurring inside element A, the Editor Maker 112 associates a button in the panel corresponding to A. When this button is selected the panel associated with Bi is shown for editing the Bi element.
[0054] Consider the following content model:
-
- [0055] <!ELEMENT OUTER (INNER1, INNER2)>
- [0056] <!ATTLIST OUTER
- [0057] ATTR1 CDATA #REQUIRED
- [0058] ATTR2 CDATA #REQUIRED>
- [0059] <!ELEMENT INNER1 . . . >
- [0060] <!ELEMENT INNER2 . . . >
[0061] The panel widget generated for “OUTER”, as it would be displayed by the browser 104 on the client computer 102, is shown in FIG. 3 . Selecting the INNER1button widget would display the panel for INNER1, while selecting the INNER2button widget would display the panel for INNER2.
[0062] Attributes
[0063] Since attribute values in XML can only be text, an attribute needs only a text editor widget in the visual editor 118. The Editor Maker 112 generates a pair of widgets for each attribute, including a label widget (bearing the attribute name) and the text editor widget. To differentiate between text editor widgets for different attributes, a label widget is associated with the text editor widget, wherein the label is the name of the attribute in the preferred embodiment (other labels could be used in alternative embodiments).
[0064] The text editor widget provided by the Editor Maker 112 allows a user to input values for the attribute. In DTD, an attribute may have three different declarations: mandatory (#REQUIRED), optional (#IMPLIED), or fixed value (#FIXED). Attributes can also be of different types: NMTOKEN, STRING, etc.
[0065] For user input, the text editor widget performs two functions:
[0066] 1. The text editor widget allows the user to enter a value only if the attribute is declared to be IMPLIED or REQUIRED. For FIXED attributes, the text editor widget uses the value specified in the DTD and does not permit the user to change this value.
[0067] 2. The text editor widget validates the values entered by the user against the different possible types of the attributes.
[0068] Since editing is an incremental process, the text editor widget does not require that the user enter a value for every attribute that is declared to be REQUIRED. However, the user can invoke a validation call to have the text editor widget to check and verify that all the attributes that are REQUIRED have indeed been entered.
[0069] Consider the following example DTD:
-
- [0070] <!ENTITY % bool “(true|false)”>
- [0071] <!ATTLIST A
- [0072] ATTR1 CDATA #IMPLIED
- [0073] ATTR2 % bool #REQUIRED
- [0074] ATTR3 CDATA #FIXED “YES”>
[0075] For this example DTD, the Editor Maker 112 generates three pairs (label widget, text editor widget) for these three attributes, as shown in FIG. 4 . The boxes labeled ATTR1, ATTR2, and ATTR3 are label widgets, and each label widget is adjacent a text editor widget that it labels. The text editor widget associated with ATTR1 would allow the user to enter any string, the text editor widget associated with ATTR2 would allow the user to enter only the values “true” or “false”, and the text editor widget associated with ATTR3 would only display a value and would not allow the user to change the value.
[0076] As an alternative, since the text editor widget associated with ATTR2 can accept only an enumerated number of values, it could be replaced by a “choice” widget that displays all possible values so that the user can select one of the values. Similarly, the text editor widget associated with ATTR3 could be replaced by a label widget, since the user cannot enter a value for ATTR3.
[0077] Zero Or One: B?
[0078] When an element A has a content model that includes B?, the Editor Maker 112 associates a button in A's panel for B. This is the same as the case when B is in the content model of A.
[0079] Zero/One Or More: B* or B+
[0080] Regular expressions such as B*, B+ that indicate multiple instances of an element result in indexed properties. When a content model contains expressions of the form B* or B+, the Editor Maker 112 associates two widgets with the content model: (1) a list widget that displays a list of widgets; and (2) a choice widget, as illustrated in FIG. 5 .
[0081] The list widget of the visual editor 118 is generated for the following content model:
-
- [0082] <!ELEMENT group_list (group)*>
- [0083] <!ATTLIST group_list
- [0084] attr1 CDATA #REQUIRED>
- [0085] <!ELEMENT group . . . >
[0086] The choice widget includes three choices: Add, Delete, or Edit. These choices allow the user to add an element of type B to the list, delete an element of type B from the list, or edit a member in the list, respectively.
-
- [0087] 1. To add a member of type B, the user selects the Add choice and an empty panel related to a B element is displayed.
- [0088] 2. To delete an element from the list, the user chooses a particular element in the list and selects “Delete” from the choice widget. The user can select multiple elements in the list to be deleted at the same time.
- [0089] 3. To edit an element, the user selects an element and the panel associated with the element is displayed.
[0090] Note that instead of deleting and editing through the choice menu, an action event may be associated with the list widget, so that when a user selects a particular item, a pop-up menu for add, delete or edit is displayed.
[0091] One Or The Other: A|B
[0092] When an element has a content model of the form A |B, the Editor Maker 112 translates this to a choice widget. The user can select one of the two and the associated edit panel is displayed.
[0093] FIG. 6 illustrates the panel widget of the visual editor 118 that is generated for the following content model:
-
- [0094] <!ELEMENT (INNER1 |INNER2)>
[0095] One Followed by the Other: A, B
[0096] For this content model, a button is displayed for each of the elements in the sequence in a panel widget for the parent element.
[0097] FIG. 7 illustrates the panel widget of the visual editor 118 that is generated for the following content model:
-
- [0098] <!ELEMENT OUTER (INNER1, INNER2, INNER3)>
[0099] Selecting any of the buttons displays the element panel associated with corresponding element.
[0100] Grouping: (A)
[0101] Grouping is often used to group a plurality of elements in the content model to jointly apply any of the above-mentioned operators, such as?, *, +, etc., to the members of the group jointly, thus overriding any default precedence conditions. As described above, FIG. 5 illustrates the list widget of the visual editor 118 that is generated for the grouping content model.
[0102] It is possible to put all the button widgets corresponding to a group in a panel. However, grouping is often used for clarity and unnecessarily creating a grouping panel might result in too many widgets. This is especially true with situations such as ((A)), where unnecessary parentheses are introduced.
[0103] The ANY Content Model
[0104] An ANY content model in the DTD indicates that the element itself can contain elements of any type, i.e., the content model is “open”. For this content model, the visual editor 118 displays the XML document, so that the user can edit the XML document directly. The visual editor 118 may also provide a tree editor for the XML document, wherein the tree editor is a structural editor that assists the user in entering well-formed structures into the XML document.
[0105] The EMPTY Content Model
[0106] For the EMPTY content model, the only properties displayed by the visual editor 118 are text editor widgets for its attributes. If there are no attributes, i.e., then no panel is displayed for the element (selecting the button corresponding to the element in the containing panel does nothing).
[0107] The PCDATA Content Model
[0108] The PCDATA content model results a text editor widget where the user types in text corresponding to the PCDATA. The text editor widget checks that XML tag characters, such as ‘<’, ‘>’, etc., are not present in the PCDATA, unless the data is specified as a CDATA. Also, the text editor widget provides a toggle mechanism to wrap the PCDATA around in a CDATA.
[0109] Optimization
[0110] The Editor Maker 112 attempts to solve a number of correctness, optimization, and aesthetics related issues when generating the visual editor 118 from the XML schema.
[0111] For example, often when the application developer specifies A, B in the content model, they mean ((A, B)|(B, A)). Sometimes, the application developer specifies this explicitly, but, when the list gets long and complicated, for example, as in A*, B?, C+, the application developer has to specify explicitly numerous combinations (in the example, six combinations) and may inadvertently omit some combinations.
[0112] The Editor Maker 112 automatically generates these combinations by default. Thus, when it sees A, B, it automatically assumes B, A as well.
[0113] However, this may not be a correct assumption in all situations. The Editor Maker 112 tries to be careful when it makes these assumption. For example, when some element occurs multiple times in a sequence, for example, as A in -A, B, A-, it converts that element to an A+ content model (thus generating a list editor for the occurrences of A). However, it introduces an additional constraint in the list editor that a user cannot enter more than two instances of A (as is the case in the original content model), because the generated editor would indicate an error if such an event occurred.
[0114] The Editor Maker 112 also eliminates unnecessary grouping parentheses.
[0115] Generating Visual Editors for Different Regular Expression Operators
[0116] The application developer can customize the visual editors 118 for different regular expression operators using the customization specification file 206.
[0117] Consider the following example DTD:
-
- [0118] <!ELEMENT editor EMPTY>
- [0119] <!ATTLIST editor
[0120]
| OR | CDATA #IMPLIED | |
| GROUP | CDATA #IMPLIED | |
| COMMA | CDATA #IMPLIED | |
| STAR | CDATA #IMPLIED | |
| PLUS | CDATA #IMPLIED | |
| For-PCDATA | CDATA #IMPLIED | |
| For-ATTRS | CDATA #IMPLIED | |
| For-ANY | CDATA #IMPLIED | |
| For-EMPTY | CDATA #IMPLIED> | |
[0121] In the customization specifications file 206, the application developer can identify the specific widgets implementations for the Editor Maker 112. An example of this would be the following:
-
- [0122] <editor For-ATTRS=“java.awt.TextArea”/>
[0123] Using the above specification, the Editor Maker 112 generates a TextArea widget for the attribute using the identified implementation.
[0124] Name Generation For Elements
[0125] In an alternative embodiment, the Editor Maker 112 also allows element-by-element or attribute-by-attribute customization using the customization specifications file 206. For example, the DTD in the customization specifications file 206 for element name generation could be the following:
-
- [0126] <!ELEMENT editor-generator (triple)*>
- [0127] <!ELEMENT tripleEMPTY>
- [0128] <!ATTLIST triple
- [0129] content-name CDATA #REQUIRED
- [0130] type “(Attribute|Element)” #IMPLIED
- [0131] editor-name CDATA #REQUIRED>
[0132] Consider the following example content model:
-
- [0133] <!ELEMENT Outer (Inner1, Inner2)>
- [0134] <!ATTLIST Outer
- [0135] attr CDATA #IMPLIED>
[0136] The application developer can provide a customization specification of the following form:
-
- [0137] <editor-generator>
- [0138] <triplet name=“Outer”
- [0139] editor-name=“java.awt.List”
- [0140] type=“element”/>
- [0141] <triplet name=“Inner1”
- [0142] editor-name=“java.awt.TextArea”
- [0143] type=“element”/>
- [0144] <triplet name=“Inner2”
- [0145] editor-name=“myEditor.Foo”
- [0146] type=“element”/>
- [0147] <triplet name=“attr”
- [0148] type=“attribute”
- [0149] editor-name=“java.awt.TextArea”/>
- [0138] <triplet name=“Outer”
- [0150] </editor-generator>
- [0137] <editor-generator>
[0151] The application developer can also customize the names for class specifications using the following DTD:
-
- [0152] <!ELEMENT class-names EMPTY>
- [0153] <!ATTLIST class-names
- [0154] editor-class CDATA #IMPLIED
- [0155] content-class CDATA #IMPLIED
- [0156] handler-class CDATA #IMPLIED>
[0157] For example, the application developer can specify the names MyEditor, MyImpl, MyHandlers, respectively, for the three classes discussed above, using the following XML specification:
-
- [0158] <class-names editor-class=“MyEditor”
- [0159] content-class=“MyImpl”
- [0160] handler-class=“MyHandlers”/>
- [0158] <class-names editor-class=“MyEditor”
[0161] The application developer can also specify the package name for the classes in the customization specifications file 206. By default, the Editor Maker 112 names the package after the name of the DTD file used to generate the classes. If the application developer can change the name of package using the following DTD:
-
- [0162] <!ELEMENT generated-package EMPTY>
- [0163] <!ATTLIST generated-package
- [0164] name CDATA #REQUIRED>
[0165] For example, the application developer can specify that the generated classes should belong to the package “com.ibm.almaden.gcsConfig” using the following XML specification:
[0166] <generated-package name=“com.ibm.almaden.gcsConfig”/>
[0167] Using the Visual Editors to Validate Content
[0168] The visual editor 118 generated by the Editor Maker 112 provides the functionality where the user can ask the visual editor 118 to validate an element or ask questions as to what are the possible values at some point of the editing process. The former enables the user to create partially valid documents, while the latter enable hint-based editing.
[0169] Even though the visual editor 118 includes the functionality to validate a XML document, the user may wish to save a partially created XML document. This file will be well-formed, but may not be valid.
[0170] Interaction with Other Tools
[0171] In addition, the visual editor 118 can be made to interface to other classes, for example, the classes generated by the BeanMaker described in co-pending and commonly-assigned application Ser. No. 09/166,043, entitled “CONVERTING SCHEMAS TO COMPONENT MODELS,” filed on Oct. 5, 1998, by Neelakantan Sundaresan, which application is incorporated by reference herein. In one embodiment, the visual editor 118 can be used to automatically generate Java Beans.
CONCLUSION
[0172] This concludes the description of the preferred embodiment of the invention. The following describes some alternative embodiments for accomplishing the present invention. For example, any type of computer, such as a mainframe, minicomputer, or personal computer, could be used to implement the present invention. In addition, the present invention is not limited by specific document or programming languages, and could comprise languages other than XML and Java. For example, the present invention could also be used with HTML, SGML, NetRexx, VisualBasic Script, XML, Perl, C, C++, Cobol, etc.
[0173] In summary, the present invention discloses a method, apparatus, and article of manufacture for automatically generating a visual editor from an eXtensible Markup Language (XML) schema and then using the visual editor to edit the data contained in corresponding XML documents. The entities within an XML schema are mapped to components of the visual editor, such as forms, widgets, etc., that are generated as class specifications. These class specifications can be customized through the use of a customization specification file, as desired. The class specifications are then instantiated as objects in a Java Virtual Machine to perform the functions of the visual editor.
[0174] The foregoing description of the preferred embodiment of the invention has been presented for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise form disclosed. Many modifications and variations are possible in light of the above teaching. It is intended that the scope of the invention be limited not by this detailed description, but rather by the claims appended hereto.
Claims
What is claimed is:
1. A computer-implement method for generating a document editor, comprising:
(a) generating one or more class specifications in the computer from a schema for the document, wherein the class specifications identify user interface components of the editor corresponding to entities defined in the schema; and
(b) instantiating one or more objects in the computer from the class specifications to invoke the editor.
2. The method of claim 1 above, wherein the documents are eXtensible Markup Language (XML) documents and the schemas are XML schemas.
3. The method of claim 2 above, wherein the schemas are selected from a group including Document Type Definition (DTD) schemas, Document Content Definition (DCD) schemas, and XSchema schemas.
4. The method of claim 1 above, wherein the class specifications comprise Java class specifications.
5. The method of claim 1 above, wherein the generating step further comprises converting an entity defined in the schema into the class specification.
6. The method of claim 1 above, wherein the generating step further comprises the step of generating the class specifications in the computer from the schemas and one or more optional customization specifications.
7. The method of claim 6 above, wherein the optional customization specifications define what class names to generate for each entity defined in the schema.
8. The method of claim 1 above, wherein the class specifications include one or more specifications selected from a group comprising (1) a visual editor class specification, (2) a content implementation class specification, and a handler class specification.
9. The method of claim 1 above, further comprising mapping the entities defined in the schema to components of the editor.
10. The method of claim 1 above, wherein the entities are selected from a group comprising elements and attributes of elements.
11. The method of claim 10 above, wherein the attribute has a declaration selected from a group comprising mandatory, optional, and fixed value.
12. The method of claim 11 above, further comprising accepting user input for attributes having a mandatory declaration.
13. The method of claim 11 above, further comprising accepting user input for attributes having an optional declaration.
14. The method of claim 11 above, further comprising entering values from the schema for attributes having a fixed value declaration.
15. The method of claim 10 above, further comprising validating values entered for the attribute.
16. The method of claim 1 above, wherein the class specifications include at least one function for validating at least one entity defined in the schema.
17. The method of claim 1 above, wherein the generating step further comprises the step of generating the class specifications from a regular expression language comprising one or more declarations of elements enclosed within an element.
18. The method of claim 17 above, wherein the regular expression language includes one or more regular expression operators selected from a group comprising:
(1) a “zero or more” operator,
(2) a “one or more” operator,
(3) a “one or the other” operator,
(4) a “one followed by the other” operator,
(5) a “zero or one” operator,
(6) a “grouping” operator, and
(7) an “any” operator.
19. The method of claim 18 above, wherein the class specifications define one or more widgets that are associated with each of the operators.
20. The method of claim 1 above, wherein the class specifications define at least one widget associated with an entity in the schema.
21. The method of claim 1 above, further comprising identifying specific widget implementations for use with the editor.
22. The method of claim 1 above, further comprising customizing the editor for use with different regular expression operators.
23. The method of claim 1 above, further comprising attempting to solve correctness, optimization, or aesthetics related issues when generating the visual editor from the schema.
24. A computer-implemented apparatus for generating a document editor, comprising:
(a) a computer; and
(b) an editor maker, executed by the computer, for generating one or more class specifications in the computer from a schema for the document, wherein the class specifications identify user interface components of the editor corresponding to entities defined in the schema, and for instantiating one or more objects in the computer from the class specifications to invoke the editor.
25. The apparatus of claim 24 above, wherein the documents are eXtensible Markup Language (XML) documents and the schemas are XML schemas.
26. The apparatus of claim 25 above, wherein the schemas are selected from a group including Document Type Definition (DTD) schemas, Document Content Definition (DCD) schemas, and XSchema schemas.
27. The apparatus of claim 24 above, wherein the class specifications comprise Java class specifications.
28. The apparatus of claim 24 above, wherein the means for generating further comprises means for converting an entity defined in the schema into the class specification.
29. The apparatus of claim 24 above, wherein the means for generating further comprises means for generating the class specifications in the computer from the schemas and one or more optional customization specifications.
30. The apparatus of claim 29 above, wherein the optional customization specifications define what class names to generate for each entity defined in the schema.
31. The apparatus of claim 24 above, wherein the class specifications include one or more specifications selected from a group comprising (1) a visual editor class specification, (2) a content implementation class specification, and a handler class specification.
32. The apparatus of claim 24 above, further comprising means for mapping the entities defined in the schema to components of the editor.
33. The apparatus of claim 24 above, wherein the entities are selected from a group comprising elements and attributes of elements.
34. The apparatus of claim 33 above, wherein the attribute has a declaration selected from a group comprising mandatory, optional, and fixed value.
35. The apparatus of claim 34 above, further comprising means for accepting user input for attributes having a mandatory declaration.
36. The apparatus of claim 34 above, further comprising means for accepting user input for attributes having an optional declaration.
37. The apparatus of claim 34 above, further comprising means for entering values from the schema for attributes having a fixed value declaration.
38. The apparatus of claim 33 above, further comprising means for validating values entered for the attribute.
39. The apparatus of claim 24 above, wherein the class specifications include at least one function for validating at least one entity defined in the schema.
40. The apparatus of claim 24 above, wherein the means for generating further comprises means for generating the class specifications from a regular expression language comprising one or more declarations of elements enclosed within an element.
41. The apparatus of claim 40 above, wherein the regular expression language includes one or more regular expression operators selected from a group comprising:
(1) a “zero or more” operator,
(2) a “one or more” operator,
(3) a “one or the other” operator,
(4) a “one followed by the other” operator,
(5) a “zero or one” operator,
(6) a “grouping” operator, and
(7) an “any” operator.
42. The apparatus of claim 41 above, wherein the class specifications define one or more widgets that are associated with each of the operators.
43. The apparatus of claim 24 above, wherein the class specifications define at least one widget associated with an entity in the schema.
44. The apparatus of claim 24 above, further comprising means for identifying specific widget implementations for use with the editor.
45. The apparatus of claim 24 above, further comprising means for customizing the editor for use with different regular expression operators.
46. The apparatus of claim 24 above, further comprising means for attempting to solve correctness, optimization, or aesthetics related issues when generating the visual editor from the schema.
47. An article of manufacture embodying logic for performing a method for generating a document editor for use in an object-oriented computer system, the method comprising the steps of:
(a) generating one or more class specifications from a schema for the document, wherein the class specifications identify user interface components of the editor corresponding to entities defined in the schema; and
(b) instantiating one or more objects from the class specifications to invoke the editor.
48. The method of claim 47 above, wherein the documents are eXtensible Markup Language (XML) documents and the schemas are XML schemas.
49. The method of claim 48 above, wherein the schemas are selected from a group including Document Type Definition (DTD) schemas, Document Content Definition (DCD) schemas, and XSchema schemas.
50. The method of claim 47 above wherein the class specifications comprise Java class specifications.
51. The method of claim 47 above, wherein the generating step further comprises converting an entity defined in the schema into the class specification.
52. The method of claim 47 above, wherein the generating step further comprises the step of generating the class specifications in the computer from the schemas and one or more optional customization specifications.
53. The method of clam 52 above, wherein the optional customization specifications define what class names to generate for each entity defined in the schema.
54. The method of claim 47 above, wherein the class specifications include one or more specifications selected from a group comprising (1) a visual editor class specification, (2) a content implementation class specification, and a handler class specification.
55. The method of claim 47 above, further comprising mapping the entities defined in the schema to components of the editor.
56. The method of claim 47 above, wherein the entities are selected from a group comprising elements and attributes of elements.
57. The method of claim 56 above, wherein the attribute has a declaration selected from a group comprising mandatory, optional, and fixed value.
58. The method of claim 57 above, further comprising accepting user input for attributes having a mandatory declaration.
59. The method of claim 57 above, further comprising accepting user input for attributes having an optional declaration.
60. The method of claim 57 above, further comprising entering values from the schema for attributes having a fixed value declaration.
61. The method of claim 56 above, further comprising validating values entered for the attribute.
62. The method of claim 47 above, wherein the class specifications include at least one function for validating at least one entity defined in the schema.
63. The method of claim 47 above, wherein the generating step further comprises the step of generating the class specifications from a regular expression language comprising one or more declarations of elements enclosed within an element.
64. The method of claim 63 above, wherein the regular expression language includes one or more regular expression operators selected from a group comprising:
(1) a “zero or more” operator,
(2) a “one or more” operator,
(3) a “one or the other” operator,
(4) a “one followed by the other” operator,
(5) a “zero or one” operator,
(6) a “grouping” operator, and
(7) an “any” operator.
65. The method of claim 64 above, wherein the class specifications define one or more widgets that are associated with each of the operators.
66. The method of claim 47 above, wherein the class specifications define at least one widget associated with an entity in the schema.
67. The method of claim 47 above, further comprising identifying specific widget implementations for use with the editor.
68. The method of claim 47 above, further comprising customizing the editor for use with different regular expression operators.
69. The method of claim 47 above, further comprising attempting to solve correctness, optimization, or aesthetics related issues when generating the visual editor from the schema.
Patent Citations (10)
| Patent | Date | Inventor | Cited By |
|---|---|---|---|
| US5185867(A) | 1993-02-01 | Ito | Applicant |
| US5493678(A) | 1996-02-01 | Arcuri et al. | Applicant |
| US5617578(A) | 1997-04-01 | Kroll et al. | Applicant |
| US5640566(A) | 1997-06-01 | Victor et al. | Applicant |
| US5915259(A) | 1999-06-01 | Murata | Examiner |
| US5920879(A) | 1999-07-01 | Kyojima et al. | Examiner |
| US5924101(A) | 1999-07-01 | Bach et al. | Examiner |
| US5926823(A) | 1999-07-01 | Okumura et al. | Examiner |
| US6272673(B1) | 2001-08-01 | Dale et al. | Examiner |
| US6279015(B1) | 2001-08-01 | Fong et al. | Examiner |
Non-Patent Literature (16)
- Alschuler, Liora, “SoftQuad previews XMetal Prototype”, May 1998, The Seybold Report on Internet Publishing, vol 2, No. 9.Examiner
- XMetal 1.0, Available at: http://www.webreference.com/html/watch/xmetal.Examiner
- Softquad HotMetalPro 3.0 User's Manual, 1996, pp. 77-83.Examiner
- W3C Extensible Markup Language (XML) 1.0, Feb. 1998, available: http://www.w3.org/TR/1998/REC-xml-19980210.Examiner
- W3C Document Content Description for XML, Jul. 1998, http://www.w3.org/TR/NOTE-dcd.Examiner
- W3C Extensible Markup Language (XML) 1.0, Feb. 1998, available: http://www.w3.org/TR/1998/REC-xml-19980210.Examiner
- W3C Document Content Description for XML, Jul. 1998, http://www.w3.org/TR/NOTE-dcd.Examiner
- Bray, “Extensible Markup Language (XML): Part I. Syntax,” http://www.w3.org/TR/WD-xml-lang-970331, Mar. 31, 1997.Examiner
- Kirsanov, “XML DTDs and Valid XML Documents,” http://www.webreference.com/dlab/books/html/38-3.html, Jun. 16, 1997.Examiner
- Bray, “Document Content Description for XML,” http://www.w3.org/TR/NOTE-dcd, Jul. 31, 1998.Examiner
- Sitt Sen Chok and Kim Marriot, Automatic Construction of User Interfaces from Constraint Multiset Grammars, 11th IEEE International Symposium of Visual Languages, Darmstadt, Germany, Sep. 5-9, 1995, pp. 242-249.Applicant
- Susan M. Uskudarli and T.M. Dines, “Towards a Visual Programming Environment Generator from Algebraic Specifications”, 11th IEEE Interntional Symposium on Visual Languages, Darmstadt, Germany, Sep.5-9, 1995, pp. 234-241.Applicant
- Jun'ichi Miyao and Shi-kuo Chang, “A Framework of a Visual Language with Dynamic Specification”, 11th IEEE International Symposium on Visual Languages, Darmstadt, Germany, Sep. 5-9, 1995, pp. 140-147.Applicant
- Margaret Burnett and Marla J. Baker, “A Classification System for Visual Programming Languages”, Technical Report 93-60-14, Department of Computer Science, Oregon State University Colorado, USA. rev. Jun. 16, 1994, pp. 2-20.Applicant
- Louis Weitzman and Kent Wittenburg, “Automatic Presentation of Multimedia Documents Using Relational Grammars”, in Proceedings of ACM Multimedia '94 (San Francisco, CA, Oct. 15-20, 1994), New York: ACM, 1995, pp. 443-451.Applicant
- Paul Prescod, “Formalizing SGML and XML Instances and Schemata with Forest Automata Theory”, (undated internet publication from http://www.prescod.net/forest/shorttut) 9pp. and relevant bibliography page from OASIS: The SGML/XML Web Page referencing Draft technical paper authored by Paul Prescod entitled: Formalizing XML and SGML Instance with Forest Automata Theory, Waterloo, Ontario: University of Waterloo, Department of Computer Science, May 5, 1998, 1pp.Applicant