Customization creation and update for multi-layer XML customization

• US 8,966,465 B2
• Filed: 02/12/2008
• Issued: 02/24/2015
• Est. Priority Date: 02/12/2008
• Status: Active Grant

• Current Assignee: Oracle International Corporation (Oracle Corporation)
• Original Assignee: Oracle International Corporation (Oracle Corporation)
• Inventors: Konduri, Gangadhar
• Primary Examiner(s): Wong, Don
• Assistant Examiner(s): Aguilera, Todd
• Application Number:
  US12/029,615
• Publication Number:
  US 20090204943A1
• Time in Patent Office: 2,569 Days
• Field of Search: None
• US Class Current: 717/168
• CPC Class Codes: G06F 8/51 Source to source
• CPC Class Codes: G06F 8/71 Version control security arrangements therefor G06F21/57; Configuration management

Abstract

Embodiments of the present invention provide techniques for customizing aspects of a metadata-driven software application. In particular, embodiments of the present invention provide (1) a self-contained metadata engine for generating customized metadata documents from base metadata documents and customizations; (2) a customization syntax for defining customizations; (3) a customization creation/update component for creating and updating customizations; (4) a customization restriction mechanism for restricting the creation of new customizations by specific users or groups of users; and (5) memory and caching optimizations for optimizing the storage and lookup of customized metadata documents.

Claims

1. A method for customizing a software application, the method comprising:

retrieving a first metadata document via a software component configured to enable creation and/or update of XML documents, wherein;

the first metadata document is based at least in part on Extensible Markup Language (XML);

content of the first metadata document at least partially defines one or more characteristics of at least a portion of a software application; and

at least one of the one or more characteristics corresponds to one or more of content, behavior, and/or appearance;

in response to retrieving the first metadata document, creating in memory, a metadata object to represent the first metadata document;

receiving, from the software component, one or more modifications to the metadata object, wherein the one or more modifications;

are expressed as method calls performed on the metadata object; and

comprise a modification to a source element in the first metadata document;

translating the one or more method calls into one or more customization instructions, wherein the one or more customization instructions, when executed, cause at least the portion of the software application to change at least one of the one or more characteristics, the translating comprising;

checking whether each of a plurality of elements is associated with a respective unique identifier, the plurality of elements comprising a sibling element, a parent element, and the source element;

selecting a unique identifier based on a predetermined order comprising determining whether the source element is associated with a globally unique identifier and, if the source element is not associated with the globally unique identifier, determining whether the source element is associated with a locally unique identifier; and

generating at least one customization instruction of the one or more customization instructions to reference the modification to the source element based at least in part on the checking and the selecting; and

storing in a second metadata document the one or more customization instructions as a first customization for the first metadata document, wherein the first customization is stored separately from the first metadata document.

2. The method of claim 1, wherein the software component is an XML editor included in the software application, and wherein the steps of retrieving the first metadata document, receiving the one or more modifications, translating the one or more method calls, and storing the one or more customization instructions are performed at runtime of the software application.

3. The method of claim 1, wherein the software component is an XML editor included in a software development tool, and wherein the steps of retrieving the first metadata document, receiving the one or more modifications, translating the one or more method calls, and storing the one or more customization instructions are performed at design time of the software application.

4. The method of claim 1, wherein the first metadata document is retrieved as a Document Object Model (DOM) object, and wherein the one or modifications are expressed as standard DOM method calls.

5. The method of claim 1, wherein the first metadata document is retrieved as a Java Architecture for XML Bindings (JAXB) representation, and wherein the one or modifications are expressed as standard JAXB method calls.

6. The method of claim 1, wherein a plurality of customization levels are associated with the first metadata document, and wherein the first customization corresponds to a tip customization level, the tip customization level being that last customization level in the plurality of customization levels to be applied to the first metadata document.

7. The method of claim 6, wherein if a customization already exists for the tip customization level, the one or more customization instructions are added to the existing customization.

8. The method of claim 6, wherein if a customization does not already exist for the tip customization level, the one or more customizations are added to a newly created customization.

9. The method of claim 1, wherein, if the source element is associated with the globally unique identifier, the modification to the source element is translated into the at least one customization instruction that references the globally unique identifier for the source element.

10. The method of claim 1, wherein if the source element is associated with the locally unique identifier but not the globally unique identifier, the modification to the source element is translated into the at least one customization instruction that references the locally unique identifier for the source element.

11. The method of claim 1, wherein if the source element is not associated with the globally unique identifier or the locally unique identifier, the modification to the source element is translated into the at least one customization instruction that references an XPath expression pointing to the source element.

12. The method of claim 1, wherein the one or more customization instructions are optimized prior to being stored.

13. The method of claim 12, wherein the one or more customization instructions include a first modification instruction to modify a source element and second modification instruction to modify the source element, and wherein the one or more customization instructions are optimized by combining the first and second modification instructions into a single modification instruction.

14. The method of claim 13, wherein the first modification instruction corresponds to a first modification performed during a first runtime session of the software application, and wherein the second modification instruction corresponds to a second modification performed during a second runtime session of the software application.

15. The method of claim 12, wherein the one or more customization instructions include an insert instruction to insert a new element and a modification instruction to modify a portion of a subtree of the new element, and wherein the one or more customization instructions are optimized by combining the insert instruction and the modification instruction into a single insert instruction.

16. The method of claim 12, wherein the one or more customization instructions include an insert instruction to insert a new element and a replace instruction to delete the new element, and wherein the one or more customization instructions are optimized by removing the insert instruction and the replace instruction.

17. The method of claim 12, wherein the first customization is configured to be applied on top of a plurality of additional customizations, wherein a customization instruction in the one or more customization instructions is only applicable to a single customization in the plurality of additional customizations, and wherein the customization instruction is preserved when the one or more customizations are optimized.

18. A system for customizing a software application, the system comprising:

one or more processors;

a memory coupled to the one or more processors;

a first component including a user interface configured to enable creation and/or update of XML documents, wherein a first metadata document is retrieved as a metadata object that is stored in the memory, wherein;

the first metadata document is based at least in part on Extensible Markup Language (XML);

content of the first metadata document at least partially defines one or more characteristics of at least a portion of a software application; and

at least one of the one or more characteristics corresponds to one or more of content, behavior, and/or appearance; and

a second component configured to;

receive, from the software component, one or more modifications to the metadata object, wherein;

the one or more modifications are expressed as method calls performed on the metadata object; and

comprise a modification to a source element in the first metadata document;

translate the one or more method calls into one or more customization instructions, wherein the one or more customization instructions, when executed, cause at least the portion of the software application to change at least one of the one or more characteristics, the translating comprising;

checking whether each of a plurality of elements is associated with a respective unique identifier, the plurality of elements comprising a sibling element, a parent element, and the source element;

selecting a unique identifier based on a predetermined order comprising determining whether the source element is associated with a globally unique identifier and, if the source element is not associated with the globally unique identifier, determining whether the source element is associated with a locally unique identifier; and

generating at least one customization instruction of the one or more customization instructions to reference the modification to the source element based at least in part on the checking and the selecting; and

store in a second metadata document the one or more customization instructions as a first customization for the first metadata document, wherein the first customization is stored separately from the first metadata document.

19. A non-transitory machine-readable medium for a computer system, the non-transitory machine-readable medium having stored thereon a series of instructions which, when executed by a processing component, cause the processing component to customize a software application by:

retrieving a first metadata document via a software component configured to enable creation and/or update of XML documents, wherein;

the first metadata document is based at least in part on Extensible Markup Language (XML);

content of the first metadata document at least partially defines one or more characteristics of at least a portion of a software application; and

at least one of the one or more characteristics corresponds to one or more of content, behavior, and/or appearance;

in response to retrieving the first metadata document, creating in memory, a metadata object to represent the first metadata document;

receiving, from the software component, one or more modifications to the metadata object, wherein the one or more modifications;

are expressed as method calls performed on the metadata object; and

comprise a modification to a source element in the first metadata document;

translating the one or more method calls into one or more customization instructions, wherein the one or more customization instructions, when executed, cause at least the portion of the software application to change at least one of the one or more characteristics, the translating comprising;

checking whether each of a plurality of elements is associated with a respective unique identifier, the plurality of elements comprising a sibling element, a parent element, and the source element;

selecting a unique identifier based on a predetermined order comprising determining whether the source element is associated with a globally unique identifier and, if the source element is not associated with the globally unique identifier, determining whether the source element is associated with a locally unique identifier; and

generating at least one customization instruction of the one or more customization instructions to reference the modification to the source element based at least in part on the checking and the selecting; and

storing in a second metadata document the one or more customization instructions as a first customization for the first metadata document, wherein the first customization is stored separately from the first metadata document.