Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/siddhi-io/siddhi-execution-string

Extension that provides basic string handling capabilities
https://github.com/siddhi-io/siddhi-execution-string

execution expression-evaluator extension siddhi string utility

Last synced: about 1 month ago
JSON representation

Extension that provides basic string handling capabilities

Awesome Lists containing this project

README

        

Siddhi Execution String
======================================

[![Jenkins Build Status](https://wso2.org/jenkins/job/siddhi/job/siddhi-execution-string/badge/icon)](https://wso2.org/jenkins/job/siddhi/job/siddhi-execution-string/)
[![GitHub Release](https://img.shields.io/github/release/siddhi-io/siddhi-execution-string.svg)](https://github.com/siddhi-io/siddhi-execution-string/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/siddhi-io/siddhi-execution-string.svg)](https://github.com/siddhi-io/siddhi-execution-string/releases)
[![GitHub Open Issues](https://img.shields.io/github/issues-raw/siddhi-io/siddhi-execution-string.svg)](https://github.com/siddhi-io/siddhi-execution-string/issues)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/siddhi-io/siddhi-execution-string.svg)](https://github.com/siddhi-io/siddhi-execution-string/commits/master)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

The **siddhi-execution-string extension** is a Siddhi extension that provides basic string handling capabilities such as concat, length, replace all, etc.

For information on Siddhi and it's features refer Siddhi Documentation.

## Download

* Versions 5.x and above with group id `io.siddhi.extension.*` from here.
* Versions 4.x and lower with group id `org.wso2.extension.siddhi.*` from here.

## Latest API Docs

Latest API Docs is 5.0.13.

## Features

* groupConcat *(Aggregate Function)*



This function aggregates the received events by concatenating the keys in those events using a separator, e.g.,a comma (,) or a hyphen (-), and returns the concatenated key string.



* charAt *(Function)*


This function returns the 'char' value that is present at the given index position. of the input string.



* charFrequency *(Function)*


Gives the frequency of a char in input string.



* coalesce *(Function)*


This returns the first input parameter value of the given argument, that is not null.



* concat *(Function)*


This function returns a string value that is obtained as a result of concatenating two or more input string values.



* contains *(Function)*


This function returns true if theinput.string contains the specified sequence of char values in the search.string.



* equalsIgnoreCase *(Function)*


This returns a boolean value by comparing two strings lexicographically without considering the letter case.



* fillTemplate *(Function)*


fillTemplate(string, map) will replace all the keys in the string using values in the map. fillTemplate(string, r1, r2 ..) replace all the entries {{1}}, {{2}}, {{3}} with r1 , r2, r3.



* hex *(Function)*


This function returns a hexadecimal string by converting each byte of each character in the input string to two hexadecimal digits.



* length *(Function)*


Returns the length of the input string.



* locate *(Function)*


This function returns the position of one string within another. Optionally, the user can give the starting index to be search from.



* lower *(Function)*


Converts the capital letters in the input string to the equivalent simple letters.



* regexp *(Function)*


Returns a boolean value based on the matchability of the input string and the given regular expression.



* repeat *(Function)*


Repeats the input string for a specified number of times.



* replaceAll *(Function)*


Finds all the substrings of the input string that matches with the given expression, and replaces them with the given replacement string.



* replaceFirst *(Function)*


Finds the first substring of the input string that matches with the given regular expression, and replaces itwith the given replacement string.



* reverse *(Function)*


Returns the input string in the reverse order character-wise and string-wise.



* split *(Function)*


Splits the input.string into substrings using the value parsed in the split.string and returns the substring at the position specified in the group.number.



* strcmp *(Function)*


Compares two strings lexicographically and returns an integer value. If both strings are equal, 0 is returned. If the first string is lexicographically greater than the second string, a positive value is returned. If the first string is lexicographically greater than the second string, a negative value is returned.



* substr *(Function)*


Returns a substring of the input string by considering a subset or all of the following factors: starting index, length, regular expression, and regex group number.



* trim *(Function)*


Returns a copy of the input string without the leading and trailing whitespace (if any).



* unhex *(Function)*


Returns a string by converting the hexadecimal characters in the input string.



* upper *(Function)*


Converts the simple letters in the input string to the equivalent capital/block letters.



* tokenize *(Stream Processor)*


This function splits the input string into tokens using a given regular expression and returns the split tokens.


## Dependencies

There are no other dependencies needed for this extension.

## Installation

For installing this extension on various siddhi execution environments refer Siddhi documentation section on adding extensions.

## Support and Contribution

* We encourage users to ask questions and get support via StackOverflow, make sure to add the `siddhi` tag to the issue for better response.

* If you find any issues related to the extension please report them on the issue tracker.

* For production support and other contribution related information refer Siddhi Community documentation.