The PropertyList is a utility class that
can be used to hold a list of properties. It’s derived from an Array,
so it can hold the properties in a well defined order. The order can be
determined by an arbitrary number of sorting levels. A sorting level
specifies an attribute who’s value should be used for sorting, a
scenario index if necessary and the sorting direction (up/down). All nodes
in the PropertyList must belong to the same
PropertySet.
addSortingCriteria(criteria, up, scIdx)
click to toggle source
Append a new sorting level to the existing levels.
98: def addSortingCriteria(criteria, up, scIdx)
99: unless @propertySet.knownAttribute?(criteria) ||
100: @propertySet.hasQuery?(criteria, scIdx)
101: raise TjException.new, "Unknown attribute #{criteria} used for " +
102: 'sorting criterium'
103: end
104: if scIdx == 1
105: if @propertySet.scenarioSpecific?(criteria)
106: raise TjException.new, "Attribute #{criteria} is scenario specific." +
107: "You must specify a scenario id."
108: end
109: else
110: if @propertySet.project.scenario(scIdx).nil?
111: raise TjException.new, "Unknown scenario index #{scIdx} used."
112: end
113: if !@propertySet.scenarioSpecific?(criteria)
114: raise TjException.new, "Attribute #{criteria} is not scenario " +
115: "specific"
116: end
117: end
118: @sortingCriteria.push(criteria)
119: @sortingUp.push(up)
120: @scenarioIdx.push(scIdx)
121: @sortingLevels += 1
122: end
append(list)
click to toggle source
Append another Array of PropertyTreeNodes or a PropertyList to this. The list will be sorted
again.
84: def append(list)
85: if $DEBUG
86: list.each do |node|
87: unless node.propertySet == @propertySet
88: raise "Fatal Error: All nodes must belong to the same PropertySet."
89: end
90: end
91: end
92:
93: @items.concat(list)
94: sort!
95: end
index()
click to toggle source
This function sets the index attribute of all the properties in the list.
The index starts with 0 and increases for each property.
173: def index
174: i = 0
175: @items.each do |p|
176: p.set('index', i += 1)
177: end
178: end
itemIndex(item)
click to toggle source
Return the Array index of item or nil.
167: def itemIndex(item)
168: @items.index(item)
169: end
method_missing(func, *args, &block)
click to toggle source
This class should be a derived class of Array. But since it re-defines
sort!() and still needs to call Array::sort!() I took a different route.
All missing methods will be propagated to the @items Array.
58: def method_missing(func, *args, &block)
59: @items.method(func).call(*args, &block)
60: end
resetSorting()
click to toggle source
Clear all sorting levels.
75: def resetSorting
76: @sortingLevels = 0
77: @sortingCriteria = []
78: @sortingUp = []
79: @scenarioIdx = []
80: end
setSorting(modes)
click to toggle source
Set all sorting levels as Array of triplets.
67: def setSorting(modes)
68: resetSorting
69: modes.each do |mode|
70: addSortingCriteria(*mode)
71: end
72: end
sort!()
click to toggle source
Sort the properties according to the currently defined sorting criteria.
132: def sort!
133: if treeMode?
134:
135:
136:
137:
138:
139: sc = @sortingCriteria.delete_at(0)
140: su = @sortingUp.delete_at(0)
141: si = @scenarioIdx.delete_at(0)
142: @sortingLevels -= 1
143:
144:
145: sortInternal
146:
147: index
148:
149: indexTree
150:
151:
152: @sortingCriteria.insert(0, sc)
153: @sortingUp.insert(0, su)
154: @scenarioIdx.insert(0, si)
155: @sortingLevels += 1
156:
157:
158: sortInternal
159: else
160: sortInternal
161: end
162:
163: index
164: end
to_ary()
click to toggle source
62: def to_ary
63: @items.dup
64: end
treeMode?()
click to toggle source
If the first sorting level is ‘tree’ the breakdown structure of
the list is preserved. This is a somewhat special mode and this function
returns true if the mode is set.
127: def treeMode?
128: @sortingLevels > 0 && @sortingCriteria[0] == 'tree'
129: end
![[+]](../images/find.png "show/hide quicksearch")