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(table, key_value) ⇒ Cell

Creates a boxed object for a KeyValue object

Parameters:

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

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

def initialize table, key_value
  @table = table
  @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


126
127
128
129
130
 
# File 'lib/hbase-jruby/cell.rb', line 126

def <=> other
  (@comparator ||=
    KeyValue.const_defined?(:COMPARATOR) ?
      KeyValue::COMPARATOR : KeyValue.COMPARATOR).compare(@java, other.java)
end

#bigdecimal ⇒ BigDecimal

Returns the column value as a BigDecimal

Returns:

  • (BigDecimal) 

100
101
102
 
# File 'lib/hbase-jruby/cell.rb', line 100

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) 

118
119
120
 
# File 'lib/hbase-jruby/cell.rb', line 118

def boolean
  Util.from_bytes :boolean, value
end

#byte ⇒ Fixnum

Returns the 1-byte column value as a Fixnum

Returns:

  • (Fixnum) 

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

def byte
  Util.from_bytes :byte, value
end

#double ⇒ Float

Returns the 8-byte column value as a Float

Returns:

  • (Float) 

112
113
114
 
# File 'lib/hbase-jruby/cell.rb', line 112

def double
  Util.from_bytes :double, value
end

#eql?(other) ⇒ Boolean Also known as: ==

Checks if the cells are the same

Parameters:

Returns:

  • (Boolean) 

134
135
136
 
# File 'lib/hbase-jruby/cell.rb', line 134

def eql? other
  (self <=> other) == 0
end

#family ⇒ String Also known as: cf

Returns the name of the column family of the cell

Returns:

  • (String) 

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

def family
  String.from_java_bytes @java.getFamily
end

#fixnum ⇒ Fixnum Also known as: long

Returns the 8-byte 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

Returns the 4-byte column value as a Float

Returns:

  • (Float) 

106
107
108
 
# File 'lib/hbase-jruby/cell.rb', line 106

def float
  Util.from_bytes :float, value
end

#hash ⇒ Object 


139
140
141
 
# File 'lib/hbase-jruby/cell.rb', line 139

def hash
  @java.hasCode
end

#inspect ⇒ String

Returns a printable version of this cell

Returns:

  • (String) 

145
146
147
 
# File 'lib/hbase-jruby/cell.rb', line 145

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

#int ⇒ Fixnum

Returns the 4-byte column value as a Fixnum

Returns:

  • (Fixnum) 

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

def int
  Util.from_bytes :int, value
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) 

35
36
37
 
# File 'lib/hbase-jruby/cell.rb', line 35

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

#raw ⇒ byte[]

Returns the value of the cell as a Java byte array

Returns:


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

def raw
  @java.getValue
end

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

Returns the rowkey of the cell decoded as the given type

Parameters:

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

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

Returns:


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

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

#short ⇒ Fixnum

Returns the 2-byte column value as a Fixnum

Returns:

  • (Fixnum) 

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

def short
  Util.from_bytes :short, value
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) 

42
43
44
 
# File 'lib/hbase-jruby/cell.rb', line 42

def timestamp
  @java.getTimestamp
end

#value ⇒ Object

Returns the value of the cell. If the column in not defined in the schema, returns Java byte array.


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

def value
  _, _, type = @table.lookup_schema(cq)
  Util.from_bytes(type, raw)
end