US 7,636,722 B2Grant

System and method for describing application extensions in XML

Issue Date:2009-12-22

•15 Claims

•3 Drawing Sheets

Abstract

A system and method for an extendable application framework, comprising a user interface, at least one service, at least one extension, wherein one of the at least one extensions can provide access to functionality in the user interface, and wherein one of the at least one services can provide access to functionality in one of the at least one extensions.

Metadata

Assignee

BEA Systems, Inc.

Inventors

Ross Bunkerr
Brendan MacLean
Britton W. Piehler

Application Information

Application Number:US 10/786,772

Filing Date:2004-02-25

Priority Date:2003-02-28

Art Unit:2167

Classifications

IPC:

G06F17/00G06F7/00

Patent Drawings (3 sheets)

Description

Claim of Priority

[0001] This application claims priority from the following application, which is hereby incorporated by reference in its entirety:

[0002] EXTENSIBLE INTERACTIVE SOFTWARE DEVELOPMENT ENVIRONMENT, U.S. Application No. 60/451,340, Inventors: Ross Bunker et al., filed on Feb. 28, 2003.

Cross-Reference to Related Applications

[0003] This application is related to the following co-pending applications which are each hereby incorporated by reference in their entirety:

[0004] SYSTEM AND METHOD FOR MULTI-LANGUAGE EXTENSIBLE COMPILER FRAMEWORK, U.S. application Ser. No. 10/782,715, Inventors: Kevin Zatloukal, filed on Feb. 19, 2004.

[0005] SYSTEMS AND METHODS FOR MULTI-LANGUAGE DEBUGGING, U.S. Application No. 60/450,014, Inventors: William Pugh et al., filed on Feb. 26, 2003.

[0006] SYSTEMS AND METHODS FOR MULTI-VIEW DEBUGGING ENVIRONMENT, U.S. Application No. 60/451,368, Inventors: Josh Eckels et al., filed on Mar. 1, 2003.

[0007] SYSTEMS AND METHODS FOR TYPE-INDEPENDENCE SOURCE CODE EDITING, U.S. Application No. 60/449,984, Inventors: Britt Piehler et al., filed on Feb. 26, 2003.

[0008] MULTI-THREADED MULTI-LANGUAGE COMPILER FRAMEWORK, U.S. Application No. 60/488,629, Inventors: Kevin Zatloukal, filed on Jul. 19, 2003.

[0009] EXTENDABLE COMPILER FRAMEWORK, U.S. application Ser. No. 10/951,315, Inventors: Kevin Zatloukal, filed on Sep. 27, 2004.

Copyright Notice

[0010] A portion of the disclosure of this patent document contains material which is subject to copyright protection. The copyright owner has no objection to the facsimile reproduction by anyone of the patent document or the patent disclosure, as it appears in the Patent and Trademark Office patent file or records, but otherwise reserves all copyright rights whatsoever.

Field of the Disclosure

[0011] The present invention disclosure relates to an extensible interactive development environment.

Background

[0012] Typical interactive applications provide for operating on a fixed set of file types where the file contains a single type of content. Increasingly, applications require the use of files that contain many different kinds of interleaved content or code in different programming languages. Moreover, the frequency with which new types of content and programming languages become available is increasing rapidly. These factors require a new kind of interactive application that can be dynamically configured.

Brief Description of the Drawings

[0013] FIG. 1 is an exemplary illustration of an interactive application extension component in an embodiment.

[0014] FIG. 2 is an exemplary illustration of a generic interactive application in an embodiment.

[0015] FIG. 3 is an exemplary illustration of services in an embodiment.

Detailed Description

[0016] The invention is illustrated by way of example and not by way of limitation in the figures of the accompanying drawings in which like references indicate similar elements. It can be noted that references to “an” or “one” embodiment in this disclosure are not necessarily to the same embodiment, and such references mean at least one.

[0017] In one embodiment, a generic interactive application (GIA) can be dynamically configured and functionally extended by defining it in terms of interchangeable building blocks called extensions. By way of a non-limiting example, extensions can provide new graphical user interface (GUI) components, new project/file types, and new application functionality. An example of a GIA is WebLogic® Workshop, an interactive software development environment available from BEA Systems, Inc. of San Jose, Calif.

[0018] FIG. 1 is an exemplary illustration of an interactive application extension component in an embodiment. In one embodiment, an extension can include an XML (Extensible Markup Language) descriptor 100 (“extension.xml”), an optional set of classes defined in an object-oriented programming language (e.g., Java™, C#, C++, or another suitable language) 102 that can expose interfaces and consume services, and optional resources 104 (e.g., images, text strings, sounds, and any other suitable resource). An extension's components can be packaged together in an archive as a file (e.g., a JAR Java™ Archive), a directory or any combination thereof. For complex extensions, a JAR file can contain the code that is the extension's implementation, a manifest file which defines the class path, and attributes that reference dependent JARs that need to be available at run time by the extension.

[0019] FIG. 2 is an exemplary illustration a generic interactive application in an embodiment. Although this diagram depicts components as logically separate, such depiction is merely for illustrative purposes. It will be apparent to those skilled in the art that the components portrayed in this figure can be arbitrarily combined or divided into separate software, firmware and/or hardware. Furthermore, it will also be apparent to those skilled in the art that such components, regardless of how they are combined or divided, can execute on the same computing device or can be distributed among different computing devices connected by one or more networks or other suitable communication means.

[0020] In one embodiment, a GIA 204 includes a user interface (UI) 200 and a set of services 206. The GIA and its services can make use of and extend the functionality of, the UI. By way of a non-limiting example, the UI can include one or more of the following: 1) a graphical user interface (GUI) (e.g., rendered with Hypertext Markup Language); 2) an ability to respond to sounds and/or voice commands; 3) an ability to respond to input from a remote control device (e.g., a cellular telephone, a PDA, or other suitable remote control); 4) an ability to respond to gestures (e.g., facial and otherwise); 5) an ability to respond to commands from a process on the same or another computing device; and 6) an ability to respond to input from a computer mouse and/or keyboard. This disclosure is not limited to any particular UI. Those of skill in the art will recognize that many other UI embodiments are possible and fully within the scope and spirit of this disclosure.

[0021] Each service can be associated with an extension 208. An extension can expose and consume the services of other extensions. In one embodiment, a service is a public interface that has an implementation and provides access to functionality in an extension. An extension may declare services that it implements. For instance, a debugger extension can define a debugger service that, among other things, provides a method for setting a breakpoint in a program source file. Services can be consumed by an extension's classes and can be registered with the system using tags in the extensions.xml file.

[0022] In one embodiment, at startup a GIA run-time component can read all extension.xml files, batch them together and ensure that the services requested by each are available. Extensions may define handlers for an <extension-xml> tag found in the extension.xml file. Handlers are associated with a particular id attribute. In one embodiment, an extension.xml file can be scanned for code fragments contained within a <extension-xml> tag and those fragments can be passed to handlers defined for the particular id attribute at run-time. This mechanism allows extensions to create extendable infrastructure in which other extensions can participate. In one embodiment, a handler class can be instantiated by the GIA and is responsible for parsing XML contained in a fragment.

[0023] FIG. 3 is an exemplary illustration of a services in an embodiment. In one embodiment and by way of a non-limiting example, services can include: a resource service 300 to provide access to resources such as icons, images, and localizable strings; a frame service 302 to allow extensions to specify a GUI docking layout; a file service 304 that can provide a set of services for file system access and manipulation; a server service (not shown) to provide a set of services for accessing a server; a document services 306 to provide a means to supply an abstract document interface for files that are part of the application project; and an action service 308 to provide methods for adding and manipulating menu and toolbar items.

[0024] In one embodiment, the root element for the XML in the extension.xml file is <extension-definition>. An <extension-definition> element may have one or more <extension-xml> elements as children, each describing a different extension. The particular type of extension can be described by setting the value of the <extension-xml> element's id attribute. Exemplary values for the id attribute are given in Table 1.

[0025] By way of a non-limiting example, the following XML describes an extension that adds three GUI panels for setting properties in a GIA: one for a Project Properties dialog, one for an Application (workspace) Properties dialog, and one for a GIA Properties dialog:

[0026]


	<extension-definition>
	<extension-xml id=“urn:com:settings”>
	<project-preferences>
	<panel
	label=“%strings.workshop.debugger.extension.debuggerTab%”
	class=“workshop.debugger.ui.DebuggerPreferencesPanel”/>
	</project-preferences>
	<workspace-preferences>
	<panel
	label=“%strings.workshop.debugger.extension.debugSourcepath%”
	class=“workshop.debugger.ui.DebugSourcepathPreferences”
	priority=“40”/>
	</workspace-preferences>
	<GIA-preferences>
	<panel
	label=“%strings.workshop.debugger.extension.debuggerViews%”
	class=“workshop.debugger.ui.ExpressionViewPreferences”/>
	</GIA-preferences>
	</extension-xml>
	</extension-definition>
Syntax:
	<extension-xml id=“urnForExtensionType”>
	<!-- Extension-specific XML. -->
	</extension-xml>
Parents:
	<extension-definition>
Children:
	<file-extension>, <create-template>, <project-attributes>

[0027] Multiple <extension-xml> elements may occur as children of the <extension-definition> element, which is the root element of an extension.xml file.

[0028]

TABLE 1

Exemplary Extension Types in an Embodiment
EXTENSION	EXTENSION
TYPE	DESCRIPTION	ID ATTRIBUTE SET TO

Document	Defines support	urn:com:document
	for a document
	type.
Actions	Defines menus,	urn:com:actions
	popups, and toolbars,
	along with their
	associated behavior.
Encoding	Defines support	urn:com:encoding
	for a file type.
Frame	Defines a frame	urn:com:frame
	view (e.g., a
	dockable window).
Help	Defines paths to	urn:com:help
	search for help
	topics when
	context-sensitive
	help is requested.
Settings	Defines a new	urn:com:settings
	properties panel.
Project	Defines a new	urn:com:project
	project type.
Debugger	Defines a new	urn:com:debugExpressionViews
	debugger variable
	view.

[0029] In one embodiment, the <action-ui> element can specify UI details for actions in a GIA. In general, this element can be used for defining new UI elements (e.g., menu and popup commands, toolbar buttons, etc.) associated with actions. By way of a non-limiting example:

[0030]


	<extension-xml>
	<action-ui>
	<action-group>
	<menu>
	<menu>
	<action-group>
	<popup>
	<action-group>
	<toolbar>
	<action-group>
	<action-set>
	<action>
	<location>
	Syntax:
	<action-ui>
	<!-- Children that describe specific actions or groups of
	actions. -->
	</action-ui>
	Parents:
	<extension-xml>
	Children:
	<action-group>, <menu>, <toolbar>, <popup>

[0031] In one embodiment, a <menu> element can be used to specify a UI menu item. Attributes for this element are provided in Table 3. By way of a non-limiting example:

[0032]


	<extension-xml>
	<action-ui>
	<action-group>
	<menu>
	<extension-xml>
	<action-ui>
	<menu>
	Syntax:
	<menu
	id=“nameToUseInContextPaths”
	label=“labelInGIA”
	[path=“uiContextPath”]
	priority=“priorityNumber”
	>
	Parents:
	<action-ui>, <action-group>
	Children:
	<action-group>

[0033]

TABLE 2

Exemplary <menu> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

id	The name of this menu item. The full context for
	this action item can be determined by combining
	this attribute with the path attribute.
label	The text to display for the menu in the GIA. A
	programmer can also indicate the action's default
	key-stroke accelerator by preceding it with
	‘@’. If the label begins and ends with
	the ‘%’ escape character, the label can be
	interpreted as a Java ™ PropertyBundle path.
	The label (including accelerator) will be
	determined by using the ResourceSvc to load
	the property named by the path. Place ‘&’
	before the character which is to be the menu mnemonic.
path	Optional string. A path through the UI hierarchy,
	followed by the final group in the last menu. For
	example, “menu/services/controls/add” would
	locate an action in the “add” group, of the
	“controls” sub-menu, of the “services”
	menu, in the main menu. Use the id attribute to
	specify the name of the menu item beneath “add”.
priority	This item's GUI priority.

[0034] In one embodiment, <action-group> adds a new action group to a ‘View’ menu. Action groups (and all other UI elements) are sorted with lowest priority numbers first. An action group is simply a place to put actions. If no actions are put in the action group, then it will not be visible in the UI. A separator can be shown between each visible command group. In one embodiment, a default priority can be provided. In another embodiment, a priority can be specified.

[0035]


	Syntax:
	<action-group priority=“priorityNumber”>
	Parents:
	<action-ui>
	Children:
	<menu>, <action-ref>

[0036] In one embodiment, a <popup> element specifies a UI popup window or menu. The <popup> element's attributes are provided in Table 3.

[0037]


	<extension-xml>
	<action-ui>
	<popup>
	Syntax:
	<popup
	id=“nameToUseInContextPaths”
	path=“uiContextPath”
	>
	Parents:
	<action-ui>
	Children:
	<action-group>

[0038]

TABLE 3

Exemplary <popup> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

id	The name of this item. The full context for this action
	item can be determined by combining this attribute with
	the path attribute.
path	A path through the UI hierarchy, followed by the final
	group in the last menu. For example,
	“menu/services/controls/add” would locate an action
	in the “add” group, of the “controls”
	sub-menu, of the “services” menu, in the main
	menu. Use the id attribute to specify the name of
	the menu item beneath “add”.

[0039] In one embodiment, a <toolbar> element can specify a UI toolbar or toolbar button. Its attributes are specified in Table 4.

[0040]


	Syntax:
	<toolbar
	id=“nameToUseInContextPaths”
	label=“labelInGIA”
	[path=“uiContextPath”]
	priority=“priorityNumber”
	>
	Parents:
	<action-ui>
	Children:
	<action-group>

[0041]

TABLE 4

Exemplary <toolbar> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

id	The name of this item. The full context for this
	action item can be determined by combining this
	attribute with the path attribute.
label	The text to display for the menu in the GIA. A
	programmer can also indicate the action's default
	key-stroke accelerator by preceding it with
	‘@’. If the label begins and ends with
	the ‘%’ escape character, the label is
	interpreted as a Java PropertyBundle path. The
	label (including accelerator) will be determined
	by using the ResourceSvc to load the property
	named by the path. Place ‘&’ before
	the character which is to be the menu mnemonic.
path	Optional string. A path through the UI hierarchy,
	followed by the final group in the last menu. For
	example, “menu/services/controls/add” would
	locate an action in the “add” group, of the
	“controls” sub-menu, of the “services”
	menu, in the main menu. Use the id attribute to
	specify the name of the menu item beneath “add”.
priority	Required int.

[0042] In one embodiment, an <action-set> element can specify actions in an extension. It may occur multiple times as a child of <extension-xml>. Specific actions, such as a menu or popup command, or a toolbar button, are described by each <action> child element.

[0043]


	Syntax:
	<action-set
	scope=“classNameForView”
	extends=“classNameForExtendedView”
	>
	Parents:
	<extension-xml>
	Children:
	<action>

[0044]

TABLE 5

Exemplary <action-set> Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

scope	Optional string. The fully-qualified class name for
	a view (a document, document view or frame view) that
	is active in order for this action to be available.
	Default is global scope, meaning that the actions in
	this set may be accessible to the user regardless of
	the active view.
extends	Optional string. The fully-qualified class name for
	a view whose scope this action set extends. Extending
	an action-set of an existing scope adds all the
	actions of the base scope into the extending scope.

[0045] In one embodiment, an <action> element can specify a UI action, such as a menu or popup command, or a toolbar button. Attributes for this element are provided in Table 6.

[0046]


	Syntax:
	<action
	[class=“classNameForHandler”]
	[label=“menuText”]
	[tooltip=“tooltipText”]
	[icon=“pathToGifFile”]
	[id=“”]
	>
	Parents:
	<action-set>
	Children:
	<location>

[0047]

TABLE 6

Exemplary <action> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	Optional string. The fully-qualified class name for
	the class that defines this action. In one embodiment,
	the class can have a parameter-less constructor and
	implement an IAction interface. By way of a non-limiting
	example, this interface can be a fairly simple extension
	of Swing's own ActionListener interface. The interface
	can also implement a listener to allow the action to
	respond to property changes and update its state.
	IAction Method Summary:
	void actionPerformed(ActionEvent)
	Invoked when an action occurs.
	void propertyChange(PropertyChangeEvent)
	Updates the state of this action using the given
	property change event.
label	Optional string. The text to display for this action
	in menus. Place ‘&’ before the character which
	is to be the menu mnemonic. A programmer can also
	indicate the action's default key-stroke accelerator
	by preceding it with ‘@’. If the label begins and
	ends with the ‘%’ escape character, the label is
	interpreted as a Java PropertyBundle path. The label
	(including accelerator) will be determined by using
	the ResourceSvc to load the property named by the path.
tooltip	Optional string. The text to show as a tool tip
	for a toolbar, in status bar for menus, or in
	customization dialogs.
icon	Optional string. A path to an image resource to
	show on toolbars and menus.
id	Optional string.

[0048] In one embodiment, a <location> element specifies a location in a GIA user interface (such as an existing menu group) where an action can be placed. This element is provided as a convenience for simple cases. In general, a programmer can define new user interface for actions with <action-ui> elements.

[0049]


	Syntax:
	<location path=“path”>
	Parents:
	<action>
	Children:
	None.

[0050] In one embodiment, a <view> element allows the specification of new debugger variable view. The following non-limiting example uses the XmlExpressionView view implementation for a view of a string variable:

[0051]


	<extension-xml id=″urn:com:debugExpressionViews″>
	<view
	priority=″80″
	valueType=″java.lang.String″
	description=″View as XML″
	class=”workshop.debugger.ui.expressionview.XmlExpressionV
	iew”/>
	</extension-xml>
Syntax:
	<view
	class=″viewImplementation″
	description=″viewDescriptionInGIA″
	matchesNulls=″true \| false″
	priority=″rankingAmongViews″
	valueType=″typeWhoseDataThisIsAViewFor″
	>
Parents:
	<extension-xml>
Children:
	<view>

[0052]

TABLE 7

Exemplary <view> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	The fully-qualified name of the class that provides
	the custom view. In one embodiment, this class can
	implement an IDebugExpressionView interface. This
	interface is responsible for displaying, editing, and
	populating the children of an expression in locals
	and watch windows of a GIA debugger. Watch windows
	can add, remove, or completely specify which fields
	to show, and provide custom renderers and editors for its
	values.
	Implementing classes class can have a argument-less
	constructor, as they can be instantiated using
	Class.newInstance( ). Mappings between types
	and which views they should use can be specified in
	extension.xml.
	Views can also used to render the hovering value
	tooltip in the source editor when debugging. The
	default view is always used for these tooltips.
	When inserting a view, it can be first instantiated
	using Class.newInstance( ), then init( ) is called,
	and it is then added to its parent in the tree.
	If there are exceptions thrown when instantiating a
	debugger view, they can be logged to a file, and
	the matching view with the next highest priority
	can be instantiated. Common causes of problems
	include classpath issues that prevent the class
	from being found by the classloader, not having
	a public argument-less constructor, or having an
	exception thrown in the view's constructor.
description	The description to display for the view when the
	user right-clicks.
priority	A number indicating this view's ranking among views
	for variables of this type.
valueType	The fully-qualified name of the type to provide
	this view for.

[0053] In one embodiment, a <document-handler> element describes a document extension, with which a programmer can add to the GIA to support new document types. New document types may require a specific user interface (such as an icon) and behavior. The extension.xml file for a document extension can specify the class to use for handling the new type of document, the document's file extension, and so on.

[0054]


	Syntax:
	<document-handler
	class=“handlerClassName”
	icon=“pathToIcon”
	label=“descriptiveTextForDocumentType”
	>
	Parents:
	<extension-xml>
	Children:
	<file-extension>, <create-template>, <project-attributes>

[0055]

TABLE 8

Exemplary <document-handler> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	The fully-qualified name of the handler class for
	this document type. In one embodiment, the specified
	class can implement an IDocumentHandler interface.
	The IDocumentHandler is a basic interface that the
	document service can use to map a URI to an IDocument
	interface. Handlers are registered with the IDE at
	startup using extension.xml. The extension XML allows
	the specification of a set of project attributes that
	can be used to limit the scope of a document handler
	to specific sets of projects. Attributes may
	be required by the handler on the project that
	contains a document it opens.
icon	Path to an image that can be used to represent
	this file type. This will be used, for example,
	to allow the Application window to display an image
	next to the file name.
label	A plain text description of this file type. This
	will be used as explanatory text where appropriate.

[0056] In one embodiment, the <document-handler> element may have one or more <file-extension> child elements. These can be used to specify the extension of a file for which this document handler may be used. Attributes are discussed in Table 9.

[0057]


	Syntax:
	<file-extension
	priority=“prioritySetting”
	[handler=“handlerName”]
	>
	Parents:
	<document-handler>
	Children:
	None

[0058]

TABLE 9

Exemplary <file-extension> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

priority	The ranking of the handler for this file extension.
	The priority attribute captures a relative ranking
	of how well the handler understands this particular
	extension. A document service can use this to find
	a default handler for a given file extension. It will
	choose the handler with the highest priority. In the
	event of a tie, one of the handlers with the highest
	priority can be arbitrarily chosen.
	Possible values are: lowest, low, medium, high,
	highest, unknown and info-only. A value of
	“unknown” indicates that the handler can
	actually inspect the contents of the file in order
	to determine what priority it actually has. A value
	of “info-only” indicates that the handler does
	not possess any knowledge of the contents of the
	file, but merely provides an icon and description.
handler	Optional string. In one embodiment, an
	″unknown″ priority value indicates that the
	handler can actually inspect the contents of a file in
	order to determine what priority it actually has. By
	way of a non-limiting example, imagine a Dialog editor
	that understands files Java ™ files, but only if the
	class extends the JDialog class. If no ″highest″
	handler is available for a file at run time,
	″unknown″ handlers can be given the opportunity
	to inspect the file and return one of the six more
	specific priority values. The highest priority among
	the ″unknown″ type handlers and any remaining
	non-″highest″ handlers will be designated as the
	default handler for a file.

[0059] In one embodiment, a programmer will most often implement “highest” priority handlers, but a programmer may also have “low” and “medium” priority handlers. For example, the extension .java can have a high priority handler that handles JAVA files. However, the extension .jws is also a JAVA file. In the absence of a “highest” priority handler for it (in other words, the web services extension), the JAVA file handler can be able to also handle JWS files. Therefore, the JAVA file handler may declare itself to be a “low” priority handler for files with a jws extension.

[0060] In one embodiment, a <create-template> element can specify information used in a right-click UI menu and/or a New File dialog when creating a new file of this type.

[0061]


	Syntax:
	<create-template
	[id=“id”]
	priority=“priorityNumber”
	[createCategories=“fileCategories”]
	[label=“descriptiveText”]
	>
	Parents:
	<document-handler>
	Children:
	<description>

[0062]

TABLE 10

Exemplary <create-template> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

priority	A number indicating this handler's ranking for
	this file type.
label	A plain text description of this file type.
	This can be used as explanatory text where
	appropriate.
createCategories	Categories in the New File dialog under which
	this file type will appear. Make this value
	“ShortCut” to specify that the file
	type can appear on the right-click menu.
id	Optional string.

[0063] In one embodiment, a <description> element can be used to specify text that can appear for this file type in the New File dialog.

[0064]


	Syntax:
	<description>
	Description text that appears for file type in the New File
	dialog.
	</description>
	Parents:
	<create-template>.
	Children:
	None.

[0065] In one embodiment, an <file-encoding> element can be used to describe a file encoding extension. A programmer can use a file encoding extension to specify how a file can be handled when parsing. By way of a non-limiting example, if a programmer wanted files with an .htm extension to be treated by the GIA in the same way as files with an .html extension, the extension might look as follows:

[0066]


	<extension-xml>
	<file-encoding appliesTo=“htm” treatAs=“html”/>
	</extension-xml>
	Syntax:
	<file-encoding
	appliesTo=“handlerClassName”
	[class=“pathToIcon”]
	[treatAs=“descriptiveTextForDocumentType”]
	>
	Parents:
	<extension-xml>
	Children:
	None.

[0067]

TABLE 11

Exemplary <file-encoding> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

appliesTo	The extension or extensions for files this encoding
	extension applies to.
class	The fully-qualified name of a class to use for
	handling files with this extension.
treatAs	The extension of files whose handler can be used
	to handle files this encoding extension applies to.

[0068] In one embodiment, a <frame-view-set> can be used to specify one or more UI frame views. A programmer can use the <frame-view> element to define certain appearance and behavior properties for the view in the GIA.

[0069]


	Syntax:
	<frame-view-set>
	<!-- frame-view elements to specify new frames -->
	</frame-view-set>
	Parents:
	<extension-xml>
	Children:
	<frame-view>

[0070] In one embodiment, a <frame-view> element can describe an extension that adds a dockable frame window to the GIA UI. The extension can provide basic information about the frame, including its label in the UI, its icon in menus, and a class that implements the UI and behavior for the frame. In addition, a programmer can use an <application-layout> element to specify that frames can be visible in specific positions at startup.

[0071]


	Syntax:
	<frame-view
	askavailable=“true \| false”
	class=“classNameForViewImplementation”
	[hasaction=“true \| false”]
	[icon=“pathToGifFile”]
	[id=“identifierForThisView”]
	label=“labelToDisplayInUI”
	>
	Parents:
	<frame-view-set>
	Children:
	None.

[0072]

TABLE 12

Exemplary <frame-view> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

askavailable	Optional boolean. Set to “True” to specify
	that this view implements an IFrameView, and
	that its isAvailable( ) method can be called
	to determine whether the frame can be shown.
	Implement this interface, or derive from
	JComponent for all classes specified in the
	‘class’ attribute of a <frame-view> tag.
	IFrameView's benefits over using a simple
	JComponent are, that it can provide a
	‘Component’ other than itself, for cases
	where component construction is more complex,
	and it can specify the view's ‘availability’
	dynamically.
class	The fully-qualified class name of the frame view
	implementation. the class that is your
	implementation of the view - its user interface
	and behavior. A frame view implementation class
	can extend Component, implement IFrameView,
	or both.
hasaction	True to specify that a menu item for this view
	cannot be shown in a generated frame view menu.
icon	Path to a GIF file that can be used to represent
	this view in menus.
id	An identifier to distinguish between multiple
	instances of the implementation class.
label	The label used in the view tab, and in the
	View menu.

[0073] In one embodiment, an <application-layout> element can specify parameters for frame layouts, or descriptors that specify startup positions for frame views. This element can be used to create multiple frame views in the GIA UI.

[0074]


	Syntax:
	<application-layout
	id=“layoutInWhichTheseLayoutsShouldAppear”
	>
	Parents:
	<extension-xml>
	Children:
	<frame-layout>

[0075]

TABLE 13

Exemplary <application-layout> Element
Attributes in an Embodiment
	ATTRIBUTE	DESCRIPTION

	id	Identifier for the application layout to which
		this element's children can be applied. In one
		embodiment, valid values include “main” and
		“urn:com:debug”.

[0076] In one embodiment, a <frame-layout> element can specify the parameters of a layout, or the specific positions of one or more frame views at GIA startup.

[0077]


	Syntax:
	<frame-layout
	id=“frameLayoutID”
	>
	Parents:
	<application-layout>
	Children:
	<frame-container>

[0078]

TABLE 14

Exemplary <frame-layout> Element Attributes in an Embodiment
	ATTRIBUTE	DESCRIPTION

	id	Id of the frame layout to which the children can
		be applied. The valid value is “main”.

[0079] In one embodiment, a <frame-container> element can specify layout parameters for a group of frame view windows. This element can be used when there are two or more frame views that can appear in specific positions relative to each other at startup.

[0080]


	Syntax:
	<frame-container
	[orientation=“orientationInGIA”]
	proportion=“percentageOfGIASpace”
	>
	Parents:
	<frame-layout>
	Children:
	<frame-view-ref>, <frame-container>.

[0081]

TABLE 15

Exemplary <frame-container> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

orientation	This container's orientation in the layout. Valid
	values are “tabbed”, “root”, “north”, “south”,
	“west”, or “east”. Valid only on the root
	<frame-container> in a <frame-layout> element.
proportion	The percentage of space that this container can
	occupy in the GIA. For example, a container
	oriented “south” with a proportion of “25%”
	would occupy the lower 25 percent of the GIA. As
	with HTML tables, proportions need not add up
	to 100 percent.

[0082] In one embodiment, a <frame-view-ref> element can specify a frame view to appear in a container. Within the <frame-container> element, which defines layout parameters, the <frame-view-ref> element specifies details about the frame itself.

[0083]


	Syntax:
	<frame-view-ref
	class=“frameViewImplementationClass”
	[id=“frameLayoutID”]
	[proportion=“percentageOfContainerSpace”]
	[visible=“true \| false”]
	>
	Parents:
	<frame-container>
	Children:
	None.

[0084]

TABLE 16

Exemplary <frame-view-ref> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	The fully-qualified class name of the frame
	view implementation.
id	An identifier to distinguish between multiple
	instances of the implementation class.
proportion	The percentage of space that this container
	can occupy in the container. For example, a
	container oriented “south” with a proportion
	of “25%” would occupy the lower 25 percent of
	the GIA. As with HTML tables, proportions need
	not add up to 100 percent.
visible	Boolean: false to hide this frame on startup.

[0085] In one embodiment, the <help-root> describes a help extension through which a programmer can specify paths that can be added to the locations searched by the GIA when context-sensitive help is requested. By way of a non-limiting example, when a user presses an F1 key, a context-sensitive help engine can search for a topic (e.g., an HTML file) that corresponds to the user's current context (such as Source View, with the cursor positioned in a class variable name).

[0086]


	Syntax:
	<help-root
	dir=“pathRelativeToParent”
	parent=“parentForHelpPaths”
	url=“urlToHelpRoot”
	>
	Parents:
	<extension-xml>
	Children:
	None.

[0087]

TABLE 17

Exemplary <help-root> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

dir	Optional string. The directory to search as
	a help root. This directory is relative to the
	value specified in the parent attribute.
parent	Optional string. A path to a JAR file or
	directory relative to the WebLogic Workshop
	extensions directory. An absolute path may be
	used, but it is not recommended. If this
	attribute is omitted, the directory is assumed to
	be in the extension's own JAR file or directory.
url	Optional string. An absolute URL that specifies
	a new help root. This may be any URL, but will
	typically be HTTP or file based. Set this
	attribute's value as an alternative to setting
	the dir and parent attribute values.

[0088] In one embodiment, a <GIA-preferences> element can describe a preferences extension, which can add one or more panels to the GIA properties dialogs. These dialogs can include GIA Properties, Project Properties, and Application Properties (also known as “workspace properties”). For each of these dialogs, a programmer can specify one or more panels with the <panel> child element.

[0089]


	Syntax:
	<GIA-preferences>
	<!-- panel elements that define user interface for the
	properties panel -->
	</GIA-preferences>
	Parents:
	<extension-xml>
	Children:
	<panel>

[0090] In one embodiment, a <workspace-preferences> element can specify one or more panels that can be included in the Application Properties dialog.

[0091]


	Syntax:
	<workspace-preferences>
	<!-- panel elements that define user interface for the
	properties panel -->
	</workspace-preferences>
	Parents:
	<extension-xml>
	Children:
	<panel>

[0092] In one embodiment, a <project-preferences> element can specify one or more GUI panels that can be included in the Project Properties dialog.

[0093]


	Syntax:
	<project-preferences>
	<!-- panel elements that define user interface for the
	properties panel -->
	</project-preferences>
	Parents:
	<extension-xml>
	Children:
	<panel>

[0094] In one embodiment, a <panel> element can specify a panel that can appear in a properties dialog.

[0095]


Syntax:
	<panel
	class=“implementationClassName”
	label=“labelForThisPanelInDialog”
	[priority=“numberForDisplayRanking”]
	>
Parents:
	<GIA-preferences>, <workspace-preferences>, <project-preferences>
Children:
	None.

[0096]

TABLE 18

Exemplary <panel> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	The fully-qualified name of the panel's
	implementation class.
label	The name that can appear in the properties dialog,
	and which the user clicks to select the panel.
priority	Optional int. A number indicating the ranking
	for this panel in the list of panels.

[0097] In one embodiment, a <project-type> element can specify details related to the project's appearance in the GIA and about a project type file name extension.

[0098]


	Syntax:
	<project-type
	id=“IdentifierForProjectType”
	closedfoldericon=“pathToGifFile”
	icon=“pathToIcon”
	label=“descriptiveTextForDocumentType”
	openfoldericon=“pathToGifFile”
	>
	Parents:
	<extension-xml>
	Children:
	<attribute>, <driver>

[0099]

TABLE 19

Exemplary <project-type> Element Attributes in an Embodiment
	ATTRIBUTE	DESCRIPTION

	id	An identifier for this project type. This
		can be a short name representing this project
		type -- for example, “php” for a PHP project
		type.
	closedfoldericon	The path to the .gif file representing the
		top-level folder of a project of
		this type when the folder is closed.
	icon	The path to the .gif file to use for
		representing this project type in the UI.
	label	The text to display for this project type in
		the New Project dialog.
	openfoldericon	The path to the .gif file representing the
		top-level folder of a project of
		this type when the folder is open.

[0100] In one embodiment, an <attribute> element can specify an attribute supported by a project type. In one embodiment, project type attributes can correspond to predefined behavior in the GIA. By way of a non-limiting example, specifying “true” for the warnOnXSDAdd attribute tells the GIA that a warning message can be displayed if a GIA user tries to add an XSD file to the project (the warning states that the XSD will not be compiled unless put into a schema project).

[0101]


	Syntax:
	<attribute
	name=“attributeName”
	value=“attributeValue”
	>
	Parents:
	<project-type>
	Children:
	None.

[0102]

TABLE 20

Exemplary <attribute> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

name	The name of the attribute whose value is being specified.
value	The attribute's value.

[0103] In one embodiment, a <driver> element can specify driver(s) to load when a project of this type is loaded. By way of a non-limiting example, a programmer might want to implement a driver that checks for files added to the project's file system. When the user adds a project of this type to an application, the GIA “attaches” each of the specified drivers to it, so that the driver code is running while the user is working in the application. The project itself need not have focus in order for drivers to be active.

[0104]


	Syntax:
	<driver
	class=“driverImplementationClass”
	type=“driverInterface”
	>
	Parents:
	<project-type>
	Children:
	None.

[0105]

TABLE 21

Exemplary <driver> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	Required string. The fully-qualified name of the
	driver implementation. This class can implement
	the interface specified in the type attribute.
type	Required string. The fully-qualified name of the
	driver interface.

[0106] In one embodiment, a template defines a set of files and/or code to be used to check the contents of or add content to a GIA project. In one embodiment and by way of a non-limiting illustration, the GIA can load its set of templates by finding zip files with a template.xml file at its root located in a ‘templates’ directory.

[0107] In one embodiment, a template.xml file may contain any number of project or application template definitions. A template definition may optionally include display information indicating where and how the template will be displayed to the user. All templates, regardless of whether they contain display information, can be accessed programmatically by extension writers, or be extended or referenced by other template definitions.

[0108] In one embodiment, a <template-definition> element is the top-level element for project templates. It can contain any number of <project-template> and <application-template> elements.

[0109]


Syntax:
	<template-definition>
	<!-- Children <project-template> and <application-template>
	elements. -->
	</template-definition>
Parents:
	None
Children:
	<project-template>, <application-template>

[0110] In one embodiment, a <project-template> element can be used to define a set of content for populating a single new or existing project of a specific project type. A project template can also use a custom template processor class located in an extension JAR to call a GIA extension API, examine and update configuration files, query the user for input, or control the addition of content to a source directory. In one embodiment, project template definitions may be displayed in a New Project Dialog, Import Project Dialog, or in an application tree project-context menu under Install. They may also be extended by other project templates and referenced by application templates.

[0111] In one embodiment, a project template can be used by an template processor class to examine, configure or populate a project instance. In one embodiment, a template processor can have two methods: check( ) which determines if the project conforms to the template, and load( ) which configures or adds content to the project. A custom template processor implementation may be specified in the template definition; otherwise the default Workshop implementation will be used.

[0112]


	Syntax
	<project-template
	type=“projectType”
	id=“projectID”
	[extends=“extendedProjectID”]
	[processor=“IProjectTemplateProcessor”]
	>
	Parents:
	<template-definition>
	Children:
	<display>, <content>

[0113]

TABLE 22

Exemplary <project-template> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

type	Identifies the type of project that will be
	created. Project types can be defined in
	extension.xml and define how the project builds,
	deploys and runs, as well as how this template
	will be processed.
id	Uniquely identifies this template among all
	templates defined for its project type. Note that
	this id does not have to be unique among all
	project templates.
extends	Points to the id of a template of the same project
	type that this template extends. If this attribute
	is set, then un-initialized, non-required attributes
	can be set to values from the extended template.
processor	Class name of a template processor implementation.
	If this attribute is omitted, then a default
	processor implementation will be created.

[0114] In one embodiment, a <display> element can display options for a New Project dialog.

[0115]


	Syntax:
	<display
	location=“ newdialog \| importdialog \| contextmenu ”
	[label=“projLabel”]
	[icon=“imageName”]
	[description=“projDescription”]
	[priority=“menuLocationInteger”]
	[categories=“projCategory1, projCategory2, ...”]
	>
	Parents:
	<project-template>
	Children:
	None.

[0116]

TABLE 23

Exemplary <display> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

location	Comma separated list of display location identifiers.
	Workshop-defined values:
	newdialog - a New Project dialog
	importdialog - an Import Project dialog
	contextmenu - a project context menu
label	Label that can be displayed in the New Project dialogs.
icon	Icon that can be displayed for this template. All
	project types will specify a default icon which will
	be used if this attribute is omitted. The value of
	this attribute may be a GIF file in the template ZIP
	file, or it may be a resource in an extension JAR file.
description	Optional string. Description of this template that
	will be displayed in the Project dialogs.
priority	Optional integer. Used to order the templates
	displayed in the dialog template list, higher values
	being displayed before lower values.
categories	Optional string. Comma separated list of template
	category names.

[0117] In one embodiment, a <content> element can be used to specify a menu item.

[0118]


	Syntax:
	<content
	type=“ archive \| file ”
	destination=“ project \| libraries \| modules ”
	source=“sourceFileOrZIP”
	[overwrite=“ true \| false ”]
	>
	Parents:
	<project-template>
	Children:
	None.

[0119]

TABLE 24

Exemplary <content> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

type	Indicates how the source file can be processed.
	Values supported by the default template processor:
	archive - a zip file
	file - a file
destination	Where the content will be placed. Values supported
	by the default template processor:
	project - the root of the project directory
	libraries - the application Libraries directory
	modules - the application Modules directory
source	The content source file; when opening as a stream,
	will first look in the template ZIP file, then it
	try to open the content as a resource.
overwrite	Optional boolean. Specifies the behavior if same
	files already exist in the application directories.
	If this attribute is omitted, the value is false.
	The default template processor will immediately
	quit processing this content element if
	overwrite is false and a collision occurs.

[0120] In one embodiment, an <application-template> element can be used to define a set of content for populating a new or existing application. An application template can also use a custom template processor class located in an extension jar to call an GIA extension API, examine and update configuration files, query a user for input, or control the addition of content to the application directory. By way of a non-limiting example, application template definitions may be displayed in a New Application Dialog, or in a application tree root context menu under Install. They may also be extended by other application templates and referenced by application templates.

[0121] Application templates may also contain any number of content elements, however these content members may only contain application-level data: data in the Libraries, Modules folders, etc. Project content can be specified in a project template. Project templates may be referenced, or they may be completely defined inside the application template. Project templates defined inside the application template will not appear in the New Project and Add Project dialog and may only be used when creating this application.

[0122]


	Syntax:
	<application-template
	id=“uniqueID”
	>
	Parents:
	<template-definition>
	Children:
	<display>, <content>, <project-template-ref>

[0123]

TABLE 25

Exemplary <application-template> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

id	Uniquely identifies this application template
	among all application templates defined in this
	template zip file. Note that this id does not have
	to be unique among all application templates loaded
	by Workshop.

[0124] In one embodiment, a <project-template-ref> element can be used to reference to an externally defined project template. The referenced project template may be defined in the current template ZIP file, or any other template ZIP file in the /template directory. The project type id and template id are used to find the referenced project template. The referenced project template will be used to create a project with the name given and the content defined by the project template.

[0125]


	Syntax:
	<project-template-ref
	[default-name=“name”]
	[type=“projType”]
	[template=“projTemplateID”]
	>
	Parents:
	<application-template>
	Children:
	None.

[0126]

TABLE 26

Exemplary <project-template-ref> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

default-name	The name that will be used for the created project.
type	A project	Possible values:
	type id.
	TYPE	DESCRIPTION
	Datasync	Datasync projects contain server
		data including campaigns, content,
		placeholders, content selectors,
		user segments, and property sets.
	Control	Control projects are used to create
		Java controls and packaging them
		as JAR files.
	WebApp	WebApp projects can contain web
		applications, web services,
		and business processes.
	EJB	EJB projects are used to create
		EJBs and packaging them as JAR files.
	PortalWebApp	A WebApp project that also enables
		Portals. This can only be added
		to an portal enabled application.
	xbean	Schema project for building
		XMLBean JARs from schema files
		(XSD files).
template	A project template id.

[0127] The following is an annotated example of a template.xml file.

[0128]


<template-definition>
<!-- This a Web project template and extends the ‘default’ Web
project template. -->
	<project-template id=“_example_proj1_”
	type=“urn:com:project.type:WebApp”
	extends=“default”
processor=“workshop.workspace.project.TestTemplateProcessor”>
	<!-- Defines where and how this template will be
displayed to the Workshop user. -->
	<display
	location=“newdialog, importdialog”
	label=“_Example Project_”
	description=“This project template demonstrates the
Workshop template syntax, and extends the default web project
template. See {wlw_install_dir}/templates/example-template.zip.”
	icon=“exampleProject.gif”
	priority=“0”
	categories=“_Example_” />
	<!-- zip to be extracted at the root of the project
directory -->
	<content type=“archive” destination=“project”
source=“default-project.zip”/>
	<!-- file to be put in the libraries directory -->
	<content type=“file” destination=“libraries”
source=“CreditScoreBean.jar” overwrite=“true”/>
	<!-- file to be put in the modules directory -->
	<content type=“file” destination=“modules”
source=“CreditScoreEJB.jar” overwrite=“true”/>
	</project-template>
	<!-- This a Web project template that will appear in the
Application tree's Install context menu
	when the user right-clicks on a Web project folder.
	Note that this template uses a custom template processor
implementation. This class could
	query the user for input, examine and update existing
configuration files, and control how
	content elements are added to the project. -->
	<project-template id=“_example_proj1_installmenu_”
	type=“urn:com:project.type:WebApp”
processor=“workshop.workspace.project.InstallTemplateProcessor”>
	<!-- Defines where and how this template will be
displayed to the Workshop user. -->
	<display
	location=“contextmenu”
	label=“_Add Project Resources_”
	description=“This project template demonstrates the
Workshop template syntax, and extends the default web project
template. See {wlw_install_dir}/templates/example-template.zip.”
	icon=“exampleProject.gif”
	categories=“_Example_” />
	<!-- zip to be extracted at the root of the project
directory -->
	<content type=“archive” destination=“project”
source=“ui_resouces.zip”/>
	</project-template>
<application-template id=“_example_app1_”>
	<display
	location=“newdialog”
	icon=“exampleApp.gif”
	label=“_Example Application 1_”
	description=“This application template demonstrates
the Workshop template syntax. See
{wlw_install_dir}/templates/example-template.zip.”
	priority=“1”
	categories=“_Example_” />
	<!-- zip to be extracted in the libraries directory -->
	<content type=“archive” destination=“libraries”
source=“libraries.zip”/>
	<!-- file to be put in the modules directory -->
	<content type=“file” destination=“modules”
source=“testEJB.jar”/>
	<!-- references a project template defined in another
template zip file -->
	<project-template-ref default-name=“_StandardControl_”
type=“Control” template=“default”/>
	<!-- references a project template defined above -->
	<project-template-ref default-name=“_ExampleWebApp_”
type=“urn:com:project.type:WebApp” template=“_example_proj1_”/>
	<!-- project template only used in this application
template -->
	<project-template default-name=“_Example Java_”
	id=“_example_app1_proj1_”
	type=“Java”>
	<content type=“file” destination=“project”
source=“Example.java”/>
	</project-template>
	</application-template>
	<!--
	This application template extends an application template
defined in this
	template zip. Currently we only support extending app
templates defined
	in the same template zip.
	-->
	<application-template id=“_example_app2_”
	extends=“_example_app1_”>
	<display
	location=“contextmenu”
	label=“_Example Application Content_” />
	<!-- A project template only used in this application
template.
	Extends the default control project -->
	<project-template default-name=“_ExampleControl_”
	id=“_example_app2_proj1_”
	type=“Control”
	extends=“default”>
	<content type=“file” destination=“project”
source=“Example.java”/>
	</project-template>
	</application-template>
</template-definition>

[0129] One embodiment may be implemented using a conventional general purpose or a specialized digital computer or microprocessor(s) programmed according to the teachings of the present disclosure, as will be apparent to those skilled in the computer art. Appropriate software coding can readily be prepared by skilled programmers based on the teachings of the present disclosure, as will be apparent to those skilled in the software art. The invention may also be implemented by the preparation of integrated circuits or by interconnecting an appropriate network of conventional component circuits, as will be readily apparent to those skilled in the art.

[0130] One embodiment includes a computer program product which is a storage medium (media) having instructions stored thereon/in which can be used to program a computer to perform any of the features presented herein. The storage medium can include, but is not limited to, any type of disk including floppy disks, optical discs, DVD, CD-ROMs, microdrive, and magneto-optical disks, ROMs, RAMs, EPROMs, EEPROMs, DRAMs, VRAMs, flash memory devices, nanosystems (including molecular memory integrated circuits), or any type of storage media suitable for storing instructions and/or data.

[0131] Stored on any one of the computer readable medium (media), the present invention includes software for controlling both the hardware of the general purpose/specialized computer or microprocessor, and for enabling the computer or microprocessor to interact with a human user or other mechanism utilizing the results of the present invention. Such software may include, but is not limited to, device drivers, operating systems, execution environments/containers, and applications.

[0132] The foregoing description of the preferred embodiments of the present invention have been provided for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise forms disclosed. Many modifications and variations will be apparent to the practitioner skilled in the art. Embodiments were chosen and described in order to best explain the principles of the invention and its practical application, thereby enabling others skilled in the art to understand the invention, the various embodiments and with various modifications that are suited to the particular use contemplated. It is intended that the scope of the invention be defined by the following claims and their equivalents.

Claims

Post-issuance certificates present

The text shown below may not reflect later post-issuance changes.

What is claimed is:

1. A computer-readable storage media having stored thereon computer instructions for a computer-based extendable application framework that when executed by a processor cause the instructions to provide:

a user interface;

a plurality of services, wherein a service includes a public interface that has an implementation and provides access to functionality in an extension of a plurality of extensions;

said plurality of extensions to extend an application, wherein the plurality of extensions provide functionality accessible in the user interface, wherein each extension in the plurality of extensions include:

a set of classes defined in an object-oriented programming language,

an XML (Extensible Markup Language) description,

wherein the XML description is scanned for code fragments that are contained within an XML tag and are to be passed to handlers defined for a particular ID attribute at runtime to batch together XML descriptions from other extensions of the plurality of extensions and ensure services requested by the XML description are available,

an optional set of resources, and

wherein the extension of the plurality of extensions defines handlers for the XML tag found in the XML description;

wherein each one of the plurality of services is associated with an extension in the plurality of extensions;

wherein one of the plurality of extensions exposes and consumes services associated with another extension in the plurality of extensions, wherein the exposed and consumed services are consumed by the set of classes;

wherein one of the plurality of extensions provides functionality accessible in the user interface;

wherein one of the plurality of services provides access to functionality in one of the plurality of extensions; and

wherein the XML description comprises a root element comprising one or more children elements that each describe a different type of extension.

2. The computer-readable storage media of claim 1 wherein: one of the plurality of extensions utilizes one of the plurality of services.

3. The computer-readable storage media of claim 1 wherein: each extension of the plurality of extensions is an interchangeable application building block.

4. The computer-readable storage media of claim 1 wherein:

a first extension of the plurality of extensions provides functionality to support at least one of: 1) a document type; 2) a user interface action; 3) a file encoding; 4) property settings; and 5) debugging information.

5. A computer-based method for configuring an application in a computer-based extendable application framework, comprising the steps of:

providing a user interface at a computer to allow user interaction with the application;

providing a plurality of extensions at the computer to extend the application, wherein each extension of the plurality of extensions include:

a set of classes defined in an object-oriented programming language,

an XML (Extensible Markup Language) description,

wherein the XML description is scanned for code fragments that are contained within a XML tag and are to be passed to handlers defined for a particular ID attribute at runtime to batch together XML descriptions from other extensions in the plurality of extensions and ensure services requested by the XML description are available,

an optional set of resources, and

wherein the extension of the plurality of extensions defines handlers for the XML tag found in the XML description;

wherein the providing of the plurality of extensions permits one of the plurality of extensions to provide functionality accessible in the user interface; and

providing a plurality of services wherein the providing the plurality of services permits one of the plurality of services to provide access to functionality in one of the plurality of extensions;

wherein each service of the plurality of services include a public interface that has an implementation and provides access to functionality in an extension;

wherein each one of the plurality of services is associated with an extension in the plurality of extensions;

wherein the XML description comprises a root element comprising one or more children elements that each describe a different type of extension.

6. The method of claim 5 wherein: one of the plurality of extensions utilizes one of the plurality of services.

7. The method of claim 5 wherein: each extension of the plurality of extensions is an interchangeable application building block.

8. The method of claim 5 wherein: an extension of the plurality of extensions provides functionality to support at least one of: 1) a document type; 2) a user interface action; 3) a file encoding; 4) property settings; and 5) debugging information.

9. A computer-readable storage medium having stored thereon computer instructions for a computer-based extendable application framework system that when executed by a processor cause instructions for system to:

provide a user interface to allow user interaction with an application;

provide a plurality of extensions to extend the application, wherein the plurality of extensions provide functionality accessible in the user interface, wherein each extension of the plurality of extensions includes:

a set of classes defined in an object-oriented programming language, and

an XML (Extensible Markup Language) description,

wherein the XML description is scanned for code fragments that are contained within an XML tag and are to be passed to handlers defined for a particular ID attribute at runtime to batch together XML descriptions from other extensions in the plurality of extensions and ensure services requested by the XML description are available,

an optional set of resources, and

wherein the extension of the plurality of extensions defines handlers for the XML tag found in the XML description;

wherein the providing of the plurality of extensions permits one of the plurality of extensions to provide functionality accessible in the user interface;

provide a plurality of services wherein the providing of the plurality of services permits one of the plurality of services to provide access to functionality in one of the plurality of extensions;

wherein each service of the plurality of services includes a public interface that has an implementation and provides access to functionality in an extension of the plurality of extensions;

wherein each one of the plurality of services is associated with an extension in the plurality of extensions;

wherein the XML description comprises a root element comprising one or more children elements that each describe a different type of extension.

10. The computer readable storage medium of claim 9 wherein:

one of the plurality of extensions utilizes one of the plurality of services.

11. The computer readable storage medium of claim 9 wherein:

each extension of the plurality of extensions is an interchangeable application building block.

12. The computer readable storage medium of claim 9 wherein:

an extension of the plurality of extensions provides functionality to support at least one of: 1) a document type; 2) a user interface action; 3) a file encoding; 4) property settings; and 5) debugging information.

13. The computer-readable storage media of claim 1, wherein the plurality of services includes at least one of:

a resource service to provide access to a set of resources;

a frame service to allow extensions of the plurality of extensions to specify a graphical user interface (GUI) docking layout;

a file service to provide a set of services for file system access and manipulation;

a server service to provide a set of services for accessing a server;

a document service to supply an abstract document interface for files that are part of an application project; and

an action service to provide methods for adding and manipulating menu and toolbar items.

14. The method of claim 5, wherein the plurality of services includes at least one of:

a resource service to provide access to a set of resources;

a frame service to allow extensions of the plurality of extensions to specify a graphical user interface (GUI) docking layout;

a file service to provide a set of services for file system access and manipulation;

a server service to provide a set of services for accessing a server;

a document service to supply an abstract document interface for files that are part of an application project; and

an action service to provide methods for adding and manipulating menu and toolbar items.

15. The computer readable storage medium of claim 9, wherein the plurality of services includes at least one of:

a resource service to provide access to a set of resources;

a frame service to allow extensions of the plurality of extensions to specify a graphical user interface (GUI) docking layout;

a file service to provide a set of services for file system access and manipulation; a server service to provide a set of services for accessing a server;

a document service to supply an abstract document interface for files that are part of an application project; and

an action service to provide methods for adding and manipulating menu and toolbar items.

Patent Citations (208)

Patent	Date	Inventor	Cited By
US5321841(A)	1994-06-01	East et al.	Applicant
US5469562(A)	1995-11-01	Saether	Applicant
US5604860(A)	1997-02-01	McLaughlin et al.	Applicant
US5630131(A)	1997-05-01	Palevich et al.	Applicant
US5748975(A)	1998-05-01	Van De Vanter	Applicant
US5801958(A)	1998-09-01	Dangelo et al.	Applicant
US5835769(A)	1998-11-01	Jervis et al.	Applicant
US5836014(A)	1998-11-01	Faiman, Jr.	Applicant
US5862327(A)	1999-01-01	Kwang	Applicant
US5867822(A)	1999-02-01	Sankar	Applicant
US5944794(A)	1999-08-01	Okamoto et al.	Applicant
US5950010(A)	1999-09-01	Hesse	Applicant
US5961593(A)	1999-10-01	Gabber et al.	Applicant
US5966535(A)	1999-10-01	Benedikt et al.	Applicant
US6012083(A)	2000-01-01	Savitzky et al.	Applicant
US6016495(A)	2000-01-01	McKeehan et al.	Applicant
US6018730(A)	2000-01-01	Nichols et al.	Applicant
US6023578(A)	2000-02-01	Birsan et al.	Applicant
US6023722(A)	2000-02-01	Colyer	Applicant
US6028997(A)	2000-02-01	Leymann et al.	Applicant
US6029000(A)	2000-02-01	Woolsey et al.	Applicant
US6044217(A)	2000-03-01	Brealey et al.	Applicant
US6067548(A)	2000-05-01	Cheng	Applicant
US6067623(A)	2000-05-01	Blakley et al.	Applicant
US6070184(A)	2000-05-01	Blount et al.	Applicant
US6092102(A)	2000-07-01	Wagner	Applicant
US6106569(A)	2000-08-01	Bohrer et al.	Examiner
US6119149(A)	2000-09-01	Notani	Applicant
US6141686(A)	2000-10-01	Jackowski	Applicant
US6141701(A)	2000-10-01	Whitney	Applicant
US6148336(A)	2000-11-01	Thomas et al.	Applicant
US6185734(B1)	2001-02-01	Saboff et al.	Applicant
US6212546(B1)	2001-04-01	Starkovich et al.	Applicant
US6222533(B1)	2001-04-01	Notani	Applicant
US6226675(B1)	2001-05-01	Meltzer et al.	Applicant
US6230287(B1)	2001-05-01	Pinard et al.	Applicant
US6230309(B1)	2001-05-01	Turner	Applicant
US6237135(B1)	2001-05-01	Timbol	Applicant
US6243737(B1)	2001-06-01	Flanagan et al.	Applicant
US6282711(B1)	2001-08-01	Halpern	Applicant
US6292932(B1)	2001-09-01	Baisley et al.	Applicant
US6311327(B1)	2001-10-01	O'Brien et al.	Applicant
US6324681(B1)	2001-11-01	Sebesta	Applicant
US6330569(B1)	2001-12-01	Baisley et al.	Applicant
US6334114(B1)	2001-12-01	Jacobs et al.	Applicant
US6338064(B1)	2002-01-01	Ault et al.	Applicant
US6343265(B1)	2002-01-01	Glebov et al.	Applicant
US6349408(B1)	2002-02-01	Smith	Applicant
US6353923(B1)	2002-03-01	Bogle et al.	Applicant
US6360358(B1)	2002-03-01	Elsbree et al.	Applicant
US6367068(B1)	2002-04-01	Vaidyanathan et al.	Applicant
US6377939(B1)	2002-04-01	Young	Applicant
US6393605(B1)	2002-05-01	Loomans	Applicant
US6408311(B1)	2002-06-01	Baisley et al.	Applicant
US6411698(B1)	2002-06-01	Bauer et al.	Applicant
US6445711(B1)	2002-09-01	Scheel et al.	Applicant
US6470364(B1)	2002-10-01	Prinzing	Applicant
US6516322(B1)	2003-02-01	Meredith	Applicant
US6549949(B1)	2003-04-01	Bowman-Amuah	Applicant
US6560636(B2)	2003-05-01	Cohen et al.	Applicant
US6560769(B1)	2003-05-01	Moore et al.	Applicant
US6567738(B2)	2003-05-01	Gopp et al.	Applicant
US6584454(B1)	2003-06-01	Hummel et al.	Applicant
US6594693(B1)	2003-07-01	Borwankar	Applicant
US6594700(B1)	2003-07-01	Graham et al.	Applicant
US6601113(B1)	2003-07-01	Koistinen et al.	Examiner
US6604198(B1)	2003-08-01	Beckman et al.	Applicant
US6609115(B1)	2003-08-01	Mehring et al.	Applicant
US6615258(B1)	2003-09-01	Barry et al.	Applicant
US6636491(B1)	2003-10-01	Kari et al.	Applicant
US6637020(B1)	2003-10-01	Hammond	Applicant
US6643652(B2)	2003-11-01	Helgeson et al.	Applicant
US6651108(B2)	2003-11-01	Popp et al.	Examiner
US6654932(B1)	2003-11-01	Bahrs et al.	Applicant
US6662357(B1)	2003-12-01	Bowman-Amuah	Applicant
US6678518(B2)	2004-01-01	Eerola	Applicant
US6684388(B1)	2004-01-01	Gupta et al.	Applicant
US6687702(B2)	2004-02-01	Vaitheeswaran et al.	Applicant
US6687848(B1)	2004-02-01	Najmi	Applicant
US6721740(B1)	2004-04-01	Skinner et al.	Applicant
US6721779(B1)	2004-04-01	Maffeis	Applicant
US6732237(B1)	2004-05-01	Jacobs et al.	Applicant
US6748420(B1)	2004-06-01	Quatrano et al.	Applicant
US6754884(B1)	2004-06-01	Lucas et al.	Examiner
US6757689(B2)	2004-06-01	Battas et al.	Applicant
US6789054(B1)	2004-09-01	Makhlouf	Applicant
US6795967(B1)	2004-09-01	Evans et al.	Applicant
US6799718(B2)	2004-10-01	Chan et al.	Applicant
US6802000(B1)	2004-10-01	Greene et al.	Applicant
US6804686(B1)	2004-10-01	Stone et al.	Applicant
US6823495(B1)	2004-11-01	Vedula et al.	Applicant
US6832238(B1)	2004-12-01	Sharma et al.	Applicant
US6836883(B1)	2004-12-01	Abrams et al.	Applicant
US6847981(B2)	2005-01-01	Song et al.	Applicant
US6850979(B1)	2005-02-01	Saulpaugh et al.	Applicant
US6859180(B1)	2005-02-01	Rivera	Applicant
US6874143(B1)	2005-03-01	Murray et al.	Examiner
US6889244(B1)	2005-05-01	Gaither et al.	Applicant
US6915519(B2)	2005-07-01	Williamson et al.	Applicant
US6918084(B1)	2005-07-01	Slaughter et al.	Applicant
US6920607(B1)	2005-07-01	Ali et al.	Examiner
US6922827(B2)	2005-07-01	Vasilik et al.	Applicant
US6950866(B1)	2005-09-01	Lowry et al.	Examiner
US6950872(B2)	2005-09-01	Todd, II	Applicant
US6959307(B2)	2005-10-01	Apte	Applicant
US6963914(B1)	2005-11-01	Breitbart et al.	Applicant
US6971096(B1)	2005-11-01	Ankireddipally et al.	Applicant
US6976086(B2)	2005-12-01	Sadeghi et al.	Applicant
US6983328(B2)	2006-01-01	Beged-Dov et al.	Applicant
US6985939(B2)	2006-01-01	Fletcher et al.	Applicant
US7000219(B2)	2006-02-01	Barrett et al.	Applicant
US7017146(B2)	2006-03-01	Dellarocas et al.	Applicant
US7035944(B2)	2006-04-01	Fletcher et al.	Applicant
US7043722(B2)	2006-05-01	Bau, III	Applicant
US7051072(B2)	2006-05-01	Stewart et al.	Applicant
US7054858(B2)	2006-05-01	Sutherland	Applicant
US7058940(B2)	2006-06-01	Calahan	Examiner
US7062718(B2)	2006-06-01	Kodosky et al.	Applicant
US7069507(B1)	2006-06-01	Alcazar et al.	Examiner
US7072934(B2)	2006-07-01	Helgeson et al.	Applicant
US7073167(B2)	2006-07-01	Iwashita	Applicant
US7076772(B2)	2006-07-01	Zatloukal	Applicant
US7089568(B2)	2006-08-01	Yoshida et al.	Applicant
US7096422(B2)	2006-08-01	Rothschiller et al.	Applicant
US7107578(B1)	2006-09-01	Alpern	Applicant
US7111243(B1)	2006-09-01	Ballard et al.	Applicant
US7117504(B2)	2006-10-01	Smith et al.	Applicant
US7127704(B2)	2006-10-01	Van De Vanter et al.	Applicant
US7143186(B2)	2006-11-01	Stewart et al.	Applicant
US7146422(B1)	2006-12-01	Marlatt et al.	Applicant
US7152090(B2)	2006-12-01	Amirisetty et al.	Applicant
US7155705(B1)	2006-12-01	Hershberg et al.	Applicant
US7159007(B2)	2007-01-01	Stawikowski	Applicant
US7165041(B1)	2007-01-01	Guheen et al.	Applicant
US7181731(B2)	2007-02-01	Pace et al.	Applicant
US7184967(B1)	2007-02-01	Mital et al.	Applicant
US7240331(B2)	2007-07-01	Vion-Dury et al.	Applicant
US7260599(B2)	2007-08-01	Bauch et al.	Applicant
US7260818(B1)	2007-08-01	Iterum et al.	Applicant
US2002/0004848(A1)	2002-01-01	Sudarshan et al.	Applicant
US2002/0010781(A1)	2002-01-01	Tuatini	Applicant
US2002/0010803(A1)	2002-01-01	Oberstein et al.	Applicant
US2002/0016759(A1)	2002-02-01	Macready et al.	Applicant
US2002/0049788(A1)	2002-04-01	Lipkin et al.	Applicant
US2002/0073080(A1)	2002-06-01	Lipkin	Applicant
US2002/0073236(A1)	2002-06-01	Helgeson et al.	Applicant
US2002/0073396(A1)	2002-06-01	Crupi et al.	Applicant
US2002/0078365(A1)	2002-06-01	Burnett et al.	Applicant
US2002/0083075(A1)	2002-06-01	Brummel et al.	Applicant
US2002/0111922(A1)	2002-08-01	Young et al.	Applicant
US2002/0116454(A1)	2002-08-01	Dyla et al.	Applicant
US2002/0120685(A1)	2002-08-01	Srivastava et al.	Applicant
US2002/0143960(A1)	2002-10-01	Goren et al.	Applicant
US2002/0152106(A1)	2002-10-01	Stoxen et al.	Applicant
US2002/0161826(A1)	2002-10-01	Arteaga et al.	Applicant
US2002/0165936(A1)	2002-11-01	Alston et al.	Applicant
US2002/0169644(A1)	2002-11-01	Greene	Applicant
US2002/0174178(A1)	2002-11-01	Stawikowski	Applicant
US2002/0174241(A1)	2002-11-01	Beged-Dov et al.	Applicant
US2002/0184610(A1)	2002-12-01	Chong et al.	Applicant
US2002/0188486(A1)	2002-12-01	Gil et al.	Applicant
US2002/0194244(A1)	2002-12-01	Raventos	Applicant
US2002/0194267(A1)	2002-12-01	Flesner et al.	Applicant
US2002/0194495(A1)	2002-12-01	Gladstone et al.	Applicant
US2002/0198891(A1)	2002-12-01	Li et al.	Examiner
US2003/0004746(A1)	2003-01-01	Kheirolomoom et al.	Applicant
US2003/0005181(A1)	2003-01-01	Bau, III et al.	Applicant
US2003/0014439(A1)	2003-01-01	Boughannam	Applicant
US2003/0018661(A1)	2003-01-01	Darugar	Applicant
US2003/0018665(A1)	2003-01-01	Dovin et al.	Applicant
US2003/0018832(A1)	2003-01-01	Amirisetty et al.	Applicant
US2003/0018963(A1)	2003-01-01	Ashworth et al.	Applicant
US2003/0023957(A1)	2003-01-01	Bau, III et al.	Applicant
US2003/0028364(A1)	2003-02-01	Chan et al.	Applicant
US2003/0028579(A1)	2003-02-01	Kulkarni et al.	Applicant
US2003/0041198(A1)	2003-02-01	Exton et al.	Applicant
US2003/0043191(A1)	2003-03-01	Tinsley et al.	Applicant
US2003/0046266(A1)	2003-03-01	Mullins	Applicant
US2003/0046591(A1)	2003-03-01	Asghari-Kamrani et al.	Applicant
US2003/0051066(A1)	2003-03-01	Pace et al.	Applicant
US2003/0055868(A1)	2003-03-01	Fletcher et al.	Applicant
US2003/0055878(A1)	2003-03-01	Fletcher et al.	Applicant
US2003/0074217(A1)	2003-04-01	Beisiegel et al.	Applicant
US2003/0079029(A1)	2003-04-01	Garimella et al.	Applicant
US2003/0110117(A1)	2003-06-01	Saidenberg et al.	Applicant
US2003/0110446(A1)	2003-06-01	Nemer	Applicant
US2003/0126136(A1)	2003-07-01	Omoigui	Applicant
US2003/0149791(A1)	2003-08-01	Kane et al.	Applicant
US2003/0167358(A1)	2003-09-01	Marvin et al.	Applicant
US2003/0196168(A1)	2003-10-01	Hu	Applicant
US2004/0019645(A1)	2004-01-01	Goodman et al.	Applicant
US2004/0040011(A1)	2004-02-01	Bosworth et al.	Applicant
US2004/0046789(A1)	2004-03-01	Inanoria	Examiner
US2004/0078373(A1)	2004-04-01	Ghoneimy et al.	Applicant
US2004/0103406(A1)	2004-05-01	Patel	Applicant
US2004/0133660(A1)	2004-07-01	Junghubert et al.	Applicant
US2004/0148336(A1)	2004-07-01	Hubbard et al.	Applicant
US2004/0204976(A1)	2004-10-01	Oyama et al.	Applicant
US2004/0216086(A1)	2004-10-01	Bau	Applicant
US2004/0225995(A1)	2004-11-01	Marvin et al.	Applicant
US2004/0260715(A1)	2004-12-01	Mongeon et al.	Applicant
US2005/0050068(A1)	2005-03-01	Vaschillo et al.	Applicant
US2005/0278585(A1)	2005-12-01	Spencer	Applicant
US2006/0041893(A1)	2006-02-01	Castro et al.	Examiner
US2006/0206856(A1)	2006-09-01	Breeden et al.	Applicant
US2006/0234678(A1)	2006-10-01	Juitt et al.	Applicant
US2007/0038500(A1)	2007-02-01	Hammitt et al.	Applicant
WO1/90884(A2)	2001-11-01		Applicant

Non-Patent Literature (36)

IBM TDB, “Abstraction of remote operating systems”, Aug. 1, 2001, IP.com, IP.Com No. IPCOM000015157D, pp. 1-3.Examiner
Kunisetty, Workflow Modeling and Simulation Using an Extensible Object-Oriented Knowledge Base Management System, CiteSeer, 1996, pp. 1-60, entire reference.Applicant
Van Der Aalst et al, Verification of XRL: An XML-Based Workflow Language, IEEE, Jul. 2001, pp. 427-432, entire reference.Applicant
Blake, Rule-Driven Coordination Agents: A Self-Configurable Agent Architecture for Distributed Control, IEEE, Mar. 2001, pp. 271-277, entire reference.Applicant
Dahalin et al, Workflow Interoperability Using Extensible Markup Language (XML), IEEE, Jul. 2002, pp. 513-516, entire reference.Applicant
International Search Report PCT/US04/05488, mailed Mar. 1, 2005, 3 sheets.Applicant
Mariucci, Marcello. “Enterprise Application Server Development Environments.”, Overview. University of Stuttgart. Oct. 10, 2000, p. 1-10.Applicant
Sun Microsystems. “IPlanet Application Server 6.0 White Paper.”, Technical Reference Guide. May 25, 2000, all, fig. on p. 20.Applicant
Roman, Ed and Rickard Oberg, “The Technical Benefits of EJB and J2EE Technologies over COM+ and Windows DNA.” Dec. 1999, pp. 3-5, fig. 1.Applicant
Hewlett-Packard. “HP Application Server.” technical guide version 8.0. 1999-2001, all.Applicant
Duvos, Enrique and Azer Bestavros. “An Infrastructure for the Dynamic Distribution of Web Applications and Services.” Department of Computer Science, Boston University. Dec. 2000, pp. 4-12.Applicant
Paul, Laura Gibbons, “RosettaNet: Teaching Business to Work Together”, Oct. 1, 1999. http://www.developer.com/sml/article.php/616641.Applicant
“Introducing Microsoft DotNet”, by Christophe Lauer, Jul. 2, 2002, http://webarchive.org/web/20020702162429/http://www.freevbcode.com/ShowCode.as;?ID=2171.Applicant
Tang, et al., “Integrating Remote Invocation and Distributed Shared State,” Proceedings of the 18th International Parallel and Distributed Processing Symposium, (IPDPS '04), Apr. 26-30, 2004, 10 pages.Applicant
Mays, et al., “A Persistent Store for Large Shared Knowledge Bases,” IEEE Transactions on Knowledge and Data Engineering, vol. 3, No. 1, Mar. 1991, pp. 33-41.Applicant
Embury, et al., “Assisting the Comprehension of Legacy Transactions,” Proceedings of the Eighth Working Conference on Reverse Engineering, Oct. 2-5, 2001, IEEE, pp. 345-354.Applicant
Kilgore, “Multi-Language, Open-Source Modeling Using the Microsoft .NET Architecture,” Proceedings of the 2002 Winter Simulation Conference, Dec. 8-11, 2002, IEEE, vol. 1, pp. 629-633.Applicant
Java Debug Interface—definition, retrieved from <URL http://java.sun.com/j2se/1.4.2/docs/guide/jpda/jdi/overview-summary.html on Feb. 21, 2007, pp. 1-3.Applicant
HP, “HP Application Server”, Developer's Guide, Version 8.0, 1999-2001, pp. 27-81, 127, 160, 195-271.Applicant
Liebmann, “Adaptive Data Dissemination and Caching for Edge Service Architecture Built with the J2EE”, 2004 ACM Symposium on Applied Computing, Mar. 2004, pp. 1717-1724, ACM Press.Applicant
Sosnoski, “XML and Java technologies: Data binding, Part 1: Code generation approaches—JAXB and more,” IBM, Jan. 1, 2003, http://www-128.ibm.com/developerworks/library/x-databdopt/index.html, pp. 1-11.Applicant
Bogunvic, N, “A Programming Model for Composing Data-Flow Collaborative Applications”, IEEE Mar. 1999, 7 pages.Applicant
Sung, S.Y., et al., “A Multimedia Authoring Tool for the Internet”, IEEE 1997, pp. 304-308.Applicant
Smith, M., et al., “Marching Towards a Software Reuse Future”, ACM Ada Letters, Nov./Dec. 1994, vol. XIV, No. 6, pp. 62-72.Applicant
Muller, “Event-Oriented Dynamic Adaptation of Workflows Model, Architecture, and Implementation,” 2002, University of Leipzig, Germany, pp. i-viv, 1-342.Applicant
Peltz, “Web Service Orchestration,” HP, Jan. 2003, Hewlett Packard, Co., pp. 1-20.Applicant
Mohan, C. et al., “ARIES: a transaction recovery method supporting fine-granularity locking and partial rollbacks using write-ahead logging,” ACM Transactions on Database Systems (TODS), vol. 17, Issue 1 (Mar. 1992), pp. 94-162.Applicant
BEA, Transforming Data Using Xquery Mapper, 2006, BEA AquaLogic Service Bus 2.0 Documentation, pp. 1-19.Applicant
Stylus Studio, Xquery Mapper, 2007, Stylus Studios, pp. 1-6.Applicant
Altova, XML-to-XML Mapping, 2007, Altova, pp. 1-3.Applicant
Jamper, Jamper-Java XML Mapper, 2007, Sourceforge, pp. 1-4.Applicant
Alonso, G. et al., “Advanced Transaction Models in Workflow Contexts,” Feb. 1996, Proceedings of 12th International Conference on Data Engineering, retrieved from http://citeseer.ist.psu.edu/alonso96advanced.html, 8 pages.Applicant
Van Der Aalst, W.M.P. et al., “XML Based Schema Definition for Support of Inter-Organizational Workflow,” 2000, University of Colorado and University of Eindhoven report, retrieved from http://citeseer.ist.psu.edu/vanderaalst00xml.html, pp. 1-39.Applicant
Plaindoux, Didier, “XML Transducers in Java,” May 2002, The Eleventh International World Wide Web Conference, retrieved from http://www.2002.org/CDROM/poster/132/index.html, pp. 1-6.Applicant
Microsoft, “Microsoft.net Framework,” 2001, Microsoft Corporation, pp. 1-50.Applicant
Willink, Edward D., “Meta-Compilation for C++,” Jan. 2000, University of Surrey, p. 362.Applicant

US 7,636,722 B2Grant

System and method for describing application extensions in XML

Issue Date:2009-12-22

•15 Claims

•3 Drawing Sheets

Abstract

Metadata

Assignee

BEA Systems, Inc.

Inventors

Ross Bunkerr
Brendan MacLean
Britton W. Piehler

Application Information

Application Number:US 10/786,772

Filing Date:2004-02-25

Priority Date:2003-02-28

Art Unit:2167

Classifications

IPC:

G06F17/00G06F7/00

Patent Drawings (3 sheets)

Description

Claim of Priority

[0001] This application claims priority from the following application, which is hereby incorporated by reference in its entirety:

[0002] EXTENSIBLE INTERACTIVE SOFTWARE DEVELOPMENT ENVIRONMENT, U.S. Application No. 60/451,340, Inventors: Ross Bunker et al., filed on Feb. 28, 2003.

Cross-Reference to Related Applications

[0003] This application is related to the following co-pending applications which are each hereby incorporated by reference in their entirety:

[0004] SYSTEM AND METHOD FOR MULTI-LANGUAGE EXTENSIBLE COMPILER FRAMEWORK, U.S. application Ser. No. 10/782,715, Inventors: Kevin Zatloukal, filed on Feb. 19, 2004.

[0005] SYSTEMS AND METHODS FOR MULTI-LANGUAGE DEBUGGING, U.S. Application No. 60/450,014, Inventors: William Pugh et al., filed on Feb. 26, 2003.

[0006] SYSTEMS AND METHODS FOR MULTI-VIEW DEBUGGING ENVIRONMENT, U.S. Application No. 60/451,368, Inventors: Josh Eckels et al., filed on Mar. 1, 2003.

[0007] SYSTEMS AND METHODS FOR TYPE-INDEPENDENCE SOURCE CODE EDITING, U.S. Application No. 60/449,984, Inventors: Britt Piehler et al., filed on Feb. 26, 2003.

[0008] MULTI-THREADED MULTI-LANGUAGE COMPILER FRAMEWORK, U.S. Application No. 60/488,629, Inventors: Kevin Zatloukal, filed on Jul. 19, 2003.

[0009] EXTENDABLE COMPILER FRAMEWORK, U.S. application Ser. No. 10/951,315, Inventors: Kevin Zatloukal, filed on Sep. 27, 2004.

Copyright Notice

Field of the Disclosure

[0011] The present invention disclosure relates to an extensible interactive development environment.

Background

Brief Description of the Drawings

[0013] FIG. 1 is an exemplary illustration of an interactive application extension component in an embodiment.

[0014] FIG. 2 is an exemplary illustration of a generic interactive application in an embodiment.

[0015] FIG. 3 is an exemplary illustration of services in an embodiment.

Detailed Description

[0026]


	<extension-definition>
	<extension-xml id=“urn:com:settings”>
	<project-preferences>
	<panel
	label=“%strings.workshop.debugger.extension.debuggerTab%”
	class=“workshop.debugger.ui.DebuggerPreferencesPanel”/>
	</project-preferences>
	<workspace-preferences>
	<panel
	label=“%strings.workshop.debugger.extension.debugSourcepath%”
	class=“workshop.debugger.ui.DebugSourcepathPreferences”
	priority=“40”/>
	</workspace-preferences>
	<GIA-preferences>
	<panel
	label=“%strings.workshop.debugger.extension.debuggerViews%”
	class=“workshop.debugger.ui.ExpressionViewPreferences”/>
	</GIA-preferences>
	</extension-xml>
	</extension-definition>
Syntax:
	<extension-xml id=“urnForExtensionType”>
	<!-- Extension-specific XML. -->
	</extension-xml>
Parents:
	<extension-definition>
Children:
	<file-extension>, <create-template>, <project-attributes>

[0027] Multiple <extension-xml> elements may occur as children of the <extension-definition> element, which is the root element of an extension.xml file.

[0028]

TABLE 1

Exemplary Extension Types in an Embodiment
EXTENSION	EXTENSION
TYPE	DESCRIPTION	ID ATTRIBUTE SET TO

Document	Defines support	urn:com:document
	for a document
	type.
Actions	Defines menus,	urn:com:actions
	popups, and toolbars,
	along with their
	associated behavior.
Encoding	Defines support	urn:com:encoding
	for a file type.
Frame	Defines a frame	urn:com:frame
	view (e.g., a
	dockable window).
Help	Defines paths to	urn:com:help
	search for help
	topics when
	context-sensitive
	help is requested.
Settings	Defines a new	urn:com:settings
	properties panel.
Project	Defines a new	urn:com:project
	project type.
Debugger	Defines a new	urn:com:debugExpressionViews
	debugger variable
	view.

[0030]


	<extension-xml>
	<action-ui>
	<action-group>
	<menu>
	<menu>
	<action-group>
	<popup>
	<action-group>
	<toolbar>
	<action-group>
	<action-set>
	<action>
	<location>
	Syntax:
	<action-ui>
	<!-- Children that describe specific actions or groups of
	actions. -->
	</action-ui>
	Parents:
	<extension-xml>
	Children:
	<action-group>, <menu>, <toolbar>, <popup>

[0031] In one embodiment, a <menu> element can be used to specify a UI menu item. Attributes for this element are provided in Table 3. By way of a non-limiting example:

[0032]


	<extension-xml>
	<action-ui>
	<action-group>
	<menu>
	<extension-xml>
	<action-ui>
	<menu>
	Syntax:
	<menu
	id=“nameToUseInContextPaths”
	label=“labelInGIA”
	[path=“uiContextPath”]
	priority=“priorityNumber”
	>
	Parents:
	<action-ui>, <action-group>
	Children:
	<action-group>

[0033]

TABLE 2

Exemplary <menu> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

id	The name of this menu item. The full context for
	this action item can be determined by combining
	this attribute with the path attribute.
label	The text to display for the menu in the GIA. A
	programmer can also indicate the action's default
	key-stroke accelerator by preceding it with
	‘@’. If the label begins and ends with
	the ‘%’ escape character, the label can be
	interpreted as a Java ™ PropertyBundle path.
	The label (including accelerator) will be
	determined by using the ResourceSvc to load
	the property named by the path. Place ‘&’
	before the character which is to be the menu mnemonic.
path	Optional string. A path through the UI hierarchy,
	followed by the final group in the last menu. For
	example, “menu/services/controls/add” would
	locate an action in the “add” group, of the
	“controls” sub-menu, of the “services”
	menu, in the main menu. Use the id attribute to
	specify the name of the menu item beneath “add”.
priority	This item's GUI priority.

[0035]


	Syntax:
	<action-group priority=“priorityNumber”>
	Parents:
	<action-ui>
	Children:
	<menu>, <action-ref>

[0036] In one embodiment, a <popup> element specifies a UI popup window or menu. The <popup> element's attributes are provided in Table 3.

[0037]


	<extension-xml>
	<action-ui>
	<popup>
	Syntax:
	<popup
	id=“nameToUseInContextPaths”
	path=“uiContextPath”
	>
	Parents:
	<action-ui>
	Children:
	<action-group>

[0038]

TABLE 3

Exemplary <popup> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

id	The name of this item. The full context for this action
	item can be determined by combining this attribute with
	the path attribute.
path	A path through the UI hierarchy, followed by the final
	group in the last menu. For example,
	“menu/services/controls/add” would locate an action
	in the “add” group, of the “controls”
	sub-menu, of the “services” menu, in the main
	menu. Use the id attribute to specify the name of
	the menu item beneath “add”.

[0039] In one embodiment, a <toolbar> element can specify a UI toolbar or toolbar button. Its attributes are specified in Table 4.

[0040]


	Syntax:
	<toolbar
	id=“nameToUseInContextPaths”
	label=“labelInGIA”
	[path=“uiContextPath”]
	priority=“priorityNumber”
	>
	Parents:
	<action-ui>
	Children:
	<action-group>

[0041]

TABLE 4

Exemplary <toolbar> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

id	The name of this item. The full context for this
	action item can be determined by combining this
	attribute with the path attribute.
label	The text to display for the menu in the GIA. A
	programmer can also indicate the action's default
	key-stroke accelerator by preceding it with
	‘@’. If the label begins and ends with
	the ‘%’ escape character, the label is
	interpreted as a Java PropertyBundle path. The
	label (including accelerator) will be determined
	by using the ResourceSvc to load the property
	named by the path. Place ‘&’ before
	the character which is to be the menu mnemonic.
path	Optional string. A path through the UI hierarchy,
	followed by the final group in the last menu. For
	example, “menu/services/controls/add” would
	locate an action in the “add” group, of the
	“controls” sub-menu, of the “services”
	menu, in the main menu. Use the id attribute to
	specify the name of the menu item beneath “add”.
priority	Required int.

[0043]


	Syntax:
	<action-set
	scope=“classNameForView”
	extends=“classNameForExtendedView”
	>
	Parents:
	<extension-xml>
	Children:
	<action>

[0044]

TABLE 5

Exemplary <action-set> Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

scope	Optional string. The fully-qualified class name for
	a view (a document, document view or frame view) that
	is active in order for this action to be available.
	Default is global scope, meaning that the actions in
	this set may be accessible to the user regardless of
	the active view.
extends	Optional string. The fully-qualified class name for
	a view whose scope this action set extends. Extending
	an action-set of an existing scope adds all the
	actions of the base scope into the extending scope.

[0045] In one embodiment, an <action> element can specify a UI action, such as a menu or popup command, or a toolbar button. Attributes for this element are provided in Table 6.

[0046]


	Syntax:
	<action
	[class=“classNameForHandler”]
	[label=“menuText”]
	[tooltip=“tooltipText”]
	[icon=“pathToGifFile”]
	[id=“”]
	>
	Parents:
	<action-set>
	Children:
	<location>

[0047]

TABLE 6

Exemplary <action> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	Optional string. The fully-qualified class name for
	the class that defines this action. In one embodiment,
	the class can have a parameter-less constructor and
	implement an IAction interface. By way of a non-limiting
	example, this interface can be a fairly simple extension
	of Swing's own ActionListener interface. The interface
	can also implement a listener to allow the action to
	respond to property changes and update its state.
	IAction Method Summary:
	void actionPerformed(ActionEvent)
	Invoked when an action occurs.
	void propertyChange(PropertyChangeEvent)
	Updates the state of this action using the given
	property change event.
label	Optional string. The text to display for this action
	in menus. Place ‘&’ before the character which
	is to be the menu mnemonic. A programmer can also
	indicate the action's default key-stroke accelerator
	by preceding it with ‘@’. If the label begins and
	ends with the ‘%’ escape character, the label is
	interpreted as a Java PropertyBundle path. The label
	(including accelerator) will be determined by using
	the ResourceSvc to load the property named by the path.
tooltip	Optional string. The text to show as a tool tip
	for a toolbar, in status bar for menus, or in
	customization dialogs.
icon	Optional string. A path to an image resource to
	show on toolbars and menus.
id	Optional string.

[0049]


	Syntax:
	<location path=“path”>
	Parents:
	<action>
	Children:
	None.

[0051]


	<extension-xml id=″urn:com:debugExpressionViews″>
	<view
	priority=″80″
	valueType=″java.lang.String″
	description=″View as XML″
	class=”workshop.debugger.ui.expressionview.XmlExpressionV
	iew”/>
	</extension-xml>
Syntax:
	<view
	class=″viewImplementation″
	description=″viewDescriptionInGIA″
	matchesNulls=″true \| false″
	priority=″rankingAmongViews″
	valueType=″typeWhoseDataThisIsAViewFor″
	>
Parents:
	<extension-xml>
Children:
	<view>

[0052]

TABLE 7

Exemplary <view> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	The fully-qualified name of the class that provides
	the custom view. In one embodiment, this class can
	implement an IDebugExpressionView interface. This
	interface is responsible for displaying, editing, and
	populating the children of an expression in locals
	and watch windows of a GIA debugger. Watch windows
	can add, remove, or completely specify which fields
	to show, and provide custom renderers and editors for its
	values.
	Implementing classes class can have a argument-less
	constructor, as they can be instantiated using
	Class.newInstance( ). Mappings between types
	and which views they should use can be specified in
	extension.xml.
	Views can also used to render the hovering value
	tooltip in the source editor when debugging. The
	default view is always used for these tooltips.
	When inserting a view, it can be first instantiated
	using Class.newInstance( ), then init( ) is called,
	and it is then added to its parent in the tree.
	If there are exceptions thrown when instantiating a
	debugger view, they can be logged to a file, and
	the matching view with the next highest priority
	can be instantiated. Common causes of problems
	include classpath issues that prevent the class
	from being found by the classloader, not having
	a public argument-less constructor, or having an
	exception thrown in the view's constructor.
description	The description to display for the view when the
	user right-clicks.
priority	A number indicating this view's ranking among views
	for variables of this type.
valueType	The fully-qualified name of the type to provide
	this view for.

[0054]


	Syntax:
	<document-handler
	class=“handlerClassName”
	icon=“pathToIcon”
	label=“descriptiveTextForDocumentType”
	>
	Parents:
	<extension-xml>
	Children:
	<file-extension>, <create-template>, <project-attributes>

[0055]

TABLE 8

Exemplary <document-handler> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	The fully-qualified name of the handler class for
	this document type. In one embodiment, the specified
	class can implement an IDocumentHandler interface.
	The IDocumentHandler is a basic interface that the
	document service can use to map a URI to an IDocument
	interface. Handlers are registered with the IDE at
	startup using extension.xml. The extension XML allows
	the specification of a set of project attributes that
	can be used to limit the scope of a document handler
	to specific sets of projects. Attributes may
	be required by the handler on the project that
	contains a document it opens.
icon	Path to an image that can be used to represent
	this file type. This will be used, for example,
	to allow the Application window to display an image
	next to the file name.
label	A plain text description of this file type. This
	will be used as explanatory text where appropriate.

[0057]


	Syntax:
	<file-extension
	priority=“prioritySetting”
	[handler=“handlerName”]
	>
	Parents:
	<document-handler>
	Children:
	None

[0058]

TABLE 9

Exemplary <file-extension> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

priority	The ranking of the handler for this file extension.
	The priority attribute captures a relative ranking
	of how well the handler understands this particular
	extension. A document service can use this to find
	a default handler for a given file extension. It will
	choose the handler with the highest priority. In the
	event of a tie, one of the handlers with the highest
	priority can be arbitrarily chosen.
	Possible values are: lowest, low, medium, high,
	highest, unknown and info-only. A value of
	“unknown” indicates that the handler can
	actually inspect the contents of the file in order
	to determine what priority it actually has. A value
	of “info-only” indicates that the handler does
	not possess any knowledge of the contents of the
	file, but merely provides an icon and description.
handler	Optional string. In one embodiment, an
	″unknown″ priority value indicates that the
	handler can actually inspect the contents of a file in
	order to determine what priority it actually has. By
	way of a non-limiting example, imagine a Dialog editor
	that understands files Java ™ files, but only if the
	class extends the JDialog class. If no ″highest″
	handler is available for a file at run time,
	″unknown″ handlers can be given the opportunity
	to inspect the file and return one of the six more
	specific priority values. The highest priority among
	the ″unknown″ type handlers and any remaining
	non-″highest″ handlers will be designated as the
	default handler for a file.

[0060] In one embodiment, a <create-template> element can specify information used in a right-click UI menu and/or a New File dialog when creating a new file of this type.

[0061]


	Syntax:
	<create-template
	[id=“id”]
	priority=“priorityNumber”
	[createCategories=“fileCategories”]
	[label=“descriptiveText”]
	>
	Parents:
	<document-handler>
	Children:
	<description>

[0062]

TABLE 10

Exemplary <create-template> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

priority	A number indicating this handler's ranking for
	this file type.
label	A plain text description of this file type.
	This can be used as explanatory text where
	appropriate.
createCategories	Categories in the New File dialog under which
	this file type will appear. Make this value
	“ShortCut” to specify that the file
	type can appear on the right-click menu.
id	Optional string.

[0063] In one embodiment, a <description> element can be used to specify text that can appear for this file type in the New File dialog.

[0064]


	Syntax:
	<description>
	Description text that appears for file type in the New File
	dialog.
	</description>
	Parents:
	<create-template>.
	Children:
	None.

[0066]


	<extension-xml>
	<file-encoding appliesTo=“htm” treatAs=“html”/>
	</extension-xml>
	Syntax:
	<file-encoding
	appliesTo=“handlerClassName”
	[class=“pathToIcon”]
	[treatAs=“descriptiveTextForDocumentType”]
	>
	Parents:
	<extension-xml>
	Children:
	None.

[0067]

TABLE 11

Exemplary <file-encoding> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

appliesTo	The extension or extensions for files this encoding
	extension applies to.
class	The fully-qualified name of a class to use for
	handling files with this extension.
treatAs	The extension of files whose handler can be used
	to handle files this encoding extension applies to.

[0069]


	Syntax:
	<frame-view-set>
	<!-- frame-view elements to specify new frames -->
	</frame-view-set>
	Parents:
	<extension-xml>
	Children:
	<frame-view>

[0071]


	Syntax:
	<frame-view
	askavailable=“true \| false”
	class=“classNameForViewImplementation”
	[hasaction=“true \| false”]
	[icon=“pathToGifFile”]
	[id=“identifierForThisView”]
	label=“labelToDisplayInUI”
	>
	Parents:
	<frame-view-set>
	Children:
	None.

[0072]

TABLE 12

Exemplary <frame-view> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

askavailable	Optional boolean. Set to “True” to specify
	that this view implements an IFrameView, and
	that its isAvailable( ) method can be called
	to determine whether the frame can be shown.
	Implement this interface, or derive from
	JComponent for all classes specified in the
	‘class’ attribute of a <frame-view> tag.
	IFrameView's benefits over using a simple
	JComponent are, that it can provide a
	‘Component’ other than itself, for cases
	where component construction is more complex,
	and it can specify the view's ‘availability’
	dynamically.
class	The fully-qualified class name of the frame view
	implementation. the class that is your
	implementation of the view - its user interface
	and behavior. A frame view implementation class
	can extend Component, implement IFrameView,
	or both.
hasaction	True to specify that a menu item for this view
	cannot be shown in a generated frame view menu.
icon	Path to a GIF file that can be used to represent
	this view in menus.
id	An identifier to distinguish between multiple
	instances of the implementation class.
label	The label used in the view tab, and in the
	View menu.

[0074]


	Syntax:
	<application-layout
	id=“layoutInWhichTheseLayoutsShouldAppear”
	>
	Parents:
	<extension-xml>
	Children:
	<frame-layout>

[0075]

TABLE 13

Exemplary <application-layout> Element
Attributes in an Embodiment
	ATTRIBUTE	DESCRIPTION

	id	Identifier for the application layout to which
		this element's children can be applied. In one
		embodiment, valid values include “main” and
		“urn:com:debug”.

[0076] In one embodiment, a <frame-layout> element can specify the parameters of a layout, or the specific positions of one or more frame views at GIA startup.

[0077]


	Syntax:
	<frame-layout
	id=“frameLayoutID”
	>
	Parents:
	<application-layout>
	Children:
	<frame-container>

[0078]

TABLE 14

Exemplary <frame-layout> Element Attributes in an Embodiment
	ATTRIBUTE	DESCRIPTION

	id	Id of the frame layout to which the children can
		be applied. The valid value is “main”.

[0080]


	Syntax:
	<frame-container
	[orientation=“orientationInGIA”]
	proportion=“percentageOfGIASpace”
	>
	Parents:
	<frame-layout>
	Children:
	<frame-view-ref>, <frame-container>.

[0081]

TABLE 15

Exemplary <frame-container> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

orientation	This container's orientation in the layout. Valid
	values are “tabbed”, “root”, “north”, “south”,
	“west”, or “east”. Valid only on the root
	<frame-container> in a <frame-layout> element.
proportion	The percentage of space that this container can
	occupy in the GIA. For example, a container
	oriented “south” with a proportion of “25%”
	would occupy the lower 25 percent of the GIA. As
	with HTML tables, proportions need not add up
	to 100 percent.

[0083]


	Syntax:
	<frame-view-ref
	class=“frameViewImplementationClass”
	[id=“frameLayoutID”]
	[proportion=“percentageOfContainerSpace”]
	[visible=“true \| false”]
	>
	Parents:
	<frame-container>
	Children:
	None.

[0084]

TABLE 16

Exemplary <frame-view-ref> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	The fully-qualified class name of the frame
	view implementation.
id	An identifier to distinguish between multiple
	instances of the implementation class.
proportion	The percentage of space that this container
	can occupy in the container. For example, a
	container oriented “south” with a proportion
	of “25%” would occupy the lower 25 percent of
	the GIA. As with HTML tables, proportions need
	not add up to 100 percent.
visible	Boolean: false to hide this frame on startup.

[0086]


	Syntax:
	<help-root
	dir=“pathRelativeToParent”
	parent=“parentForHelpPaths”
	url=“urlToHelpRoot”
	>
	Parents:
	<extension-xml>
	Children:
	None.

[0087]

TABLE 17

Exemplary <help-root> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

dir	Optional string. The directory to search as
	a help root. This directory is relative to the
	value specified in the parent attribute.
parent	Optional string. A path to a JAR file or
	directory relative to the WebLogic Workshop
	extensions directory. An absolute path may be
	used, but it is not recommended. If this
	attribute is omitted, the directory is assumed to
	be in the extension's own JAR file or directory.
url	Optional string. An absolute URL that specifies
	a new help root. This may be any URL, but will
	typically be HTTP or file based. Set this
	attribute's value as an alternative to setting
	the dir and parent attribute values.

[0089]


	Syntax:
	<GIA-preferences>
	<!-- panel elements that define user interface for the
	properties panel -->
	</GIA-preferences>
	Parents:
	<extension-xml>
	Children:
	<panel>

[0090] In one embodiment, a <workspace-preferences> element can specify one or more panels that can be included in the Application Properties dialog.

[0091]


	Syntax:
	<workspace-preferences>
	<!-- panel elements that define user interface for the
	properties panel -->
	</workspace-preferences>
	Parents:
	<extension-xml>
	Children:
	<panel>

[0092] In one embodiment, a <project-preferences> element can specify one or more GUI panels that can be included in the Project Properties dialog.

[0093]


	Syntax:
	<project-preferences>
	<!-- panel elements that define user interface for the
	properties panel -->
	</project-preferences>
	Parents:
	<extension-xml>
	Children:
	<panel>

[0094] In one embodiment, a <panel> element can specify a panel that can appear in a properties dialog.

[0095]


Syntax:
	<panel
	class=“implementationClassName”
	label=“labelForThisPanelInDialog”
	[priority=“numberForDisplayRanking”]
	>
Parents:
	<GIA-preferences>, <workspace-preferences>, <project-preferences>
Children:
	None.

[0096]

TABLE 18

Exemplary <panel> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	The fully-qualified name of the panel's
	implementation class.
label	The name that can appear in the properties dialog,
	and which the user clicks to select the panel.
priority	Optional int. A number indicating the ranking
	for this panel in the list of panels.

[0097] In one embodiment, a <project-type> element can specify details related to the project's appearance in the GIA and about a project type file name extension.

[0098]


	Syntax:
	<project-type
	id=“IdentifierForProjectType”
	closedfoldericon=“pathToGifFile”
	icon=“pathToIcon”
	label=“descriptiveTextForDocumentType”
	openfoldericon=“pathToGifFile”
	>
	Parents:
	<extension-xml>
	Children:
	<attribute>, <driver>

[0099]

TABLE 19

Exemplary <project-type> Element Attributes in an Embodiment
	ATTRIBUTE	DESCRIPTION

	id	An identifier for this project type. This
		can be a short name representing this project
		type -- for example, “php” for a PHP project
		type.
	closedfoldericon	The path to the .gif file representing the
		top-level folder of a project of
		this type when the folder is closed.
	icon	The path to the .gif file to use for
		representing this project type in the UI.
	label	The text to display for this project type in
		the New Project dialog.
	openfoldericon	The path to the .gif file representing the
		top-level folder of a project of
		this type when the folder is open.

[0101]


	Syntax:
	<attribute
	name=“attributeName”
	value=“attributeValue”
	>
	Parents:
	<project-type>
	Children:
	None.

[0102]

TABLE 20

Exemplary <attribute> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

name	The name of the attribute whose value is being specified.
value	The attribute's value.

[0104]


	Syntax:
	<driver
	class=“driverImplementationClass”
	type=“driverInterface”
	>
	Parents:
	<project-type>
	Children:
	None.

[0105]

TABLE 21

Exemplary <driver> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

class	Required string. The fully-qualified name of the
	driver implementation. This class can implement
	the interface specified in the type attribute.
type	Required string. The fully-qualified name of the
	driver interface.

[0108] In one embodiment, a <template-definition> element is the top-level element for project templates. It can contain any number of <project-template> and <application-template> elements.

[0109]


Syntax:
	<template-definition>
	<!-- Children <project-template> and <application-template>
	elements. -->
	</template-definition>
Parents:
	None
Children:
	<project-template>, <application-template>

[0112]


	Syntax
	<project-template
	type=“projectType”
	id=“projectID”
	[extends=“extendedProjectID”]
	[processor=“IProjectTemplateProcessor”]
	>
	Parents:
	<template-definition>
	Children:
	<display>, <content>

[0113]

TABLE 22

Exemplary <project-template> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

type	Identifies the type of project that will be
	created. Project types can be defined in
	extension.xml and define how the project builds,
	deploys and runs, as well as how this template
	will be processed.
id	Uniquely identifies this template among all
	templates defined for its project type. Note that
	this id does not have to be unique among all
	project templates.
extends	Points to the id of a template of the same project
	type that this template extends. If this attribute
	is set, then un-initialized, non-required attributes
	can be set to values from the extended template.
processor	Class name of a template processor implementation.
	If this attribute is omitted, then a default
	processor implementation will be created.

[0114] In one embodiment, a <display> element can display options for a New Project dialog.

[0115]


	Syntax:
	<display
	location=“ newdialog \| importdialog \| contextmenu ”
	[label=“projLabel”]
	[icon=“imageName”]
	[description=“projDescription”]
	[priority=“menuLocationInteger”]
	[categories=“projCategory1, projCategory2, ...”]
	>
	Parents:
	<project-template>
	Children:
	None.

[0116]

TABLE 23

Exemplary <display> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

location	Comma separated list of display location identifiers.
	Workshop-defined values:
	newdialog - a New Project dialog
	importdialog - an Import Project dialog
	contextmenu - a project context menu
label	Label that can be displayed in the New Project dialogs.
icon	Icon that can be displayed for this template. All
	project types will specify a default icon which will
	be used if this attribute is omitted. The value of
	this attribute may be a GIF file in the template ZIP
	file, or it may be a resource in an extension JAR file.
description	Optional string. Description of this template that
	will be displayed in the Project dialogs.
priority	Optional integer. Used to order the templates
	displayed in the dialog template list, higher values
	being displayed before lower values.
categories	Optional string. Comma separated list of template
	category names.

[0117] In one embodiment, a <content> element can be used to specify a menu item.

[0118]


	Syntax:
	<content
	type=“ archive \| file ”
	destination=“ project \| libraries \| modules ”
	source=“sourceFileOrZIP”
	[overwrite=“ true \| false ”]
	>
	Parents:
	<project-template>
	Children:
	None.

[0119]

TABLE 24

Exemplary <content> Element Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

type	Indicates how the source file can be processed.
	Values supported by the default template processor:
	archive - a zip file
	file - a file
destination	Where the content will be placed. Values supported
	by the default template processor:
	project - the root of the project directory
	libraries - the application Libraries directory
	modules - the application Modules directory
source	The content source file; when opening as a stream,
	will first look in the template ZIP file, then it
	try to open the content as a resource.
overwrite	Optional boolean. Specifies the behavior if same
	files already exist in the application directories.
	If this attribute is omitted, the value is false.
	The default template processor will immediately
	quit processing this content element if
	overwrite is false and a collision occurs.

[0122]


	Syntax:
	<application-template
	id=“uniqueID”
	>
	Parents:
	<template-definition>
	Children:
	<display>, <content>, <project-template-ref>

[0123]

TABLE 25

Exemplary <application-template> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

id	Uniquely identifies this application template
	among all application templates defined in this
	template zip file. Note that this id does not have
	to be unique among all application templates loaded
	by Workshop.

[0125]


	Syntax:
	<project-template-ref
	[default-name=“name”]
	[type=“projType”]
	[template=“projTemplateID”]
	>
	Parents:
	<application-template>
	Children:
	None.

[0126]

TABLE 26

Exemplary <project-template-ref> Element
Attributes in an Embodiment
ATTRIBUTE	DESCRIPTION

default-name	The name that will be used for the created project.
type	A project	Possible values:
	type id.
	TYPE	DESCRIPTION
	Datasync	Datasync projects contain server
		data including campaigns, content,
		placeholders, content selectors,
		user segments, and property sets.
	Control	Control projects are used to create
		Java controls and packaging them
		as JAR files.
	WebApp	WebApp projects can contain web
		applications, web services,
		and business processes.
	EJB	EJB projects are used to create
		EJBs and packaging them as JAR files.
	PortalWebApp	A WebApp project that also enables
		Portals. This can only be added
		to an portal enabled application.
	xbean	Schema project for building
		XMLBean JARs from schema files
		(XSD files).
template	A project template id.

[0127] The following is an annotated example of a template.xml file.

[0128]


<template-definition>
<!-- This a Web project template and extends the ‘default’ Web
project template. -->
	<project-template id=“_example_proj1_”
	type=“urn:com:project.type:WebApp”
	extends=“default”
processor=“workshop.workspace.project.TestTemplateProcessor”>
	<!-- Defines where and how this template will be
displayed to the Workshop user. -->
	<display
	location=“newdialog, importdialog”
	label=“_Example Project_”
	description=“This project template demonstrates the
Workshop template syntax, and extends the default web project
template. See {wlw_install_dir}/templates/example-template.zip.”
	icon=“exampleProject.gif”
	priority=“0”
	categories=“_Example_” />
	<!-- zip to be extracted at the root of the project
directory -->
	<content type=“archive” destination=“project”
source=“default-project.zip”/>
	<!-- file to be put in the libraries directory -->
	<content type=“file” destination=“libraries”
source=“CreditScoreBean.jar” overwrite=“true”/>
	<!-- file to be put in the modules directory -->
	<content type=“file” destination=“modules”
source=“CreditScoreEJB.jar” overwrite=“true”/>
	</project-template>
	<!-- This a Web project template that will appear in the
Application tree's Install context menu
	when the user right-clicks on a Web project folder.
	Note that this template uses a custom template processor
implementation. This class could
	query the user for input, examine and update existing
configuration files, and control how
	content elements are added to the project. -->
	<project-template id=“_example_proj1_installmenu_”
	type=“urn:com:project.type:WebApp”
processor=“workshop.workspace.project.InstallTemplateProcessor”>
	<!-- Defines where and how this template will be
displayed to the Workshop user. -->
	<display
	location=“contextmenu”
	label=“_Add Project Resources_”
	description=“This project template demonstrates the
Workshop template syntax, and extends the default web project
template. See {wlw_install_dir}/templates/example-template.zip.”
	icon=“exampleProject.gif”
	categories=“_Example_” />
	<!-- zip to be extracted at the root of the project
directory -->
	<content type=“archive” destination=“project”
source=“ui_resouces.zip”/>
	</project-template>
<application-template id=“_example_app1_”>
	<display
	location=“newdialog”
	icon=“exampleApp.gif”
	label=“_Example Application 1_”
	description=“This application template demonstrates
the Workshop template syntax. See
{wlw_install_dir}/templates/example-template.zip.”
	priority=“1”
	categories=“_Example_” />
	<!-- zip to be extracted in the libraries directory -->
	<content type=“archive” destination=“libraries”
source=“libraries.zip”/>
	<!-- file to be put in the modules directory -->
	<content type=“file” destination=“modules”
source=“testEJB.jar”/>
	<!-- references a project template defined in another
template zip file -->
	<project-template-ref default-name=“_StandardControl_”
type=“Control” template=“default”/>
	<!-- references a project template defined above -->
	<project-template-ref default-name=“_ExampleWebApp_”
type=“urn:com:project.type:WebApp” template=“_example_proj1_”/>
	<!-- project template only used in this application
template -->
	<project-template default-name=“_Example Java_”
	id=“_example_app1_proj1_”
	type=“Java”>
	<content type=“file” destination=“project”
source=“Example.java”/>
	</project-template>
	</application-template>
	<!--
	This application template extends an application template
defined in this
	template zip. Currently we only support extending app
templates defined
	in the same template zip.
	-->
	<application-template id=“_example_app2_”
	extends=“_example_app1_”>
	<display
	location=“contextmenu”
	label=“_Example Application Content_” />
	<!-- A project template only used in this application
template.
	Extends the default control project -->
	<project-template default-name=“_ExampleControl_”
	id=“_example_app2_proj1_”
	type=“Control”
	extends=“default”>
	<content type=“file” destination=“project”
source=“Example.java”/>
	</project-template>
	</application-template>
</template-definition>