class TaskJuggler::PropertyList

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.

Attributes

propertySet[R]

query[RW]

scenarioIdx[R]

sortingCriteria[R]

sortingLevels[R]

sortingUp[R]

Public Class Methods

new(arg, copyItems = true) click to toggle source

A PropertyList is always bound to a certain PropertySet. All properties in the list must be of that set.

# File lib/taskjuggler/PropertyList.rb, line 36
def initialize(arg, copyItems = true)
  @items = copyItems ? arg.to_ary : []
  if arg.is_a?(PropertySet)
    # Create a PropertyList from the given PropertySet.
    @propertySet = arg
    # To keep the list sorted, we may have to access Property attributes.
    # Pre-scheduling, we can only use static attributes. Post-scheduling,
    # we can include dynamic attributes as well. This query template will
    # be used to query attributes when it has been set. Otherwise the list
    # can only be sorted by static attributes.
    @query = nil
    resetSorting
    addSortingCriteria('seqno', true, -1)
    sort!
  else
    # Create a PropertyList from a given other PropertyList.
    @propertySet = arg.propertySet
    @query = arg.query ? arg.query.dup : nil
    @sortingLevels = arg.sortingLevels
    @sortingCriteria = arg.sortingCriteria.dup
    @sortingUp = arg.sortingUp.dup
    @scenarioIdx = arg.scenarioIdx.dup
  end
end

Public Instance Methods

[](node) click to toggle source

# File lib/taskjuggler/PropertyList.rb, line 102
def [](node)
  @items.find { |n| n.ptn == node.ptn }
end

append(list) click to toggle source

Append another Array of PropertyTreeNodes or a PropertyList to this. The list will be sorted again.

# File lib/taskjuggler/PropertyList.rb, line 128
def append(list)
  if $DEBUG
    list.each do |node|
      unless node.propertySet == @propertySet
        raise "Fatal Error: All nodes must belong to the same PropertySet."
      end
    end
  end

  @items.concat(list)
  raise "Duplicate items" if @items != @items.uniq
  sort!
end

checkForDuplicates(sourceFileInfo) click to toggle source

Make sure that the list does not contain the same PropertyTreeNode more than once. This could happen for adopted tasks. If you use includeAdopted(), you should call this method after filtering to see if the filter was strict enough.

# File lib/taskjuggler/PropertyList.rb, line 82
def checkForDuplicates(sourceFileInfo)
  ptns = {}
  @items.each do |i|
    if ptns.include?(i.ptn)
      error('proplist_duplicate',
            "An adopted property is included as #{i.logicalId} and " +
            "as #{ptns[i.ptn].logicalId}. Please use stronger filtering " +
            'to avoid including the property more than once!',
            sourceFileInfo)
    end
    ptns[i.ptn] = i
  end
end

include?(node) click to toggle source

Specialized version of Array::include? that also matches adopted tasks.

# File lib/taskjuggler/PropertyList.rb, line 98
def include?(node)
  !@items.find { |p| p.ptn == node.ptn }.nil?
end

includeAdopted() click to toggle source

# File lib/taskjuggler/PropertyList.rb, line 68
def includeAdopted
  adopted = []
  @items.each do |p|
    p.adoptees.each do |ap|
      adopted += includeAdoptedR(ap, p)
    end
  end
  append(adopted)
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.

# File lib/taskjuggler/PropertyList.rb, line 191
def index
  i = 0
  @items.each do |p|
    p.force('index', i += 1)
  end
end

itemIndex(item) click to toggle source

Return the Array index of item or nil.

# File lib/taskjuggler/PropertyList.rb, line 185
def itemIndex(item)
  @items.index(item)
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.

# File lib/taskjuggler/PropertyList.rb, line 64
def method_missing(func, *args, &block)
  @items.method(func).call(*args, &block)
end

resetSorting() click to toggle source

Clear all sorting levels.

# File lib/taskjuggler/PropertyList.rb, line 119
def resetSorting
  @sortingLevels = 0
  @sortingCriteria = []
  @sortingUp = []
  @scenarioIdx = []
end

setSorting(modes) click to toggle source

Set all sorting levels as Array of triplets.

# File lib/taskjuggler/PropertyList.rb, line 111
def setSorting(modes)
  resetSorting
  modes.each do |mode|
    addSortingCriteria(*mode)
  end
end

sort!() click to toggle source

Sort the properties according to the currently defined sorting criteria.

# File lib/taskjuggler/PropertyList.rb, line 150
def sort!
  if treeMode?
    # Tree sorting is somewhat complex. It will be based on the 'tree'
    # attribute of the PropertyTreeNodes but we have to update them first
    # based on the other sorting criteria.

    # Remove the tree sorting mode first.
    sc = @sortingCriteria.delete_at(0)
    su = @sortingUp.delete_at(0)
    si = @scenarioIdx.delete_at(0)
    @sortingLevels -= 1

    # Sort the list based on the rest of the modes.
    sortInternal
    # The update the 'index' attributes of the PropertyTreeNodes.
    index
    # An then the 'tree' attributes.
    indexTree

    # Restore the 'tree' sorting mode again.
    @sortingCriteria.insert(0, sc)
    @sortingUp.insert(0, su)
    @scenarioIdx.insert(0, si)
    @sortingLevels += 1

    # Sort again, now based on the updated 'tree' attributes.
    sortInternal
  else
    sortInternal
  end
  # Update indexes.
  index
end

to_ary() click to toggle source

# File lib/taskjuggler/PropertyList.rb, line 106
def to_ary
  @items.dup
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.

# File lib/taskjuggler/PropertyList.rb, line 145
def treeMode?
  @sortingLevels > 0 && @sortingCriteria[0] == 'tree'
end