com.mapr.db.impl

Class FamilyDescriptorImpl

java.lang.Object

com.mapr.db.impl.FamilyDescriptorImpl

All Implemented Interfaces:

FamilyDescriptor, Cloneable

@API.Internal
public class FamilyDescriptorImpl
extends Object
implements FamilyDescriptor

Nested Class Summary

Nested classes/interfaces inherited from interface com.mapr.db.FamilyDescriptor

FamilyDescriptor.Compression

Field Summary

Fields

Modifier and Type	Field and Description
static com.mapr.fs.proto.Dbserver.ColumnFamilyAttr	DEFAULT_COLUMN_FAMILY_ATTR

Constructor Summary

Constructors

Constructor and Description
FamilyDescriptorImpl()
FamilyDescriptorImpl(String familyName, org.ojai.FieldPath jsonPath)
FamilyDescriptorImpl(String familyName, String jsonPath)

Method Summary

Methods

Modifier and Type	Method and Description
FamilyDescriptorImpl	clone() Creates and returns a copy of this FamilyDescriptor.
boolean	equals(Object obj)
FamilyDescriptor.Compression	getCompression()
int	getId() Read-only
org.ojai.FieldPath	getJsonFieldPath()
String	getName()
com.mapr.fs.proto.Dbserver.SchemaFamily.Builder	getSchemaFamily()
long	getTTL()
int	hashCode()
boolean	isInMemory()
FamilyDescriptor	setCompression(FamilyDescriptor.Compression compression) Sets the FamilyDescriptor.Compression scheme used to store data in the family
FamilyDescriptor	setInMemory(boolean inMemory) Sets whether preference is given to data of this family when data is evicted from the in memory cache.
FamilyDescriptor	setJsonFieldPath(org.ojai.FieldPath fieldPath) Sets the json field path of this family
FamilyDescriptor	setJsonFieldPath(String fieldPath) Sets the json field path of this family
FamilyDescriptor	setName(String name) Sets the name of this family.
FamilyDescriptor	setTTL(long ttl) Sets the Time-To-Live for the data stored in this family
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COLUMN_FAMILY_ATTR

public static final com.mapr.fs.proto.Dbserver.ColumnFamilyAttr DEFAULT_COLUMN_FAMILY_ATTR

Constructor Detail

FamilyDescriptorImpl

public FamilyDescriptorImpl()

FamilyDescriptorImpl

public FamilyDescriptorImpl(String familyName,
                    String jsonPath)

FamilyDescriptorImpl

public FamilyDescriptorImpl(String familyName,
                    org.ojai.FieldPath jsonPath)

Method Detail

getId

public int getId()

Read-only

getSchemaFamily

public com.mapr.fs.proto.Dbserver.SchemaFamily.Builder getSchemaFamily()

getName

public String getName()

Specified by:

getName in interface FamilyDescriptor

Returns:

the name of the family

setName

public FamilyDescriptor setName(String name)

Description copied from interface: FamilyDescriptor

Sets the name of this family.

Specified by:

setName in interface FamilyDescriptor

Parameters:

name - family name

Returns:

this for chain invocation

getJsonFieldPath

public org.ojai.FieldPath getJsonFieldPath()

Specified by:

getJsonFieldPath in interface FamilyDescriptor

Returns:

the json field path of this family

setJsonFieldPath

public FamilyDescriptor setJsonFieldPath(String fieldPath)

Description copied from interface: FamilyDescriptor

Sets the json field path of this family

Specified by:

setJsonFieldPath in interface FamilyDescriptor

Returns:

this for chain invocation

setJsonFieldPath

public FamilyDescriptor setJsonFieldPath(org.ojai.FieldPath fieldPath)

Description copied from interface: FamilyDescriptor

Sets the json field path of this family

Specified by:

setJsonFieldPath in interface FamilyDescriptor

Returns:

this for chain invocation

getTTL

public long getTTL()

Specified by:

getTTL in interface FamilyDescriptor

Returns:

the Time-To-Live in seconds for the data stored in this family

setTTL

public FamilyDescriptor setTTL(long ttl)

Description copied from interface: FamilyDescriptor

Sets the Time-To-Live for the data stored in this family

Specified by:

setTTL in interface FamilyDescriptor

Parameters:

ttl - time to live in seconds

Returns:

this for chain invocation

isInMemory

public boolean isInMemory()

Specified by:

isInMemory in interface FamilyDescriptor

Returns:

true if higher preference is given to the data stored in this family while evicting from in-memory cache.

setInMemory

public FamilyDescriptor setInMemory(boolean inMemory)

Description copied from interface: FamilyDescriptor

Sets whether preference is given to data of this family when data is evicted from the in memory cache.

Specified by:

setInMemory in interface FamilyDescriptor

Returns:

this for chain invocation

getCompression

public FamilyDescriptor.Compression getCompression()

Specified by:

getCompression in interface FamilyDescriptor

Returns:

the FamilyDescriptor.Compression scheme used to store data in the family

setCompression

public FamilyDescriptor setCompression(FamilyDescriptor.Compression compression)

Description copied from interface: FamilyDescriptor

Sets the FamilyDescriptor.Compression scheme used to store data in the family

Specified by:

setCompression in interface FamilyDescriptor

Parameters:

compression - the Compression scheme

Returns:

this for chain invocation

toString

public String toString()

Overrides:

toString in class Object

clone

public FamilyDescriptorImpl clone()

Description copied from interface: FamilyDescriptor

Creates and returns a copy of this FamilyDescriptor.

Specified by:

clone in interface FamilyDescriptor

Overrides:

clone in class Object

Returns:

a clone of this FamilyDescriptor

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object