org.apache.fluo.api.data

Class Column

java.lang.Object

org.apache.fluo.api.data.Column

All Implemented Interfaces:

Serializable, Comparable<Column>

public final class Column
extends Object
implements Comparable<Column>, Serializable

Represents all or a subset of the column family, column qualifier, and column visibility fields. A column with no fields set is represented by Column.EMPTY. Column is immutable after it is created.

Since:

1.0.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Column	EMPTY

Constructor Summary

Constructors

Constructor and Description
Column() Creates an empty Column where family, qualifier and visibility are not set
Column(Bytes family) Creates Column with only a family.
Column(Bytes family, Bytes qualifier) Creates Column with a family and qualifier.
Column(Bytes family, Bytes qualifier, Bytes visibility) Creates Column with family, qualifier, and visibility
Column(CharSequence family) Creates Column with only a family.
Column(CharSequence family, CharSequence qualifier) Creates Column with a family and qualifier.
Column(CharSequence family, CharSequence qualifier, CharSequence visibility) Creates Column with family, qualifier, and visibility.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Column other)
boolean	equals(Object o)
Bytes	getFamily() Retrieves Column Family (in Bytes).
Bytes	getQualifier() Retrieves Column Qualifier (in Bytes).
String	getsFamily() Get the column family as a string using UTF-8 encoding.
String	getsQualifier() Get the column family as a string using UTF-8 encoding.
String	getsVisibility() Get the column visibility as a string using UTF-8 encoding.
Bytes	getVisibility() Retrieves Column Visibility (in Bytes).
int	hashCode()
boolean	isFamilySet() Returns true if family is set
boolean	isQualifierSet() Returns true if qualifier is set
boolean	isVisibilitySet() Returns true if visibility is set.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final Column EMPTY

Constructor Detail

Column

public Column()

Creates an empty Column where family, qualifier and visibility are not set

Column

public Column(Bytes family)

Creates Column with only a family.

Column

public Column(CharSequence family)

Creates Column with only a family. String parameter will be encoded as UTF-8.

Column

public Column(Bytes family,
              Bytes qualifier)

Creates Column with a family and qualifier.

Column

public Column(CharSequence family,
              CharSequence qualifier)

Creates Column with a family and qualifier. String parameters will be encoded as UTF-8.

Column

public Column(Bytes family,
              Bytes qualifier,
              Bytes visibility)

Creates Column with family, qualifier, and visibility

Column

public Column(CharSequence family,
              CharSequence qualifier,
              CharSequence visibility)

Creates Column with family, qualifier, and visibility. String parameters will be encoded as UTF-8.

Method Detail

isFamilySet

public boolean isFamilySet()

Returns true if family is set

getFamily

public Bytes getFamily()

Retrieves Column Family (in Bytes). Returns Bytes.EMPTY if not set.

getsFamily

public String getsFamily()

Get the column family as a string using UTF-8 encoding.

isQualifierSet

public boolean isQualifierSet()

Returns true if qualifier is set

getQualifier

public Bytes getQualifier()

Retrieves Column Qualifier (in Bytes). Returns Bytes.EMPTY if not set.

getsQualifier

public String getsQualifier()

Get the column family as a string using UTF-8 encoding.

isVisibilitySet

public boolean isVisibilitySet()

Returns true if visibility is set.

getVisibility

public Bytes getVisibility()

Retrieves Column Visibility (in Bytes). Returns Bytes.EMPTY if not set.

getsVisibility

public String getsVisibility()

Get the column visibility as a string using UTF-8 encoding.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Column other)

Specified by:

compareTo in interface Comparable<Column>

equals

public boolean equals(Object o)

Overrides:

equals in class Object