org.commonvox.hbase_column_manager

Class ColumnAuditor

Object

ColumnAuditor

All Implemented Interfaces:

Comparable<SchemaEntity>

public class ColumnAuditor
extends Object

A ColumnAuditor object (obtained via a RepositoryAdmin's getColumnAuditors method) contains captured* or discovered** metadata pertaining to a specific Column Qualifier actively stored in HBase as part of a Column Family of a ColumnManager-included Table.

*When ColumnManager is activated, ColumnAuditor metadata is gathered at runtime as Mutations are submitted via the HBase API to any ColumnManager-included Table.

**ColumnAuditor metadata may also be gathered for already-existing Columns via the method RepositoryAdmin.discoverColumnMetadata(boolean, boolean).

Constructor Summary

Constructors

Constructor and Description
ColumnAuditor(byte[] columnQualifier) Create ColumnAuditor instance for persisting user-specified values and/or configurations.
ColumnAuditor(String columnQualifier) Create ColumnAuditor instance for persisting user-specified values and/or configurations.

Method Summary

Modifier and Type	Method and Description
int	compareTo(SchemaEntity other)
boolean	equals(Object obj)
long	getCellOccurrencesCount() Get the count of all the cells in all the columns which have this ColumnAuditor's column-qualifier.
long	getCellOccurrencesTimestamp() Get timestamp of latest invocation of column metadata discovery which incremented cell occurrences count for this ColumnAuditor.
long	getColumnOccurrencesCount() Get the count of rows in the Table in which this ColumnAuditor's column-qualifier appears.
long	getColumnOccurrencesTimestamp() Get timestamp of latest invocation of column metadata discovery which incremented column occurrences count for this ColumnAuditor.
byte[]	getColumnQualifier() Get Column Qualifier.
String	getColumnQualifierAsString() Get Column Qualifier as a String.
long	getMaxValueLengthFound() Get the length of the longest value found in HBase for this column.
int	hashCode()
ColumnAuditor	setConfiguration(String key, String value) Setter for adding configuration entry to configuration map
ColumnAuditor	setValue(byte[] key, byte[] value) Setter for adding value entry to value map
ColumnAuditor	setValue(ImmutableBytesWritable key, ImmutableBytesWritable value) Setter for adding value entry to value map
ColumnAuditor	setValue(String key, String value) Setter for adding value entry to value map
String	toString() Returns a String in the format "SchemaEntityType: EntityName" (e.g., "ColumnFamily: myColumnFamily").

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ColumnAuditor

public ColumnAuditor(byte[] columnQualifier)

Create ColumnAuditor instance for persisting user-specified values and/or configurations.

Parameters:

columnQualifier - Column Qualifier

ColumnAuditor

public ColumnAuditor(String columnQualifier)

Create ColumnAuditor instance for persisting user-specified values and/or configurations.

Parameters:

columnQualifier - Column Qualifier

Method Detail

setValue

public final ColumnAuditor setValue(String key,
                                    String value)

Setter for adding value entry to value map

Parameters:

key - Value key

value - Value value

Returns:

this object to allow method chaining

setValue

public final ColumnAuditor setValue(byte[] key,
                                    byte[] value)

Setter for adding value entry to value map

Parameters:

key - Value key

value - Value value

Returns:

this object to allow method chaining

setValue

public final ColumnAuditor setValue(ImmutableBytesWritable key,
                                    ImmutableBytesWritable value)

Setter for adding value entry to value map

Parameters:

key - Value key

value - Value value

Returns:

this object to allow method chaining

setConfiguration

public final ColumnAuditor setConfiguration(String key,
                                            String value)

Setter for adding configuration entry to configuration map

Parameters:

key - Configuration key

value - Configuration value

Returns:

this object to allow method chaining

getMaxValueLengthFound

public long getMaxValueLengthFound()

Get the length of the longest value found in HBase for this column. Note that MaxValueLengthFound for a given column is incremented upward only when a value longer than that of any previously submitted/discovered value is found (either in the context of real-time metadata capture from a submitted Table Mutation, or in the process of column metadata discovery). MaxValueLengthFound is never decremented, even when the longest value for the column is deleted from HBase, so the MaxValueLengthFound actually represents the maximum length EVER recorded for the value of a specific column, not necessarily the longest value CURRENTLY stored in HBase for the column.

Returns:

maximum value length found in HBase for this column

getColumnOccurrencesCount

public long getColumnOccurrencesCount()

Get the count of rows in the Table in which this ColumnAuditor's column-qualifier appears. This method returns a value of -1 if column discovery has not been run.

Returns:

count of rows in which this ColumnAuditor's column-qualifier appears, or -1 if column discovery has not been run

getColumnOccurrencesTimestamp

public long getColumnOccurrencesTimestamp()

Get timestamp of latest invocation of column metadata discovery which incremented column occurrences count for this ColumnAuditor.

Returns:

timestamp of latest discovery invocation which incremented column occurrences count for this ColumnAuditor ColumnAuditor; returns 0 if column discovery has not been run

getCellOccurrencesCount

public long getCellOccurrencesCount()

Get the count of all the cells in all the columns which have this ColumnAuditor's column-qualifier. This method returns a value of -1 if column discovery has not been run. For a complete count of all cells, column discovery must be run with the includeAllCells parameter set to true.

Returns:

count of all the cells in all the columns which have this ColumnAuditor's column-qualifier, or -1 if column discovery has not been run

getCellOccurrencesTimestamp

public long getCellOccurrencesTimestamp()

Get timestamp of latest invocation of column metadata discovery which incremented cell occurrences count for this ColumnAuditor.

Returns:

timestamp of latest discovery invocation which incremented cell occurrences count for this ColumnAuditor ColumnAuditor; returns 0 if column discovery has not been run

getColumnQualifier

public byte[] getColumnQualifier()

Get Column Qualifier.

Returns:

Column Qualifier as byte-array

getColumnQualifierAsString

public String getColumnQualifierAsString()

Get Column Qualifier as a String.

Returns:

Column Qualifier as String

compareTo

public int compareTo(SchemaEntity other)

Specified by:

compareTo in interface Comparable<SchemaEntity>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a String in the format "SchemaEntityType: EntityName" (e.g., "ColumnFamily: myColumnFamily").

Overrides:

toString in class Object

Returns:

formatted String