StreamBase Project Properties

To open the Properties dialog for a StreamBase project, first select the project in the Package Explorer. Then:

  • Right-click and select Properties from the context menu, or

  • Invoke Project → Properties from the main Studio menu, or

  • Press Alt-Enter.

StreamBase Studio extends the Eclipse project properties dialog by adding a StreamBase page. StreamBase projects are modified by a combination of the standard Eclipse project Property pages, and the StreamBase page.

StreamBase Page

The StreamBase page of the current project's Properties dialog shows a read-only view of the Module and Operator Resource search paths that the current project is configured to use, in search order of precedence. When you run this project's application in StreamBase Studio, if the application uses Modules, or if its Operators and Adapters require any resources or files, then the StreamBase Server uses these search paths to locate those modules and resources.

Both tables on this page have the same three columns:

  • The first column is empty for locations with built-in in the Source column. For file system locations specified in sbd.sbconf, the first column shows shows a yellow caution icon normally, or shows a red warning icon If you specify a path that StreamBase cannot locate. The yellow caution icon is a reminder that resources in file system locations will be used by StreamBase Server, but are ignored while authoring in StreamBase Studio. Hover the mouse cursor over an icon for its details.

  • The Resolved Workspace or File System Path column lists the workspace paths or file system paths where StreamBase looks for Modules or Operator Resources.

    • Directories with the value built-in in the Source column are relative to the root of the Studio workspace, and are visible in the Package Explorer.

    • A value of (application directory) denotes the folder that contains the current project's StreamBase application. (This is usually the root of the project's folder in the Package Explorer, but might be a subfolder.)

  • The Source column indicates where each directory path was configured.

    • A value of built-in means that StreamBase has automatically included the path, because the path is either in the current project, or in a project referenced by the current project. (See Project References Page.)

    • A value of sbd.sbconf means that the path is configured in your project's configuration file.

Adding Entries to the Resource Search Path Tables

Adding a path to the resource search path tables means you are making the resources in that path available for use by the current project's StreamBase application. There are two ways to add a path to the resource search path tables:

  • Add a reference to another project, as described below in Project References Page. Limitations: the referenced project must exist in the current Studio workspace; and the resources you want to use must reside at the root of the referenced project.

  • Add a file system path to the current project's sbd.sbconf file, as described in Using resources outside your workspace in Managing Studio Resource Files. Also see Defining a StreamBase Server Configuration to learn about opening an existing sbd.sbconf file, or creating one if it does not exist.

Resource Search Path Order of Precedence

When a StreamBase application refers to a Module or to a Java Operator or Adapter resource, StreamBase uses a pre-defined search sequence to resolve the location of the object. A search for a specified object ends when that object is located. StreamBase searches the following locations in this order:

  1. The containing folder of the calling application.

    By default, StreamBase creates resources in the root of the project's folder, but you are free to organize your project into subfolders. If the calling application is itself in a subfolder, that subfolder is searched first.

  2. The folder named /Resources, if one exists at the root of the current project. (Applies only to the Operator Resource Search Path table; may be removed in future releases.)

    StreamBase project folders prior to release 5.0 always included a folder named /Resources that contained Java Operator and Adapter resources. If you preserved the legacy folder structure when you migrated projects from an earlier release, then the /Resources folder is searched next for resources needed by Operators and Adapters.

  3. The root of the calling application's project folder.

    (Of course, if the calling application is in the root folder and not a subfolder, the root folder is searched first.)

  4. The root folder of every referenced project.

    Establish references from the current project to other projects in your workspace by means of the Project References page of the Properties dialog. See Project References for instructions.

  5. Paths specified in this project's configuration file.

Objects in other locations are not automatically located. For example, if you want to run an application located in the project's root folder, and the application depends on files stored in a subfolder, the subfolder is not automatically in the search path.

The actual search path order for each StreamBase project is reflected in the tables in the StreamBase page of the Properties dialog for that project.

Project References Page

Use the Project References page to add or remove references to other projects in StreamBase Studio's workspace. A reference is a link from the current project to another project. The reference makes certain resources in the referenced project become available for use in the current project. The resources that become available are modules, and any files that are called by Operators and Adapters, such as data files or input files. (The Operators and Adapters themselves are added to the current project by means of the Java Build Path page of the Properties dialog.)

Adding a reference to another project does not automatically add that project's resources to the current project; it only makes the referenced project's resources available to be added.

To create a reference from the current project to another project in the workspace, follow these steps:

In the project's Properties dialog, open the Project References page. Then:

  1. Select the project or projects to which you want to add references.

  2. Click OK.

Java Build Path Page

Like Eclipse Java projects, StreamBase projects use the Java Build Path to locate classes referenced by your Java source code. You must add entries to the Java Build Path for this project if this project will use:

  • The StreamBase Client API

  • A custom Java Operator

  • A custom Java Adapter

  • Any other Java classes referenced by your Java code

Adding Other Projects to the Java Build Path

Adding another project to a build path makes that project's resources available to the current project. For example, if you create function aliases in project A using the StreamBase Java Function Wizard, the aliases are added to project A and all projects that contain project A in their build paths.

In the project's Properties dialog, open the Java Build Path page. Then:

  1. Open the Projects tab.

  2. Click the Add button.

  3. Select the projects to add and click OK.

  4. Click OK to dismiss the Properties dialog.

Adding the StreamBase Client API to the Java Build Path

The StreamBase Client API is usually added to a project's Java Build Path in the New StreamBase Project dialog. If you check that dialog's Add the StreamBase Client API checkbox at project creation time, then this project already references the Client API library. If you need to add the Client API after project creation, follow these steps:

In the project's Properties dialog, open the Java Build Path page. Then:

  1. Open the Libraries tab.

  2. Click the Add Library button.

  3. Select StreamBase Client API and click Next.

  4. On the next dialog page, click Finish.

  5. Click OK.

Adding a Java Operator or Adapter to the Java Build Path

StreamBase custom Java Operators and custom Java Adapters are traditionally packaged as JAR files, but this packaging is optional. To add an Operator or Adapter JAR file to this project's Java Build Path, follow these steps:

In the project's Properties dialog, open the Java Build Path page. Then:

  1. Open the Libraries tab.

  2. Click the Add JARs button.

  3. Open the workspace folder that contains your Operator or Adapter JAR file.

  4. Select the JAR file and click OK.

  5. Click OK.

If your Operator or Adapter's JAR file resides outside the Studio workspace, use the Add External JARs button instead, and navigate to the location of the JAR file. Finally, if your Operator or Adapter is in a non-JAR form, use the other tabs and controls of the Java Build Path page to locate and add the Java resource.

Related Topics

Back to Top ^