twb 3.9.3 → 3.9.7

data/lib/twb/analysis/Sheets/sheetfiltersanalyzerA.rb

@@ -0,0 +1,81 @@
+#  WorksheetFields.rb Copyright (C) 2017, 2018  Chris Gerrard
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.  
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'twb'
+require 'csv'
+
+module Twb
+module Analysis
+
+  class SheetFiltersAnalyzerA
+
+    include TabTool
+
+    attr_accessor :localEmit
+
+    def initialize
+      init
+      @funcdoc     = {:class=>self.class, :blurb=>'Analyze Worksheet filters.', :description=>'Documents Quick Filters and the values they employ, if any. Work in progess.',}
+      #--
+      docFileName  = docFile('TWBWorksheetFiltersA.csv')
+      $sheetFieldsCSV  = CSV.open( docFileName  ,'w')
+      $sheetFieldsCSV  << ['Workbook','Worksheet','Filter Type','Operation','Data Source','Field','Value','Alias', 'Alias?']
+      addDocFile docFileName, "Workbooks, Worksheets and the sheets' Quick Filters"
+      #--
+      @sheetCount  = 0
+      @filterCount = 0
+    end
+
+    def metrics
+      {
+        '# of Worksheets'        => @sheetCount,
+        '# of Worksheet Filters' => @filterCount
+      }
+    end
+
+    def processTWB twb
+       @twb     = twb
+       @twbName = @twb.name
+       emit "   -- #{@twbName}"
+       @twbDomainsLoaded = false
+       parseFilters
+    end
+
+    def parseFilters
+      @worksheets  = @twb.worksheets
+      @worksheets.each do |sheet|
+        emit "\n\nSHEET: #{sheet.name}"
+        filters = sheet.filters
+        filters.each do |filter|
+          filter.emit "-----------------------------\nWORKSHEET:: #{sheet.name}\n-----------------------------"
+          if filter.values.empty?
+          # $sheetFieldsCSV  << ['Workbook','Worksheet','Filter Type','Operation'     ,'Data Source','Field','Value','Alias', 'Alias?']
+            $sheetFieldsCSV  << [@twbName  ,sheet.name, filter.type  ,filter.inexclude, filter.dataSource.uiname, filter.uiname,nil,nil,nil]
+          end
+          filter.values.each do |valueMap|
+            value  = valueMap[:value]
+            valias = valueMap[:alias]
+            same   = value.eql? valias
+            # puts "RECORDING FILTER VALUES:  %-25s  --  %-25s  same? %s " % [value,valias,same]
+            $sheetFieldsCSV  << [@twbName  ,sheet.name, filter.type  ,filter.inexclude, filter.dataSource.uiname, filter.uiname, value, valias, same]
+          end
+        end
+      end
+    end
+
+end # class SheetFiltersAnalyzerA
+
+end # module Twb
+end # module Analysis

data/lib/twb/calculatedfield.rb

@@ -18,7 +18,9 @@ require 'digest/md5'
 
 module Twb
 
-  class CalculatedField < TabClass
+  class CalculatedField
+
+    include TabTool
 
     attr_reader :dataSource
     attr_reader :node,        :properties

data/lib/twb/datasource.rb

@@ -13,13 +13,15 @@
 #  You should have received a copy of the GNU General Public License
 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-require 'nokogiri'
-require 'digest/md5'
+# require 'nokogiri'
+# require 'digest/md5'
 require 'json'
 
 module Twb
 
-  class DataSource < TabClass
+  class DataSource
+
+    include TabTool
   
     @@hasher = Digest::SHA256.new
 
@@ -53,6 +55,7 @@ module Twb
     attr_reader :aliases
     attr_reader :calculatedFields, :calculatedFieldNamesMap, :calculatedFieldNames, :calculatedField 
     attr_reader :allFields 
+    attr_reader :groups 
     attr_reader :filters
     attr_reader :node
 
@@ -222,6 +225,7 @@ module Twb
     def loadAliases
       @aliases   = {}
       # puts $node.xpath('.//column/aliases/..').length
+      cnt = 0
       @node.xpath('./column//aliases/..').each do |anode|
         # puts "anode:: #{anode}"
         # puts " path:: #{anode.path}"
@@ -252,6 +256,7 @@ module Twb
         end
         @aliases[name] = aliasMap
       end
+      emit "FIELD ALIASES: @aliases"
       return @aliases
     end
 
@@ -366,6 +371,10 @@ module Twb
         @fieldUINames[fld.name]   = fld.uiname
         @fieldUINames[fld.uiname] = fld.uiname
       end
+      groups.each do |fld|
+        @fieldUINames[fld.name]   = fld.uiname
+        @fieldUINames[fld.uiname] = fld.uiname
+      end
       return @fieldUINames
     end
 
@@ -463,6 +472,20 @@ module Twb
       end
     end
 
+    def groups
+      @groups ||= loadGroups
+    end
+
+    def loadGroups
+      @groups = []
+      groupNodes = @node.xpath('.//group')
+      groupNodes.each do |groupNode|
+        groupField = Twb::GroupField.new(groupNode)
+        @groups << groupField
+      end
+      return @groups
+    end
+
     def processFilters
       if @filters.nil?
         @filters = {}

data/lib/twb/groupfield.rb

@@ -0,0 +1,55 @@
+#  Copyright (C) 2018  Chris Gerrard
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'nokogiri'
+
+module Twb
+# module Data
+
+  class GroupField
+
+    include TabTool
+
+    attr_reader :node
+    attr_reader :name, :uiname, :caption
+
+    def initialize node
+      @node        = node
+      @caption     = @node['caption']
+      @name        = @node['name'].gsub(/^\[|\]$/,'')
+      @uiname      = @caption.nil? ? @name : @caption
+    end
+
+    def id
+        @id ||= @id = @name.hash
+    end
+
+    def properties
+      @properties ||= loadProperties
+    end
+
+    def loadProperties
+      @properties= {}
+      @node.attributes.each do |name,attr|
+        @properties[name] = attr.value
+      end
+      @properties[:uiname] = @name
+      return @properties
+    end
+
+  end # class GroupField
+
+# end # module Data
+end # module Twb

data/lib/twb/parameter.rb

@@ -0,0 +1,119 @@
+#  Copyright (C) 2018  Chris Gerrard
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'nokogiri'
+require 'digest/md5'
+
+module Twb
+
+  class Parameter
+
+    include TabTool
+
+    attr_reader :caption,       :name,     :uiname
+    attr_reader :dataType,      :format,   :dataTypeCustom
+    attr_reader :domainType,    :role,     :type
+    attr_reader :currentValue,  :values
+    attr_reader :node
+
+    def initialize(paramNode)
+        @node       = paramNode
+        # -- 
+        @name           = @node['name'].gsub(/^\[|\]$/,'')
+        @caption        = @node['caption']
+        @uiname         = caption.nil? ? nameTech : caption
+        @dataType       = @node['datatype']
+        @format         = @node['default-format'].nil?      ? '<<default>>' : @node['default-format']
+        @dataTypeCustom = @node['datatype-customized'].nil? ? false : true
+        @domainType     = @node['param-domain-type']
+        @role           = @node['role']
+        @type           = @node['type']
+        @currentValue   = paramNode.at_xpath('./calculation[@class="tableau"]')['formula'].gsub(/^[#"]|[#"]$/,'')
+        @values         = []
+        processNode
+    end
+
+    def to_s
+        "%s => %s" % [uiname, values]
+    end
+
+    private
+
+    def processNode
+        processMembers
+        processRange
+        processAll
+    end
+
+    def processMembers
+      #-- for when there are members, i.e. Lists
+      # <column caption='Date - List' datatype='date' datatype-customized='true' name='[Date - All 9/5/2018 Std Short Date (copy)]' param-domain-type='list' role='measure' type='quantitative' value='#2002-01-02#'>
+      #   <calculation class='tableau' formula='#2002-01-02#' />
+      #   <members>
+      #     <member value='#2002-01-02#' />
+      #     <member value='#2006-12-05#' />
+      #     <member value='#1999-11-01#' />
+      #   </members>
+      members    = @node.xpath('.//member')
+      @hasMembers = !members.empty? 
+      emit "# members: #{members.length}"
+      members.each do |m|
+        mvalue = m['value'].gsub(/^[#"]|[#"]$/,'')
+        malias = m['alias']
+        mvalui = malias.nil? ? mvalue : malias
+        @values << {:valueTech => mvalue, :alias => malias, :value => mvalui}
+
+      end
+    end
+
+    def processRange
+      # <column caption='Date - Range CV 3/3/2003 :  ...12/5/2006' datatype='date' datatype-customized='true' name='[Date - Range CV 8/29/2001 3/23/2000...12/5/2006 (copy)]' param-domain-type='range' role='measure' type='quantitative' value='#2003-03-03#'>
+      #   <calculation class='tableau' formula='#2003-03-03#' />
+      #   <range max='#2006-12-05#' />
+      #--
+      # <column caption='Integer List Range -73...2,109 SS1' datatype='integer' datatype-customized='true' name='[Integer List Primes (copy)]' param-domain-type='range' role='measure' type='quantitative' value='1'>
+      #   <calculation class='tableau' formula='1' />
+      #   <range max='2109' min='1' />
+      # </column>
+      #--
+      # <column caption='Date - Range CV 8/29/2001 3/23/2000...' datatype='date' datatype-customized='true' name='[Date - Range CV 8/29/2001 3/23/2000...12/5/2006 (copy 2)]' param-domain-type='range' role='measure' type='quantitative' value='#2001-09-29#'>
+      #   <calculation class='tableau' formula='#2001-09-29#' />
+      #   <range min='#2000-03-23#' />
+      # </column>
+      #--
+      # <column caption='Integer List Range -73...2,109 SS3' datatype='integer' datatype-customized='true' name='[Integer List Range -73...2,109 SS1 (copy)]' param-domain-type='range' role='measure' type='quantitative' value='1'>
+      #   <calculation class='tableau' formula='1' />
+      #   <range granularity='3' max='2109' min='1' />
+      # </column>
+      if 'range' == domainType
+        @hasRange = true
+        rangeNode = @node.at_xpath('./range')
+        min = rangeNode['min'].nil? ? nil : rangeNode['min'].gsub(/^[#"]|[#"]$/,'')
+        max = rangeNode['max'].nil? ? nil : rangeNode['max'].gsub(/^[#"]|[#"]$/,'')
+        range = "#{min}...#{max}"
+        @values << {:value => range}
+      end
+    end
+
+    def processAll
+      unless @hasMembers || @hasRange
+        @values << {:value => '<<All>>'}
+      end
+    end
+
+  end # class Parameter
+
+end # module Twb
+

data/lib/twb/quickfilter.rb

@@ -0,0 +1,442 @@
+#  Copyright (C) 2018  Chris Gerrard
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'nokogiri'
+require 'digest/md5'
+
+module Twb
+
+  class QuickFilter
+
+    include TabTool
+
+    attr_reader :field,     :name,      :uiname
+    attr_reader :type
+    attr_reader :dataSource
+    attr_reader :node,      :values
+    attr_reader :inexclude, :inexMode,  :includeNull
+
+    def initialize(node,twb)
+      init
+      emit "\nFILTER:\n#{node}\n====="
+      @node         = node
+      filterClass   = node['class']
+      @type         = filterClass.gsub('-',' ').capitalize
+      fieldCode     = node['column']
+      codedField    = Twb::CodedField.new(fieldCode) 
+      fieldTech     = codedField.name
+      inexclusions  = fieldTech =~ /^(Ex|In)clusions/
+      @measureNames = ':Measure Names' == fieldTech
+      srcTech       = codedField.dataSource
+      @dataSource   = twb.datasource(srcTech)
+      @dsAliases    = @dataSource.aliases
+      field         = @measureNames || inexclusions ? fieldTech : @dataSource.field(fieldTech)
+      uiname        = @dataSource.fieldUIName(fieldTech)
+      @uiname       = @measureNames || inexclusions ? fieldTech : uiname.nil? ? fieldTech : uiname
+      @field        = @uiname
+      @includeNull  = if @node['include-null'].nil? 
+                         true
+                      elsif 'false' == @node['include-null']
+                         false
+                      else
+                        true
+                      end
+      @values       = []
+      enode      = @node.at_xpath('.//*[@user:ui-enumeration]')
+      @inexclude = if enode.nil?
+                      'Include'
+                   else case enode['user:ui-enumeration']
+                          when 'inclusive' then 'Include'
+                          when 'exclusive' then 'Exclude'
+                          when  nil   then 'Include'
+                          when 'all'  then 'Include'
+                          else             'undefined'
+                        end 
+                   end
+      @inexMode  = enode.nil? ? 'Default' : 'Specified'
+      emit "\n::  FIELD  :: #{field} == #{@uiname}   --  #{fieldTech}  --  #{codedField.rawCode}"
+      emit "       filter class: #{filterClass}"
+      emit "         field code: #{fieldCode}"
+      emit "        coded field: #{codedField}"
+      emit "         field tech: #{fieldTech}"
+      emit "         field name: nil? #{@uiname.nil?}   #{@uiname}  "
+      emit "           src tech: #{srcTech}"
+      emit "       @measureNames: #{@measureNames}"
+      emit "                 ds: #{@dataSource.uiname}"
+      emit "              field: #{@uiname}"
+      emit "         @inexclude: #{@inexclude}"
+      emit " "
+      aaa = case filterClass
+        when 'relative-date' then resolveRelativeDate
+        when 'quantitative'  then resolveQuantitative
+        when 'categorical'   then resolveCategoricalValues
+      end
+    end
+
+    def to_s
+        "%s => %s" % [uiname, values]
+    end
+
+    private
+
+    def recordValue value, valias=nil
+      # puts "recordValue--: #{value} :: @'#{valias}'"
+      valias = value if valias.nil?
+      @values <<  {:value => value, :alias => valias}
+      # puts "recordValue--: done"
+    end
+
+
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-1' include-future='true' include-null='false' last-period='-1' period-type='day' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-1' include-future='true' include-null='false' last-period='-1' period-type='year' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-1' include-future='true' include-null='false' last-period='0' period-type='year' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-2' include-future='true' include-null='false' last-period='0' period-type='day' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-2' include-future='true' include-null='false' last-period='0' period-type='year' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-6' include-future='true' include-null='false' last-period='0' period-type='day' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='false' include-null='false' last-period='0' period-type='year' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='true' include-null='false' last-period='0' period-type='day' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='true' include-null='false' last-period='0' period-type='year' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='true' include-null='false' last-period='2' period-type='day' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='true' include-null='false' last-period='2' period-type='year' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='true' include-null='false' last-period='4' period-type='day' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='1' include-future='true' include-null='false' last-period='1' period-type='day' />
+    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='1' include-future='true' include-null='false' last-period='1' period-type='year' />
+    def resolveRelativeDate
+      emit "resolveRelativeDate"
+      periodType  = @node['period-type']
+      inclFuture  = @node['include-future'] == 'true'
+      firstPeriod = @node['first-period'].to_i
+      lastPeriod  = @node['last-period'].to_i
+      sum         = firstPeriod + lastPeriod
+      prod        = firstPeriod * lastPeriod
+      periodTech  = "#{periodType} : #{firstPeriod} -> #{lastPeriod}"
+      period      = periodTech
+      if sum == 0 && prod == 0
+        period = case periodType
+                   when 'day'  then "Today"
+                   else inclFuture ? "This #{periodType.capitalize}" : "#{periodType.capitalize} to date"
+                 end
+      elsif firstPeriod == lastPeriod
+         future = firstPeriod > 0
+         reln   = future ? 'Next' : 'Previous'
+         period = case periodType
+                    when 'day' then  future ? 'Tomorrow' : 'Yesterday' 
+                    else        "#{reln} #{periodType.capitalize}"
+                  end
+      else
+         span = lastPeriod - firstPeriod + 1
+         future = firstPeriod == 0 
+         reln   = future ? "Next" : "Last"
+         period = "#{reln} #{span} #{periodType.capitalize}s"
+      end
+      recordValue period, periodTech
+    end
+
+        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='in-range'>
+        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='in-range'>
+        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='in-range'>
+        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='all' />
+        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='non-null' />
+        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='null' />
+    def resolveQuantitative
+      emit "resolveQuantitative"
+      inclValues = @node['included-values']
+      qvalues = if 'in-range' == inclValues
+                   quantRangeValues
+                else
+                   "#{inclValues.capitalize} Values"
+                end
+      # recordValue qvalues, inclValues
+    end
+
+    def quantRangeValues
+      min  = @node.at_xpath('min')
+      max  = @node.at_xpath('max')
+      emit "min: nil? %-6s  val: %-s " % [min.nil?,min]
+      emit "max: nil? %-6s  val: %-s " % [max.nil?,max]
+      minrv  = parseRangeVal min unless min.nil?
+      maxrv  = parseRangeVal max unless max.nil?
+      mintxt = min.nil? ? '' : max.nil? ? "At least: #{minrv}" : "#{minrv}"
+      maxtxt = max.nil? ? '' : min.nil? ? "At most: #{maxrv}"  : ",...,#{maxrv}"
+      recordValue "#{mintxt}#{maxtxt}"
+      # emit   "#{mintxt}#{maxtxt}"
+      # return "#{mintxt} #{maxtxt}"
+    end
+
+    def parseRangeVal node
+      return 'nil' if node.nil?
+      text = node.text 
+      if text.start_with?('#') 
+        return text.gsub(/^[#]|[#]$/,'') 
+      end
+      num = text.to_f
+      # num.negative? ? num.floor : num.ceil
+      result = if num < 0
+                 num.floor
+               else
+                 num.ceil
+               end
+      return result
+    end   
+
+    # <filter class='categorical' column='[Sample - Superstore - English (Extract)].[none:Region:nk]'>
+    #   <groupfilter from='&quot;East&quot;' function='range' level='[none:Region:nk]' to='&quot;West&quot;' user:ui-domain='relevant' user:ui-enumeration='inclusive' user:ui-marker='enumerate' />
+    # </filter>
+    #--
+    def resolveCategoricalValues
+      emit "resolveCategoricalValues"
+      emit "@measureNames: #{@measureNames}"
+      if @node.element_children.empty?
+        # <filter class='categorical' column='[Sample - Superstore].[Top Customers by Profit (copy)]' />
+        recordValue 'All'
+        return
+      end
+      firstChild = @node.at_xpath('./groupfilter')
+      unless firstChild.nil?  # should not happen per 'if @node.element_children.empty?' above
+          function   = firstChild['function']
+          emit  "function  : #{function}"
+          emit  node.to_s
+          #-- single element filter
+          case function
+          when 'member'
+              member = firstChild['member']
+              value  = @measureNames ?  @dataSource.fieldUIName(Twb::CodedField.new(member).name) : member.gsub(/^"|"$/,'') 
+              recordValue value, @dataSource.deAlias(@uiname,value)
+          when 'empty-level'
+            recordValue 'None'
+          when 'range'
+              filtersFromRangeNode firstChild
+          when 'union'
+              emit "No resolving to do here. 'union' function accommodated with collection of members"
+          when 'except'
+              emit "UNRESOLVED function: #{function}"
+          when 'reorder-dimensionality'
+              emit "UNRESOLVED function: #{function}, involved with Inclusions & Exclusions - complicated to handle"
+          when 'level-members'
+              uiEnum = firstChild['user:ui-enumeration']
+              case uiEnum
+              when 'all'
+                recordValue 'All'
+              else
+                recordValue 'N/A'
+                emit "###### ALERT - Unresolved Quick filter ######"
+              end
+          else
+            recordValue "UNRESOLVED fn: #{function}"
+          end
+          # if 'member'.eql? function
+          #   emit  "HANDLING SINGLE MEMBER FILTER"
+          #   member = firstChild['member']
+          #   value  = @measureNames ?  @dataSource.fieldUIName(Twb::CodedField.new(member).name) : member.gsub(/^"|"$/,'') 
+          #   alia   = @dataSource.deAlias(@uiname,value)
+          #   emit  "value :%-25s =>  alias: %-s" % [value, alia]
+          #   recordValue value, alia
+          #   return
+          # end
+          # if 'empty-level' == function
+          #   recordValue 'None', 'None'
+          #   return
+          # end
+          # if 'range'.eql? function
+          #   emit  "HANDLING RANGE 1st Child FILTER"
+          #   # values = filtersFromRangeNode firstChild
+          #   filtersFromRangeNode firstChild
+          #   # values.each do |valMap|
+          #   #   recordValue valMap[:value], valMap[:alias]
+          #   # end
+          # end
+          #-- another single element filter
+          # <groupfilter function="level-members" level="[none:Business Line:nk]" user:ui-enumeration="all" user:ui-marker="enumerate"/>
+          # <filter class='categorical' column='[federated.1astm0q1hl2ydc1dyqhqq0igvxkp].[none:Business Line:nk]' context='true'>
+          #   <groupfilter function='level-members' 
+          #                level='[none:Business Line:nk]' 
+          #                user:ui-enumeration='all' 
+          #                user:ui-exclude='true' 
+          #                user:ui-marker='enumerate' />
+          # </filter>
+          # <filter class='categorical' column='[federated.1astm0q1hl2ydc1dyqhqq0igvxkp].[none:Business Line:nk]' context='true'>
+          #   <groupfilter function='level-members' 
+          #                level='[none:Business Line:nk]' 
+          #                user:ui-enumeration='all' 
+          #                user:ui-marker='enumerate' />
+          # </filter>
+          if 'level-members'.eql? function
+            emit  "HANDLING level-members FILTER"
+            #--
+            # <filter class='categorical' column='[Sample - Superstore].[Top Customers by Profit (copy)]'>
+            #   <groupfilter function='level-members' level='[Customer Name]' user:ui-enumeration='all' user:ui-marker='enumerate' />
+            # </filter>
+            #--
+            # <filter class='categorical' column='[Sample - Superstore].[none:Customer Name:nk]'>
+            #   <groupfilter function='level-members' level='[none:Customer Name:nk]' user:ui-enumeration='all' user:ui-marker='enumerate' />
+            # </filter>
+            #--
+            # <filter class='categorical' column='[Sample - Superstore].[Top Customers by Profit (copy)]'>
+            #   <groupfilter function='level-members' level='[Customer Name]' user:ui-enumeration='all' user:ui-exclude='true' user:ui-marker='enumerate' />
+            # </filter>
+            #--
+            # <filter class='categorical' column='[Sample - Superstore].[none:Customer Name:nk]'>
+            #   <groupfilter function='level-members' level='[none:Customer Name:nk]' user:ui-enumeration='all' user:ui-marker='enumerate' />
+            # </filter>
+            #--
+            # <filter class='categorical' column='[Sample - Superstore].[Top Customers by Profit (copy)]'>
+            #   <groupfilter function='except' user:ui-domain='relevant' user:ui-enumeration='exclusive' user:ui-marker='enumerate'>
+            #     <groupfilter function='level-members' level='[Customer Name]' />
+            #     <groupfilter function='union'>
+            #       <groupfilter function='member' level='[Customer Name]' member='&quot;Adrian Barton&quot;' />
+            #       <groupfilter function='member' level='[Customer Name]' member='&quot;Raymond Buch&quot;' />
+            #     </groupfilter>
+            #   </groupfilter>
+            # </filter>
+            #--
+            uiEnum = firstChild['user:ui-enumeration']
+            case uiEnum
+            when 'all'
+              recordValue 'All', 'All'
+            when 'inclusive'
+              @inexclude = 'Include'
+            when 'exclusive'
+              @inexclude = 'Exclude'
+            end
+          end
+          #-- otherwise filter contains multiple elements
+          #-- handle individual member elements
+          elements = firstChild.xpath('.//groupfilter')
+          elements.each do |element|
+            function = element.attribute('function').text
+            emit "element function: #{function}\n    node:\n#{element}"
+            if 'member'.eql? function
+              member = element.attribute('member').text
+              name   = @measureNames ? @dataSource.fieldUIName(Twb::CodedField.new(member).name) : member.gsub(/^"|"$/,'')
+              emit "%%%% member NAME:: #{name}"
+              if '%null%' == name then name = 'Null' end
+              alia  =  @dataSource.fieldAlias(@uiname,name) # $TableNameAliases[name]
+              recordValue name, alia
+            end
+            if 'range'.eql? function
+              emit "%%%% range element:: #{element}"
+              t = filtersFromRangeNode element
+              if t.empty?
+                fromAttr = element['from']
+                from     = fromAttr.nil? ? '' : fromAttr.gsub(/^[#"']|[#"']$/,'')
+                toAttr   = element['to']
+                to       = toAttr.nil?   ? '' : toAttr.gsub(/^[#"']|[#"']$/,'')
+                range = "#{from},...,#{to}"
+                recordValue range, range
+              end 
+              t.each do |name,alia|
+                # emit "%%%% range Name: %-20s   ALIAS: %-s " % [name, alia]
+                recordValue name, @dataSource.fieldAlias(@uiname,name)
+              end
+            end
+          end
+      end
+    end
+
+    def filtersFromRangeNode node
+      unless @twbDomainsLoaded
+        loadDomains 
+      end
+      # results = []
+      emit  "filtersFromRangeNode"
+      emit  "    from: #{node.attribute('from')}"
+      emit  "    to. : #{node.attribute('to')}"
+      from = node.attribute('from').text.gsub(/^"|"$/,'')
+      to   = node.attribute(  'to').text.gsub(/^"|"$/,'')
+      emit  "    from: #{from}"
+      emit  "    to. : #{to}"
+      if @twbDomainsLoaded
+        # results = filtersInRange from, to
+        filtersInRange from, to
+      else
+        range = "#{from},...,#{to}"
+        recordValue range, range
+      end
+      # return results
+    end
+
+    def filtersInRange from, to
+      emit  "filtersInRange"
+      # results   = {}
+      dsFields  = @twbFielddomains[@dataSource.uiname]
+      emit  "dsFields    : #{dsFields}"
+      if dsFields.nil? || dsFields.empty?
+          alert  "#### ALERT #### - '#{@uiname}' FIELD DOMAIN VALUES FOR '#{@twb.name} DATASOURCE #{@dataSource.uiname} NOT LOADED ####"
+          emit   @twbFieldDomains
+          emit   "==========="
+          emit   dsFields
+          emit   "==========="
+      else
+          fieldVals = dsFields[@uiname].to_a
+          if @dataSource.fieldHasAliases @uiname
+            #-- resolve aliases
+            dbValues = SortedSet.new
+            aliases  = @dataSource.fieldAliases @uiname
+            fieldVals.each do |fv|
+              fvAliased = aliases.has_value? fv
+              if fvAliased
+                dbValues <<  aliases.key(fv)
+              else 
+                dbValues <<  fv
+              end
+            end
+            $fieldVals = dbValues.to_a
+          else
+            #-- use domain values as returned
+            $fieldVals = dsFields[@uiname].to_a
+          end
+          # domainVals = dsFields[field].to_a
+          # #-- need to dealias (unalias?) the field domain values
+          # dbVals = SortedSet.new
+          # domainVals.each do |dv|
+          emit  "field values: #{$fieldVals}"
+          unless $fieldVals.nil? || $fieldVals.empty?
+              values = $fieldVals
+              f_i    = values.index from
+              t_i    = values.index to
+              emit  "      from: #{f_i} :: '#{from}'"
+              emit  "        to: #{t_i} :: '#{to}'"
+              badRange = f_i.nil? || t_i.nil?
+              emit "badRange: #{badRange}"
+              if badRange
+                emit  "BAD RANGE"
+              else
+                tnames  = values[f_i..t_i]
+                tnames.each do |tname|
+                  # results[tname] = @dataSource.deAlias(@uiname,tname) # $TableNameAliases[tname]
+                  recordValue tname, @dataSource.deAlias(@uiname,tname)
+                end
+                # emit  " filtersInRange  f:%-35s  t:%-s " % ["'#{from}:#{f_i}'", "'#{to}:#{t_i}'"]
+                # emit  "         names:  #{results.keys}"
+                # emit  "       aliases:  #{results.values}"
+              end
+          end
+      end
+      # return results
+    end
+
+    def loadDomains
+      emit  "def loadDomains\n=="
+      unless @twb.nil?
+        loader            = Twb::Util::FieldDomainLoader.new
+        @twbFielddomains  = loader.loadWorkbook @twb
+        emit  "FIELD DOMAINS:: #{@twbFielddomains}\n=="
+        @twbDomainsLoaded = true
+      end
+    end
+
+  end # class QuickFilter
+
+end # module Twb