m204wiki - User contributions [en]

Word (String function)

2011-04-27T15:46:37Z

198.242.244.36:

{{Template:String:Word subtitle}}


Note that processing a string of words may be better accomplished with the <var>[[StringTokenizer class|StringTokenizer]]</var> class.

==Syntax==
{{Template:String:Word syntax}}

===Syntax terms===
<table class="syntaxTable">
<tr><th>%selectedWord</th><td><var>Word</var> returns the word selected by <var class="term>number</var> within the <var class="term">string</var> method object.
</td></tr>
<tr><th>string</th>
<td>The list of words, from which the result word is selected.
</td></tr>
<tr><th>number</th>
<td>The number of the word to select from the <var class="term">string</var> method object. The first word is word number 1. The value of this argument must be greater than or equal to 1.
</td></tr>
<tr><th><var>Spaces</var></th>
<td>A set of "whitespace" characters, that is, characters that separate words. The default is the blank character. If the null string is provided, the blank character is used as the whitespace character.
</td></tr>
</table>
==Usage notes==
==Examples==
The following fragment:
PrintText {~='Dasher**** Dancer**** Prancer****':Word(2)}.
PrintText {~='Dasher**** Dancer**** Prancer****':Word(2, Spaces=' *)')}.
PrintText {~='One more time':Word(4))}.

produces the following result:
'Dasher**** Dancer**** Prancer****':Word(2)=Dancer****.
'Dasher**** Dancer**** Prancer****':Word(2, Spaces=' *)')=Dancer.
'One more time':Word(4))=.

==See also==
<ul>
<li>[[List of StringTokenizer methods]]
<li><var>Word</var> is the OO version of <var>$Lstr_Word</var>, although there
is one difference: <var>$Lstr_Word</var> allows a word number argument which is
less than 1 (and treats it the same as if 1 were specified).
As mentioned above, <var>Word</var> does not allow a word number argument which
is less than 1.
</ul>
{{Template:String:Word footer}}

Words (String function)

2011-04-27T15:04:02Z

198.242.244.36:

{{Template:String:Words subtitle}}


Note that processing a string of words may be better accomplished with the <var>[[StringTokenizer class|StringTokenizer]]</var> class.

==Syntax==
{{Template:String:Words syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%outString</th><td> <var>Words</var> returns the substring of the <var class="term">string</var> method object which starts at word number <var class="term">start</var> and continues for up to as many words as <var class="term">count</var>.
</td></tr>
<tr><th>string</th>
<td>The method object string, from which the substring is extracted.
</td></tr>
<tr><th>start</th>
<td>The number of the word in <var class="term">string</var> that is the start of the extracted substring; must be greater than or equal to 1 (1 designates the first word). If <var class="term">start</var> is greater than the number of words in <var class="term">string</var>, the null string is returned.
</td></tr>
<tr><th>count</th>
<td>The number of words in the substring to extract. This is an optional argument; the default is to extract the rest of <var class="term">string</var> starting at word number <var class="term">start</var>. If <var class="term">count</var> is greater than the number of words remaining in <var class="term">string</var> starting with word number <var class="term">start</var>, the remainder of the <var class="term">string</var> starting at word number <var class="term">start</var> is returned. This argument must be non-negative; if zero, the null string is returned.
</td></tr>
<tr><th><var>Spaces</var></th>
<td>A set of "whitespace" characters, that is, characters that separate words. The default is the blank character. If the null string is provided, the blank character is used as the whitespace character.
</td></tr>
</table>
==Usage notes==
==Examples==
The following fragment:
PrintText {~='aa bb cc':Words(1, 2)}.
PrintText {~='aa bb cc':Words(4, 1)}.
PrintText {~='aa bb cc':Words(3, 2)}.
PrintText {~='aa bb cc':Words(2, 0)}.

produces the following result:
'aa bb cc':Words(2)=bb cc.
'aa bb cc':Words(1, 2)=aa bb.
'aa bb cc':Words(4, 1)=.
'aa bb cc':Words(3, 2)=cc.
'aa bb cc':Words(2, 0)=.

==See also==
<ul>
<li>[[List of StringTokenizer methods]]
<li><var>Words</var> is the OO version of <var>$Lstr_SubWord</var>.
</ul>
{{Template:String:Words footer}}

WordCount (String function)

2011-04-27T15:02:53Z

198.242.244.36:

{{Template:String:WordCount subtitle}}


Note that processing a string of words may be better accomplished with the <var>[[StringTokenizer class|StringTokenizer]]</var> class.

==Syntax==
{{Template:String:WordCount syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th><td><var>WordCount</var> returns the number of words in the <var class="term">string</var> method object.
</td></tr>
<tr><th>string</th>
<td>The list of words to be counted.
</td></tr>
<tr><th><var>Spaces</var></th>
<td>A set of "whitespace" characters, that is, characters that separate words. The default is the blank character. If the null string is provided, the blank character is used as the whitespace character.
</td></tr>
</table>
==Usage notes==
==Examples==
The following fragment:
PrintText {~="I'd like to buy the world a joke":WordCount}

produces the following result:
"I'd like to buy the world a joke":WordCount=8

==See also==
<ul>
<li>[[List of StringTokenizer methods]]
<li><var>WordCount</var> is the OO version of <var>$Lstr_Words</var>.
</ul>
{{Template:String:WordCount footer}}

DeepCopy (UserStatistics function)

2010-12-17T19:04:08Z

198.242.244.36:

Create "deep copy" of UserStatistics object
[[Category:UserStatistics methods|DeepCopy function]]
[[Category:System methods]]



DeepCopy is a member of the [[UserStatistics class]].


This method creates a “deep copy” of a UserStatistics object.
DeepCopy is identical to the [[Copy (UserStatistics function)|Copy]] method.

For more information about copyability, see [[Copying objects]].
===Syntax===
%newUstat = %ustat:DeepCopy
===Syntax terms===
<dl>
<dt>%newUstat
<dd>A UserStatistics object variable to contain the copied object.
<dt>%ustat
<dd>A UserStatistics object variable.

</dl>

IsNull and IsNotNull (SelectionCriterion functions)

2010-12-17T16:58:48Z

198.242.244.36: /* Examples */

Create selection expression that provides
[[Category:SelectionCriterion methods|IsNull and IsNotNull constructors]]
[[Category:System methods]]



IsNull and IsNotNull are members of the [[SelectionCriterion class]].


These shared methods take no parameters and create a new SelectionCriterion object.
The methods provide control for Null objects in the collection you are searching.
They also let you determine whether a collection contains items that are objects,
because they cancel the request if the collection being searched contains
non-object (intrinsic type) items.

An IsNull criterion returns true for a collection item
if the item is a Null object;
an IsNotNull criterion returns true for item objects that are not Null.

These methods are available as of ''Sirius Mods'' version 7.8.
===Syntax===
%selc = [%(selectionCriterion for itemtype):] IsNull

%selc = [%(selectionCriterion for itemtype):] IsNotNull
===Syntax terms===
<dl>
<dt>%selc
<dd>A SelectionCriterion object variable to contain the new object instance.
<dt>%(selectionCriterion for itemtype)
<dd>This optional specification of the class and collection item type
in parentheses indicates
that the method is shared and does not operate on a specific instance.
<dt>criterion
<dd>A SelectionCriterion object specification.

</dl>
===Examples===

The examples below test a variety of searches against
arraylist <tt>%al</tt> of objects of class <tt>T</tt>:
<pre>
class T
public
variable x is float
end public
end class

%al is arraylist of object t
%t is object t
%t1 is object t
%t2 is object t

%t1 = null
%t2 = new
%al = list(%t1, %t2)
</pre>
<ol>
<li>The [[FindNextItem (Arraylist function)|FindNextItem Arraylist function]] (or FindNextItem in other [[Collections|collections]] classes),
which throws an exception if its selection criterion
matches no item, fails in the Try clause below when it tests the Null object item.
The method's exception is not thrown because the test failure prevents the method
from completing its search:
<pre>
try %t = %al:findNextItem(EQ(x,1))
printtext found t
printtext {~} = {%t:x}
catch itemNotFound
printText None!
end try
</pre>

The result is:
<pre>
CANCELLING REQUEST: MSIR.0750: Class ARRAYLIST, function
FindNextItem: reference to null object in line xx
</pre>
To complete this request without cancellation,
you can use an IsNotNull criterion to bypass Null items:
<pre>
try %t = %al:findNextItem(AND(isNotNull, eq(x,1)))
printtext found t
printtext {~} = {%t:x}
catch itemNotFound
printText None!
end try
</pre>

The search finds no matching items, so the Catch clause above catches the
method's ItemNotFound exception, and the result is:
<pre>
None!
</pre>
<li>Instead of bypassing Null items, you might instead want the search to
include them:
<pre>
try %t = %al:findNextItem(OR(isNull, eq(x,1)))
printtext found t
printtext {~} = {%t:x}
catch itemNotFound
printText None!
end try
</pre>

The Null item is found, but the Try clause PrintText invocation
of <tt>%t:x</tt> fails, and the result is:
<pre>
CANCELLING REQUEST: MSIR.0561: Text output:
reference to null object in line xx
</pre>

If you want to search exclusively for the next Null item in a collection,
you can simply use this:
<pre>
%t = %al:findNextItem(isNull)
</pre>
<li>To successfully locate the non-Null item in <tt>%al</tt>,
you could use either of the following method calls in the Try clause:
<pre>
%t = %al:findNextItem(isNotNull)

%t = %al:findNextItem(AND(isNotNull, eq(x,0)))
</pre>

Thanks to the change in the EQ criterion in the second call above,
the result of trying either of these searches is:
<pre>
found t
%t:x=0
</pre>
</ol>

TokensToUpper (StringTokenizer property)

2010-12-16T19:55:38Z

198.242.244.36:

Convert returned tokens to all-uppercase?
[[Category:StringTokenizer methods|TokensToUpper property]]
[[Category:System methods]]



TokensToUpper is a member of the [[StringTokenizer class]].


This readWrite property returns or sets the Boolean value that indicates
whether to convert returned, non-quoted, tokens to all-uppercase characters.
The default value for a new tokenizer is <tt>False</tt>.

===Syntax===
%bool = %tok:TokensToUpper

%tok:TokensToUpper = %bool
===Syntax terms===
<dl>
<dt>%bool
<dd>An enumeration object of type Boolean to contain the returned value of
TokensToUpper.
For more information about Boolean enumerations, see [[Using Boolean enumerations]].
<dt>%tok
<dd>A StringTokenizer object variable.

</dl>
===Usage Notes===
<ul>
<li>TokensToUpper has no effect on non-alphabetic characters.
<li>The [[TokensToLower (StringTokenizer property)|TokensToLower]] property specifies or reports whether
returned tokens are to be converted to lowercase characters.
</ul>
===Examples===

In the following example,
the input string's tokens are returned in sequence
under the default (<tt>False</tt>) setting of TokensToUpper:
<pre>
%tok is object stringtokenizer
%tok = new
%tok:string = 'Bad,F ?3mO ,7,{x Z}'
repeat while not %tok:atEnd
printText {~} is {%tok:nextToken}
end repeat
</pre>

The resulting tokens are:
<pre>
%tok:nextToken is Bad,F
%tok:nextToken is ?3mO
%tok:nextToken is ,7,{x
%tok:nextToken is Z}
</pre>

If <tt>%tok:TokensToUpper = True</tt> is specified for the instantiated object,
the resulting tokens are:
<pre>
%tok:nextToken is BAD,F
%tok:nextToken is ?3MO
%tok:nextToken is ,7,{X
%tok:nextToken is Z}
</pre>

TokensToLower (StringTokenizer property)

2010-12-16T19:55:02Z

198.242.244.36:

Convert returned tokens to all-lowercase?
[[Category:StringTokenizer methods|TokensToLower property]]
[[Category:System methods]]



TokensToLower is a member of the [[StringTokenizer class]].


This readWrite property returns or sets the Boolean value that indicates
whether to convert returned, non-quoted, tokens to all-lowercase characters.
The default value for a new tokenizer is <tt>False</tt>.

===Syntax===
%bool = %tok:TokensToLower

%tok:TokensToLower = %bool
===Syntax terms===
<dl>
<dt>%bool
<dd>An enumeration object of type Boolean to contain the returned value of
TokensToLower.
For more information about Boolean enumerations, see [[Using Boolean enumerations]].
<dt>%tok
<dd>A StringTokenizer object variable.

</dl>
===Usage Notes===
<ul>
<li>TokensToLower has no effect on non-alphabetic characters.
<li>The [[TokensToUpper (StringTokenizer property)|TokensToUpper]] property specifies or reports whether
returned tokens are to be converted to uppercase characters.
</ul>
===Examples===

In the following example,
the input string's tokens are returned in sequence
under the default (<tt>False</tt>) setting of TokensToLower:
<pre>
%tok is object stringtokenizer
%tok = new
%tok:string = 'Bad,F ?3mO ,7,{x Z}'
repeat while not %tok:atEnd
printText {~} is {%tok:nextToken}
end repeat
</pre>

The resulting tokens are:
<pre>
%tok:nextToken is Bad,F
%tok:nextToken is ?3mO
%tok:nextToken is ,7,{x
%tok:nextToken is Z}
</pre>

If <tt>%tok:TokensToLower = True</tt> is specified for the instantiated object,
the resulting tokens are:
<pre>
%tok:nextToken is bad,f
%tok:nextToken is ?3mo
%tok:nextToken is ,7,{x
%tok:nextToken is z}
</pre>

TokenChars (StringTokenizer property)

2010-12-16T19:53:58Z

198.242.244.36:

What are the token-delimiter characters?
[[Category:StringTokenizer methods|TokenChars property]]
[[Category:System methods]]



TokenChars is a member of the [[StringTokenizer class]].


This readWrite property returns or sets the characters that are recognized as
token-delimiter characters, that is, as single-character delimiters that are
also tokens themselves.
As a delimiter, a token-delimiter character is a non-included boundary at the
end or beginning of a token, unless the character is part of a quoted region
(in which case it is treated as a non-delimiter character).

===Syntax===
%string = %tok:TokenChars

%tok:TokenChars = %string
===Syntax terms===
<dl>
<dt>%string
<dd>A string variable to contain the returned value of the current
token-delimiter character(s) or to be set as the new value(s).
The default value for a new tokenizer instance is a null.

If you are setting TokenChars, each character in the string is a
token character — that is, you may not separate characters —
and no character may repeat (except for apostrophe, which may be doubled).
<dt>%tok
<dd>A StringTokenizer object variable.

</dl>
===Usage Notes===
<ul>
<li>The TokenChars tokens are initially settable in the
[[New (StringTokenizer constructor)|New]] call that creates the tokenizer instance.
<li>No character can be one of the TokenChars characters and also
one of either the Quotes characters or the Spaces characters.
</ul>
===Examples===

The statements in the sequence below tokenize the given equation:
<pre>
%tok = new(tokenchars='()=+')
%tok:string = 'y = (x + 1)(x - 1)'
repeat while not %tok:atEnd
printText {~} is {%tok:nextToken}
end repeat
</pre>

The result is:
<pre>
%tok:nextToken is y
%tok:nextToken is =
%tok:nextToken is (
%tok:nextToken is x
%tok:nextToken is +
%tok:nextToken is 1
%tok:nextToken is )
%tok:nextToken is (
%tok:nextToken is x
%tok:nextToken is -
%tok:nextToken is 1
%tok:nextToken is )
</pre>

StringLength (StringTokenizer function)

2010-12-16T19:51:58Z

198.242.244.36:

Length of current tokenizing string
[[Category:StringTokenizer methods|StringLength function]]
[[Category:System methods]]



StringLength is a member of the [[StringTokenizer class]].


This method returns the length of the current tokenizing string.
This string is the value of the [[String (StringTokenizer property)|String]] property.
===Syntax===
%num = %tok:StringLength
===Syntax terms===
<dl>
<dt>%num
<dd>A numeric variable to contain the returned length of the tokenizing string.
<dt>%tok
<dd>A StringTokenizer object variable.

</dl>
===Usage Notes===
<ul>
<li>The [[StartOfString (StringTokenizer function)|StartOfString]] function
returns the substring of the tokenizer string that precedes the first
character of the current token.
The [[RestOfString (StringTokenizer function)|RestOfString]] function
returns the substring of the tokenizer string that follows the current position.
</ul>
===Examples===

The following statements return the length of the input string (that is, 24) into
%len:
<pre>
%toc:string = 'A Stringlength example '
%len = %toc:stringlength
</pre>

String (StringTokenizer property)

2010-12-16T19:49:22Z

198.242.244.36:

The string to be tokenized
[[Category:StringTokenizer methods|String property]]
[[Category:System methods]]



String is a member of the [[StringTokenizer class]].


This readWrite property returns or sets the string to be tokenized.

===Syntax===
%string = %tok:String

%tok:String = %string
===Syntax terms===
<dl>
<dt>%string
<dd>A string variable to contain the returned or set value of the string
to be tokenized.
The default value is a null string.
<dt>%tok
<dd>A StringTokenizer object variable.

</dl>
===Usage Notes===
<ul>
<li>When the String method assigns a string, it
resets to <tt>0</tt> the [[NextPosition (StringTokenizer property)|NextPosition]] value,
and it invalidates the value of [[CurrentToken (StringTokenizer function)|CurrentToken]]
and the value of [[CurrentTokenPosition (StringTokenizer property)|CurrentTokenPosition]].
</ul>
===Examples===

The following statement sets the value of the input string
of the %toc StringTokenizer object:
<pre>
%toc:string = 'A String example!'
</pre>