org.commonvox.hbase_column_manager

Class ColumnDefinition

Object

ColumnDefinition

All Implemented Interfaces:

Comparable<SchemaEntity>

public class ColumnDefinition
extends Object

A ColumnDefinition (managed via a number of RepositoryAdmin add, get, and delete methods) contains administrator-maintained settings pertaining to a specific Column Qualifier within a Column Family of a ColumnManager-included Table;
when a Column Family has its ColumnDefinitionsEnforced setting enabled, then (a) any Column Qualifier submitted in a Put to that Column Family must correspond to an existing ColumnDefinition, and (b) the corresponding Column value submitted must pass all validations (if any) stipulated by the ColumnDefinition.

Constructor Summary

Constructors

Constructor and Description
ColumnDefinition(byte[] columnQualifier)
ColumnDefinition(String columnQualifier)

Method Summary

Modifier and Type	Method and Description
int	compareTo(SchemaEntity other)
boolean	equals(Object obj)
long	getColumnLength() Get the defined column length (i.e., the maximum length permitted for any submitted value for this column when ColumnDefinitionsEnforced is set to true for the column's Column Family); if returned value is 0 (the default), NO length validation of column values will be performed.
byte[]	getColumnQualifier() Get Column Qualifier.
String	getColumnQualifierAsString() Get Column Qualifier as a String.
String	getColumnValidationRegex() Get the defined column regex (i.e., the regular expression that any submitted value for this column must match when ColumnDefinitionsEnforced is set to true for the column's Column Family); if returned value is blank (the default), NO regular expression validation of column values will be performed.
int	hashCode()
ColumnDefinition	setColumnLength(long columnLength) Set the defined column length (i.e., the maximum length permitted for any submitted value for this column when ColumnDefinitionsEnforced is set to true for the column's Column Family); setting the value to 0 (the default) will result in NO length validation of column values being performed.
ColumnDefinition	setColumnValidationRegex(String regexString) Set the column's validation regex (i.e., the regular expression that any submitted value for this column must match when ColumnDefinitionsEnforced is set to true for the column's Column Family); setting the value to blank (the default) will result in NO regular expression validation of column values being performed.
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

ColumnDefinition

public ColumnDefinition(byte[] columnQualifier)

Parameters:

columnQualifier - Column Qualifier

ColumnDefinition

public ColumnDefinition(String columnQualifier)

Parameters:

columnQualifier - Column Qualifier

Method Detail

setColumnLength

public ColumnDefinition setColumnLength(long columnLength)

Set the defined column length (i.e., the maximum length permitted for any submitted value for this column when ColumnDefinitionsEnforced is set to true for the column's Column Family); setting the value to 0 (the default) will result in NO length validation of column values being performed.

Parameters:

columnLength - length setting defined for column

Returns:

this object, for method chaining

getColumnLength

public long getColumnLength()

Get the defined column length (i.e., the maximum length permitted for any submitted value for this column when ColumnDefinitionsEnforced is set to true for the column's Column Family); if returned value is 0 (the default), NO length validation of column values will be performed.

Returns:

defined column length for this column

setColumnValidationRegex

public ColumnDefinition setColumnValidationRegex(String regexString)

Set the column's validation regex (i.e., the regular expression that any submitted value for this column must match when ColumnDefinitionsEnforced is set to true for the column's Column Family); setting the value to blank (the default) will result in NO regular expression validation of column values being performed.

Parameters:

regexString - regular expression validation-string defined for column

Returns:

this object, for method chaining

getColumnValidationRegex

public String getColumnValidationRegex()

Get the defined column regex (i.e., the regular expression that any submitted value for this column must match when ColumnDefinitionsEnforced is set to true for the column's Column Family); if returned value is blank (the default), NO regular expression validation of column values will be performed.

Returns:

defined column length 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