com.mapr.db

Interface FamilyDescriptor

All Superinterfaces:

Cloneable

public interface FamilyDescriptor
extends Cloneable

A FamilyDescriptor describes a family such as its JSON path in the document, time to live, compression settings, and so on. It can be used as input when creating a table or adding/modifying a family.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FamilyDescriptor.Compression

Method Summary

Methods

Modifier and Type	Method and Description
FamilyDescriptor	clone() Creates and returns a copy of this FamilyDescriptor.
FamilyDescriptor.Compression	getCompression()
org.ojai.FieldPath	getJsonFieldPath()
String	getName()
long	getTTL()
boolean	hasName()
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 ttlInSec) Sets the Time-To-Live for the data stored in this family

Method Detail

hasName

boolean hasName()

Returns:

true if the descriptor has the name of the family name set

getName

String getName()

Returns:

the name of the family

setName

FamilyDescriptor setName(String name)

Sets the name of this family.

Parameters:

name - family name

Returns:

this for chain invocation

getJsonFieldPath

org.ojai.FieldPath getJsonFieldPath()

Returns:

the JSON field path of this family

setJsonFieldPath

FamilyDescriptor setJsonFieldPath(String fieldPath)

Sets the JSON field path of this family

Parameters:

fieldPath -

Returns:

this for chain invocation

setJsonFieldPath

FamilyDescriptor setJsonFieldPath(org.ojai.FieldPath fieldPath)

Sets the JSON field path of this family

Parameters:

fieldPath -

Returns:

this for chain invocation

getTTL

long getTTL()

Returns:

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

setTTL

FamilyDescriptor setTTL(long ttlInSec)

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

Parameters:

ttlInSec - time to live in seconds

Returns:

this for chain invocation

isInMemory

boolean isInMemory()

Returns:

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

setInMemory

FamilyDescriptor setInMemory(boolean inMemory)

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

Parameters:

inMemory -

Returns:

this for chain invocation

getCompression

FamilyDescriptor.Compression getCompression()

Returns:

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

setCompression

FamilyDescriptor setCompression(FamilyDescriptor.Compression compression)

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

Parameters:

compression - the Compression scheme

Returns:

this for chain invocation

clone

FamilyDescriptor clone()

Creates and returns a copy of this FamilyDescriptor.

Returns:

a clone of this FamilyDescriptor