File: SortCriter.st

package info (click to toggle)
gnu-smalltalk 3.2.4-2.1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 32,688 kB
  • ctags: 14,104
  • sloc: ansic: 87,424; sh: 22,729; asm: 8,465; perl: 4,513; cpp: 3,548; xml: 1,669; awk: 1,581; yacc: 1,357; makefile: 1,237; lisp: 855; lex: 843; sed: 258; objc: 124
file content (412 lines) | stat: -rw-r--r-- 11,309 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
"======================================================================
|
|   SortCriteria example
|
|
 ======================================================================"


"======================================================================
|
| Written by Peter William Lount.
|
| This file is part of GNU Smalltalk.
|
 ======================================================================"

Object subclass: #SortCriteria
	instanceVariableNames: 'columnSortCriteria '
	classVariableNames: ''
	poolDictionaries: ''
	category: 'Sort Criteria'!

Object subclass: #SortCriteriaColumn
	instanceVariableNames: 'columnName ascendingFlag accessProtocol '
	classVariableNames: ''
	poolDictionaries: ''
	category: 'Sort Criteria'!

Object subclass: #SortCriteriaTest
	instanceVariableNames: 'size length code '
	classVariableNames: ''
	poolDictionaries: ''
	category: 'Sort Criteria'!

SortCriteria comment: 
'SortCriteria and SortCriteriaColumn objects copyright 1996, 1997, 1998, and 1999 by Peter William Lount
All rights reserved. peter@smalltalk.org, http://www.smalltalk.org

Usage License
You may use these objects for any purpose what so ever as long as this notice remains intact. If these objects are used in a used in a software product for which source code is not released to the public you must visibly display the above notice.'!


!SortCriteria methodsFor: 'initialization' stamp: 'pwl 7/16/1999 12:04'!
initialize

    columnSortCriteria := OrderedCollection new.! !


!SortCriteria methodsFor: 'sorted collection protocol' stamp: 'PWVL 9/14/1998 18:03'!
fixTemps
	"We don't need to do anything here."! !

!SortCriteria methodsFor: 'sorted collection protocol' stamp: 'PWVL 9/14/1998 17:17'!
value: theFirstElement value: theSecondElement
    "Part of the protocol that Blocks used in sorting use... the default sort block used by SortedCollection
    is [:a :b | a <= b]. We implement this protocol and can therefore be
    placed into the SortedCollection..."
    | aResult aLastColCriteria |
    columnSortCriteria isNil ifTrue: [
	 "Ignore the sorting order as we don't have any columns to sort...yet"
	^ true
    ] ifFalse: [
	 	"We have columns to sort, so lets sort them..."
	columnSortCriteria do: [:aColumnCriteria |
	    aResult := aColumnCriteria value: theFirstElement value: theSecondElement.
	    aResult == nil ifFalse: [
		"The elements are either greater or less, but not equal, return which..."
		^aResult
	    ].
	    "The elements in this column were equal - use the next column (if any)  to decide sort order..."
	    aLastColCriteria := aColumnCriteria.
	].
	"The last comparison of the elements were equal...return the appropriate value..."
	^ aLastColCriteria equalBoolean
    ]! !


!SortCriteria methodsFor: 'sort order' stamp: 'pwl 7/16/1999 11:35'!
addColumnName: theColumnName
ascendingFlag: theBoolean

    columnSortCriteria add: (
	SortCriteriaColumn new
	    columnName: theColumnName ;
	    ascendingFlag: theBoolean;
	    yourself
    )! !

!SortCriteria methodsFor: 'sort order'!
columnNames
    "Generate and return a list of column names in sequence..."
    | aList |
    aList := OrderedCollection new: columnSortCriteria size.
    columnSortCriteria do: [:aColSortCriteria |
	aList add: aColSortCriteria columnName asSymbol
    ].
    ^aList! !

"-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- "!

SortCriteria class
	instanceVariableNames: ''!

!SortCriteria class methodsFor: 'instance creation' stamp: 'pwl 7/16/1999 12:02'!
new
	^super new initialize! !



!SortCriteriaColumn methodsFor: 'initialize' stamp: 'pwl 7/16/1999 12:04'!
initialize

	self ascendingSort.
	self useMethodPerformProtocol.! !


!SortCriteriaColumn methodsFor: 'equality testing'!
equalBoolean
    "Return the boolean flag used to determine sort order when the two elements are the same...
    This is dependent upon the ascendingFlag sort order...
	i.e. Ascending sort: when a <= b return true, when a > b return false.
	      Decending sort: when a <= b return false, when a > b return true...
	Therefore, if you'll notice, it works to return a logical not of the ascending flag...
    "
    ^ ascendingFlag! !


!SortCriteriaColumn methodsFor: 'sort attribute'!
columnName
    ^columnName! !

!SortCriteriaColumn methodsFor: 'sort attribute'!
columnName: theColumnName
    columnName := theColumnName asSymbol! !


!SortCriteriaColumn methodsFor: 'sort order'!
ascendingFlag
    ^ascendingFlag! !

!SortCriteriaColumn methodsFor: 'sort order'!
ascendingFlag: theBoolean
    ascendingFlag := theBoolean.! !

!SortCriteriaColumn methodsFor: 'sort order' stamp: 'PWVL 9/14/1998 17:27'!
ascendingSort
    self ascendingFlag: true.! !

!SortCriteriaColumn methodsFor: 'sort order' stamp: 'PWVL 9/14/1998 17:27'!
decendingSort
    self ascendingFlag: false.! !


!SortCriteriaColumn methodsFor: 'attribute access protocols' stamp: 'PWVL 9/14/1998 17:27'!
useDictionaryAtProtocol
	accessProtocol := #dictionaryAt.
! !

!SortCriteriaColumn methodsFor: 'attribute access protocols' stamp: 'PWVL 9/14/1998 17:28'!
useMethodPerformProtocol
	accessProtocol := #methodPerform.
! !

!SortCriteriaColumn methodsFor: 'attribute access protocols' stamp: 'pwl 7/16/1999 11:46'!
valueOfColumnNamed: theColumnName 
for: theTargetObject
ifAbsent: theAbsentBlock

	"Retreive the value of the column name for the target object using the appropiate access method protocol.
	If the object does not have the column name as an attribute then execute the absent block and return it's result."

	accessProtocol = #dictionaryAt ifTrue: [
		^theTargetObject 
			at: columnName 
			ifAbsent: [
				nil
			].
	].
	accessProtocol = #methodPerform ifTrue: [
		^theTargetObject 
			perform: columnName
	].
	^nil! !


!SortCriteriaColumn methodsFor: 'sorted collection protocol' stamp: 'pwl 7/16/1999 08:56'!
value: theFirstElement value: theSecondElement
    | aFirstValue aSecondValue |
    "Compare the two elements and determine which comes first...
    If a column name is missing then use a blank value order..."
    columnName isNil ifTrue: [^ascendingFlag].

	"Get the value of the first element."
	aFirstValue := self valueOfColumnNamed: columnName for: theFirstElement ifAbsent: [^ascendingFlag].
	aFirstValue ifNil: [^ascendingFlag].

	"Get the value of the second element."
	aSecondValue := self valueOfColumnNamed: columnName for: theSecondElement ifAbsent: [^ascendingFlag not].
	aSecondValue ifNil: [^ascendingFlag not].

    "Actually compare the values now taking the ascending and decending order into account..."
    ascendingFlag ifTrue: [
	aFirstValue < aSecondValue ifTrue: [
	    "The first element comes before the second element..."
	    ^true
	] ifFalse: [
	    "Are the two elements equal?"
	    aFirstValue = aSecondValue ifTrue: [
		"The elements are equal... the next column (if any) must be checked..."
		^nil
	    ] ifFalse: [
		"The second element comes before the first..."
		^false
	    ]
	 ]
    ] ifFalse: [
	"The sort order is decending...reverse the comparisons..."
	aSecondValue < aFirstValue ifTrue: [
	    "The second element comes before the first element..."
	    ^true
	] ifFalse: [
	    "Are the two elements equal?"
	    aSecondValue = aFirstValue ifTrue: [
		"The elements are equal..."
		^nil
	    ] ifFalse: [
		"The first element comes before the second..."
		^false
	    ]
	 ]
    ]! !

"-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- "!

SortCriteriaColumn class
	instanceVariableNames: ''!

!SortCriteriaColumn class methodsFor: 'instance creation' stamp: 'pwl 7/16/1999 12:02'!
new
	^super new initialize! !



!SortCriteriaTest comment:
'SortCriteriaTest is a test and an example of using the sort criteria objects.'!


!SortCriteriaTest methodsFor: 'accessing'!
code
    ^code! !

!SortCriteriaTest methodsFor: 'accessing'!
code: theObject
    code := theObject! !

!SortCriteriaTest methodsFor: 'accessing'!
length
    ^length! !

!SortCriteriaTest methodsFor: 'accessing'!
length: theObject
    length := theObject! !

!SortCriteriaTest methodsFor: 'accessing'!
size
    ^size! !

!SortCriteriaTest methodsFor: 'accessing'!
size: theObject
    size := theObject! !


!SortCriteriaTest methodsFor: 'printing' stamp: 'pwl 7/16/1999 12:46'!
printOn: theStream
  
    theStream
		nextPutAll: '(', self class name;
		nextPutAll: ' code: ', self code printString;
		nextPutAll: ' size: ', self size printString;
		nextPutAll: ' length: ', self length printString;
		nextPutAll: ')'; 
		cr
		! !

"-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- "!

SortCriteriaTest class
	instanceVariableNames: ''!

!SortCriteriaTest class methodsFor: 'testing' stamp: 'pwl 7/16/1999 12:50'!
addToList: theSortedList

    theSortedList add: (
	SortCriteriaTest new
	    code: 'R301';
	    size: '5M';
	    length: 50;
	    yourself
    ).
    theSortedList add: (
	SortCriteriaTest new
	    code: 'R202';
	    size: '29M';
	    length: 70;
	    yourself
    ).
    theSortedList add: (
	SortCriteriaTest new
	    code: 'R002';
	    size: '18M';
	    length: 65;
	    yourself
    ).
    theSortedList add: (
	SortCriteriaTest new
	    code: 'R202';
	    size: '15M';
	    length: 89;
	    yourself
    ).
   theSortedList add: (
	SortCriteriaTest new
	    code: 'R101';
	    size: '26M';
	    length: 90;
	    yourself
    ).
    theSortedList add: (
	SortCriteriaTest new
	    code: 'R202';
	    size: '15M';
	    length: 16;
	    yourself
    ).
    theSortedList add: (
	SortCriteriaTest new
	    code: 'R202';
	    size: '15M';
	    length: 18;
	    yourself
    ).
    theSortedList add: (
	SortCriteriaTest new
	    code: 'R202';
	    size: '15M';
	    length: 45;
	    yourself
    ).
    theSortedList add: (
	SortCriteriaTest new
	    code: 'R202';
	    size: '15M';
	    length: 89;
	    yourself
    ).
    theSortedList add: (
	SortCriteriaTest new
	    code: 'R202';
	    size: '15M';
	    length: 114;
	    yourself
    ).


    ^theSortedList! !

!SortCriteriaTest class methodsFor: 'testing' stamp: 'pwl 7/16/1999 12:48'!
test1
	"SortCriteriaTest test1"

	| aSortedList aSortCriteria |
	aSortCriteria := SortCriteria new.
	aSortCriteria addColumnName: #code ascendingFlag: true.
	aSortCriteria addColumnName: #size ascendingFlag: false.
	aSortCriteria addColumnName: #length ascendingFlag: false.

	aSortedList := SortedCollection sortBlock: aSortCriteria.
	self addToList: aSortedList.

    ^aSortedList! !

!SortCriteriaTest class methodsFor: 'testing' stamp: 'pwl 7/16/1999 12:49'!
test2
	"SortCriteriaTest test2"

	| aSortedList aSortCriteria |
	aSortCriteria := SortCriteria new.
	aSortCriteria addColumnName: #code ascendingFlag: true.
	aSortCriteria addColumnName: #size ascendingFlag: true.
	aSortCriteria addColumnName: #length ascendingFlag: true.

	aSortedList := SortedCollection sortBlock: aSortCriteria.

	self addToList: aSortedList.

    ^aSortedList! !

!SortCriteriaTest class methodsFor: 'testing' stamp: 'pwl 7/16/1999 13:05'!
test3
	"SortCriteriaTest test3"

	| aSortedList aSortCriteria |
	aSortCriteria := SortCriteria new.
	aSortCriteria addColumnName: #length ascendingFlag: false.
	aSortCriteria addColumnName: #code ascendingFlag: true.
	aSortCriteria addColumnName: #size ascendingFlag: true.

	aSortedList := SortedCollection sortBlock: aSortCriteria.

	self addToList: aSortedList.

    ^aSortedList! !