hbase-jruby 0.6.4-java → 0.7.0-java

data/lib/hbase-jruby/hbase.rb

@@ -5,12 +5,16 @@ require 'thread'
 # @author Junegunn Choi <junegunn.c@gmail.com>
 # @!attribute [r] config
 #   @return [org.apache.hadoop.conf.Configuration]
+# @!attribute [r] schema
+#   @return [HBase::Schema]
 class HBase
   attr_reader :config, :schema
 
   include Admin
   include HBase::Util
 
+  DEFAULT_COLUMN_CACHE_SIZE = 200
+
   # @overload HBase.log4j=(filename)
   #   Configure Log4j logging with the given file
   #   @param [String] filename Path to log4j.properties or log4j.xml file
@@ -24,41 +28,43 @@ class HBase
   #   @param [java.util.Properties] props Properties object
   #   @return [java.util.Properties]
   def self.log4j= arg
-    org.apache.log4j.PropertyConfigurator rescue nil
-    if defined?(org.apache.log4j.PropertyConfigurator)
-      if arg.is_a?(Hash)
-        props = java.util.Properties.new
-        arg.each do |k, v|
-          props.setProperty k.to_s, v.to_s
-        end
-        org.apache.log4j.PropertyConfigurator.configure props
-      else
-        case File.extname(arg).downcase
-        when '.xml'
-          org.apache.log4j.xml.DOMConfigurator.configure arg
-        else
-          org.apache.log4j.PropertyConfigurator.configure arg
-        end
+    if arg.is_a?(Hash)
+      props = java.util.Properties.new
+      arg.each do |k, v|
+        props.setProperty k.to_s, v.to_s
       end
+      org.apache.log4j.PropertyConfigurator.configure props
     else
-      @@log4j = arg
+      case File.extname(arg).downcase
+      when '.xml'
+        org.apache.log4j.xml.DOMConfigurator.configure arg
+      else
+        org.apache.log4j.PropertyConfigurator.configure arg
+      end
     end
   end
 
   # Connects to HBase
-  # @param [Hash] config A key-value pairs to build HBaseConfiguration from
+  # @overload initialize(zookeeper_quorum)
+  #   @param [String] zookeeper_quorum hbase.zookeeper.quorum
+  # @overload initialize(config)
+  #   @param [Hash] config A key-value pairs to build HBaseConfiguration from
   def initialize config = {}
     begin
       org.apache.hadoop.conf.Configuration
     rescue NameError
       raise NameError.new(
-        "Required Java classes not loaded. Set up CLASSPATH or try `HBase.resolve_dependency!`")
+        "Required Java classes not loaded. Set up CLASSPATH.`")
     end
 
     HBase.import_java_classes!
 
     @config =
       case config
+      when String
+        HBaseConfiguration.create.tap do |hbcfg|
+          hbcfg.set 'hbase.zookeeper.quorum', config
+        end
       when org.apache.hadoop.conf.Configuration
         config
       else
@@ -146,12 +152,19 @@ class HBase
   # Creates an HBase::Table instance for the specified name
   # @param [#to_s] table_name The name of the table
   # @param [Hash] opts Options
-  #   @option opts [Boolean] :cache Use thread-local cache (default: false)
+  #   @option opts [Fixnum] :column_cache The size of thread-local column-key
+  #   interpretation cache (default: 200)
   # @return [HBase::Table]
   def table table_name, opts = {}
     check_closed
 
-    ht = HBase::Table.send :new, self, @config, table_name, opts[:cache]
+    # Backward-compatibility (to be removed)
+    if opts.has_key?(:cache)
+      opts = { :column_cache => opts[:cache] ? DEFAULT_COLUMN_CACHE_SIZE : 0 }
+    end
+
+    ht = HBase::Table.send :new, self, @config,
+        table_name, opts.fetch(:column_cache, DEFAULT_COLUMN_CACHE_SIZE)
 
     if block_given?
       yield ht

data/lib/hbase-jruby/row.rb

@@ -130,7 +130,7 @@ class Row
   alias str string
 
   # Returns all versions of column values as Strings in a Hash indexed by their timestamps
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Hash<Fixnum, String>]
   def strings col
     decode_value :string, col, true
@@ -138,7 +138,7 @@ class Row
   alias strs strings
 
   # Returns the latest column value as a Symbol
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Symbol]
   def symbol col
     decode_value :symbol, col
@@ -146,7 +146,7 @@ class Row
   alias sym symbol
 
   # Returns all versions of column values as Symbols in a Hash indexed by their timestamps
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Hash<Fixnum, Symbol>]
   def symbols col
     decode_value :symbol, col, true
@@ -154,49 +154,49 @@ class Row
   alias syms symbols
 
   # Returns the latest 1-byte column value as a Fixnum
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Fixnum]
   def byte col
     decode_value :byte, col
   end
 
   # Returns all versions of 1-byte column values as Fixnums in a Hash indexed by their timestamps
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Hash<Fixnum, Fixnum>]
   def bytes col
     decode_value :byte, col, true
   end
 
   # Returns the latest 2-byte column value as a Fixnum
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Fixnum]
   def short col
     decode_value :short, col
   end
 
   # Returns all versions of 2-byte column values as Fixnums in a Hash indexed by their timestamps
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Hash<Fixnum, Fixnum>]
   def shorts col
     decode_value :short, col, true
   end
 
   # Returns the latest 4-byte column value as a Fixnum
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Fixnum]
   def int col
     decode_value :int, col
   end
 
   # Returns all versions of 4-byte column values as Fixnums in a Hash indexed by their timestamps
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Hash<Fixnum, Fixnum>]
   def ints col
     decode_value :int, col, true
   end
 
   # Returns the latest 8-byte column value as a Fixnum
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Fixnum]
   def fixnum col
     decode_value :fixnum, col
@@ -204,7 +204,7 @@ class Row
   alias long fixnum
 
   # Returns all versions of 8-byte column values as Fixnums in a Hash indexed by their timestamps
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Hash<Fixnum, Fixnum>]
   def fixnums col
     decode_value :fixnum, col, true
@@ -212,37 +212,49 @@ class Row
   alias longs fixnums
 
   # Returns the latest column value as a BigDecimal
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [BigDecimal]
   def bigdecimal col
     decode_value :bigdecimal, col
   end
 
   # Returns all versions of column values as BigDecimals in a Hash indexed by their timestamps
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Hash<Fixnum, BigDecimal>]
   def bigdecimals col
     decode_value :bigdecimal, col, true
   end
 
-  # Returns the latest column value as a Float
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # Returns the latest 4-byte column value as a Float
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Float]
   def float col
     decode_value :float, col
   end
-  alias double float
 
-  # Returns all versions of column values as Floats in a Hash indexed by their timestamps
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # Returns all versions of 4-byte column values as Floats in a Hash indexed by their timestamps
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Hash<Fixnum, Float>]
   def floats col
     decode_value :float, col, true
   end
-  alias doubles floats
+
+  # Returns the latest 8-byte column value as a Float
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
+  # @return [Float]
+  def double col
+    decode_value :double, col
+  end
+
+  # Returns all versions of 8-byte column values as Floats in a Hash indexed by their timestamps
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
+  # @return [Hash<Fixnum, Float>]
+  def doubles col
+    decode_value :double, col, true
+  end
 
   # Returns the latest column value as a boolean value
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [true, false]
   def boolean col
     decode_value :boolean, col
@@ -250,7 +262,7 @@ class Row
   alias bool boolean
 
   # Returns all versions of column values as boolean values in a Hash indexed by their timestamps
-  # @param [String, Array] column Column name as String or 2-element Array of family and qualifier
+  # @param [String, Array] col Column name as String or 2-element Array of family and qualifier
   # @return [Hash<Fixnum, true|false>]
   def booleans col
     decode_value :boolean, col, true
@@ -262,6 +274,10 @@ class Row
     Bytes.compareTo(rowkey(:raw), other.rowkey(:raw))
   end
 
+  def inspect
+    "#<HBase::Row:#{object_id} table=#{@table.name} rowkey=#{Bytes.toStringBinary @result.getRow}>"
+  end
+
 private
   def get_value col, with_versions = false
     cf, cq, _ = @table.lookup_and_parse col, true

data/lib/hbase-jruby/schema.rb

@@ -67,8 +67,10 @@ class Schema
     end
 
     table = table.to_sym
-    @lookup[table] = lookup
-    @schema[table] = definition
+    @lookup = @lookup.dup.tap { |h| h[table] = lookup }
+    @schema = @schema.dup.tap { |h| h[table] = definition }
+
+    definition
   end
 
   # @private
@@ -103,8 +105,8 @@ class Schema
   # @param [Symbol] table
   def delete table
     table = table.to_sym
-    @lookup.delete table
-    @schema.delete table
+    @lookup = @lookup.reject { |k, v| k == table }
+    @schema = @schema.reject { |k, v| k == table }
     nil
   end
 

data/lib/hbase-jruby/scoped.rb

@@ -27,9 +27,9 @@ class Scoped
                 :cache_blocks => true }.merge(options)
 
     scan = block_given? ? filtered_scan : filtered_scan_minimum
-    scan.cache_blocks = options[:cache_blocks]
+    scan.setCacheBlocks options[:cache_blocks]
     if options[:caching] && (@limit.nil? || options[:caching] < @limit)
-      scan.caching = options[:caching]
+      scan.setCaching options[:caching]
     end
 
     cnt = 0
@@ -524,7 +524,7 @@ private
       end if range
 
       # Caching
-      scan.caching = @caching if @caching
+      scan.setCaching @caching if @caching
 
       # Filters (with projection)
       prefix_filter = [*build_prefix_filter].compact
@@ -536,7 +536,7 @@ private
       # Limit
       if @limit
         if [@caching, @dcaching].compact.all? { |c| @limit < c }
-          scan.caching = @limit
+          scan.setCaching @limit
         end
       end
 

data/lib/hbase-jruby/table/admin.rb

@@ -99,7 +99,7 @@ class Table
   #     :max_filesize       => 512 * 1024 ** 2,
   #     :memstore_flushsize =>  64 * 1024 ** 2,
   #     :readonly           => false,
-  #     :deferred_log_flush => true
+  #     :durability         => :async_wal
   #   )
   def alter! props, &block
     _alter props, true, &block
@@ -313,52 +313,53 @@ private
 
   MAX_SPLIT_WAIT = 30
 
-  def while_disabled admin
-    begin
-      admin.disableTable @name if admin.isTableEnabled(@name)
-      yield
-    ensure
-      admin.enableTable @name
-    end
+  def hcd obj, opts
+    hcd =
+      case obj
+      when HColumnDescriptor
+        obj
+      else
+        HColumnDescriptor.new(obj.to_s)
+      end
+    patch_column_descriptor!(hcd, opts)
   end
 
-  def hcd name, opts
-    HColumnDescriptor.new(name.to_s).tap do |hcd|
-      opts.each do |key, val|
-        if key == :config
-          val.each do |k, v|
-            hcd.setConfiguration k, v.to_s
-          end
-        elsif method = COLUMN_PROPERTIES[key] && COLUMN_PROPERTIES[key][:set]
-          hcd.send method,
-            ({
-              :bloomfilter => proc { |v|
-                enum =
-                  if defined?(org.apache.hadoop.hbase.regionserver.StoreFile::BloomType)
-                    org.apache.hadoop.hbase.regionserver.StoreFile::BloomType
-                  else
-                    # 0.95 or later
-                    org.apache.hadoop.hbase.regionserver.BloomType
-                  end
-                const_shortcut enum, v, "Invalid bloom filter type"
-              },
-              :compression => proc { |v|
-                const_shortcut Compression::Algorithm, v, "Invalid compression algorithm"
-              },
-              :compression_compact => proc { |v|
-                const_shortcut Compression::Algorithm, v, "Invalid compression algorithm"
-              },
-              :data_block_encoding => proc { |v|
-                const_shortcut org.apache.hadoop.hbase.io.encoding.DataBlockEncoding, v, "Invalid data block encoding algorithm"
-              }
-            }[key] || proc { |a| a }).call(val)
-        elsif key.is_a?(String)
-          hcd.setValue key, val.to_s
-        else
-          raise ArgumentError, "Invalid property: #{key}"
+  def patch_column_descriptor! hcd, opts
+    opts.each do |key, val|
+      if key == :config
+        val.each do |k, v|
+          hcd.setConfiguration k, v.to_s
         end
-      end#opts
-    end
+      elsif method = COLUMN_PROPERTIES[key] && COLUMN_PROPERTIES[key][:set]
+        hcd.send method,
+          ({
+            :bloomfilter => proc { |v|
+              enum =
+                if defined?(org.apache.hadoop.hbase.regionserver.StoreFile::BloomType)
+                  org.apache.hadoop.hbase.regionserver.StoreFile::BloomType
+                else
+                  # 0.95 or later
+                  org.apache.hadoop.hbase.regionserver.BloomType
+                end
+              const_shortcut enum, v, "Invalid bloom filter type"
+            },
+            :compression => proc { |v|
+              const_shortcut Compression::Algorithm, v, "Invalid compression algorithm"
+            },
+            :compression_compact => proc { |v|
+              const_shortcut Compression::Algorithm, v, "Invalid compression algorithm"
+            },
+            :data_block_encoding => proc { |v|
+              const_shortcut org.apache.hadoop.hbase.io.encoding.DataBlockEncoding, v, "Invalid data block encoding algorithm"
+            }
+          }[key] || proc { |a| a }).call(val)
+      elsif key.is_a?(String)
+        hcd.setValue key, val.to_s
+      else
+        raise ArgumentError, "Invalid property: #{key}"
+      end
+    end#opts
+    hcd
   end
 
   def self.const_shortcut base, v, message
@@ -406,69 +407,58 @@ private
     with_admin do |admin|
       htd = admin.get_table_descriptor(@name.to_java_bytes)
       patch_table_descriptor! htd, props
-      while_disabled(admin) do
-        admin.modifyTable @name.to_java_bytes, htd
-        wait_async_admin(admin, &block) if bang
-      end
+      admin.modifyTable @name.to_java_bytes, htd
+      wait_async_admin(admin, &block) if bang
     end
   end
 
   def _add_family name, opts, bang, &block
     with_admin do |admin|
-      while_disabled(admin) do
-        admin.addColumn @name, hcd(name.to_s, opts)
-        wait_async_admin(admin, &block) if bang
-      end
+      admin.addColumn @name, hcd(name.to_s, opts)
+      wait_async_admin(admin, &block) if bang
     end
   end
 
   def _alter_family name, opts, bang, &block
     with_admin do |admin|
-      while_disabled(admin) do
-        admin.modifyColumn @name, hcd(name.to_s, opts)
-        wait_async_admin(admin, &block) if bang
-      end
+      htd = admin.get_table_descriptor(@name.to_java_bytes)
+      hcd = htd.getFamily(name.to_s.to_java_bytes)
+      admin.modifyColumn @name, hcd(hcd, opts)
+      wait_async_admin(admin, &block) if bang
     end
   end
 
   def _delete_family name, bang, &block
     with_admin do |admin|
-      while_disabled(admin) do
-        admin.deleteColumn @name, name.to_s
-        wait_async_admin(admin, &block) if bang
-      end
+      admin.deleteColumn @name, name.to_s
+      wait_async_admin(admin, &block) if bang
     end
   end
 
   def _add_coprocessor class_name, props, bang, &block
     with_admin do |admin|
-      while_disabled(admin) do
-
-        htd = admin.get_table_descriptor(@name.to_java_bytes)
-        if props.empty?
-          htd.addCoprocessor class_name
-        else
-          path, priority, params = props.values_at :path, :priority, :params
-          raise ArgumentError, ":path required" unless path
-          params = params ? Hash[ params.map { |k, v| [k.to_s, v.to_s] } ] : {}
-          htd.addCoprocessor class_name,
-            org.apache.hadoop.fs.Path.new(path),
-            priority || org.apache.hadoop.hbase.Coprocessor::PRIORITY_USER, params
-        end
-        admin.modifyTable @name.to_java_bytes, htd
-        wait_async_admin(admin, &block) if bang
+      htd = admin.get_table_descriptor(@name.to_java_bytes)
+      if props.empty?
+        htd.addCoprocessor class_name
+      else
+        path, priority, params = props.values_at :path, :priority, :params
+        raise ArgumentError, ":path required" unless path
+        params = params ? Hash[ params.map { |k, v| [k.to_s, v.to_s] } ] : {}
+        htd.addCoprocessor class_name,
+          org.apache.hadoop.fs.Path.new(path),
+          priority || org.apache.hadoop.hbase.Coprocessor::PRIORITY_USER, params
       end
+      admin.modifyTable @name.to_java_bytes, htd
+      wait_async_admin(admin, &block) if bang
     end
   end
 
   def _remove_coprocessor name, bang, &block
     with_admin do |admin|
-      while_disabled(admin) do
-        htd = admin.get_table_descriptor(@name.to_java_bytes)
-        htd.removeCoprocessor name
-        admin.modifyTable @name.to_java_bytes, htd
-        wait_async_admin(admin, &block) if bang
-      end
+      htd = admin.get_table_descriptor(@name.to_java_bytes)
+      htd.removeCoprocessor name
+      admin.modifyTable @name.to_java_bytes, htd
+      wait_async_admin(admin, &block) if bang
     end
   end
 

data/lib/hbase-jruby/table/checked_operation.rb

@@ -16,7 +16,7 @@ class Table
         @rowkey, @cf, @cq, @val, @mutation.put(@rowkey, props))
     end
 
-    # @param [Object] *extra Optional delete specification. Column family, qualifier, and timestamps
+    # @param [Object*] extra Optional delete specification. Column family, qualifier, and timestamps
     def delete *extra
       @table.htable.checkAndDelete(
         @rowkey, @cf, @cq, @val, @mutation.delete(@rowkey, *extra))

data/lib/hbase-jruby/table/inspection.rb

@@ -95,6 +95,7 @@ private
         end
         r[:meta]      = ri.is_meta_region
         r[:online]    = !ri.is_offline
+        r[:encoded_name] = ri.encoded_name
       }
     }
   end

data/lib/hbase-jruby/table.rb

@@ -308,6 +308,7 @@ class Table
     @hbase.schema.lookup @name_sym, col
   end
 
+  # Schema lookup without column-key caching
   # @private
   def lookup_and_parse col, expect_cq
     @hbase.schema.lookup_and_parse @name_sym, col, expect_cq
@@ -315,21 +316,36 @@ class Table
 
   # @private
   module ThreadLocalCache
+    # Schema lookup with column-key caching
     def lookup_and_parse col, expect_cq
-      thread_local(@hbase, @name_sym, :columns)[col] ||=
-          @hbase.schema.lookup_and_parse(@name_sym, col, expect_cq)
+      cache = thread_local(@hbase, @name_sym, :columns)
+
+      # Column-key cache invalidation
+      schema = @hbase.schema
+      if schema.to_h.object_id != @schema_h.object_id
+        @schema_h = schema.to_h
+        cache.clear
+      end
+
+      unless parsed = cache[col]
+        parsed = schema.lookup_and_parse(@name_sym, col, expect_cq)
+        cache[col] = parsed if cache.length < @cache_size
+      end
+      parsed
     end
   end
 
 private
-  def initialize hbase, config, name, cache
+  def initialize hbase, config, name, cache_size
     @hbase    = hbase
+    @schema_h = hbase.schema.to_h
     @config   = config
     @name     = name.to_s
     @name_sym = name.to_sym
     @mutation = Mutation.new(self)
+    @cache_size = cache_size
 
-    extend ThreadLocalCache if cache
+    extend ThreadLocalCache if cache_size > 0
   end
 
   def check_closed

data/lib/hbase-jruby/util.rb

@@ -14,7 +14,7 @@ module Util
     # @param [byte[]] v
     # @return [byte[]]
     def to_bytes v
-      import_java_classes!
+      HBase.import_java_classes!
 
       case v
       when Array
@@ -42,7 +42,7 @@ module Util
         raise ArgumentError, "Unknown value format" unless len == 1
 
         val = v.values.first
-        raise ArgumentError, "Unknown value format" unless val.is_a?(Fixnum)
+        raise ArgumentError, "Unknown value format" unless val.is_a?(Numeric)
 
         case v.keys.first
         when :byte
@@ -53,6 +53,10 @@ module Util
           Bytes.java_send :toBytes, [Java::short], val
         when :long, :fixnum
           Bytes.java_send :toBytes, [Java::long], val
+        when :float
+          Bytes.java_send :toBytes, [Java::float], val
+        when :double
+          Bytes.java_send :toBytes, [Java::double], val
         else
           raise ArgumentError, "Invalid value format"
         end
@@ -69,7 +73,7 @@ module Util
       return nil               if val.nil?
       return Util.to_bytes val if type.nil?
 
-      import_java_classes!
+      HBase.import_java_classes!
       case type
       when :string, :str, :symbol, :sym
         val.to_s.to_java_bytes
@@ -83,7 +87,9 @@ module Util
         Bytes.java_send :toBytes, [Java::short], val
       when :long, :fixnum
         Bytes.java_send :toBytes, [Java::long], val
-      when :float, :double
+      when :float
+        Bytes.java_send :toBytes, [Java::float], val
+      when :double
         Bytes.java_send :toBytes, [Java::double], val
       when :bigdecimal
         case val
@@ -108,7 +114,7 @@ module Util
     def from_bytes type, val
       return nil if val.nil?
 
-      import_java_classes!
+      HBase.import_java_classes!
       case type
       when :string, :str
         Bytes.to_string val
@@ -124,7 +130,9 @@ module Util
         Bytes.to_string(val).to_sym
       when :bigdecimal
         BigDecimal.new(Bytes.to_big_decimal(val).to_s)
-      when :float, :double
+      when :float
+        Bytes.to_float val
+      when :double
         Bytes.to_double val
       when :boolean, :bool
         Bytes.to_boolean val
@@ -169,17 +177,6 @@ module Util
         return cf, cq
       end
     end
-
-  private
-    def import_java_classes!
-      HBase.import_java_classes!
-      if defined?(ByteBuffer) && defined?(KeyValue) && defined?(Bytes)
-        self.instance_eval do
-          def import_java_classes!
-          end
-        end
-      end
-    end
   end
 
 private