mdarray-jcsv 0.6.3-java

data/lib/dimensions.rb

@@ -0,0 +1,276 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2015 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+class Jcsv
+
+  private
+  
+  ##########################################################################################
+  # Class Dimension keeps track of all data dimensions in a CSV file.  A data dimension is
+  # similar to a mathematical dimension such as x, y or z.  In principle, every data should
+  # be associates with only one set of data dimensions.  For example, let's say that our
+  # data has an employee ID, then column ID defines a dimension on the data, since every
+  # employee has a one ID and every ID is associated with only one employee.  As another
+  # example, let's say that we have data about a medical experiment that was done with a
+  # set of patients for 4 weeks, which were given either a medicine of a placebo.  The
+  # data could have columns labeled: "Patient Index", "Week", "Type of Medicine", "Blood
+  # Sample".  Some entries would be:
+  #
+  # "Patient Index"       "Week"        "Type of Medicine"      "Blood Sample"
+  #       1                 1               Placebo                 xxxx
+  #       1                 2               Placebo                 xxxx
+  #       2                 1               med1                    xxxx
+  #       2                 2               med1                    xxxx
+  #
+  # "Patient Index", "Week", "Type of Medice" are three dimensions of this data and taken
+  # together unequivocally define the data, i.e., those dimensions are similar to a DB key.
+  # Since this is a key, there should be no other line of data with the same values in
+  # the dimensions.
+  #
+  # CSV files are not ideal for maintaining dimensions, so, in order to read dimensions
+  # in a CSV file, there is the need for some rules.
+  ##########################################################################################
+  
+  class Dimension
+
+    attr_reader :name
+    attr_reader :frozen
+    attr_reader :current_value
+    attr_reader :next_value
+    attr_reader :labels
+    attr_accessor :index     # column index of this dimension in the csv file
+    
+    #------------------------------------------------------------------------------------
+    # dim_name is the dimension name.
+    #------------------------------------------------------------------------------------
+
+    def initialize(dim_name)
+      @name = dim_name
+      @frozen = false
+      @next_value = 0
+      @max_value = 0
+      @labels = Hash.new 
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def size
+      @labels.size
+    end
+
+    alias :length :size
+    
+    #------------------------------------------------------------------------------------
+    # Adds a new label to this dimension and keeps track of its index.  Labels are
+    # indexed starting at 0 and always incrementing.  All labels in the dimension are
+    # distinct. If trying to add a label that already exists, will:
+    # * add it if it is a new label and return its index;
+    # * return the index of an already existing label if the index is non-decreasing and
+    #   monotonically increasing or if it is back to 0.  That is, if the last returned
+    #   index is 5, then the next index is either 5 or 6 (new label), or 0.
+    # * If the last returned index is 0, then the dimension becomes frozen and no more
+    #   labels can be added to it.  After this point, add_label has to be called always
+    #   in the same order that it was called previously.
+    #------------------------------------------------------------------------------------
+
+    def add_label(label)
+      
+      if (@labels.has_key?(label))
+        # Just read one more line with the same label.  No problem, keep reading
+        if (@labels[label] == @current_value)
+          
+        elsif (@labels[label] == @next_value)
+          # Reading next label
+          @current_value = @next_value
+          @next_value = (@next_value + 1) % (@max_value + 1)
+        elsif (@labels[label] < @current_value && @labels[label] == 0)
+          # reached the last label and going back to the first one
+          reset
+          return true
+        else
+          # Label read is out of order.  Expected value is either 0 (starting over) or
+          # the next value.  Although we raise an exception, we allow the calling method
+          # to catch the exception and let the program still run.
+          expected_value = (@labels[label] < @current_value)? 0 : @next_value
+          reset if @labels[label] < @current_value
+          @current_value = @labels[label] + 1
+          @next_value = @current_value + 1
+          raise "Missing data: next expected label was '#{@labels.key(expected_value)}' but read '#{label}'."
+        end
+      else
+        @current_value = @labels[label] = @next_value
+        @next_value += 1
+        # Trying to add a label when the dimension is frozen raises an exception
+        raise "Dimension '#{@name}' is frozen when adding label '#{label}'." if frozen
+      end
+
+      false
+      
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def reset
+      if !@frozen
+        @frozen = true
+        @max_value = @current_value
+        @current_value = 0
+        @next_value = 1
+      end
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def index(label)
+      @labels[label]
+    end
+    
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def[](label)
+      index(label)
+    end
+        
+  end
+
+  ##########################################################################################
+  #
+  ##########################################################################################
+
+  class Dimensions
+
+    attr_reader :dimensions_names
+    attr_reader :dimensions
+    attr_reader :rank
+    
+    #------------------------------------------------------------------------------------
+    # dimensions is an array of column names that will be used as dimensions
+    #------------------------------------------------------------------------------------
+
+    def initialize(dimensions_names)
+
+      @dimensions_names = dimensions_names
+      @rank = @dimensions_names.size
+      @dimensions = Hash.new
+      
+      @dimensions_names.each do |dim_name|
+        @dimensions[dim_name] = Dimension.new(dim_name)
+      end
+
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def length(dim_name)
+      @dimensions[dim_name].labels.size
+    end
+
+    alias :size :length
+    
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def labels(dim_name)
+      @dimensions[dim_name].labels
+    end
+    
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def shape
+      
+      sh = Array.new
+      @dimensions_names.each do |dim_name|
+        sh << length(dim_name)
+      end
+      sh
+      
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def add_label(dim_name, label)
+
+      should_reset = @dimensions[dim_name].add_label(label)
+      @dimensions[dim_name].reset if should_reset
+      
+      (@dimensions_names.index(dim_name)...@dimensions_names.size).each do |i|
+        name = @dimensions_names[i]
+        @dimensions[name].reset
+      end if should_reset
+
+    end
+    
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def[]=(dim_name, label)
+      add_label(dim_name, label)
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def dimension(name)
+      @dimensions[name]
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def[](name)
+      @dimensions[name]
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def each
+      
+      @dimensions_names.each do |name|
+        yield @dimensions[name]
+      end
+      
+    end
+    
+  end
+
+end

data/lib/filters.rb

@@ -0,0 +1,332 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2015 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+require 'bigdecimal'
+require 'ipaddr'
+
+require_relative 'locale'
+
+class Jcsv
+
+  #========================================================================================
+  #
+  #========================================================================================
+
+  class Error < RuntimeError
+
+  end
+  
+  class FilterError < Jcsv::Error
+
+  end
+
+  class ConstraintViolation < Jcsv::Error
+
+  end
+
+  class MissingHeadersError < Jcsv::Error
+
+  end
+
+  class DuplicateKeyError < Jcsv::Error
+
+  end
+
+  #========================================================================================
+  #
+  #========================================================================================
+
+  module NextFilter
+
+    # This object's next filter
+    attr_accessor :next_filter
+    
+    # last_filter is a variable that points to the last filter in the sequence of
+    # filters.  It is necessary to build the linked list of filters
+    attr_accessor :last_filter
+
+    #---------------------------------------------------------------------------------------
+    # Method >> is used to link one filter to the next filter.  Basically we keep a linked
+    # list of filters.
+    #---------------------------------------------------------------------------------------
+   
+    def >>(next_filter)
+      if (@next_filter.nil?)
+        @next_filter = next_filter
+        # this check is necessary in the following case: a >> (b >> c) >> d.  In
+        # principle one has no reason to use parenthesis, but if done, then this check
+        # should make everything still work fine
+        @last_filter = (next_filter.last_filter.nil?)? @next_filter :
+                         @next_filter.last_filter
+      else
+        @last_filter.next_filter = next_filter
+        @last_filter = next_filter        
+      end
+      self
+    end
+    
+    #---------------------------------------------------------------------------------------
+    # Executes the next filter
+    #---------------------------------------------------------------------------------------
+
+    def exec_next(value, context)
+      @next_filter? @next_filter.execute(value, context) : value      
+    end
+    
+  end
+  
+  #========================================================================================
+  #
+  #========================================================================================
+
+  class Filter < org.supercsv.cellprocessor.CellProcessorAdaptor
+    include org.supercsv.cellprocessor.ift.LongCellProcessor
+    include org.supercsv.cellprocessor.ift.DoubleCellProcessor
+    include org.supercsv.cellprocessor.ift.StringCellProcessor
+    include NextFilter
+
+  end
+  
+  #========================================================================================
+  #
+  #========================================================================================
+
+  class RBParseBool < org.supercsv.cellprocessor.ParseBool
+    include NextFilter
+    
+    def initialize(true_values, false_values, ignore_case)
+      true_values = true_values.to_java(:string)
+      false_values = false_values.to_java(:string)
+      super(true_values, false_values, ignore_case)
+    end
+    
+    def execute(value, context)
+      begin
+        exec_next(super(value, context), context)
+      rescue org.supercsv.exception.SuperCsvCellProcessorException => e
+        raise FilterError.new("#{e.message} in:\n #{context}")
+      end
+      
+    end
+
+  end
+  
+  #========================================================================================
+  #
+  #========================================================================================
+
+  class RBConvertNilTo < Filter
+    attr_reader :value
+    
+    def initialize(value)
+      @value = value
+      super()
+    end
+    
+    def execute(value, context)
+      val = (value)? value : @value
+      exec_next(val, context)
+    end
+
+  end
+
+  #========================================================================================
+  #
+  #========================================================================================
+
+  class RBOptional < Filter
+        
+    def execute(value, context)
+      (value)? exec_next(value, context) : value      
+    end
+
+  end
+
+  #========================================================================================
+  #
+  #========================================================================================
+
+  class RBParseChar < org.supercsv.cellprocessor.ParseChar
+    include NextFilter
+
+    def initialize
+      super()
+    end
+
+    def execute(value, context)
+      begin
+        exec_next(super(value, context), context)
+      rescue org.supercsv.exception.SuperCsvCellProcessorException => e
+        raise FilterError.new("#{e.message} in:\n #{context}")
+      end
+    end
+    
+  end
+
+  #========================================================================================
+  #
+  #========================================================================================
+  
+  class RBCollector < Filter
+
+    attr_reader :collection
+    
+    def initialize
+      @collection = []
+      super()
+    end
+    
+    def execute(value, context)
+      validateInputNotNull(value, context)
+      @collection << value
+      exec_next(value, context)
+    end
+
+  end
+
+  #========================================================================================
+  #
+  #========================================================================================
+
+  class RBIPAddr < Filter
+
+    def execute(value, context)
+      validateInputNotNull(value, context)
+      value = IPAddr.new(value)
+      exec_next(value, context)
+    end
+    
+  end
+  
+  #========================================================================================
+  #
+  #========================================================================================
+
+  class RBDynamic < Filter
+
+    def initialize(block: nil)
+      @block = block
+      super()
+    end
+
+    def execute(value, context)
+      value = @block.call(value, context) if @block
+      exec_next(value, context)
+    end
+    
+  end
+  
+  #========================================================================================
+  #
+  #========================================================================================
+
+  class RBGsub < Filter
+    
+    def initialize(*args, block: nil)
+      @args = args
+      @block = block
+      super()
+    end
+
+    def execute(value, context)
+      value = (@block)? @block.call(value, *(@args)) : value.gsub(*(@args))
+      exec_next(value, context)
+    end
+    
+  end
+
+  #========================================================================================
+  #
+  #========================================================================================
+
+  class RBStringGeneric < Filter
+
+    def initialize(function, *args, block: nil)
+      @function = function
+      @args = args
+      @block = block
+      super()
+    end
+
+    def execute(value, context)
+      value = value.send(@function, *(@args), &(@block))
+      exec_next(value, context)
+    end
+    
+  end
+
+  #========================================================================================
+  #
+  #========================================================================================
+
+  def self.bool(true_values: ["true", "1", "y", "t"],
+                false_values: ["false", "n", "0", "f"],
+                ignore_case: true)
+    RBParseBool.new(true_values, false_values, ignore_case)
+  end
+
+  def self.convert_nil_to(value)
+    RBConvertNilTo.new(value)
+  end
+
+  def self.optional
+    RBOptional.new
+  end
+
+  def self.char
+    RBParseChar.new
+  end
+    
+  def self.collector
+    RBCollector.new
+  end
+
+  def self.ipaddr
+    RBIPAddr.new
+  end
+  
+  def self.dynamic(*args, &block)
+    RBDynamic.new(*args, block: block)
+  end
+
+  def self.gsub(*args, &block)
+    RBGsub.new(*args, block: block)
+  end
+  
+  def self.str(function, *args, &block)
+    RBStringGeneric.new(function, *args, block: block)
+  end
+  
+end
+
+require_relative 'date_filters'
+require_relative 'numeric_filters'
+require_relative 'constraints'
+
+
+=begin
+# class Java::OrgSupercsvCellprocessor::CellProcessorAdaptor
+class Java::OrgSupercsvCellprocessor::CellProcessorAdaptor
+  field_reader :next
+end
+=end