Class: HBase::Cell

Inherits:
Object
  • Object
show all
Defined in:
lib/hbase-jruby/cell.rb

Overview

@return [org.apache.hadoop.hbase.KeyValue]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key_value) ⇒ Cell

Creates a boxed object for a KeyValue object

Parameters:

  • key_value (org.apache.hadoop.hbase.KeyValue) 


10
11
12
13
 
# File 'lib/hbase-jruby/cell.rb', line 10

def initialize key_value
  @java = key_value
  @ck   = nil
end

Instance Attribute Details

#java ⇒ Object (readonly)

Returns the value of attribute java.



6
7
8
 
# File 'lib/hbase-jruby/cell.rb', line 6

def java
  @java
end

Instance Method Details

#<=>(other) ⇒ Fixnum

Implements column key order

Parameters:

Returns:

  • (Fixnum) —

    -1, 0, or 1



103
104
105
 
# File 'lib/hbase-jruby/cell.rb', line 103

def <=> other
  KeyValue.COMPARATOR.compare(@java, other.java)
end

#bigdecimal ⇒ BigDecimal

Returns the column value as a BigDecimal

Returns:

  • (BigDecimal) 


82
83
84
 
# File 'lib/hbase-jruby/cell.rb', line 82

def bigdecimal
  Util.from_bytes :bigdecimal, value
end

#boolean ⇒ true, false Also known as: bool

Returns the column value as a boolean value

Returns:

  • (true, false) 


95
96
97
 
# File 'lib/hbase-jruby/cell.rb', line 95

def boolean
  Util.from_bytes :boolean, value
end

#column_key ⇒ ColumnKey

Returns the ColumnKey object for the cell

Returns:



25
26
27
 
# File 'lib/hbase-jruby/cell.rb', line 25

def column_key
  @ck ||= ColumnKey.new @java.getFamily, @java.getQualifier
end

#family ⇒ String Also known as: cf

Returns the name of the column family of the cell

Returns:

  • (String) 


31
32
33
 
# File 'lib/hbase-jruby/cell.rb', line 31

def family
  String.from_java_bytes @java.getFamily
end

#fixnum ⇒ Fixnum Also known as: long

Returns the column value as a Fixnum

Returns:

  • (Fixnum) 


75
76
77
 
# File 'lib/hbase-jruby/cell.rb', line 75

def fixnum
  Util.from_bytes :fixnum, value
end

#float ⇒ Float Also known as: double

Returns the column value as a Float

Returns:

  • (Float) 


88
89
90
 
# File 'lib/hbase-jruby/cell.rb', line 88

def float
  Util.from_bytes :float, value
end

#inspect ⇒ String

Returns a printable version of this cell

Returns:

  • (String) 


109
110
111
 
# File 'lib/hbase-jruby/cell.rb', line 109

def inspect
  %[#{cf}:#{cq} = "#{string}"@#{ts}]
end

#qualifier(type = :string) ⇒ Object Also known as: cq

Returns the column qualifier of the cell

Parameters:

  • type (Symbol) (defaults to: :string) —

    The type of the qualifier. Can be one of :string, :symbol, :fixnum, :float, :short, :int, :bigdecimal, :boolean and :raw.

Returns:

  • (Object) 


40
41
42
 
# File 'lib/hbase-jruby/cell.rb', line 40

def qualifier type = :string
  Util.from_bytes type, @java.getQualifier
end

#rowkey(type = :string) ⇒ String, byte[]

Returns the rowkey of the cell decoded as the given type

Parameters:

  • type (Symbol) (defaults to: :string) —

    The type of the rowkey. Can be one of :string, :symbol, :fixnum, :float, :short, :int, :bigdecimal, :boolean and :raw.

Returns:

  • (String, byte[]) 


19
20
21
 
# File 'lib/hbase-jruby/cell.rb', line 19

def rowkey type = :string
  Util.from_bytes type, @java.getRow
end

#string ⇒ String Also known as: str

Returns the column value as a String

Returns:

  • (String) 


61
62
63
 
# File 'lib/hbase-jruby/cell.rb', line 61

def string
  Util.from_bytes :string, value
end

#symbol ⇒ Symbol Also known as: sym

Returns the column value as a Symbol

Returns:

  • (Symbol) 


68
69
70
 
# File 'lib/hbase-jruby/cell.rb', line 68

def symbol
  Util.from_bytes :symbol, value
end

#timestamp ⇒ Fixnum Also known as: ts

Returns the timestamp of the cell

Returns:

  • (Fixnum) 


47
48
49
 
# File 'lib/hbase-jruby/cell.rb', line 47

def timestamp
  @java.getTimestamp
end

#value ⇒ byte[] Also known as: raw

Returns the value of the cell as a Java byte array

Returns:

  • (byte[]) 


54
55
56
 
# File 'lib/hbase-jruby/cell.rb', line 54

def value
  @java.getValue
end