Constructor Detail

• KeyValueUtil

  public KeyValueUtil()

Method Detail

• length

  public static int length(Cell cell)

  Returns number of bytes this cell would have been used if serialized as in KeyValue

  Parameters:

  cell -

  Returns:

  the length

• keyLength

  public static int keyLength(Cell cell)

  Returns number of bytes this cell's key part would have been used if serialized as in KeyValue. Key includes rowkey, family, qualifier, timestamp and type.

  Parameters:

  cell -

  Returns:

  the key length

• lengthWithMvccVersion

  public static int lengthWithMvccVersion(KeyValue kv,
                          boolean includeMvccVersion)

• totalLengthWithMvccVersion

  public static int totalLengthWithMvccVersion(Iterable<? extends KeyValue> kvs,
                               boolean includeMvccVersion)

• copyToNewKeyValue

  public static KeyValue copyToNewKeyValue(Cell cell)

  copy key only

• copyKeyToNewByteBuffer

  public static ByteBuffer copyKeyToNewByteBuffer(Cell cell)

  The position will be set to the beginning of the new ByteBuffer

  Parameters:

  cell -

  Returns:

  the Bytebuffer containing the key part of the cell

• copyToNewByteArray

  public static byte[] copyToNewByteArray(Cell cell)

• appendKeyTo

  public static int appendKeyTo(Cell cell,
                byte[] output,
                int offset)

• appendToByteArray

  public static int appendToByteArray(Cell cell,
                      byte[] output,
                      int offset)

  copy key and value

• copyToNewByteBuffer

  public static ByteBuffer copyToNewByteBuffer(Cell cell)

  The position will be set to the beginning of the new ByteBuffer

  Parameters:

  cell -

  Returns:

  the ByteBuffer containing the cell

• appendToByteBuffer

  public static void appendToByteBuffer(ByteBuffer bb,
                        KeyValue kv,
                        boolean includeMvccVersion)

• nextShallowCopy

  public static KeyValue nextShallowCopy(ByteBuffer bb,
                         boolean includesMvccVersion,
                         boolean includesTags)

  Creates a new KeyValue object positioned in the supplied ByteBuffer and sets the ByteBuffer's position to the start of the next KeyValue. Does not allocate a new array or copy data.

  Parameters:

  bb -

  includesMvccVersion -

  includesTags -

• createFirstKeyInNextRow

  public static KeyValue createFirstKeyInNextRow(Cell in)

  Append single byte 0x00 to the end of the input row key

• createFirstKeyInIncrementedRow

  public static KeyValue createFirstKeyInIncrementedRow(Cell in)

  Increment the row bytes and clear the other fields

• previousKey

  public static KeyValue previousKey(KeyValue in)

  Decrement the timestamp. For tests (currently wasteful) Remember timestamps are sorted reverse chronologically.

  Parameters:

  in -

  Returns:

  previous key

• createLastOnRow

  public static KeyValue createLastOnRow(byte[] row,
                         int roffset,
                         int rlength,
                         byte[] family,
                         int foffset,
                         int flength,
                         byte[] qualifier,
                         int qoffset,
                         int qlength)

  Create a KeyValue for the specified row, family and qualifier that would be larger than or equal to all other possible KeyValues that have the same row, family, qualifier. Used for reseeking. Should NEVER be returned to a client.

  Parameters:

  row - row key

  roffset - row offset

  rlength - row length

  family - family name

  foffset - family offset

  flength - family length

  qualifier - column qualifier

  qoffset - qualifier offset

  qlength - qualifier length

  Returns:

  Last possible key on passed row, family, qualifier.

• createLastOnRow

  public static KeyValue createLastOnRow(Cell kv)

  Creates a keyValue for the specified keyvalue larger than or equal to all other possible KeyValues that have the same row, family, qualifer. Used for reseeking

  Parameters:

  kv -

  Returns:

  KeyValue

• createLastOnRowCol

  public static KeyValue createLastOnRowCol(Cell kv)

  Similar to createLastOnRow(byte[], int, int, byte[], int, int, byte[], int, int) but creates the last key on the row/column of this KV (the value part of the returned KV is always empty). Used in creating "fake keys" for the multi-column Bloom filter optimization to skip the row/column we already know is not in the file. Not to be returned to clients.

  Parameters:

  kv - - cell

  Returns:

  the last key on the row/column of the given key-value pair

• createFirstOnRowColTS

  public static KeyValue createFirstOnRowColTS(Cell kv,
                               long ts)

  Creates the first KV with the row/family/qualifier of this KV and the given timestamp. Uses the "maximum" KV type that guarantees that the new KV is the lowest possible for this combination of row, family, qualifier, and timestamp. This KV's own timestamp is ignored. While this function copies the value from this KV, it is normally used on key-only KVs.

  Parameters:

  kv - - cell

  ts -

• createFirstOnRow

  public static KeyValue createFirstOnRow(byte[] row,
                          int roffset,
                          short rlength)

  Create a KeyValue that is smaller than all other possible KeyValues for the given row. That is any (valid) KeyValue on 'row' would sort _after_ the result.

  Parameters:

  row - - row key (arbitrary byte array)

  Returns:

  First possible KeyValue on passed row

• createLastOnRow

  public static KeyValue createLastOnRow(byte[] row)

  Creates a KeyValue that is last on the specified row id. That is, every other possible KeyValue for the given row would compareTo() less than the result of this call.

  Parameters:

  row - row key

  Returns:

  Last possible KeyValue on passed row

• createFirstOnRow

  public static KeyValue createFirstOnRow(byte[] row)

  Create a KeyValue that is smaller than all other possible KeyValues for the given row. That is any (valid) KeyValue on 'row' would sort _after_ the result.

  Parameters:

  row - - row key (arbitrary byte array)

  Returns:

  First possible KeyValue on passed row

• createFirstOnRow

  public static KeyValue createFirstOnRow(byte[] row,
                          long ts)

  Creates a KeyValue that is smaller than all other KeyValues that are older than the passed timestamp.

  Parameters:

  row - - row key (arbitrary byte array)

  ts - - timestamp

  Returns:

  First possible key on passed row and timestamp.

• createFirstOnRow

  public static KeyValue createFirstOnRow(byte[] row,
                          byte[] family,
                          byte[] qualifier)

  Create a KeyValue for the specified row, family and qualifier that would be smaller than all other possible KeyValues that have the same row,family,qualifier. Used for seeking.

  Parameters:

  row - - row key (arbitrary byte array)

  family - - family name

  qualifier - - column qualifier

  Returns:

  First possible key on passed row, and column.

• createFirstDeleteFamilyOnRow

  public static KeyValue createFirstDeleteFamilyOnRow(byte[] row,
                                      byte[] family)

  Create a Delete Family KeyValue for the specified row and family that would be smaller than all other possible Delete Family KeyValues that have the same row and family. Used for seeking.

  Parameters:

  row - - row key (arbitrary byte array)

  family - - family name

  Returns:

  First Delete Family possible key on passed row.

• createFirstOnRow

  public static KeyValue createFirstOnRow(byte[] row,
                          byte[] f,
                          byte[] q,
                          long ts)

  Parameters:

  row - - row key (arbitrary byte array)

  f - - family name

  q - - column qualifier

  ts - - timestamp

  Returns:

  First possible key on passed row, column and timestamp

• createFirstOnRow

  public static KeyValue createFirstOnRow(byte[] row,
                          int roffset,
                          int rlength,
                          byte[] family,
                          int foffset,
                          int flength,
                          byte[] qualifier,
                          int qoffset,
                          int qlength)

  Create a KeyValue for the specified row, family and qualifier that would be smaller than all other possible KeyValues that have the same row, family, qualifier. Used for seeking.

  Parameters:

  row - row key

  roffset - row offset

  rlength - row length

  family - family name

  foffset - family offset

  flength - family length

  qualifier - column qualifier

  qoffset - qualifier offset

  qlength - qualifier length

  Returns:

  First possible key on passed Row, Family, Qualifier.

• createFirstOnRow

  public static KeyValue createFirstOnRow(byte[] buffer,
                          byte[] row,
                          byte[] family,
                          byte[] qualifier)
                                   throws IllegalArgumentException

  Create a KeyValue for the specified row, family and qualifier that would be smaller than all other possible KeyValues that have the same row, family, qualifier. Used for seeking.

  Parameters:

  buffer - the buffer to use for the new KeyValue object

  row - the value key

  family - family name

  qualifier - column qualifier

  Returns:

  First possible key on passed Row, Family, Qualifier.

  Throws:

  IllegalArgumentException - The resulting KeyValue object would be larger than the provided buffer or than Integer.MAX_VALUE

• createFirstOnRow

  public static KeyValue createFirstOnRow(byte[] buffer,
                          int boffset,
                          byte[] row,
                          int roffset,
                          int rlength,
                          byte[] family,
                          int foffset,
                          int flength,
                          byte[] qualifier,
                          int qoffset,
                          int qlength)
                                   throws IllegalArgumentException

  Create a KeyValue for the specified row, family and qualifier that would be smaller than all other possible KeyValues that have the same row, family, qualifier. Used for seeking.

  Parameters:

  buffer - the buffer to use for the new KeyValue object

  boffset - buffer offset

  row - the value key

  roffset - row offset

  rlength - row length

  family - family name

  foffset - family offset

  flength - family length

  qualifier - column qualifier

  qoffset - qualifier offset

  qlength - qualifier length

  Returns:

  First possible key on passed Row, Family, Qualifier.

  Throws:

  IllegalArgumentException - The resulting KeyValue object would be larger than the provided buffer or than Integer.MAX_VALUE

• createFirstOnRowColTS

  public static KeyValue createFirstOnRowColTS(KeyValue kv,
                               long ts)

  Creates the first KV with the row/family/qualifier of this KV and the given timestamp. Uses the "maximum" KV type that guarantees that the new KV is the lowest possible for this combination of row, family, qualifier, and timestamp. This KV's own timestamp is ignored. While this function copies the value from this KV, it is normally used on key-only KVs.

• ensureKeyValue

  @Deprecated
  public static KeyValue ensureKeyValue(Cell cell)

  Deprecated. without any replacement.

  Parameters:

  cell -

  Returns:

  cell if it is an instance of KeyValue else we will return a new KeyValue instance made from cell

• ensureKeyValueTypeForMR

  @Deprecated
  public static KeyValue ensureKeyValueTypeForMR(Cell cell)

  Deprecated. without any replacement.

  Parameters:

  cell -

  Returns:

  cell if it is an object of class KeyValue else we will return a new KeyValue instance made from cell Note: Even if the cell is an object of any of the subclass of KeyValue, we will create a new KeyValue object wrapping same buffer. This API should be used only with MR based tools which expect the type to be exactly KeyValue. That is the reason for doing this way.

• ensureKeyValues

  @Deprecated
  public static List<KeyValue> ensureKeyValues(List<Cell> cells)

  Deprecated. 

• iscreate

  public static KeyValue iscreate(InputStream in,
                  boolean withTags)
                           throws IOException

  Create a KeyValue reading from the raw InputStream. Named iscreate so doesn't clash with the create(DataInput) method added in 2.0

  Parameters:

  in -

  withTags - whether the keyvalue should include tags are not

  Returns:

  Created KeyValue OR if we find a length of zero, we will return null which can be useful marking a stream as done.

  Throws:

  IOException

• oswrite

  public static void oswrite(Cell cell,
             OutputStream out,
             boolean withTags)
                      throws IOException

  Throws:

  IOException