Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Toolkits
A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
Toolkits
com.teracloud.streams.regex 3.0.0
com.teracloud.streams.regex.xpressive
C++ Native Functions

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Learn about different Teracloud Streams tools and features to write, compile, run, and test streams applications.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays
  You can specify or change configuration parameters when you use the submitjob or updateoperators operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Commands
  Teracloud® Streams provides a number of commands you use to perform tasks.
- Metrics
  Teracloud® Streams provides metrics to help evaluate the health of Teracloud Streams services, to aid in diagnosing performance issues, and to analyze throughput of requests. You can use the streamtool checkinstancemetrics, streamtool checkdomainmetrics, streamtool getdomainmetrics, and streamtool checkresourcemetrics commands to view the metrics data.
- Operator model
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- SPL Compiler
  The SPL compiler is an incremental compiler that generates artifacts needed to run your stream application. These artifacts include, for example, C++ code for several entities in your SPL program and an application bundle file.
- Toolkits
  A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
  - Specialized toolkit requirements and restrictions
    Several of the specialized toolkits require RPMs that are not required by the Teracloud® Streams product. There are also toolkit restrictions on some platforms.
  - Toolkits
- SPLDOC markup
  You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

C++ Native Functions: com.teracloud.streams.regex.xpressive

This page documents native functions that can be invoked from SPL, including the SPL interfaces that can be used to invoke each of the native functions.

<enum E> public boolean regexCompile(rstring pattern, E patternIndex)

Compiles and indexes regular expression pattern.

Parameters

pattern: regular expression pattern of type rstring.
patternIndex: regular expression index of enum type (e.g. enum{_1}).

Returns

boolean regular expression compilation success.

<enum E> public boolean regexFullMatch(rstring str, E patternIndex)

Performs a full match of the whole string with the pattern - runs in compiled mode (uses compiled regex index to identify the pattern).

Parameters

str: string to match of type rstring.
patternIndex: regular expression index of enum type (e.g. enum{_1}).

Returns

boolean matching success.

public boolean regexFullMatch(rstring str, rstring pattern)

Performs a full match of the whole string with the pattern - runs in interpretation mode (like SPL regexMatch function).

Parameters

str: string to match of type rstring.
pattern: regular expression of type rstring.

Returns

boolean matching success.

<enum E> public rstring regexGlobalReplace(rstring str, E patternIndex, rstring rewrite)

Performs all replacements of the string after matching the pattern - runs in compiled mode (uses compiled regex index to identify the pattern).

Parameters

str: string to match of type rstring.
patternIndex: regular expression index of enum type (e.g. enum{_1}).
rewrite: replace string of type rstring.

Returns

rstring number of matching successes.

<enum E> public boolean regexPartialMatch(rstring str, E patternIndex)

Performs a partial match of the string with the pattern - runs in compiled mode (uses compiled regex index to identify the pattern).

Parameters

str: string to match of type rstring.
patternIndex: regular expression index of enum type (e.g. enum{_1}).

Returns

boolean matching success.

public boolean regexPartialMatch(rstring str, rstring pattern)

Performs a partial match of the string with the pattern - runs in interpretation mode (like SPL regexMatch function).

Parameters

str: string to match of type rstring.
pattern: regular expression of type rstring.

Returns

boolean matching success.