====== 3.4 Operations ======
[[dido:public:s_cli:05_contents:01_prt:02_basics:start| Return to DIDO CLI Background]]

===== CamelCase =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**CamelCase** strips leading and trailing blanks, converts multiple whitespace characters to a single space, converts the text to LowerCase and then Uppercases the first letter of each word.

<code>
CamelCase ::= ( IN TextValue ) RETURN TextValue;
</code>

== Example ==
<code>
   myTextString = "  This is   a  Test";
   echo CamelCase(myTextString);
</code>
== Results In ==
<code>
   "ThisIsATest"
</code>

===== camelCase =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**camelCase** performs the **CamelCase** operation and then lowercases the first letter.

<code>
camelCase ::= ( IN TextValue ) RETURN TextValue;
</code>
== Example ==
<code>
   myTextString = "  This is   a  Test";
   echo camelCase(myTextString);
</code>
== Results In ==
<code>
   "thisIsATest"
</code>

===== CompressWhiteSpace =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**CompressWhiteSpace** converts multiple spaces within the text to a single space. It does not remove leading or trailing spaces.

<code>
CompressWhiteSpace ::= ( IN TextValue ) RETURN TextValue;
</code>

== Example ==
<code>
   myTextString = "  This is   a  Test";
   echo CompressWhiteSpace(myTextString);
</code>
== Results In ==
<code>
   "This is a Test"
</code>

===== CurrentDate =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**CurrentDate** returns the current date from the system clock using [[dido:public:ra:xapend:xapend.b_stds:tech:iso:date_time_1]]. See [[dido:public:s_cli:05_contents:01_prt:03_langconst:05_types:start#datetimevalue| DateTimeVAlue]]

<code>
CurrentDate ::= ( EMPTY_PARAM ) RETURN DateValue;
</code>

== Example ==
<code>
   myTextString = "  This is   a  Test";
   echo CurrentDate();
</code>
== Results In ==
This would be the result for 3:30 pm on September 7, 2019 in NY Eastern Daylight Savings Time (EDT)
<code>
   "2019-09-07T15:50-04:00"
</code>

===== CurrentTime =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**CurrentTime** returns the current time from the system clock. See [[dido:public:s_cli:05_contents:01_prt:03_langconst:05_types:start#timestampvalue| TimestampValue]].

<code>
CurrentTime ::= ( EMPTY_PARAM ) RETURN TimestampValue;
</code>

This would be the result for the current time in milliseconds((
CurrentMiillis,
Accessed 8 April 2021,
[[https://currentmillis.com/]]
))
<code>
   "1617929032476"
</code>

===== IsNull =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**IsNull** tests if the parameter passed is has no value (i.e., '''NULL''').


<code>
IsNull ::= ( DidoObject ) RETURN BooleanValue;
</code>

== Example ==
<code>
   myTextString = NULL;
   echo myTextString is Null IsNull(myTextString);
   myTextString = "  This is   a  Test";
   echo myTextString is Null IsNull(myTextString);
   myTextString = "";
   echo myTextString is Null IsNull(myTextString);
</code>
== Results In ==
This would be the result for 3:30 pm on September 7, 2019 in NY Eastern Daylight Savings Time (EDT)
<code>
   myTextString is Null TRUE
   myTextString is Null FALSE
   myTextString is Null FALSE
</code>

===== Length =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**Length** returns the number of characters in the TextValue. **Note:** if the TextValue is NULL, **Lenght** returns a minus 1 (i.e., ''-1'').


<code>
Length ::= ( IN Text ) RETURN IntegerValue;
</code>

== Example ==
<code>
   myTextString = NULL;
   echo length(myTextString);
   myTextString = "";
   echo length(myTextString);
   myTextString = "This is a Test";
   echo length(myTextString);
</code>
== Results In ==
<code>
   -1
   0
   14
</code>

===== LowerCase =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**LowerCase** converts the text to LowerCase, it does not modify the whitespace.


<code>
LowerCase ::= ( IN Text ) RETURN TextValue;
</code>

== Example ==
<code>
   myTextString = "  This is   a  Test";
   echo LowerCase(myTextString);
</code>
== Results In ==
<code>
   "  this is   a  test"
</code>

===== PadC =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**PadC** centers the TextValue within the given padding length. If the length of the Text string is longer than the padding length, the left and right characters are trimmed equally until it fits.

<code>
PadC ::= ( IN TextValue, IN IntegerValue ) RETURN TextValue;
</code>

== Example ==
<code>
   myTextString = "Test";
   echo     |...:.....|...: RULER
   echo PadC(myTextString,15);
</code>
== Results In ==
<code>
 |...:.....|...: RULER
"     Test     "
</code>

===== NVL =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

The **NVL** operations evaluates the two parameters passed to it. If the first value is NOT NULL, then the first value is returned. If the first value is NULL, then the second value is returned. 

== Example ==
<code>
value_1 : IntegerValue := NULL;
value_2 : IntegerValue := "1234";
value_3 : IntegerValue := NULL;

echo "1:2 -> " + NVL ( value_1, value_2);
echo "2:3 -> " + NVL ( value_2, value_3);
</code>
== Results In ==
<code>
1:2 -> 1234
2:3 -> 1234
</code>

===== PadL =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**PadL** pads the TextValue to the left until the padding length is met. If the padding length is smaller than the length of the TextValue, characters are trimmed on the left until it fits. 

<code>
PadL ::= ( IN TextValue, IN IntegerValue ) RETURN TextValue;
</code>

== Example ==
<code>
   myTextString = "Test";
   echo     |...:.....|...: RULER
   echo PadL(myTextString,15);
</code>
== Results In ==
<code>
 |...:.....|...: RULER
"           Test"
</code>
===== PadR =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**PadR** pads the TextValue to the right until the padding length is met. If the padding length is smaller than the length of the TextValue, characters are trimmed on the right until it fits. 

<code>
PadR ::= ( IN TextValue, IN IntegerValue ) RETURN TextValue;
</code>
== Example ==
<code>
   myTextString = "Test";
   echo     |...:.....|...: RULER
   echo PadL(myTextString,15);
</code>
== Results In ==
<code>
 |...:.....|...: RULER
"Test           "
</code>

===== TitleCase =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**TitleCase** converts the text to LowerCase, it does not modify the whitespace.

<code>
TitleCase ::= ( IN TextValue ) RETURN TextValue;

</code>

== Example ==
<code>
   myTextString = "  This is   a  TEST";
   echo TitleCase(myTextString);
</code>
== Results In ==
<code>
   "  This Is   A  Test"
</code>

===== Trim =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**Trim** trims all leading and trailing [[dido:public:s_cli:05_contents:01_prt:03_langconst:06_constants:start#whitespace]] from the line.

<code>
Trim ::= Trim( IN TextValue ) RETURN TextValue;
</code>

== Example ==
<code>
   myTextString = "  This is   a  TEST  ";
   echo Trim(myTextString);
</code>
== Results In ==
<code>
   "This is   a  TEST"
</code>

===== TrimL =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

Trims all leading (i.e., left side)  [[dido:public:s_cli:05_contents:01_prt:03_langconst:06_constants:start#whitespace]] from the line.

[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**TrimL** trims all leading [[dido:public:s_cli:05_contents:01_prt:03_langconst:06_constants:start#whitespace]] from the line.


<code>
TrimL ::= TrimL( IN TextValue ) RETURN TextValue;

</code>

== Example ==
<code>
   myTextString = "  This is   a  TEST  ";
   echo Trim(myTextString);
</code>
== Results In ==
<code>
   "This is   a  TEST  "
</code>
===== TrimR =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**TrimR** trims all trailing [[dido:public:s_cli:05_contents:01_prt:03_langconst:06_constants:start#whitespace]] from the line.

<code>
TrimR ::= TrimR( IN TextValue ) RETURN TextValue;
</code>

===== UpperCase =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**UpperCase** converts all the [[dido:public:ra:xapend:xapend.a_glossary:a:ascii|ASCII]] characters to their Uppercase equivalents.

<code>
UpperCase ::= ( IN TextValue ) RETURN TextValue;
</code>

== Example ==
<code>
   myTextString = "This is a Test";
   echo LowerCase(myTextString);
</code>
== Results In ==
<code>
   "THIS IS A TEST"
</code>
===== WhiteSpaceToUnderscore =====
[[dido:public:s_cli:05_contents:01_prt:03_langconst:04_operations:start| Return to Top]]

**WhiteSpaceToUnderscore** converts all whitespace characters to underscores ('''_''').

<code>
WhiteSpaceToUnderscore ::= ( IN TextValue ) RETURN TextValue;
</code>
== Example ==
<code>
   myTextString = " This is  a TEST ";
   echo WhiteSpaceToUnderscore(myTextString);
</code>
== Results In ==
<code>
   "_This_is__a_TEST_"
</code>

/**=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
/* To add a discussion page to this page, comment out the line that says 
  ~~DISCUSSION:off~~
*/
~~DISCUSSION:on|Outstanding Issues~~
~~DISCUSSION:off~~