SortOrder class - Revision history

Admin: /* Specifying a SortOrder's sort key method */

2016-01-14T15:35:08Z

Specifying a SortOrder's sort key method

← Older revision		Revision as of 15:35, 14 January 2016
Line 144:		Line 144:
	<p class="code">%clientRating is float		<p class="code">%clientRating is float

	local function tprice is float expose		local function (order):tprice is float expose
	return %this:totalprice(%clientRating)		return %this:totalprice(%clientRating)
	end function		end function
Line 153:		Line 153:
	If <code>ClientRating</code> was already a member of the Order class, you would specify:		If <code>ClientRating</code> was already a member of the Order class, you would specify:
	<p class="code">		<p class="code">
	local function tprice is float		local function (order):tprice is float
	return %this:totalprice(%this:clientRating)		return %this:totalprice(%this:clientRating)
	end function		end function

Alan: /* Specifying a SortOrder's sort key method */

2015-11-04T15:18:11Z

Specifying a SortOrder's sort key method

← Older revision		Revision as of 15:18, 4 November 2015
Line 111:		Line 111:
	end class		end class
	...		...
	%order is object sortOrder for info		%order is object sortOrder for object info
	...		...
	%order = ascending(name)		%order = ascending(name)

Dme: /* Assigning a SortOrder object variable */

2015-04-01T21:40:30Z

Assigning a SortOrder object variable

← Older revision		Revision as of 21:40, 1 April 2015
Line 65:		Line 65:

	==Assigning a SortOrder object variable==		==Assigning a SortOrder object variable==
	<var>~~SortOrderS~~</var> are immutable objects.		<var>SortOrder</var>s are immutable objects.
	You can assign a sort order to a <var>SortOrder</var> object:		You can assign a sort order to a <var>SortOrder</var> object:
	<p class="code">%myOrder is object sortOrder for longstring		<p class="code">%myOrder is object sortOrder for longstring
Line 78:		Line 78:
	%myorder = descending(reverse)		%myorder = descending(reverse)
	</p>		</p>

	==Specifying a SortOrder's sort key method==		==Specifying a SortOrder's sort key method==
	The following examples show different method types, actually "method values,"		The following examples show different method types, actually "method values,"

JAL at 23:21, 13 November 2012

2012-11-13T23:21:16Z

← Older revision		Revision as of 23:21, 13 November 2012
Line 20:		Line 20:

	where <var>[[Ascending and Descending (SortOrder functions)\|Ascending]]</var> is a <var>SortOrder</var> constructor with parameter <code>price</code>, a method defined		where <var>[[Ascending and Descending (SortOrder functions)\|Ascending]]</var> is a <var>SortOrder</var> constructor with parameter <code>price</code>, a method defined
	to operate on the items in %orders.		to operate on the items in <code>%orders</code>.

	The <code>price</code> method above is applied to each of the items in <code>%orders</code>, and the resulting		The <code>price</code> method above is applied to each of the items in <code>%orders</code>, and the resulting
Line 26:		Line 26:
	the <code>price</code> return value type.		the <code>price</code> return value type.
	<code>price</code> must return an [[Intrinsic classes\|intrinsic]] (number, string, unicode) value.		<code>price</code> must return an [[Intrinsic classes\|intrinsic]] (number, string, unicode) value.
	For more about the method in a <var>SortOrder</var>, see [[#Specifying a SortOrder's sort key method\|"Specifying a ~~<var>~~SortOrder~~</var>~~'s sort key method"]] below.		For more about the method in a <var>SortOrder</var>, see [[#Specifying a SortOrder's sort key method\|"Specifying a SortOrder's sort key method"]] below.

	If <code>%sord</code> is a <var>SortOrder</var> instance returned by the <var>Ascending</var> constructor		If <code>%sord</code> is a <var>SortOrder</var> instance returned by the <var>Ascending</var> constructor
Line 53:		Line 53:
	==Declaring a SortOrder object variable==		==Declaring a SortOrder object variable==
	The syntax for declaring a <var>SortOrder</var> object variable is:		The syntax for declaring a <var>SortOrder</var> object variable is:
	<p class="syntax"><~~var~~ class="term">objvar</~~var~~> Is Object SortOrder For <~~var~~ class="term">itemtype</~~var~~></p>		<p class="syntax"><span class="term">objvar</span> <span class="literal">Is Object SortOrder For</span> <span class="term">itemtype</span></p>

	Where:		Where:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>objvar</th>		<tr><th>objvar</th>
	<td>The name of the SortOrder object variable. </td></tr>		<td>The name of the <var>SortOrder</var> object variable. </td></tr>

	<tr><th>itemtype</th>		<tr><th>itemtype</th>
	<td>The datatype of the items in the collection to be sorted. </td></tr>		<td>The datatype of the items in the collection to be sorted. </td></tr>
Line 83:		Line 84:
	A method value is a value assigned to a [[Method variables\|method variable]].		A method value is a value assigned to a [[Method variables\|method variable]].
	And for a <var>SortOrder</var>, the method variable's implicit declaration is:		And for a <var>SortOrder</var>, the method variable's implicit declaration is:
	<p class="syntax">Is Function (<~~var~~ class="term">itemtype</~~var~~>):<~~var~~ class="term">methname</~~var~~> Is <~~var~~ class="term">intrinType</~~var~~>		<p class="syntax"><span class="literal">Is Function</span> (<span class="term">itemtype</span>):<span class="term">methname</span> <span class="literal">Is</span> <span class="term">intrinType</span>
	</p>		</p>
	Where:		Where:

JAL2: /* Specifying a SortOrder's sort key method */

2012-08-09T22:26:03Z

Specifying a SortOrder's sort key method

← Older revision		Revision as of 22:26, 9 August 2012
Line 114:		Line 114:
	%order = ascending(name)		%order = ascending(name)
	</p>		</p>

	<li>The following example outlines the use of a method variable		<li>The following example outlines the use of a method variable
	as a <var>SortOrder</var> sort key.		as a <var>SortOrder</var> sort key.
Line 130:		Line 131:
	%orders = %orders:sortnew(descending(%sortMethod))		%orders = %orders:sortnew(descending(%sortMethod))
	</p>		</p>
	<li><div id="xmplocal"></div>In this example, a [[local method]] is used to accommodate a <var>SortOrder</var> function that requires a parameter.
			<li><div id="xmplocal"></div>In this example, a [[Local and Common entities#Defining and invoking a local method\|local method]] is used to accommodate a <var>SortOrder</var> function that requires a parameter.
	The <var>SortOrder</var> syntax does not provide for specifying a parameter for the		The <var>SortOrder</var> syntax does not provide for specifying a parameter for the
	method parameter.		method parameter.
Line 159:		Line 161:
	If <code>tprice</code> was used in many places, you could move it		If <code>tprice</code> was used in many places, you could move it
	into the Order class without changing the <var>Sort</var> calls.		into the Order class without changing the <var>Sort</var> calls.

	<li>The <var>SortOrder</var> in the following fragment uses the special method		<li>The <var>SortOrder</var> in the following fragment uses the special method
	value <var>This</var> as the sort key.		value <var>This</var> as the sort key.

Dme: /* Overview */

2012-06-27T15:51:06Z

Overview

← Older revision		Revision as of 15:51, 27 June 2012
Line 22:		Line 22:
	to operate on the items in %orders.		to operate on the items in %orders.

	The ~~Price~~ method above is applied to each of the items in <code>%orders</code>, and the resulting		The <code>price</code> method above is applied to each of the items in <code>%orders</code>, and the resulting
	values are sorted in ascending order, alphabetically or numerically according to		values are sorted in ascending order, alphabetically or numerically according to
	the ~~Price~~ return value type.		the <code>price</code> return value type.
	~~Price~~ must return an [[Intrinsic classes\|intrinsic]] (number, string, unicode) value.		<code>price</code> must return an [[Intrinsic classes\|intrinsic]] (number, string, unicode) value.
	For more about the method in a <var>SortOrder</var>, see [[#Specifying a SortOrder's sort key method\|"Specifying a <var>SortOrder</var>'s sort key method"]] below.		For more about the method in a <var>SortOrder</var>, see [[#Specifying a SortOrder's sort key method\|"Specifying a <var>SortOrder</var>'s sort key method"]] below.

JAL2 at 00:18, 24 December 2011

2011-12-24T00:18:55Z

← Older revision		Revision as of 00:18, 24 December 2011
Line 4:		Line 4:
	The <var>SortNew</var> and <var>Sort</var> methods take a <var>SortOrder</var> object as a parameter which provides		The <var>SortNew</var> and <var>Sort</var> methods take a <var>SortOrder</var> object as a parameter which provides
	sorting criteria for the sort.		sorting criteria for the sort.

	~~The methods in this class are listed in [[List of SortOrder methods\|"List of SortOrder methods"]].~~

	The <var>SortOrder</var> class is new as of <var class="product">Sirius Mods</var> version 7.3.		The <var>SortOrder</var> class is new as of <var class="product">Sirius Mods</var> version 7.3.
	~~__TOC__~~
	==Overview==		==Overview==
	A <var>SortOrder</var> object consists of two kinds of information:		A <var>SortOrder</var> object consists of two kinds of information:
Line 176:		Line 174:
	<var>This</var> is the default method value as of <var class="product">Sirius Mods</var> version 7.6.		<var>This</var> is the default method value as of <var class="product">Sirius Mods</var> version 7.6.
	</ol>		</ol>

			==List of SortOrder methods==
			The [[List of SortOrder methods\|"List of SortOrder methods"]] shows all the class methods.

	[[Category:System classes]]		[[Category:System classes]]

JAL2: /* Overview */

2011-11-30T21:23:28Z

Overview

← Older revision		Revision as of 21:23, 30 November 2011
Line 43:		Line 43:
	However, to construct such a <var>SortOrder</var> collection,		However, to construct such a <var>SortOrder</var> collection,
	you must use the <var>SortOrder</var> class <var>[[List (SortOrder function)\|List]]</var> constructor.		you must use the <var>SortOrder</var> class <var>[[List (SortOrder function)\|List]]</var> constructor.
	<var>List</var> takes <var>~~SortOrderS~~</var> as inputs and returns a <var>SortOrder</var> object that contains them.		<var>List</var> takes <var>SortOrder</var>s as inputs and returns a <var>SortOrder</var> object that contains them.

	For example, to sort in ascending order by quantity and price for <code>%orders</code>:		For example, to sort in ascending order by quantity and price for <code>%orders</code>:

Dme at 20:01, 30 November 2011

2011-11-30T20:01:36Z

← Older revision		Revision as of 20:01, 30 November 2011
Line 40:		Line 40:

	To provide multiple sort criteria for a sort,		To provide multiple sort criteria for a sort,
	a <var>SortOrder</var> object may be a collection of multiple <var>~~SortOrders~~</var>.		a <var>SortOrder</var> object may be a collection of multiple <var>SortOrder</var>s.
	However, to construct such a <var>SortOrder</var> collection,		However, to construct such a <var>SortOrder</var> collection,
	you must use the <var>SortOrder</var> class <var>[[List (SortOrder function)\|List]]</var> constructor.		you must use the <var>SortOrder</var> class <var>[[List (SortOrder function)\|List]]</var> constructor.

Dme: /* Overview */

2011-11-30T20:01:07Z

Overview

← Older revision		Revision as of 20:01, 30 November 2011
Line 40:		Line 40:

	To provide multiple sort criteria for a sort,		To provide multiple sort criteria for a sort,
	a <var>SortOrder</var> object may be a collection of multiple <var>~~SortOrderS~~</var>.		a <var>SortOrder</var> object may be a collection of multiple <var>SortOrders</var>.
	However, to construct such a <var>SortOrder</var> collection,		However, to construct such a <var>SortOrder</var> collection,
	you must use the <var>SortOrder</var> class <var>[[List (SortOrder function)\|List]]</var> constructor.		you must use the <var>SortOrder</var> class <var>[[List (SortOrder function)\|List]]</var> constructor.
Line 52:		Line 52:
	The <var>SortOrder</var> object in the preceding example contains two sort criteria;		The <var>SortOrder</var> object in the preceding example contains two sort criteria;
	you may specify as many as seven.		you may specify as many as seven.

	==Declaring a SortOrder object variable==		==Declaring a SortOrder object variable==
	The syntax for declaring a <var>SortOrder</var> object variable is:		The syntax for declaring a <var>SortOrder</var> object variable is: