SelectionCriterion class - Revision history

JAL2: /* Specifying a SelectionCriterion's parameters */

2012-08-13T20:11:32Z

Specifying a SelectionCriterion's parameters

← Older revision		Revision as of 20:11, 13 August 2012
Line 181:		Line 181:
	end class		end class

			%i is float
	%fool is namedArraylist of object foo		%fool is namedArraylist of object foo
	%fool = new		%fool = new

Dme at 22:00, 11 August 2012

2012-08-11T22:00:43Z

← Older revision		Revision as of 22:00, 11 August 2012
Line 10:		Line 10:
	The <var>SelectionCriterion</var> methods are named for the operation they provide:		The <var>SelectionCriterion</var> methods are named for the operation they provide:
	<ul>		<ul>
	<li><var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Eq]]</var> (equal to), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Ne]]</var> (not equal to), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Lt]]</var> (less than), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Le]]</var> (less than or equal to),		<li>Comparisons: <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Eq]]</var> (equal to), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Ne]]</var> (not equal to), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Lt]]</var> (less than), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Le]]</var> (less than or equal to),
	<var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Gt]]</var> (greater than), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Ge]]</var> (greater than or equal to).		<var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Gt]]</var> (greater than), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Ge]]</var> (greater than or equal to). The type of comparison performed is the same as the type of the first argument of the given comparison method: <var>String</var>, <var>Float</var>, or <var>Unicode</var>.

	<li>The <var>[[And and Or (SelectionCriterion functions)\|And]]</var>, <var>[[And and Or (SelectionCriterion functions)\|Or]]</var>, and <var>[[Not (SelectionCriterion function)\|Not]]</var> methods let you combine comparison operations in a single criterion.		<li>The <var>[[And and Or (SelectionCriterion functions)\|And]]</var>, <var>[[And and Or (SelectionCriterion functions)\|Or]]</var>, and <var>[[Not (SelectionCriterion function)\|Not]]</var> methods let you combine comparison operations in a single criterion.
Line 119:		Line 119:

	===Specifying a SelectionCriterion's parameters===		===Specifying a SelectionCriterion's parameters===
	~~As stated earlier, most of the~~ <var>SelectionCriterion</var> methods		The comparison <var>SelectionCriterion</var> methods
	accept two parameters, the first a "method value" and the second an		accept two parameters, the first a "method value" and the second an
	intrinsic value.		intrinsic value.

JAL2 at 22:03, 28 June 2012

2012-06-28T22:03:15Z

← Older revision		Revision as of 22:03, 28 June 2012
Line 12:		Line 12:
	<li><var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Eq]]</var> (equal to), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Ne]]</var> (not equal to), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Lt]]</var> (less than), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Le]]</var> (less than or equal to),		<li><var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Eq]]</var> (equal to), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Ne]]</var> (not equal to), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Lt]]</var> (less than), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Le]]</var> (less than or equal to),
	<var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Gt]]</var> (greater than), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Ge]]</var> (greater than or equal to).		<var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Gt]]</var> (greater than), <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Ge]]</var> (greater than or equal to).

	<li>The <var>[[And and Or (SelectionCriterion functions)\|And]]</var>, <var>[[And and Or (SelectionCriterion functions)\|Or]]</var>, and <var>[[Not (SelectionCriterion function)\|Not]]</var> methods let you combine comparison operations in a single criterion.		<li>The <var>[[And and Or (SelectionCriterion functions)\|And]]</var>, <var>[[And and Or (SelectionCriterion functions)\|Or]]</var>, and <var>[[Not (SelectionCriterion function)\|Not]]</var> methods let you combine comparison operations in a single criterion.

	<li>The <var>[[True and False (SelectionCriterion functions)\|True]]</var> and <var>[[True and False (SelectionCriterion functions)\|False]]</var> methods respectively match all or no items.		<li>The <var>[[True and False (SelectionCriterion functions)\|True]]</var> and <var>[[True and False (SelectionCriterion functions)\|False]]</var> methods respectively match all or no items.

	<li>The <var>[[IsNull and IsNotNull (SelectionCriterion functions)\|IsNull]]</var> and <var>[[IsNull and IsNotNull (SelectionCriterion functions)\|IsNotNull]]</var> methods respectively match a collection object that is <var>Null</var>		<li>The <var>[[IsNull and IsNotNull (SelectionCriterion functions)\|IsNull]]</var> and <var>[[IsNull and IsNotNull (SelectionCriterion functions)\|IsNotNull]]</var> methods respectively match a collection object that is <var>Null</var>
	or one that is not <var>Null</var>.		or one that is not <var>Null</var>.
Line 137:		Line 140:
	<tr><th>intrinEnum</th>		<tr><th>intrinEnum</th>
	<td>A <var class="product">User Language</var> [[Intrinsic classes#intrins_classes\|intrinsic class]] type or an [[Enumerations\|enumeration]] value returned by the function. <p>		<td>A <var class="product">User Language</var> [[Intrinsic classes#intrins_classes\|intrinsic class]] type or an [[Enumerations\|enumeration]] value returned by the function. <p>
	'''Note:''' Enumeration values are allowed as of <var class="product">Sirius Mods</var> 7.8, ~~and~~ only in the <var>Eq</var> and <var>Ne</var> methods.</p>		'''Note:''' Enumeration values are allowed as of <var class="product">Sirius Mods</var> 7.8, but only in the <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Eq]]</var> and <var>[[Eq, Ne, Ge, Gt, Le and Lt (SelectionCriterion functions)\|Ne]]</var> methods.</p>
	</td></tr></table>		</td></tr></table>

JAL2: /* Specifying a SelectionCriterion's parameters */

2012-06-28T20:57:59Z

Specifying a SelectionCriterion's parameters

← Older revision		Revision as of 20:57, 28 June 2012
Line 136:		Line 136:
	</td></tr>		</td></tr>
	<tr><th>intrinEnum</th>		<tr><th>intrinEnum</th>
	<td>A <var class="product">User Language</var> [[Intrinsic classes#intrins_classes\|intrinsic class]] type or an enumeration value returned by the function. <p>		<td>A <var class="product">User Language</var> [[Intrinsic classes#intrins_classes\|intrinsic class]] type or an [[Enumerations\|enumeration]] value returned by the function. <p>
	Enumeration values are allowed as of <var class="product">Sirius Mods</var> 7.8, and only in the <var>Eq</var> and <var>Ne</var> methods.</p>		'''Note:''' Enumeration values are allowed as of <var class="product">Sirius Mods</var> 7.8, and only in the <var>Eq</var> and <var>Ne</var> methods.</p>
	</td></tr></table>		</td></tr></table>

Line 152:		Line 152:
	satisfy the <var>Function</var> template described above.		satisfy the <var>Function</var> template described above.
	<ol>		<ol>
	<li><div id="xmpxsub"></div>The ~~selectionCriterion~~ in the following example uses a class variable, <code>Income</code>, as the criterion method parameter. The collection method, <var>SubsetNew</var>, returns a <var>NamedArraylist</var> that contains all the items that satisfied the selection		<li><div id="xmpxsub"></div>The <var>SelectionCriterion</var> in the following example uses a class variable, <code>Income</code>, as the criterion method parameter. The collection method, <var>SubsetNew</var>, returns a <var>NamedArraylist</var> that contains all the items that satisfied the selection criterion.
	criterion.
	<p class="code"><nowiki>Begin		<p class="code"><nowiki>Begin
	class foo		class foo
Line 203:		Line 202:
	Jon White tired (income: 70000)		Jon White tired (income: 70000)
	</nowiki></p>		</nowiki></p>
	<li>~~The~~ second parameter in most <var>SelectionCriterion</var> methods is a <var class="product">User Language</var>
			<li>In most cases, the second parameter in most <var>SelectionCriterion</var> methods is a <var class="product">User Language</var>
	intrinsic-type value, often a string or numeric literal.		intrinsic-type value, often a string or numeric literal.
	Consequently, you cannot specify a criterion that compares two method		Consequently, you cannot specify a criterion that compares two method

JAL2: /* Specifying a SelectionCriterion's parameters */

2012-06-28T20:18:55Z

Specifying a SelectionCriterion's parameters

← Older revision		Revision as of 20:18, 28 June 2012
Line 117:		Line 117:
	===Specifying a SelectionCriterion's parameters===		===Specifying a SelectionCriterion's parameters===
	As stated earlier, most of the <var>SelectionCriterion</var> methods		As stated earlier, most of the <var>SelectionCriterion</var> methods
	accept two parameters, the first a ~~“~~method value~~”~~ and the second an		accept two parameters, the first a "method value" and the second an
	intrinsic value.		intrinsic value.
	Regarding the first, just as		Regarding the first, just as
	a <var class="product">User Language</var> ~~“~~numeric~~”~~ argument can be a numeric literal or a variable or even an		a <var class="product">User Language</var> "numeric" argument can be a numeric literal or a variable or even an
	expression that results in a number, a method value argument can be a method		expression that results in a number, a method value argument can be a method
	literal or a method variable or an expression that results in a method.		literal or a method variable or an expression that results in a method.
Line 126:		Line 126:
	More specifically, a method value is a value assigned to a [[Method variables\|method variable]].		More specifically, a method value is a value assigned to a [[Method variables\|method variable]].
	And for a <var>SelectionCriterion</var>, the method variable's ''implicit'' declaration is:		And for a <var>SelectionCriterion</var>, the method variable's ''implicit'' declaration is:
	<p class="syntax"><span class="literal">Is Function (</span><span class="term">itemtype</span><span class="literal">):</span><span class="term">methname</span> <span class="literal">Is</span> <span class="term">~~intrinType~~</span></p>		<p class="syntax"><span class="literal">Is Function (</span><span class="term">itemtype</span><span class="literal">):</span><span class="term">methname</span> <span class="literal">Is</span> <span class="term">intrinEnum</span></p>
	Where:		Where:
	<table class="syntaxTable">		<table class="syntaxTable">
Line 135:		Line 135:
	<td>A method name, but merely a placeholder in an actual declaration. Any method (system or user), class variable, or method variable that fits the declaration can be used in the <var>SelectionCriterion</var>.		<td>A method name, but merely a placeholder in an actual declaration. Any method (system or user), class variable, or method variable that fits the declaration can be used in the <var>SelectionCriterion</var>.
	</td></tr>		</td></tr>
	<tr><th>~~intrinType~~</th>		<tr><th>intrinEnum</th>
	<td>A <var class="product">User Language</var> [[Intrinsic classes#intrins_classes\|intrinsic class]] type returned by the function.		<td>A <var class="product">User Language</var> [[Intrinsic classes#intrins_classes\|intrinsic class]] type or an enumeration value returned by the function. <p>
			Enumeration values are allowed as of <var class="product">Sirius Mods</var> 7.8, and only in the <var>Eq</var> and <var>Ne</var> methods.</p>
	</td></tr></table>		</td></tr></table>

	The method value argument must conform to the following rules:		The method value argument must conform to the following rules:
	<ul>		<ul>
	<li>It must return an intrinsic value.		<li>It must return an intrinsic or enumeration value.
	<li>It cannot have any parameters other than the method object.		<li>It cannot have any parameters other than the method object.
	</ul>		</ul>

Dme: /* Specifying a SelectionCriterion's parameters */

2012-06-27T17:30:34Z

Specifying a SelectionCriterion's parameters

← Older revision		Revision as of 17:30, 27 June 2012
Line 220:		Line 220:
	%custDebtors = %custs:subsetNew(lt(netIncome, 0))		%custDebtors = %custs:subsetNew(lt(netIncome, 0))
	</nowiki></p>		</nowiki></p>
	<li><div id="xmpthis"></div>The <var>SelectionCriterion</var> in the following request uses the special method value <var>This</var> as the method parameter, and the <var>And</var> constructor combines two criteria to create one criterion. Valid only for intrinsic classes, <var>This</var> simply ~~ret~~		<li><div id="xmpthis"></div>The <var>SelectionCriterion</var> in the following request uses the special method value <var>This</var> as the method parameter, and the <var>And</var> constructor combines two criteria to create one criterion. Valid only for intrinsic classes, <var>This</var> simply returns the value of the method object.
	<p class="code"><nowiki>Begin		<p class="code"><nowiki>Begin
	%fooflt is arraylist of float		%fooflt is arraylist of float

Dme: /* Specifying a SelectionCriterion's parameters */

2012-06-27T17:26:37Z

Specifying a SelectionCriterion's parameters

← Older revision		Revision as of 17:26, 27 June 2012
Line 130:		Line 130:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>itemtype</th>		<tr><th>itemtype</th>
	<td>The class of the items in the collection to be ~~sorted~~.		<td>The class of the items in the collection to be searched.
	</td></tr>		</td></tr>
	<tr><th>methname</th>		<tr><th>methname</th>

JAL2 at 00:02, 24 December 2011

2011-12-24T00:02:13Z

← Older revision		Revision as of 00:02, 24 December 2011
Line 89:		Line 89:
	The <var>SelectionCriterion</var> class is new as of <var class="product">Sirius Mods</var> version 7.6.		The <var>SelectionCriterion</var> class is new as of <var class="product">Sirius Mods</var> version 7.6.

	~~The [[List of SelectionCriterion methods\|"List of SelectionCriterion methods"]] lists all the methods in this class.~~

	===Declaring a SelectionCriterion object variable===		===Declaring a SelectionCriterion object variable===
	The <var>SelectionCriterion</var> class operates on specific objects, so a variable of the		The <var>SelectionCriterion</var> class operates on specific objects, so a variable of the
Line 100:		Line 98:
	</nowiki></p>		</nowiki></p>

	The declaration for <code>%sel</code> in the example in the preceding section		The declaration for <code>%sel</code> in the example in the preceding section might be:
	might be:
	<p class="code"><nowiki>%sel is object selectionCriterion for float		<p class="code"><nowiki>%sel is object selectionCriterion for float
	</nowiki></p>		</nowiki></p>
Line 117:		Line 114:
	<td>The datatype of the items in the collection to be searched.		<td>The datatype of the items in the collection to be searched.
	</td></tr></table>		</td></tr></table>

	===Specifying a SelectionCriterion's parameters===		===Specifying a SelectionCriterion's parameters===
	As stated earlier, most of the <var>SelectionCriterion</var> methods		As stated earlier, most of the <var>SelectionCriterion</var> methods
Line 240:		Line 238:
	</nowiki></p>		</nowiki></p>
	</ol>		</ol>
	==~~See also==~~
	~~<table class~~=~~"list"><tr>~~		==List of SelectionCriterion methods==
	~~<td valign~~=~~"top"><ul style="margin-top:0px;">~~		The [[List of SelectionCriterion methods\|"List of SelectionCriterion methods"]] shows all the class methods.
	~~<li>~~[[List of SelectionCriterion methods]]
	~~</ul></td>~~
	~~<td valign=~~"~~top"><ul style="margin-top:0px;">~~
	~~<li>[[~~SelectionCriterion methods ~~syntax~~]]
	~~</ul></td>~~
	~~</tr>~~
	~~</table>~~
	[[Category:System classes]]		[[Category:System classes]]

Alex at 12:49, 14 September 2011

2011-09-14T12:49:26Z

← Older revision		Revision as of 12:49, 14 September 2011
Line 95:		Line 95:
	<var>SelectionCriterion</var> class must be qualified with the object to which it applies:		<var>SelectionCriterion</var> class must be qualified with the object to which it applies:
	For example:		For example:
	<p class="code"><nowiki>%sel1 is selectionCriterion for object myClass		<p class="code"><nowiki>%sel1 is object selectionCriterion for object myClass
	%sel2 is selectionCriterion for object xmlNode		%sel2 is object selectionCriterion for object xmlNode
	%sel3 is selectionCriterion for longstring		%sel3 is object selectionCriterion for longstring
	</nowiki></p>		</nowiki></p>

	The declaration for <code>%sel</code> in the example in the preceding section		The declaration for <code>%sel</code> in the example in the preceding section
	might be:		might be:
	<p class="code"><nowiki>%sel is selectionCriterion for float		<p class="code"><nowiki>%sel is object selectionCriterion for float
	</nowiki></p>		</nowiki></p>

Dme at 18:20, 15 August 2011

2011-08-15T18:20:19Z

← Older revision		Revision as of 18:20, 15 August 2011
Line 135:		Line 135:
	</td></tr>		</td></tr>
	<tr><th>methname</th>		<tr><th>methname</th>
	<td>A method name, but merely a placeholder in an actual declaration. Any method (system or user), class ~~<var>Variable</var> or <var>Property</var>, local method~~, or method variable that fits the declaration can be used in the <var>SelectionCriterion</var>.		<td>A method name, but merely a placeholder in an actual declaration. Any method (system or user), class variable, or method variable that fits the declaration can be used in the <var>SelectionCriterion</var>.
	</td></tr>		</td></tr>
	<tr><th>intrinType</th>		<tr><th>intrinType</th>
Line 149:		Line 149:
	The following examples show different method argument types		The following examples show different method argument types
	as the first parameter in a <var>SelectionCriterion</var>.		as the first parameter in a <var>SelectionCriterion</var>.
	In the examples below, the method values are respectively a class ~~<var>Variable</var>~~,		In the examples below, the method values are respectively a class variable,
	a local method, and the special method value <var>This</var>, all of which		a local method, and the special method value <var>This</var>, all of which
	satisfy the <var>Function</var> template described above.		satisfy the <var>Function</var> template described above.
	<ol>		<ol>
	<li><div id="xmpxsub"></div>The selectionCriterion in the following example uses a class ~~<var>Variable</var>~~, <code>Income</code>, as the criterion method parameter. The collection method, <var>SubsetNew</var>, returns a <var>NamedArraylist</var> that contains all the items that satisfied the selection		<li><div id="xmpxsub"></div>The selectionCriterion in the following example uses a class variable, <code>Income</code>, as the criterion method parameter. The collection method, <var>SubsetNew</var>, returns a <var>NamedArraylist</var> that contains all the items that satisfied the selection
	criterion.		criterion.
	<p class="code"><nowiki>Begin		<p class="code"><nowiki>Begin