com.linkedin.paldb.api

Interface StoreReader

All Known Implementing Classes:

ReaderImpl

public interface StoreReader

Main interface to read data from a PalDB store.

PalDB.createReader() method and then call the get() method to fetch. Call the close() to liberate resources when done.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the store reader and free resources.
<K> K	get(java.lang.Object key) Gets the value for key or null if not found.
<K> K	get(java.lang.Object key, K defaultValue) Gets the value for key or defaultValue if not found.
<K> K[]	getArray(java.lang.Object key) Gets the object array value for key or null if not found.
<K> K[]	getArray(java.lang.Object key, K[] defaultValue) Gets the object array value for key or defaultValue if not found.
boolean	getBoolean(java.lang.Object key) Gets the boolean value for key.
boolean	getBoolean(java.lang.Object key, boolean defaultValue) Gets the boolean value for key or defaultValue if not found.
boolean[]	getBooleanArray(java.lang.Object key) Gets the boolean array value for key.
boolean[]	getBooleanArray(java.lang.Object key, boolean[] defaultValue) Gets the boolean array value for key or defaultValue if not found.
byte	getByte(java.lang.Object key) Gets the byte value for key.
byte	getByte(java.lang.Object key, byte defaultValue) Gets the byte value for key or defaultValue if not found.
byte[]	getByteArray(java.lang.Object key) Gets the byte array value for key.
byte[]	getByteArray(java.lang.Object key, byte[] defaultValue) Gets the byte array value for key or defaultValue if not found.
char	getChar(java.lang.Object key) Gets the char value for key.
char	getChar(java.lang.Object key, char defaultValue) Gets the char value for key or defaultValue if not found.
char[]	getCharArray(java.lang.Object key) Gets the char array value for key.
char[]	getCharArray(java.lang.Object key, char[] defaultValue) Gets the char array value for key or defaultValue if not found.
Configuration	getConfiguration() Returns the reader's configuration.
double	getDouble(java.lang.Object key) Gets the double value for key.
double	getDouble(java.lang.Object key, double defaultValue) Gets the double value for key or defaultValue if not found.
double[]	getDoubleArray(java.lang.Object key) Gets the double array value for key.
double[]	getDoubleArray(java.lang.Object key, double[] defaultValue) Gets the double array value for key or defaultValue if not found.
java.io.File	getFile() Returns the store file.
float	getFloat(java.lang.Object key) Gets the float value for key.
float	getFloat(java.lang.Object key, float defaultValue) Gets the float value for key or defaultValue if not found.
float[]	getFloatArray(java.lang.Object key) Gets the float array value for key.
float[]	getFloatArray(java.lang.Object key, float[] defaultValue) Gets the float array value for key or defaultValue if not found.
int	getInt(java.lang.Object key) Gets the int value for key.
int	getInt(java.lang.Object key, int defaultValue) Gets the int value for key or defaultValue if not found.
int[]	getIntArray(java.lang.Object key) Gets the int array value for key.
int[]	getIntArray(java.lang.Object key, int[] defaultValue) Gets the int array value for key or defaultValue if not found.
long	getLong(java.lang.Object key) Gets the long value for key.
long	getLong(java.lang.Object key, long defaultValue) Gets the long value for key or defaultValue if not found.
long[]	getLongArray(java.lang.Object key) Gets the long array value for key.
long[]	getLongArray(java.lang.Object key, long[] defaultValue) Gets the long array value for key or defaultValue if not found.
short	getShort(java.lang.Object key) Gets the short value for key.
short	getShort(java.lang.Object key, short defaultValue) Gets the short value for key or defaultValue if not found.
short[]	getShortArray(java.lang.Object key) Gets the short array value for key.
short[]	getShortArray(java.lang.Object key, short[] defaultValue) Gets the short array value for key or defaultValue if not found.
java.lang.String	getString(java.lang.Object key) Gets the string value for key or null if not found.
java.lang.String	getString(java.lang.Object key, java.lang.String defaultValue) Gets the string value for key or defaultValue if not found.
java.lang.String[]	getStringArray(java.lang.Object key) Gets the string array value for key or null if not found.
java.lang.String[]	getStringArray(java.lang.Object key, java.lang.String[] defaultValue) Gets the string array value for key or defaultValue if not found.
<K,V> java.lang.Iterable<java.util.Map.Entry<K,V>>	iterable() Gets the store iterable.
<K> java.lang.Iterable<K>	keys() Gets the store keys iterable.
long	size() Returns the number of keys in the store.

Method Detail

close

void close()

Closes the store reader and free resources.

A closed reader can't be reopened.

getConfiguration

Configuration getConfiguration()

Returns the reader's configuration.

Returns:

the store configuration

getFile

java.io.File getFile()

Returns the store file.

Returns:

file

size

long size()

Returns the number of keys in the store.

Returns:

key count

get

<K> K get(java.lang.Object key)

Gets the value for key or null if not found.

Type Parameters:

K - return type

Parameters:

key - key to fetch

Returns:

value or null if not found

get

<K> K get(java.lang.Object key,
          K defaultValue)

Gets the value for key or defaultValue if not found.

Type Parameters:

K - return type

Parameters:

key - key to fetch

defaultValue - default value

Returns:

value of defaultValue if not found

getInt

int getInt(java.lang.Object key)
    throws NotFoundException

Gets the int value for key.

Parameters:

key - key to fetch

Returns:

int value

Throws:

NotFoundException - if not found

getInt

int getInt(java.lang.Object key,
           int defaultValue)

Gets the int value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

int value or defaultValue if not found

getLong

long getLong(java.lang.Object key)
      throws NotFoundException

Gets the long value for key.

Parameters:

key - key to fetch

Returns:

long value

Throws:

NotFoundException - if not found

getLong

long getLong(java.lang.Object key,
             long defaultValue)

Gets the long value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

long value or defaultValue if not found

getBoolean

boolean getBoolean(java.lang.Object key)
            throws NotFoundException

Gets the boolean value for key.

Parameters:

key - key to fetch

Returns:

boolean value

Throws:

NotFoundException - if not found

getBoolean

boolean getBoolean(java.lang.Object key,
                   boolean defaultValue)

Gets the boolean value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

boolean value or defaultValue if not found

getFloat

float getFloat(java.lang.Object key)
        throws NotFoundException

Gets the float value for key.

Parameters:

key - key to fetch

Returns:

float value

Throws:

NotFoundException - if not found

getFloat

float getFloat(java.lang.Object key,
               float defaultValue)

Gets the float value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

float value or defaultValue if not found

getDouble

double getDouble(java.lang.Object key)
          throws NotFoundException

Gets the double value for key.

Parameters:

key - key to fetch

Returns:

double value

Throws:

NotFoundException - if not found

getDouble

double getDouble(java.lang.Object key,
                 double defaultValue)

Gets the double value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

double value or defaultValue if not found

getShort

short getShort(java.lang.Object key)
        throws NotFoundException

Gets the short value for key.

Parameters:

key - key to fetch

Returns:

short value

Throws:

NotFoundException - if not found

getShort

short getShort(java.lang.Object key,
               short defaultValue)

Gets the short value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

short value or defaultValue if not found

getByte

byte getByte(java.lang.Object key)
      throws NotFoundException

Gets the byte value for key.

Parameters:

key - key to fetch

Returns:

byte value

Throws:

NotFoundException - if not found

getByte

byte getByte(java.lang.Object key,
             byte defaultValue)

Gets the byte value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

byte value or defaultValue if not found

getString

java.lang.String getString(java.lang.Object key)

Gets the string value for key or null if not found.

Parameters:

key - key to fetch

Returns:

string value

getString

java.lang.String getString(java.lang.Object key,
                           java.lang.String defaultValue)

Gets the string value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

string value or defaultValue if not found

getChar

char getChar(java.lang.Object key)
      throws NotFoundException

Gets the char value for key.

Parameters:

key - key to fetch

Returns:

char value

Throws:

NotFoundException - if not found

getChar

char getChar(java.lang.Object key,
             char defaultValue)

Gets the char value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

char value or defaultValue if not found

getArray

<K> K[] getArray(java.lang.Object key)

Gets the object array value for key or null if not found.

Type Parameters:

K - return type

Parameters:

key - key to fetch

Returns:

object array value or null if not found

getArray

<K> K[] getArray(java.lang.Object key,
                 K[] defaultValue)

Gets the object array value for key or defaultValue if not found.

Type Parameters:

K - return type

Parameters:

key - key to fetch

defaultValue - default value

Returns:

object array value or defaultValue if not found

getIntArray

int[] getIntArray(java.lang.Object key)
           throws NotFoundException

Gets the int array value for key.

Parameters:

key - key to fetch

Returns:

int array value

Throws:

NotFoundException - if not found

getIntArray

int[] getIntArray(java.lang.Object key,
                  int[] defaultValue)

Gets the int array value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

int array value or defaultValue if not found

getLongArray

long[] getLongArray(java.lang.Object key)
             throws NotFoundException

Gets the long array value for key.

Parameters:

key - key to fetch

Returns:

long array value

Throws:

NotFoundException - if not found

getLongArray

long[] getLongArray(java.lang.Object key,
                    long[] defaultValue)

Gets the long array value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

long array value or defaultValue if not found

getBooleanArray

boolean[] getBooleanArray(java.lang.Object key)
                   throws NotFoundException

Gets the boolean array value for key.

Parameters:

key - key to fetch

Returns:

boolean array value

Throws:

NotFoundException - if not found

getBooleanArray

boolean[] getBooleanArray(java.lang.Object key,
                          boolean[] defaultValue)

Gets the boolean array value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

boolean array value or defaultValue if not found

getFloatArray

float[] getFloatArray(java.lang.Object key)
               throws NotFoundException

Gets the float array value for key.

Parameters:

key - key to fetch

Returns:

float array value

Throws:

NotFoundException - if not found

getFloatArray

float[] getFloatArray(java.lang.Object key,
                      float[] defaultValue)

Gets the float array value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

float array value or defaultValue if not found

getDoubleArray

double[] getDoubleArray(java.lang.Object key)
                 throws NotFoundException

Gets the double array value for key.

Parameters:

key - key to fetch

Returns:

double array value

Throws:

NotFoundException - if not found

getDoubleArray

double[] getDoubleArray(java.lang.Object key,
                        double[] defaultValue)

Gets the double array value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

double array value or defaultValue if not found

getShortArray

short[] getShortArray(java.lang.Object key)
               throws NotFoundException

Gets the short array value for key.

Parameters:

key - key to fetch

Returns:

short array value

Throws:

NotFoundException - if not found

getShortArray

short[] getShortArray(java.lang.Object key,
                      short[] defaultValue)

Gets the short array value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

short array value or defaultValue if not found

getByteArray

byte[] getByteArray(java.lang.Object key)
             throws NotFoundException

Gets the byte array value for key.

Parameters:

key - key to fetch

Returns:

byte array value

Throws:

NotFoundException - if not found

getByteArray

byte[] getByteArray(java.lang.Object key,
                    byte[] defaultValue)

Gets the byte array value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

byte array value or defaultValue if not found

getCharArray

char[] getCharArray(java.lang.Object key)
             throws NotFoundException

Gets the char array value for key.

Parameters:

key - key to fetch

Returns:

char array value

Throws:

NotFoundException - if not found

getCharArray

char[] getCharArray(java.lang.Object key,
                    char[] defaultValue)

Gets the char array value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

char array value or defaultValue if not found

getStringArray

java.lang.String[] getStringArray(java.lang.Object key)
                           throws NotFoundException

Gets the string array value for key or null if not found.

Parameters:

key - key to fetch

Returns:

string array value or null if not found

Throws:

NotFoundException - if not found

getStringArray

java.lang.String[] getStringArray(java.lang.Object key,
                                  java.lang.String[] defaultValue)

Gets the string array value for key or defaultValue if not found.

Parameters:

key - key to fetch

defaultValue - default value

Returns:

string array value or defaultValue if not found

iterable

<K,V> java.lang.Iterable<java.util.Map.Entry<K,V>> iterable()

Gets the store iterable.

Note that entry objects are reused.

Type Parameters:

K - key type

V - value type

Returns:

iterable over store

keys

<K> java.lang.Iterable<K> keys()

Gets the store keys iterable.

Type Parameters:

K - key type

Returns:

iterable over keys