RadixWare Programmer Guide

From RadixWiki
Jump to: navigation, search

Introduction

This document is intended for the programmers developing the applications on the RadixWare platform. The document describes the principal objects of the RadixWare technological platform and application tools of RadixWare Designer used to develop the applications on the RadixWare platform.


For the overview and structure of the RadixWare technological platform, refer to RadixWare. Overview.

Conventions and Abbreviations

Conventions

Convention Example Applies to
Bold The definitions of each segment are joined in units. First mentioned terms; user interface elements; names of the software products
Bold with vertical slash Subversion | Commit… Menu item description
Bold italic Refer to RadixWare Explorer. User Guide Document names
Underlined For details on enumeration publishing, refer to Enumerations. References to a topic / section / subsection / page within the document
Text afterExample.jpg Example.jpgBoth cards and accounts can be classified by contracts. Therefore, the "Contract" publishing context class corresponds to two classes of publishing lists: for cards and accounts. Examples

Abbreviations

API - Application Programming Interface
ARTE - Application Runtime Environment
DB - Database
DBMS - Database Management System
EAS - Explorer Access Service
GUID - Global Unique Identifier
JML - Java Markup Language
JVM - Java Virtual Machine
ORM - Object-relational mapping
OS Operating System
SAP - Service Access Point
SCP - Service Client Profile
SQML - Structured Query Markup Language
SVN - Subversion

Conventions in Diagrams

Related Documents

The following documentation is recommended for additional information:

Main Objects of RadixWare Platform

Main title: Main Objects of RadixWare Platform

RadixWare Designer Overview

The RadixWare Designer application is a programming environment used to create applications on the base of RadixWare platform.

The RadixWare Designer application is based on the NetBeans platform. For the general information on how to work with RadixWare Designer, refer to NetBeans documentation.

This document contains the detailed information on how to work with the RadixWare Designer application.

RadixWare Designer Startup

To start up RadixWare Designer, perform the following:

  1. Get the working copy of the installed version of RadixWare. For this purpose, select the Checkout item from the context menu of the Development \| Trunk branch in RadixWare Manager project tree. At that, the system requests to select the directory where the working copy must be located.
  2. From the org.radixware/kernel/designer/bin/bin directory, start up one of the following files:
  • designer.exe on 32-bit Windows OS
  • designer64.exe on 64-bit Windows OS
  • designer on Linux OS

When starting up RadixWare Designer, the command line parameters can be defined. For the supported parameters, refer to NetBeans documentation. It is recommended to define the -J-Xmx4g -J-XX:MaxPermSize=1024m parameters at RadixWare Designer startup.

Note.jpgSometimes, when using 32-bit Windows OS, it is impossible to allocate enough storage space for RadixWare Designer operation. In this case, reduce the requested storage space. The minimum storage space satisfies the following command line parameters: -J-Xmx700m -J-XX:MaxPermSize=256m.

Starting up RadixWare Designer automatically opens the dev/trunk directory as a project.

RadixWare Designer User Interface

Main title: RadixWare Designer User Interface

Main Operations of Managing Definitions

Create Definition

To create the definition, perform one of the following actions:

  • Select the parent definition in the navigation tree and click Add .jpg on RadixWare Designer toolbar. At that, the master dialog box is opened where it is required to specify the type of the definition being created and the additional information depending on the definition type.
  • Select the definition type from the New child menu of the parent definition context menu in the navigation tree.

Rename Definition

To rename the definition, select the Rename item from the definition context menu in RadixWare Designer navigation tree. The integrity of references to the renamed definition is ensured by tags.

Delete Definition

To delete the definition, select the Delete item on the definition context menu in RadixWare Designer navigation tree. At that, the user is asked to confirm the action.

Find Usages

To find all places in the project where the definition is used, select the Find Usages menu item on the definition context menu in RadixWare Designer navigation tree or press Alt-F7. At that, the Find Usages dialog box is opened:

Find-usages-dialog.jpg

Select one of the options in the dialog box:

  • Find usages - finds all places where the definition is used.
  • Find used - finds all definitions the current definition refers to.
  • Find all subtypes/overwrites - find all definitions that override or overwrite the current definition or overriding (overwriting) definitions.
  • Find direct subtypes/overwrites only - find definitions that override (or overwrite) the current definition directly.

If the Search in current module only flag is set, the system will search only in the module containing this definition. The Usages pane will display the results of the search. Double-clicking the definition in the list opens it in the editor.

View Hierarchy of Classes

To view the hierarchy of class inheritance, select the Inspect Hierarchy… item from the context menu of the class definition in RadixWare Designer navigation tree. At that, the Hierarchy additional pane is opened:

Hierarchy.png

The Hierarchy pane displays the tree of classes hierarchy of the selected class. The Search parameter in the upper part of the pane enables a quick search through the hierarchy. When entering the text in the search field, the tree displays only the nodes with the names containing the entered string as well as their parent nodes. The Subtype and Supertype buttons in the lower part of the pane are used to switch the search direction of the associated events: from the parent classes to the ancestor classes and vice versa. Double-clicking the definition in the tree opens it in the editor.

View Call Hierarchy

To view the hierarchy of method calls, select the Call Hierarchy item from the context menu of method definition in RadixWare Designer navigation tree. At that, the Call Hierarchy additional pane is opened:

Call-hierarchy.png

The Call Hierarchy pane for each method displays the methods calling it. They are displayed as child elements. Double-clicking the definition in the tree opens it in the editor.

Definition Types

Main title: Definition Types

Report Designer

Main title: Report Designer

Translator Workplace

Main title: Translator Workplace

Development Support Means

Main title: Development Support Means

Quick Start Guide

Main title: Quick Start Guide