com.landawn.abacus.da.hbase

Class AnyPut

java.lang.Object

com.landawn.abacus.da.hbase.AnyPut

All Implemented Interfaces:

Comparable<org.apache.hadoop.hbase.client.Row>, org.apache.hadoop.hbase.client.Row

public final class AnyPut
extends Object

It's a wrapper of Put in HBase to reduce the manual conversion between bytes and String/Object.

Since:

0.8

See Also:

http://hbase.apache.org/devapidocs/index.html, Put

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.client.Row

COMPARATOR

Method Summary

Modifier and Type	Method and Description
AnyPut	add(org.apache.hadoop.hbase.Cell kv)
AnyPut	addColumn(byte[] family, byte[] qualifier, byte[] value) Adds the column.
AnyPut	addColumn(byte[] family, byte[] qualifier, long ts, byte[] value) Adds the column.
AnyPut	addColumn(byte[] family, ByteBuffer qualifier, long ts, ByteBuffer value) Adds the column.
AnyPut	addColumn(String family, String qualifier, long ts, Object value) Adds the column.
AnyPut	addColumn(String family, String qualifier, Object value) Adds the column.
AnyPut	addImmutable(byte[] family, byte[] qualifier, byte[] value) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use add(Cell) and CellBuilder instead
AnyPut	addImmutable(byte[] family, byte[] qualifier, long ts, byte[] value) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use add(Cell) and CellBuilder instead
AnyPut	addImmutable(byte[] family, ByteBuffer qualifier, long ts, ByteBuffer value) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use add(Cell) and CellBuilder instead
AnyPut	addImmutable(String family, String qualifier, long ts, Object value) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use add(Cell) and CellBuilder instead
AnyPut	addImmutable(String family, String qualifier, Object value) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use add(Cell) and CellBuilder instead
org.apache.hadoop.hbase.CellScanner	cellScanner()
int	compareTo(org.apache.hadoop.hbase.client.Row d) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use Row.COMPARATOR instead
boolean	equals(Object obj)
static List<AnyPut>	from(Collection<?> entities)
static List<AnyPut>	from(Collection<?> entities, Collection<String> selectPropNames)
static List<AnyPut>	from(Collection<?> entities, Collection<String> selectPropNames, com.landawn.abacus.util.NamingPolicy namingPolicy)
static List<AnyPut>	from(Collection<?> entities, com.landawn.abacus.util.NamingPolicy namingPolicy)
static AnyPut	from(Object entity)
static AnyPut	from(Object entity, Collection<String> selectPropNames)
static AnyPut	from(Object entity, Collection<String> selectPropNames, com.landawn.abacus.util.NamingPolicy namingPolicy)
static AnyPut	from(Object entity, com.landawn.abacus.util.NamingPolicy namingPolicy)
List<org.apache.hadoop.hbase.Cell>	get(byte[] family, byte[] qualifier) Returns a list of all KeyValue objects with matching column family and qualifier.
List<org.apache.hadoop.hbase.Cell>	get(String family, String qualifier) Returns a list of all KeyValue objects with matching column family and qualifier.
byte[]	getACL() Gets the acl.
byte[]	getAttribute(String name) Gets the attribute.
Map<String,byte[]>	getAttributesMap() Gets the attributes map.
org.apache.hadoop.hbase.security.visibility.CellVisibility	getCellVisibility() Gets the cell visibility.
List<UUID>	getClusterIds() Gets the cluster ids.
org.apache.hadoop.hbase.client.Durability	getDurability() Get the current durability.
NavigableMap<byte[],List<org.apache.hadoop.hbase.Cell>>	getFamilyCellMap() Method for retrieving the put's familyMap.
Map<String,Object>	getFingerprint() Compile the column family (i.e.
String	getId() This method allows you to retrieve the identifier for the operation if one was set.
int	getPriority() Gets the priority.
byte[]	getRow() Method for retrieving the delete's row.
long	getTimestamp() Method for retrieving the timestamp.
long	getTimeStamp() Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use getTimestamp() instead
long	getTTL() Return the TTL requested for the result of the mutation, in milliseconds.
boolean	has(byte[] family, byte[] qualifier) A convenience method to determine if this object's familyMap contains a value assigned to the given family & qualifier.
boolean	has(byte[] family, byte[] qualifier, byte[] value) A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp.
boolean	has(byte[] family, byte[] qualifier, long ts) A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp.
boolean	has(byte[] family, byte[] qualifier, long ts, byte[] value) A convenience method to determine if this object's familyMap contains the given value assigned to the given family, qualifier and timestamp.
boolean	has(String family, String qualifier) A convenience method to determine if this object's familyMap contains a value assigned to the given family & qualifier.
boolean	has(String family, String qualifier, long ts) A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp.
boolean	has(String family, String qualifier, long ts, Object value) A convenience method to determine if this object's familyMap contains the given value assigned to the given family, qualifier and timestamp.
boolean	has(String family, String qualifier, Object value) A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp.
int	hashCode()
long	heapSize()
boolean	isEmpty() Method to check if the familyMap is empty.
int	numFamilies()
static AnyPut	of(ByteBuffer rowKey)
static AnyPut	of(ByteBuffer rowKey, long timestamp)
static AnyPut	of(Object rowKey)
static AnyPut	of(Object rowKey, boolean rowIsImmutable)
static AnyPut	of(Object rowKey, int rowOffset, int rowLength)
static AnyPut	of(Object rowKey, int rowOffset, int rowLength, long timestamp)
static AnyPut	of(Object rowKey, long timestamp)
static AnyPut	of(Object rowKey, long timestamp, boolean rowIsImmutable)
static AnyPut	of(org.apache.hadoop.hbase.client.Put putToCopy)
AM	setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms) Sets the ACL.
AM	setACL(String user, org.apache.hadoop.hbase.security.access.Permission perms) Sets the ACL.
AOWA	setAttribute(String name, Object value) Sets the attribute.
AM	setCellVisibility(org.apache.hadoop.hbase.security.visibility.CellVisibility expression) Sets the visibility expression associated with cells in this Mutation.
AM	setClusterIds(List<UUID> clusterIds) Marks that the clusters with the given clusterIds have consumed the mutation.
AM	setDurability(org.apache.hadoop.hbase.client.Durability d) Set the durability for this mutation.
AM	setFamilyCellMap(NavigableMap<byte[],List<org.apache.hadoop.hbase.Cell>> map) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use Mutation.Mutation(byte[], long, NavigableMap) instead
AOWA	setId(String id) This method allows you to set an identifier on an operation.
AOWA	setPriority(int priority) Sets the priority.
AM	setTimestamp(long timestamp) Set the timestamp of the delete.
AM	setTTL(long ttl) Set the TTL desired for the result of the mutation, in milliseconds.
int	size() Number of KeyValues carried by this Mutation.
String	toJSON()
String	toJSON(int maxCols)
Map<String,Object>	toMap()
Map<String,Object>	toMap(int maxCols)
static List<org.apache.hadoop.hbase.client.Put>	toPut(Collection<?> entities)
static List<org.apache.hadoop.hbase.client.Put>	toPut(Collection<?> entities, com.landawn.abacus.util.NamingPolicy namingPolicy)
String	toString()
String	toString(int maxCols)
org.apache.hadoop.hbase.client.Put	val()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static AnyPut of(Object rowKey)

Parameters:

rowKey -

Returns:

of

public static AnyPut of(Object rowKey,
                        long timestamp)

Parameters:

rowKey -

timestamp -

Returns:

of

public static AnyPut of(Object rowKey,
                        int rowOffset,
                        int rowLength)

Parameters:

rowKey -

rowOffset -

rowLength -

Returns:

of

public static AnyPut of(Object rowKey,
                        int rowOffset,
                        int rowLength,
                        long timestamp)

Parameters:

rowKey -

rowOffset -

rowLength -

timestamp -

Returns:

of

public static AnyPut of(Object rowKey,
                        boolean rowIsImmutable)

Parameters:

rowKey -

rowIsImmutable -

Returns:

of

public static AnyPut of(Object rowKey,
                        long timestamp,
                        boolean rowIsImmutable)

Parameters:

rowKey -

timestamp -

rowIsImmutable -

Returns:

of

public static AnyPut of(ByteBuffer rowKey)

Parameters:

rowKey -

Returns:

of

public static AnyPut of(ByteBuffer rowKey,
                        long timestamp)

Parameters:

rowKey -

timestamp -

Returns:

of

public static AnyPut of(org.apache.hadoop.hbase.client.Put putToCopy)

Parameters:

putToCopy -

Returns:

from

public static AnyPut from(Object entity)

Parameters:

entity -

Returns:

from

public static AnyPut from(Object entity,
                          com.landawn.abacus.util.NamingPolicy namingPolicy)

Parameters:

entity -

namingPolicy -

Returns:

from

public static List<AnyPut> from(Collection<?> entities)

Parameters:

entities -

Returns:

from

public static List<AnyPut> from(Collection<?> entities,
                                com.landawn.abacus.util.NamingPolicy namingPolicy)

Parameters:

entities -

namingPolicy -

Returns:

from

public static AnyPut from(Object entity,
                          Collection<String> selectPropNames)

Parameters:

entity -

selectPropNames -

Returns:

from

public static AnyPut from(Object entity,
                          Collection<String> selectPropNames,
                          com.landawn.abacus.util.NamingPolicy namingPolicy)

Parameters:

entity -

selectPropNames -

namingPolicy -

Returns:

from

public static List<AnyPut> from(Collection<?> entities,
                                Collection<String> selectPropNames)

Parameters:

entities -

selectPropNames -

Returns:

from

public static List<AnyPut> from(Collection<?> entities,
                                Collection<String> selectPropNames,
                                com.landawn.abacus.util.NamingPolicy namingPolicy)

Parameters:

entities -

selectPropNames -

namingPolicy -

Returns:

val

public org.apache.hadoop.hbase.client.Put val()

addColumn

public AnyPut addColumn(String family,
                        String qualifier,
                        Object value)

Adds the column.

Parameters:

family -

qualifier -

value -

Returns:

addColumn

public AnyPut addColumn(String family,
                        String qualifier,
                        long ts,
                        Object value)

Adds the column.

Parameters:

family -

qualifier -

ts -

value -

Returns:

addColumn

public AnyPut addColumn(byte[] family,
                        byte[] qualifier,
                        byte[] value)

Adds the column.

Parameters:

family -

qualifier -

value -

Returns:

addColumn

public AnyPut addColumn(byte[] family,
                        byte[] qualifier,
                        long ts,
                        byte[] value)

Adds the column.

Parameters:

family -

qualifier -

ts -

value -

Returns:

addColumn

public AnyPut addColumn(byte[] family,
                        ByteBuffer qualifier,
                        long ts,
                        ByteBuffer value)

Adds the column.

Parameters:

family -

qualifier -

ts -

value -

Returns:

addImmutable

@Deprecated
public AnyPut addImmutable(String family,
                                        String qualifier,
                                        Object value)

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use add(Cell) and CellBuilder instead

See addColumn(byte[], byte[], byte[]). This version expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

Parameters:

family -

qualifier -

value -

Returns:

addImmutable

@Deprecated
public AnyPut addImmutable(String family,
                                        String qualifier,
                                        long ts,
                                        Object value)

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use add(Cell) and CellBuilder instead

See addColumn(byte[], byte[], long, byte[]). This version expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

Parameters:

family -

qualifier -

ts -

value -

Returns:

addImmutable

@Deprecated
public AnyPut addImmutable(byte[] family,
                                        byte[] qualifier,
                                        byte[] value)

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use add(Cell) and CellBuilder instead

See addColumn(byte[], byte[], byte[]). This version expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

Parameters:

family -

qualifier -

value -

Returns:

addImmutable

@Deprecated
public AnyPut addImmutable(byte[] family,
                                        byte[] qualifier,
                                        long ts,
                                        byte[] value)

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use add(Cell) and CellBuilder instead

See addColumn(byte[], byte[], long, byte[]). This version expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

Parameters:

family -

qualifier -

ts -

value -

Returns:

addImmutable

@Deprecated
public AnyPut addImmutable(byte[] family,
                                        ByteBuffer qualifier,
                                        long ts,
                                        ByteBuffer value)

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use add(Cell) and CellBuilder instead

See addColumn(byte[], byte[], long, byte[]). This version expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

Parameters:

family -

qualifier -

ts -

value -

Returns:

add

public AnyPut add(org.apache.hadoop.hbase.Cell kv)
           throws IOException

Parameters:

kv -

Returns:

Throws:

IOException - Signals that an I/O exception has occurred.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true, if successful

toString

public String toString()

toPut

public static List<org.apache.hadoop.hbase.client.Put> toPut(Collection<?> entities)

Parameters:

entities - AnyPut or entity with getter/setter methods

Returns:

toPut

public static List<org.apache.hadoop.hbase.client.Put> toPut(Collection<?> entities,
                                                             com.landawn.abacus.util.NamingPolicy namingPolicy)

Parameters:

entities - AnyPut or entity with getter/setter methods

namingPolicy -

Returns:

cellScanner

public org.apache.hadoop.hbase.CellScanner cellScanner()

getFingerprint

public Map<String,Object> getFingerprint()

Compile the column family (i.e. schema) information into a Map. Useful for parsing and aggregation by debugging, logging, and administration tools.

Returns:

Map

getDurability

public org.apache.hadoop.hbase.client.Durability getDurability()

Get the current durability.

Returns:

setDurability

public AM setDurability(org.apache.hadoop.hbase.client.Durability d)

Set the durability for this mutation.

Parameters:

d -

Returns:

getFamilyCellMap

public NavigableMap<byte[],List<org.apache.hadoop.hbase.Cell>> getFamilyCellMap()

Method for retrieving the put's familyMap.

Returns:

familyMap

setFamilyCellMap

@Deprecated
public AM setFamilyCellMap(NavigableMap<byte[],List<org.apache.hadoop.hbase.Cell>> map)

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use Mutation.Mutation(byte[], long, NavigableMap) instead

Method for setting the mutation's familyMap.

Parameters:

map -

Returns:

getTimeStamp

@Deprecated
public long getTimeStamp()

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use getTimestamp() instead

Method for retrieving the timestamp.

Returns:

timestamp

getTimestamp

public long getTimestamp()

Method for retrieving the timestamp.

Returns:

timestamp

setTimestamp

public AM setTimestamp(long timestamp)

Set the timestamp of the delete.

Parameters:

timestamp -

Returns:

getClusterIds

public List<UUID> getClusterIds()

Gets the cluster ids.

Returns:

setClusterIds

public AM setClusterIds(List<UUID> clusterIds)

Marks that the clusters with the given clusterIds have consumed the mutation.

Parameters:

clusterIds - of the clusters that have consumed the mutation

Returns:

getCellVisibility

public org.apache.hadoop.hbase.security.visibility.CellVisibility getCellVisibility()
                                                                             throws org.apache.hadoop.hbase.exceptions.DeserializationException

Gets the cell visibility.

Returns:

CellVisibility associated with cells in this Mutation.

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException - the deserialization exception

setCellVisibility

public AM setCellVisibility(org.apache.hadoop.hbase.security.visibility.CellVisibility expression)

Sets the visibility expression associated with cells in this Mutation.

Parameters:

expression -

Returns:

getACL

public byte[] getACL()

Gets the acl.

Returns:

The serialized ACL for this operation, or null if none

setACL

public AM setACL(String user,
                 org.apache.hadoop.hbase.security.access.Permission perms)

Sets the ACL.

Parameters:

user - User short name

perms - Permissions for the user

Returns:

setACL

public AM setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms)

Sets the ACL.

Parameters:

perms - A map of permissions for a user or users

Returns:

getTTL

public long getTTL()

Return the TTL requested for the result of the mutation, in milliseconds.

Returns:

or Long.MAX_VALUE if unset

setTTL

public AM setTTL(long ttl)

Set the TTL desired for the result of the mutation, in milliseconds.

Parameters:

ttl - the TTL desired for the result of the mutation, in milliseconds

Returns:

this

get

public List<org.apache.hadoop.hbase.Cell> get(String family,
                                              String qualifier)

Returns a list of all KeyValue objects with matching column family and qualifier.

Parameters:

family - column family

qualifier - column qualifier

Returns:

a list of KeyValue objects with the matching family and qualifier, returns an empty list if one doesn't exist for the given family.

get

public List<org.apache.hadoop.hbase.Cell> get(byte[] family,
                                              byte[] qualifier)

Returns a list of all KeyValue objects with matching column family and qualifier.

Parameters:

family - column family

qualifier - column qualifier

Returns:

a list of KeyValue objects with the matching family and qualifier, returns an empty list if one doesn't exist for the given family.

has

public boolean has(String family,
                   String qualifier)

A convenience method to determine if this object's familyMap contains a value assigned to the given family & qualifier. Both given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

Returns:

returns true if the given family and qualifier already has an existing KeyValue object in the family map.

has

public boolean has(String family,
                   String qualifier,
                   long ts)

A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp. All 3 given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

ts - timestamp

Returns:

returns true if the given family, qualifier and timestamp already has an existing KeyValue object in the family map.

has

public boolean has(String family,
                   String qualifier,
                   Object value)

A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp. All 3 given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

value - value to check

Returns:

returns true if the given family, qualifier and value already has an existing KeyValue object in the family map.

has

public boolean has(String family,
                   String qualifier,
                   long ts,
                   Object value)

A convenience method to determine if this object's familyMap contains the given value assigned to the given family, qualifier and timestamp. All 4 given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

ts - timestamp

value - value to check

Returns:

returns true if the given family, qualifier timestamp and value already has an existing KeyValue object in the family map.

has

public boolean has(byte[] family,
                   byte[] qualifier)

A convenience method to determine if this object's familyMap contains a value assigned to the given family & qualifier. Both given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

Returns:

returns true if the given family and qualifier already has an existing KeyValue object in the family map.

has

public boolean has(byte[] family,
                   byte[] qualifier,
                   long ts)

A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp. All 3 given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

ts - timestamp

Returns:

returns true if the given family, qualifier and timestamp already has an existing KeyValue object in the family map.

has

public boolean has(byte[] family,
                   byte[] qualifier,
                   byte[] value)

A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp. All 3 given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

value - value to check

Returns:

returns true if the given family, qualifier and value already has an existing KeyValue object in the family map.

has

public boolean has(byte[] family,
                   byte[] qualifier,
                   long ts,
                   byte[] value)

A convenience method to determine if this object's familyMap contains the given value assigned to the given family, qualifier and timestamp. All 4 given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

ts - timestamp

value - value to check

Returns:

returns true if the given family, qualifier timestamp and value already has an existing KeyValue object in the family map.

getRow

public byte[] getRow()

Method for retrieving the delete's row.

Specified by:

getRow in interface org.apache.hadoop.hbase.client.Row

Returns:

row

isEmpty

public boolean isEmpty()

Method to check if the familyMap is empty.

Returns:

true if empty, false otherwise

size

public int size()

Number of KeyValues carried by this Mutation.

Returns:

numFamilies

public int numFamilies()

heapSize

public long heapSize()

Returns:

Calculate what Mutation adds to class heap size.

compareTo

@Deprecated
public int compareTo(org.apache.hadoop.hbase.client.Row d)

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use Row.COMPARATOR instead

Specified by:

compareTo in interface Comparable<org.apache.hadoop.hbase.client.Row>

Specified by:

compareTo in interface org.apache.hadoop.hbase.client.Row

Parameters:

d -

Returns:

getAttribute

public byte[] getAttribute(String name)

Gets the attribute.

Parameters:

name -

Returns:

getAttributesMap

public Map<String,byte[]> getAttributesMap()

Gets the attributes map.

Returns:

setAttribute

public AOWA setAttribute(String name,
                         Object value)

Sets the attribute.

Parameters:

name -

value -

Returns:

getId

public String getId()

This method allows you to retrieve the identifier for the operation if one was set.

Returns:

setId

public AOWA setId(String id)

This method allows you to set an identifier on an operation. The original motivation for this was to allow the identifier to be used in slow query logging, but this could obviously be useful in other places. One use of this could be to put a class.method identifier in here to see where the slow query is coming from.

Parameters:

id - id to set for the scan

Returns:

getPriority

public int getPriority()

Gets the priority.

Returns:

setPriority

public AOWA setPriority(int priority)

Sets the priority.

Parameters:

priority -

Returns:

toMap

public Map<String,Object> toMap()

toMap

public Map<String,Object> toMap(int maxCols)

Parameters:

maxCols -

Returns:

toJSON

public String toJSON()

toJSON

public String toJSON(int maxCols)

Parameters:

maxCols -

Returns:

toString

public String toString(int maxCols)

Parameters:

maxCols -

Returns: