# Patent

## Title
Reusable software components

## Abstract

Methods and apparatus, including computer program products, implement techniques for structuring applications into reusable components. A reusable component having an external interface and an internal interface is implemented. The component encapsulates functionality, where multiple instances of the component are reusable at the same time. The component is configurable to embed one or more specified components. The external interface comprises an external programming interface, an external data-binding interface, and an external visual interface. The internal interface comprises an embedding interface, an internal programming interface, an internal data-binding interface, and an internal visual interface. The embedding interface specifies one or more component interfaces of components that can be embedded.

## Background
BACKGROUND
The present invention relates to electronic data processing in general, and particularly to application programming.
Applications can be developed using various architectures, including, for example, a model-view-controller (MVC) architecture. The MVC architecture breaks an application into three separate parts—models, views, and controllers. Each model can have multiple views, where each view displays information about the model to a user. A controller of the model receives events, for example, raised by a user interacting with a view to manipulate the model. Each model can have multiple controllers, and a controller can relate to multiple views. The models and the controllers typically include application code. When changes occur in a model, the model updates its views. Databinding is used for data transport between the view and its model or controller. For example, a table view can be defined to display data of a corresponding table that is stored in the model or controller. The table is used as the data source for the table view (databinding). For example, the table view can be replaced by a further view, such as a graph view, that binds against the same table. In this case, the further view displays the table data without changing anything in the controller or the model.
Application development is often divided into two general stages: design time and runtime. Design time can include designing the views of an application (including the layout of the user interface (UI) elements in each view), modeling of the application flow (including the selection of the views to displayed), designing one or more models, and creating and editing other application elements, such as controllers and contexts. Design time can also include the binding of UI elements within the views to data sources that are defined in a data type repository.
Information created during the design time can include application metadata. Application metadata can be stored in a metadata repository, and used as input to the runtime process. During the runtime process, the application metadata can be used to generate the actual runtime code of an application. In some implementations, the application metadata is platform independent, and the generated runtime code is platform specific. The runtime code can be executed in a runtime environment that provides a general framework for running applications. For example, a runtime environment can provide services for deploying and maintaining applications, as well as features such as a caching mechanism that can be used to improve performance, and automatic input assistance and default error handling that is based on the declared application metadata.
Regardless of which architecture is used, it is often desirable to structure an application (including, for example, the models, views, and controllers that make up an MVC application) into reusable entities or components. The reusable components can be embedded by the application, or by another reusable component.
SUMMARY OF THE INVENTION
In general, in one aspect, the invention provides methods and apparatus, including computer program products implementing techniques for structuring applications into reusable components. The techniques include defining a component having an external interface and internal interface, where the component is a reusable software component encapsulating functionality, and where multiple instances of the component are usable at the same time. The component is configurable to embed one or more specified components. The external interface comprises an external programming interface for programmatic interaction with the component, and external data-binding interface for data communication with the component, and an external visual interface for access to a visual presentation of the component. The internal interface provides an interface to the specified embedded components, where the internal interface comprises an embedding interface for specifying one or more component interfaces of components that can be embedded and internal programming interface for programmatic interaction with the embedded components, an internal data-binding interface for data communication with the embedded components and an internal visual interface for access to a visual representation of the embedded components.
Advantageous implementations of the invention include one or more of the following features. The external programming interface, the external data-binding interface, and the external visual interface are separate interfaces. The embedding interface, the internal programming interface, the internal data-binding interface, and the internal visual interface are separate interfaces. One or more of the internal programming interface, the internal data-binding interface, and the internal visual interface are not implemented.
In another aspect, the invention provides methods and apparatus, implementing techniques for receiving user input identifying a first component and a second component, and receiving user input embedding the second component within the first component. The first component has a first internal interface that comprises an internal programming interface and internal data-binding interface, and internal visual interface, and an embedding interface. The second component has a second external interface that comprises an external programming interface, an external data-binding interface, and an external visual interface. The received user input embedding the second component within the first component connects the first internal interface to the second external interface.
Advantageous implementations of the invention include one or more of the following features. The techniques further include generating configuration data for the first component, where the configuration data includes configuration data for the embedding interface, the internal programming interface, the internal data-binding interface, and the internal visual interface. The configuration data for the embedding interface specifies external interfaces of one or more components that can be embedded in the first component. The configuration data for the embedding interface specifies a number of instances of a component of the one or more components that can be embedded in the first component. The configuration data for the internal programming interface, the internal data-binding interface, and the internal visual interface specifies connections with the external programming interface, the external data-binding interface, and the external visual interface respectively.
Implementations can realize one or more of the following advantages. Applications implemented using reusable software components that provide an internal interface can be configured by a business expert to customize the application user interface (UI). The business expert can customize the application UI for such applications in a code free manner that does not require any software development by the business expert. The business expert can customize such applications in a visual composition tool. Applications implemented using reusable software components that provide an internal interface can be customized by a business expert by embedding components using the internal interface or by connecting components to the internal interface using a visual tool. The details of one or more implementations of the invention are set forth in the accompanying drawings and the description below. Further features, aspects, and advantages of the invention will become apparent from the description, the drawings, and the claims.



BRIEF DESCRIPTION OF THE DRAWINGS
FIG. 1 is a block diagram of a development environment for developing an application program using reusable components.
FIG. 2A is a block diagram of a component.
FIG. 2B illustrates further features of a component.
FIG. 3 is a block diagram of a system for accessing an embedded component instance.
FIG. 4 is a block diagram of a view.
FIG. 5 illustrates a visual interface with multiple views that are linked together using navigation links.
FIG. 6 illustrates an example of a structure of a context 604 at design time and at runtime.
FIG. 7 illustrates the context 604 at runtime as a set of data instances.
FIG. 8 illustrates mapping of contexts according to the present invention.
FIG. 9 is a block diagram of a reusable software component providing an external interface and an internal interface.
FIG. 10 is a block diagram illustrating different roles and functions involved in the development of applications using components that provide external and internal interfaces.
FIG. 11 illustrates an example of configuring a component to embed other components.



Like reference numbers and designations in the various drawings indicate like elements.
DETAILED DESCRIPTION
FIG. 1 is a block diagram of an environment for developing an application program 100 using reusable components. The development environment includes an application development framework 105 and a component repository 115. The application program 100 is developed using reusable components available in the component repository 110, e.g., components 115, 120, and 125. A component in the component repository 110 can have more than one instance, where the component instances are being used in multiple application programs. The application program 100 is developed at design time using the application development framework 105.
At runtime, the application runs within a runtime framework that provides the code required to create and manage the instances of the components used by the application program 100. As discussed below, the services provided by the runtime framework include component lifecycle management and managing component event subscriptions.
FIG. 2A is a block diagram of a component 200. The component 200 is a reusable entity providing functionality that can be used by many applications (or that can be used multiple times by the same application). Components 200 can be embedded, and they can have zero or more visual representations. A component having no visual representations cannot be displayed. An application or a component that embeds the component 200 is referred to as a component embedder for the component 200, and the component 200 is referred to as the embedded component.
The component 200 provides three separate interfaces—a programming interface 205, a data binding interface 210, and a visual interface 215. The programming interface 205 is used by the component embedder to interact with the component 200. The component interface is an active component. The component interface is not just a signature. The component interface defines the component methods that are visible to the component embedder and routes the visible method calls to one or more component implementations. The component embedder embeds the component 200 by programming to the programming interface 205, i.e., the component embedder can call the methods provided by the programming interface 205. In one implementation, the programming interface 205 can be provided by a controller, referred to as a component interface controller. Thus a component embedder can interact with an embedded component through the interface controller of the embedded component.
The component 200 also has one or more visual representations (which will be referred to as views). As described below, a component embedder can access and use the visual representations of the component 200 (for example, to form its own visual representations) through a visual interface 215.
The databinding interface 210, described below, is used by a component embedder to exchange data with the component 200.
In one implementation, the component 200 includes one or more controllers, one or more associated contexts, and optionally one or more views. The controllers are used to implement the logic of the component, and the views provide a visual representation of the component. A component can include multiple types of controllers, as explained below. The controllers implement event handlers that are executed in response to an action performed by a user, e.g., pressing a button or making a menu selection. Each controller is bound to an associated context. A context is a local data structure for a controller that stores data and state specific to the controller.
FIG. 2B illustrates further features of a component 200. The programming interface 205 for the component 200 includes an interface controller 220 and a configuration controller 230. The interface controller 220 implements methods that can be used (e.g., by a component embedder) to interact with the component 200. The configuration controller 230 provides access to configuration data for the component 200. The interface controller 220 has an associated interface context 225 that stores data and state for the interface controller 220. The configuration controller 230 has an associated configuration context 235 that stores configuration data for component 200. The component embedder uses the data-binding interface 210 to exchange data with the interface context 225 and the configuration context 235. The runtime framework 105 initializes the configuration context 235 when an instance of the component 200 is created at runtime using configuration data provided by the component embedder. The configuration data stored in the configuration context can include data used by the component embedder to customize the component 200, e.g., font size, and selection of fields for a table view.
FIG. 4 is a block diagram of a view. A visual interface of a software application is made up of one or more views arranged in a specific layout. A view 400 specifies a layout of at least one user interface element (UI) element 405, and a view area. UI elements in a view can include buttons, labels, and menus. The view area defines the area to be occupied by the view 400 in a visual interface embedding the view 400. The UI elements included in the view 400 can include Input UI elements, View UI elements, and Container UI elements. An Input UT element is used to receive input from the user, e.g., a drop down menu, an input field, or a table UI element. A View UI element is used to display application data, e.g., an image view, a text view, or a caption. A Container UI element, described below, is used to include other views and UI elements, e.g., a scroll container UI element having a scroll bar, or a container UI element specifying a layout for included views.
The visual interface can have more than one view, of which only some views are visible at any time. The views that are visible in the visual interface can change, e.g., the views that are visible can change in response to input from the user. Inbound plugs, outbound plugs, and navigation links are design time constructs that are used by application developer to specify transitions between the views. Each view has an inbound plug 420 and an outbound plug 425. At design time, each navigation link establishes a potential transition from the view with the outbound plug 425 to the view with the inbound plug 420. At design time, a transition from a first view to a second view is specified by connecting the outbound plug 425 of the first view to the inbound plug of the second view. The navigation links are processed at runtime to cause the view transitions specified at design time. At runtime, the application calls the outbound plug of the first view to cause a transition from the first view to the second view.
Each inbound plug 420 includes an application specific event handler, and calling the inbound plug results in running the event handler for the inbound plug 420 before displaying the view 400 corresponding to the inbound plug 420. Navigation links are typically processed in a runtime framework by calling all the inbound plugs 420 connected to an outbound plug 425 when the outbound plug 425 is called. The event handler for an inbound plug 420 can call the outbound plug 425 for the view corresponding to the inbound plug to cause other views connected to the outbound plug 425 to be displayed. The application can use the event handler for the inbound plug 420 to initialize the corresponding view, e.g., the corresponding view can be initialized based on why the view is being displayed.
The view 400 can have an associated view controller that includes the event handlers associated with the inbound plug. The view controller also contains event handlers for the UI elements in the view as well as the presentation logic for the view.
The application or a reusable component can specify any number of views at design time, any of which can be displayed at runtime. The set of views that can be displayed, for the application or the component, is referred to as the view composition. A view assembly is the set of views that are actually displayed at runtime. The view assembly, for an application or a component, consists of views in the view composition that are selected for display at a certain point in time. When a navigation link is processed at runtime, a view in a current view assembly may be replaced by one or more destination views from the view composition.
FIG. 5 illustrates a visual interface with multiple views that are linked together using navigation links. Each navigation link connects an inbound plug to an outbound plug. The view area 500 includes three views 505, 510, and 515, of which view 505 is currently displayed in the view area 500. View 505 has inbound plug 515 and outbound plug 520. View 510 has inbound plug 525 and outbound plug 530. View 515 has inbound plug 535 and outbound plug 540. Outbound plug 520 is connected to inbound plug 525 by a navigation link 545, and outbound plug 520 is connected to inbound plug 535 by a navigation link 550. If view 505 activates outbound plug 520 by triggering the specified event for the outbound plug 520, views 510 and 515 are displayed in the view area 500 instead of the view 505.
Applications can make use of components that contain view compositions. Components can embed other components, such that a first component can interact and make use of a second, embedded, component. The view composition of the first component can include views of the second component. Similarly the view composition of the application can include views of the components used by the application. In addition, an application developer can design application specific views that are part of the application's view composition.
A component developer designates one of the views in the view composition of the component as an interface view 240. The interface view 240, and the associated inbound plug and outbound plug, are the visual interface for the component 200. At design time, the component embedder can use navigation links to specify view transitions to the interface views 240 of embedded components 200 like any other view in the view composition of the component embedder. A component can present more than one visual interface by defining more than one interface view.
Each view has a view controller and a view context associated with the view controller. The view controller implements presentation logic implemented by the view such as triggering events in response to user interaction with user interface elements in the view. The view context stores data and state associated with the view controller. The view context can be used to communicate data between the view and any controller of the component 200 by mapping the view context to the context of the controller.
Referring to FIG. 2 the component 200 can also include a component controller 250 that implements common functionality required by views implemented by the component. The component controller receives control when the component is instantiated, after the component instance has been initialized. The component 200 can also include one or more custom controllers 260, and associated contexts 265. The custom controllers 260 and associated contexts 265 are used to implement and structure functionality and data storage for the component 200.
The component embedder interacts with the embedded component 200 by using the programming interface 205, the data-binding interface 210, and the visual interface 215. The embedded component 200 can interact with the component embedder by generating events. The component embedder can subscribe to events generated by the embedded component 200, and react to such events.
FIG. 3 is a block diagram of a component embedder 310 using an instance 300 of an embedded component 200, at runtime. The embedded component instance 300 is created at runtime. The embedded component 200 is reusable and several instances 300 of the embedded component 200 can be used at the same time. In the implementation shown in FIG. 3, the runtime framework provides the services necessary for managing multiple component instances 300. Services provided by the runtime framework include the creation of component instances, e.g., using a component factory method to create component instances, and managing the lifecycle of component instances, e.g., deleting component instances embedded by a component embedder when the component embedder is deleted. Thus, neither the component embedder nor the embedded component 200 needs to include code for managing multiple component instances 300. Component usage object 305 is an object provided by the application development framework 105 to manage multiple component instances. Each component usage object 305 is associated with a component.
Component usage object 305 provides life-cycle management of the associated component 200 by providing methods for creating and deleting component instances 300 of the associated component 200 at runtime. The life-cycle of the component instance 300 is controlled by the component embedder 310. At design time an application programmer programs using a programming interface for a component without specifying a particular implementation of the component. The component programming interface used by the application programmer at design time is bound to a component implementation that provides the programming interface at run time. At run time, the component embedder 310 creates the component instance 300, implementing the component programming interface used by the component embedder, by calling the methods provided by the component usage object 305. The component usage object 305 responds to requests to create a component instance by selecting a component in the repository 110 that implements the desired programming interface and creating an instance of the selected component. Alternatively, if the application programmer specifies a component implementation at design time, an instance of the specified component can be created and used at runtime.
The runtime framework 115 uses component usage object 305 to access the programming interface of the associated component. The component usage object 305 is also used to manage event subscriptions for the associated component. In an implementation where a component embedder can subscribe to events generated by embedded components, the component usage object 305 caches the event subscriptions for subscribing component, if there is no instance of the subscribing component (because the subscribing component has not been created or because it has been deleted). In such a situation, the event subscriptions are delivered to the subscribing component when the subscribing component is instantiated. Component usage object 305 includes a context mapper 330 that maintains context mappings between the component embedder 310 and the component instance 300. The component usage object 305 caches specified context mappings for a component that has not been instantiated, and creates the specified context mappings for the component after the component has been instantiated.
Context is a local data structure for a controller that stores data and state specific to the controller. Controllers within a component, i.e., the interface controller, the configuration controller, the component controller, custom controllers, and view controllers, communicate data by mapping contexts. Similarly, the data-binding interface allows the component embedder 310 to communicate data with the embedded component 300 by mapping the interface context 225 and the configuration context 235 using the context mapper 330.
FIG. 6 illustrates an example of a structure of a context 604 at design time and at runtime. In general, structure elements of the design time context structure are different from structure elements of the runtime context structure.
An example of a design time context structure is a node hierarchy, wherein the structure elements of the node hierarchy can be nodes and attributes. The root-node of the node hierarchy represents the context itself. For example, the child nodes of the root node can be defined by the application. Child nodes of the root node will also be referred to as independent nodes. Child nodes of independent nodes depend on their corresponding parent node and will also be referred to as dependent nodes.
A node has a node type. Examples of node types are value nodes and model nodes. A value node can maintain, that is, store and administrate, its own application data (transient application data). The data can be, for example, scalar data, tables or structures. A model node includes a reference to application data that persists in a corresponding model.
The parent node can also have attributes. Each child node can include an arbitrary tree structure that includes further child nodes and/or attributes. Attributes are leaves in the tree structure. Attributes represent, for example, scalar data types, such as strings and integers or JavaTM types (e.g., java.util,Date).
In the example of FIG. 6, at design time, the context 604 includes the independent node PN that includes the two attributes A1, A2 and that is the parent node of the dependent nodes CN1, CN2. The second dependent node CN2 has two further attributes A3, A4. This structure defines a first node element 601 for the parent node PN and a second node element 602 for the second child node CN2. The first node element 601 includes information about the context structure with regards to the parent node PN. In other words, it summarizes all information that is available at the context structure level that is under the level of the parent node PN. The second node element 602 includes information about the context structure with regards to the second dependent node CN2. The context structure implies that the second node element 602 depends on the first node element 601.
At runtime, structure elements (e.g., nodes) represent a set of data instances. Nodes provide type information about object instances that are maintained by the node. Each node can have a node collection, wherein each element of the node collection has the same node element type.
In the example of FIG. 6, at runtime, the parent node PN has a first node collection 701 that includes multiple runtime instances of the first node element 601. Each runtime instance of the first node element 601 can have a second node collection 702 of multiple runtime instances of the second node element 602. A node collection can be empty or has at least one instance of the corresponding node element.
A node collection has a cardinality and a node collection type, such as list, tree, set, or collection. The node collection cardinality (see table 2) and the node collection type (see table 1) can be declared at design time. An evaluation mechanism can be used to automatically evaluate the node collection of a child node at runtime when its parent node changes.







TABLE 1







Examples of node collection types








Value
Meaning





Collection
forward-only iterator (cursor) without absolute positioning


Set
no duplicates, forward-only iterator without absolute



positioning


List
duplicates allowed, position available, list iterator, absolute



positioning (indexed access)









The application can use the cardinality of a node collection to restrict possible operations on a node (e.g., prohibit indexed access to a node that has at most one node collection element).







TABLE 2







Examples of the cardinality of a node collection








Value
Meaning





0 . . . 1
node collection can be empty, contains at most one element


1 . . . 1
node collection always contains exactly one element.


0 . . . n
node collection can be empty or contain any number of elements


1 . . . n
node collection always contains at least one element.









The content of a node collection can be determined in various ways.
The node values of independent nodes can be set by initializers or event handlers or can be set through a supply function. The supply function is called when the node is accessed. To access a node, for example, the node is queried for its data by application code or by a user interface (UI) element (of the view) that is bound to the node.
Dependent nodes can get their values by using a supply function. For example, the node collection of a dependent node can become obsolete when a selection of its parent node changes. In this case the dependent node is recalculated, that is, the content of its node collection is determined on a subsequent access. In another example a representation instance is created for each dependent node of a parent node. The values of the representation instances are calculated when the corresponding parent node is accessed. In other words, using representation instances enables a “load data on demand” or a “unload data when not needed” mechanism. Therefore, memory is used in an efficient manner.
The content of a node collection can also be explicitly set to a state, such as “invalid” or “unfilled”. When the node is accessed the next time, the node collection content is determined again. This can be used to force a re-read of modified data when the modification (e.g., in the model) was not visible to the application runtime.
FIG. 7 illustrates the context 604 at runtime as a set of data instances. The nodes of the context at runtime represent a system-managed set of data instances (e.g., a java.sql.RecordSet). For example, data instances are returned 50 from a database or backend system 710 in response to a query (e.g., a structured query language (SQL) query) that is sent 40 from the computer system 700 to the database/backend system 710 when a node is accessed, for example, by an application. Examples of backend systems are Enterprises Resource Planning systems, Customer Relationship Management systems, web server systems providing web services or any other system that stores application data. Accessing a node means requesting data from the corresponding model. This can result in a corresponding query request from the model to the database/backend system 710. Nodes provide type information about object instances that are maintained by the node. The type information can also be derived from the model. For example, if the parent node PN corresponds to a customer, its node collection 701 can include all orders for this customer. When the application accesses the parent node PN, the computer system 700 can send 40 a query to retrieve all orders of the customer from the corresponding database/backend system 710, such as a sales and distribution (SD) system or a customer relationship management (CRM) system. The retrieved orders (data instances) are then returned 50 to the computer system 700 context 604 to fill the corresponding data of elements of the node collection 701.
FIG. 8 illustrates mapping of contexts according to the present invention.
Because UI elements (e.g., UI elements 851, 852) of views (e.g., VIEW 1, VIEW 2) that are used in a user interface (UI) 850 bind 81, 82 to view contexts (e.g., VIEW CONTEXT 1, VIEW CONTEXT 2) and long persisting data can reside in custom contexts (e.g., CUSTOM CONTEXT I), an embodiment of the present invention enables mapping 91, 92 of nodes/attributes of view contexts or custom contexts to nodes/attributes of custom contexts. In other words, nodes and attributes of view contexts or custom contexts can reference type-compatible nodes and attributes in other custom contexts. Nodes can also be mapped to other nodes within the same context. Node mapping reduces the need for copying data between several contexts by enabling a node N1 of a first context (e.g., a view context, such as VIEW CONTEXT 2, or a custom context) to reference 91 a node N1′ of a second context (e.g., a custom context, such as CUSTOM CONTEXT I, or an application context), where the node N1′ of the second context has or references the data. The same is true for attributes.
Therefore, the data can be manipulated in a custom/application context and each view context that references the custom/application context provides its view with the current data stored in the custom/application context. Mapping contexts can span multiple context levels. That is, a custom context can reference a further custom context. Therefore, context hierarchies can be created (see FIG. 7).
For example, related data can be collected in a dedicated custom context. The binding to this data is implemented by using a view context that is mapped to the custom context accordingly.
The extended MVC pattern enables an application developer to quickly modify an application while maintaining consistency of the application. For example, in some cases rearrangement of views or UI elements can be achieved without modifying the corresponding controller code. This provides a way for an application developer to better structure applications in light of potential functional enhancements or changes. For example, reusing a field that already exists on one view in other views can be achieved by defining the corresponding mapping while the corresponding controller code stays valid.
The following examples explain various features of context mapping that can be implemented with the present invention.
FIRST EXAMPLE
If a node M (“Mapped Node”) is mapped to a node O (“Origin Node”), node M maps its node collection to node O's node collection. The node selections of nodes M and O can be mapped. Node M can also maintain its own node selection on node O's node collection.
For example, the node collection cardinality of node M equals that of node O (e.g., by inheritance).
The selection cardinality can be inherited from origin node O. Node M can override the node cardinality inherited from node O.
If node O is a singleton node, node M is a singleton node, too. If node O is a non-singleton node, node M can be a singleton or non-singleton node. If node M is a non-singleton node it shares the same parent node collection with node O. If node M is a singleton node, then the collection of node M follows the instance of node O that belongs to the lead selection of node O's parent node.
For mapped nodes, the content of the node collection can be defined by the node collection of the origin node.
SECOND EXAMPLE
An independent node can always be mapped. It can be mapped to any other node in the same context or to any other node in another custom context (as long as no cycle is formed with regards to parent-child and mapping relationships).
A child node of a mapped node can be unmapped. In this case its content can be determined by the supply function mechanism.
When a parent node is mapped to a further parent node, a child node of the parent node can be mapped to a further child node of the further parent node. In other words, if node W is a child of node X and node Y is a child of node Z, node W can be mapped to node Y if node X is mapped to node Z.
If a child node of a mapped node is mapped to a further child node of the corresponding origin node, then either the mapped node maps to the node selection of the origin node or the origin node is a non-singleton node. This avoids a conflict between the dependencies implied by the parent/child relationship and the mapping relationship that results from mapping a selection of a child node of an unmapped node.
FIG. 9 illustrates one implementation of the reusable software component 200 that provides two types of interfaces—an external interface and an internal interface, i.e., external panel 950 and internal panel 955 respectively. The external interface 950 is used by an application or a component that embeds the component 200. The external interface provides three separate interfaces—the programming interface 205, the data-binding interface 210, and the visual interface 215 (hereinafter referred to as external programming interface, external data-binding interface, and external visual interface respectively). The internal interface 955 is used by a business expert to configure applications by embedding existing components into the component 200. The internal interface specifies what components can or should be embedded into the component 200 and the interface between the component 200 and components embedded using the internal interface. The internal interface provides four separate interfaces—a programming interface 905, a data-binding interface 910, a visual interface 915, and an embedding interface 920 (hereinafter referred to as internal programming interface, internal data-binding interface, internal visual interface, and embedding interface respectively).
The embedding interface 920 specifies one or more component interfaces of reusable components that can be embedded in the component 200. In one implementation, for each reusable component that can be embedded in the component 200, the embedding interface 920 specifies a number of instances of the reusable component that can be embedded, i.e., the cardinality of each reusable component. A component developer developing the component 200 specifies the embedding interface, including the specification of external interfaces of components that can be embedded in the component 200, and optionally the cardinality of each specified component external interface. The business expert configuring the component 200 configures the embedding interface to specify which components are to be embedded in the component 200. The external interfaces of the embedded components specified by the business expert must match one of the external interfaces specified by the component developer in the embedding interface. The business expert can also connect the external programming, data-binding, and visual interfaces of the embedded components to the internal programming, data-binding, and visual interfaces of the component 200, or to the external programming, data-binding, and visual interfaces of other embedded components respectively.
The internal programming interface 905 provides a programming interface between the component 200 and components that are embedded by the business expert. The internal programming interface can be used to specify events that are exposed by the component 200 to the embedded components, and event handlers provided by the component 200 to consume events generated by the embedded components. The internal programming interface 905 is similar to the external programming interface 205. However, the interface presented by the component 200 to an embedding component using the external programming interface 205 can be different from the interface presented to an embedded component using the internal programming interface 905. For example, some of the events and event handlers accessible through the external programming interface may not be accessible using the internal programming interface. The external programming interface specifies methods that can be used by a component embedder to interact with the component 200, and the internal programming interface specifies exits that are implemented by the component 200 to interface with embedded custom components. An exit is a predefined extension point at which a user or a developer can plug in a custom component. An exit specifies a predefined interface that must be implemented by the custom component in order to allow the custom component to be used by the component 200 in place of one or more standard components stored in the repository. The external programming interface also specifies an interface for communicating error states of the component 200 to the embedding components.
The internal data-binding interface 910 is used by the component 200 to exchange data with the embedded components. The internal data-binding interface specifies data that is passed from the component 200 to the embedded components and data that is expected to be delivered to the component 200 from the embedded components. The interface presented by the internal data-binding interface 910 can be different from the interface presented by the external data-binding interface 210 even though the two interfaces have similar features. For example, the configuration context presented to the embedding component using the external data-binding interface 210 can be different from the configuration context presented to the embedded components using the internal data-binding interface. In addition, the external data-binding interface is also used to exchange data related to the error states of the component 200 with the embedding components.
The internal visual interface 915 is used to specify a location for a visual representation of the embedded components in the visual representation of the component 200. The internal visual interface 915 and the external visual interface 215 can be used to present two different visual representations, even though the two interfaces have similar features. In a simplified implementation, the component 200 does not provide the internal visual interface 915.
Table 3 illustrates the features that are available in the external interface and the interface of the component.









TABLE 3






External Interface
Internal Interface







Visual Interface
(Public) Windows



Programming Interface
Interface and Configuration
Interface and



Controller with
Configuration



Events
Controller with



Event Handlers
Events



Methods
Event Handlers



Interface Controller with
Exits



Error State


Data-binding Interface
Configuration Context
Configuration



Interface Context
Context



Error State


Embedding Interface

Component Usages









The business expert configures an application by configuring the component 200 to reuse existing components that are embedded by the business expert. In one implementation, the component 200 exposes all configurable features and all configurable interfaces, i.e., typed holes, for embedding other components at the interfaces of the component 200, and the business expert configures the component 200 by interacting with the component interfaces, e.g., the internal interface. Exposing all the configurable features and all the configurable interfaces for embedding other components at the component interface allows a strict separation between the implementation of the component 200 and the configurable features and interfaces. As a result of this strict separation, the implementation of the component 200 is completely hidden from the business expert configuring the application, and the implementation of the component can be changed without invalidating a configured application.
The business expert configuring the component 200 has two options to specify interactions between the component 200 and components embedded by the business expert. First, the business expert can specify interactions between the component 200 and the components embedded by the business expert directly via the component interfaces specified in the embedding interface. Second, the business expert can specify interconnections between the internal programming interface, the internal data-binding interface, and the internal visual interface of the component 200 and the corresponding external programming interface, the external data-binding interface, and the external visual interface of the components embedded by the business expert. In addition to these two methods for specifying interactions between the component 200 and the embedded components, the component developer can embed other components during the implementation of the component 200 by using component usage objects that refer to the external interfaces of embedded components. However, the business expert cannot use the internal interfaces to configure the components embedded by the component developer using component usage objects.
FIG. 10 illustrates example roles and functions that can be involved in the process of developing, configuring, and using applications based on the component 200. The process begins with the development of one or more components that provide external and internal interfaces and a corresponding configuration application 1015 that is used to produce configuration data that configures the component 200 by configuring its internal interface. In one implementation, a generic configuration tool is provided as part of the development framework that can be used to perform generic configuration operations for the internal interface of the component, e.g., selecting a valid range of values for a specified data type from the allowed range of values for the specified data type.
An application provider 1010 implements the application 1012 and any components required by the application. The application provider 1010 is a skilled programmer. The application provider 1010 specifies the external interfaces of components that can be embedded within each component 200 using the embedding interface 920. The application provider 1010 is not required to specify concrete components to be embedded within the component 200. As described later, a business expert 1020 determines which components specified in the embedding interface 920 are to be embedded as part of configuring the application 1012, and specifies an implementation for each component to be embedded. In one implementation, all the UI pattern components specified in the embedding interface 920 are not embedded by the business expert 1020.
To create a customized application 1022 for a specific type of business process, the business expert 1020 specifies concrete implementations of components to be embedded in the components 200 of the application and configures the interfaces between the component 200 and the embedded components. The business expert 1020 typically has expertise in a particular application or business area, e.g., a program manager or a business executive, and is not required to have programming skills in order to customize the application 1012. In one implementation, the business expert customizes the application by dragging an implementation of an embedded component into a window and connecting it to the corresponding embedding interface of the component 200 using a graphical user interface.
Multiple application development scenarios are possible. For example, an application provider 1050 can deliver applications 1012 to a customer either with or without specifying implementations of the embedded components, and either with or without the corresponding configurations of the components 200. In one scenario, an application developer 1010 on the application provider side configures the components in the application, including specification of implementations for components that are to be embedded in the component 200, and delivers a customized application 1022 that is ready to be used by an application end-user 1030 on the customer side 1055. In an alternative scenario, a business expert 1020 on the customer side determines the implementation of components to be embedded and specifies the corresponding configuration data.
FIG. 11 illustrates configuring a component, i.e., Component_A 1100, to embed other components. The external interface 1118 for Component_A provides an external programming interface 1112, an external data-binding interface 1114, and an external visual interface 1116. The internal interface for Component_A provides an internal programming interface 1120, an internal data-binding interface 1122, and an embedding interface 1124. The developer of Component_A provides the external interface 1118, the internal interface 1126, and an implementation for the component 1100. In addition, the developer of Component_A specifies that components having external interfaces like components Component_B 1105 and Component_C 1110 can be embedded in Component_A 1100 using the embedding interface 1124. In one implementation, the component developer includes the component usage objects corresponding to Component_B and Component_C in the embedding interface 1124 to specify that such components can be embedded in Component_A. The component developer for Component_A can also provide a configuration application for configuring the internal interface 1126 to embed concrete implementations of components Component_A and Component_B. A business expert embeds Component_A and Component_B by binding an implementation of each component that implements the corresponding interfaces specified in the embedding interface 1124. Component_A 1100 can interface with the embedded Component_B and Component_C using the interfaces specified in the embedding interface 1124. In addition, since the business expert has bound the internal programming interface 1120 and the internal data-binding interface 1122 of Component_A to the external programming interface 1130 and the external data-binding interface 1132 of Component_B 1105 respectively, these interfaces can also be used by Component_A to interface with Component_B. The application provider has also bound the external data-binding interface of Component_B 1105 to the external data-binding interface of Component_C 1110 to provide a data interface between the two components.
The above-described techniques can be implemented in digital electronic circuitry, or in computer hardware, firmware, software, or in combinations of them. The implementation can be as a computer program product, i.e., a computer program tangibly embodied in an information carrier, e.g., in a machine-readable storage device or in a propagated signal, for execution by, or to control the operation of, data processing apparatus, e.g., a programmable processor, a computer, or multiple computers. A computer program can be written in any form of programming language, including compiled or interpreted languages, and it can be deployed in any form, including as a stand-alone program or as a module, component, subroutine, or other unit suitable for use in a computing environment. A computer program can be deployed to be executed on one computer or on multiple computers at one site or distributed across multiple sites and interconnected by a communication network.
Method steps can be performed by one or more programmable processors executing a computer program to perform functions of the invention by operating on input data and generating output. Method steps can also be performed by, and apparatus can be implemented as, special purpose logic circuitry, e.g., an FPGA (field programmable gate array) or an ASIC (application-specific integrated circuit). Modules can refer to portions of the computer program and/or the processor/special circuitry that implements that functionality.
Processors suitable for the execution of a computer program include, by way of example, both general and special purpose microprocessors, and any one or more processors of any kind of digital computer. Generally, a processor will receive instructions and data from a read-only memory or a random access memory or both. The essential elements of a computer are a processor for executing instructions and one or more memory devices for storing instructions and data. Generally, a computer will also include, or be operatively coupled to receive data from or transfer data to, or both, one or more mass storage devices for storing data, e.g., magnetic, magneto-optical disks, or optical disks. Information carriers suitable for embodying computer program instructions and data include all forms of non-volatile memory, including by way of example semiconductor memory devices, e.g., EPROM, EEPROM, and flash memory devices; magnetic disks, e.g., internal hard disks or removable disks; magneto-optical disks; and CD-ROM and DVD-ROM disks. The processor and the memory can be supplemented by, or incorporated in special purpose logic circuitry.
To provide for interaction with a user, the above described techniques can be implemented on a computer having a display device, e.g., a CRT (cathode ray tube) or LCD (liquid crystal display) monitor, for displaying information to the user and a keyboard and a pointing device, e.g., a mouse or a trackball, by which the user can provide input to the computer (e.g., interact with a user interface element). Other kinds of devices can be used to provide for interaction with a user as well; for example, feedback provided to the user can be any form of sensory feedback, e.g., visual feedback, auditory feedback, or tactile feedback; and input from the user can be received in any form, including acoustic, speech, or tactile input.
The above described techniques can be implemented in a distributed computing system that includes a back-end component, e.g., as a data server, and/or a middleware component, e.g., an application server, and/or a front-end component, e.g., a client computer having a graphical user interface and/or a Web browser through which a user can interact with an example implementation, or any combination of such back-end, middleware, or front-end components. The components of the system can be interconnected by any form or medium of digital data communication, e.g., a communication network. Examples of communication networks include a local area network (“LAN”) and a wide area network (“WAN”), e.g., the Internet, and include both wired and wireless networks.
The computing system can include clients and servers. A client and server are generally remote from each other and typically interact through a communication network. The relationship of client and server arises by virtue of computer programs running on the respective computers and having a client-server relationship to each other.
The invention has been described in terms of particular embodiments, but other embodiments can be implemented and are within the scope of the following claims. For example, the operations of the invention can be performed in a different order and still achieve desirable results. In certain implementations, multitasking and parallel processing may be preferable. As another example, although the use of UI patterns has been described in connection with business objects and business data, patterns can be used with other types of objects and with data that is not business-related.
Patterns can also be developed using different development processes in different development environments, and executed in different run-time systems. For example, patterns can be developed using an integrated development environment (IDE) that incorporates tools for building, testing, deploying, and maintaining applications (e.g., configuration applications and pattern components). Such tools can include visual development tools, templates (e.g., code templates), and class libraries. A class library can include base classes that provide basic functionality (e.g., input/output, string manipulation, and network communication), as well as specialized classes that provide enhanced functionality (e.g., classes for building and using graphical user interfaces on clients, and for offloading application functionality onto smart clients). Where an IDE supports multiple languages, class libraries can provide a consistent development interface across those languages.
In addition, some IDEs also provide services and functionality that can be used to reduce the amount of code that needs to be written manually. Such functionality can include, for example, the ability to declare and bind to data types, and the ability to bind application elements such as controls and data structures.
IDEs can also provide code generation capabilities—for example, the ability to automatically generate plumbing code (e.g., code for drawing windows or accessing Web services), or the ability to automatically generate run-time code (e.g., by using code generators, compilers, or both). The automatic generation of run-time code allows programs to be targeted to multiple platforms. For example, a code generator can be used to automatically generate run-time code for one or more specific platforms based on the program code produced by a developer. Alternatively, the developer code can be compiled for a run-time system, which can be hosted in multiple environments (e.g., servers, clients, or a combination of servers and clients).
Some IDEs also provide the ability to create metadata that specifies descriptive information about an application, and that can be used by a run-time system to provide services to the application. Metadata can be explicitly declared by a developer, generated in the process of generating run-time code, or both.
Examples of IDEs that can be used to develop patterns include IDEs that are built using the open Eclipse Platform supported by the Eclipse Foundation (e.g., the Web Dynpro IDE developed by SAP, or the WebSphere Studio IDE developed by IBM Corp. of Armonk, N.Y.), as well as proprietary IDEs (e.g., the Visual Studio .NET IDE developed by Microsoft Corp. of Redmond, Wash.).
The overall process of developing a pattern (including, e.g., developing a configuration application and a pattern component) can include a design time aspect and a run-time aspect. The design time aspect can involve use of the IDE to write code and to declare attributes, bindings, and other metadata. The code and the metadata can then be used to generate run-time code to be executed in a run-time system. Some development environments can be coupled to a corresponding run-time system, which allows programs developed in such development environments to take advantage of services offered by the corresponding run-time systems. For example, in the Web Dynpro environment discussed in conjunction with FIG. 5, applications can take advantage of services such as input help and validation offered by the Web Dynpro runtime, which frees developers from having to code such functionality manually into their programs.
Run-time systems provide a code execution environment that generally includes core services (e.g., memory, process, and session management), as well as enhanced services (e.g., input help and validation). In addition to the Web Dynpro runtime, other examples of run-time systems include virtual machines (e.g. the JavaTM Virtual Machine), and the Common Language Runtime (a run-time system developed by Microsoft Corp.) As specified above, run-time systems can be hosted in multiple environments, including servers and clients. Servers generally provide a core operating environment for applications (e.g., by providing a run-time system in which the application can execute). An example of a server is a J2EETM-compliant server, such as the Web Application Server from SAP or the WebShereTM Application Server from IBM Corp.

## Claims

1. A computer program product, tangibly embodied in a machine-readable storage device, comprising instructions operable to cause data processing apparatus to:
define a component having an external interface and an internal interface for embedding external components into the component, each external component being a reusable software component encapsulating functionality, wherein multiple instances of each external component are usable at the same time,
the external interface comprising:
an external programming interface for programmatic interaction with the component,
an external data-binding interface for data communication with the component, and
an external visual interface for access to a visual representation of a state of the component; and

the internal interface comprising:
an embedding interface for specifying one or more external interfaces of the external components to be embedded and a number of instances of each external component to be embedded;
an internal programming interface for programmatic interaction with the external components to be embedded,
an internal data-binding interface for data communication with the external components to be embedded, and
an internal visual interface for access to a visual representation of a state of the external components to be embedded.

2. The computer program product of claim 1, wherein the external programming interface, the external data-binding interface, and the external visual interface are separate interfaces.

3. The computer program product of claim 1, wherein the embedding interface, the internal programming interface, the internal data-binding interface, and the internal visual interface are separate interfaces.

4. The computer program product of claim 1, wherein one or more of the internal programming interface, the internal data-binding interface, and the internal visual interface are not implemented.

5. A computer program product, tangibly embodied in a machine-readable storage device, comprising instructions operable to cause data processing apparatus to:
receive user input identifying a first component having an internal interface for embedding external components, wherein the internal interface comprises an internal programming interface, an internal data-binding interface, an internal visual interface, and an embedding interface embedding interface for specifying one or more external interfaces of the embeddable external components;
receive user input identifying a second component, embeddable by the first component, the second component having an external interface among the one or more external interfaces specified by the embedding interface of the first component, wherein the external interface comprises an external programming interface, an external data-binding interface, and an external visual interface;
receive user input embedding the second component within the first component, wherein the user input embedding the second component comprises configuration data for the embedding interface, the internal programming interface, the internal data-binding interface, and the internal visual interface, of the first component, wherein the configuration data for the internal programming interface, the internal data-binding interface, and the internal visual interface specifies connections with the external programming interface, the external data-binding interface, and the external visual interface, respectively; and
connect the internal interface of the first component to the external interface of the second component.

6. The computer program product of claim 5, wherein the external interface of the second component corresponds to the external interface of the first component.

7. The computer program product of claim 6, wherein the second component has multiple instances that are usable at the same time, wherein the configuration data for the embedding interface specifies a number of instances of the second component that are embedded in the first component.

8. A computer implemented method, comprising:
receiving user input identifying a first component having an internal interface for embedding external components, wherein the internal interface comprises an internal programming interface, an internal data-binding interface, an internal visual interface, and an embedding interface for specifying one or more external interfaces of the embeddable external components;
receiving user input identifying a second component, embeddable by the first component, the second component having an external interface among the one or more external interfaces specified by the embedding interface of the first component, wherein the external interface comprises an external programming interface, an external data-binding interface, and an external visual interface;
receiving user input embedding the second component within the first component,
generating configuration data for the first component in response to the received user input embedding the second component, wherein the configuration data includes configuration data for the embedding interface, the internal programming interface, the internal data-binding interface, and the internal visual interface, wherein the configuration data for the internal programming interface, the internal data-binding interface, and the internal visual interface specifies connections with the external programming interface, the external data-binding interface, and the external visual interface, respectively; and
connecting the internal interface of the first component to the external interface of the second component.

9. The method of claim 8, wherein the external interface of the second component corresponds to the external interface of the first component.

10. The method of claim 8, wherein the second component has multiple instances that are usable at the same time, wherein the configuration data for the embedding interface specifies a number of instances of the second component that are embedded in the first component.

11. A machine-readable storage device, comprising:
means for receiving user input identifying a first component having an internal interface for embedding external components, wherein the internal interface comprises an internal programming interface, an internal data-binding interface, an internal visual interface, and an embedding interface for specifying one or more external interfaces of the embeddable external components;
means for receiving user input identifying a second component embeddable by the first component, the second component having an external interface among the one or more external interfaces specified by the embedding interface of the first component, wherein the external interface comprises an external programming interface, an external data-binding interface, and an external visual interface;
means for receiving user input embedding the second component within the first component;
means for generating configuration data for the first component in response to the received user input embedding the second component, wherein the configuration data includes configuration data for the embedding interface, the internal programming interface, the internal data-binding interface, and the internal visual interface, wherein the configuration data for the internal programming interface, the internal data-binding interface, and the internal visual interface specifies connections with the external programming interface, the external data-binding interface, and the external visual interface, respectively; and
means for connecting the internal interface of the first component to the external interface of the second component.