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).

Method Summary

Modifier and Type	Method and Description
int	compareTo(SchemaEntity other)
boolean	equals(Object obj)
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()
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

Method Detail

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

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