com.illumon.iris.db.tables.appendable.local

Class LocalAppendableColumn<DATA_TYPE>

java.lang.Object

com.illumon.iris.db.tables.appendable.BaseAppendableColumn<DATA_TYPE>

com.illumon.iris.db.tables.appendable.local.LocalAppendableColumn<DATA_TYPE>

All Implemented Interfaces:

AppendableColumn<DATA_TYPE>, BufferedAppendable, BufferedAppendableColumn<DATA_TYPE>, TableTransactionProcessor

public class LocalAppendableColumn<DATA_TYPE>
extends BaseAppendableColumn<DATA_TYPE>
implements TableTransactionProcessor, BufferedAppendableColumn<DATA_TYPE>

AppendableColumn for output to a local column location.

Application threads must synchronize in order to ensure mutually-exclusive concurrent access for all operations other than LocalAppendableColumn.force() (which may proceed concurrently).

LocalAppendableColumn.release() or LocalAppendableColumn.close() must only be called after all other operations besides LocalAppendableColumn.force() are completed, in any thread. The expectation is that after an error in writing applications will LocalAppendableColumn.release() scarce resources, or after successful writing applications will LocalAppendableColumn.close() the column.

Note that code assumes correct usage, and omits validation for alignment issues that would occur with incorrect usage.

Field Summary

Fields inherited from class com.illumon.iris.db.tables.appendable.BaseAppendableColumn

name, type

Method Summary

Modifier and Type	Method and Description
void	abortTransaction() Abort the current pending transaction.
void	addByte(byte value) Append a byte to this column.
void	addBytes(byte[] values, int startIndex, int length) Add byte values from an array.
void	addBytes(ByteBuffer inputBuffer) Add byte values from a ByteBuffer, starting at buffer.position() and continuing to buffer.limit().
void	addChar(char value) Append a char to this column.
void	addChars(char[] values, int startIndex, int length) Add char values from an array.
void	addDouble(double value) Append a double to this column.
void	addDoubles(double[] values, int startIndex, int length) Add double values from an array.
void	addFloat(float value) Append a float to this column.
void	addFloats(float[] values, int startIndex, int length) Add float values from an array.
void	addInt(int value) Append a int to this column.
void	addInts(int[] values, int startIndex, int length) Add int values from an array.
void	addLong(long value) Append a long to this column.
void	addLongs(long[] values, int startIndex, int length) Add long values from an array.
void	addShort(short value) Append a short to this column.
void	addShorts(short[] values, int startIndex, int length) Add short values from an array.
void	close() Flush all appended data to the underlying store, release any resources held, and force all appended data to be persisted to permanent storage.
void	finishTransaction() Finish the current pending transaction.
void	flush() Write all appended data to the underlying store and prepare for subsequent writes.
void	force() Force all flushed data to be persisted to permanent storage.
boolean	inTransaction()
void	release() Release any resources held.
void	setValueToRangeMap(Map<DATA_TYPE,long[]> valueToRangeMap)
void	startTransaction() Begin a new transaction.
String	toString()

Methods inherited from class com.illumon.iris.db.tables.appendable.BaseAppendableColumn

add, add, addBoolean, addBooleans, checkArrayAddBounds, encodeDateTime, encodeExternalizable, encodeSerializable, getAddHelper, getName, getType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.illumon.iris.db.tables.appendable.BufferedAppendable

prepareCheckpoint

Methods inherited from interface com.illumon.iris.db.tables.appendable.AppendableColumn

add, add, addBoolean, addBooleans, addFromArray, addFromBoxedValue, addFromBoxedValue, addFromColumnSource, addFromColumnSource, addFromColumnSource, addFromColumnSource, addFromDataColumn, getAddHelper, getName, getType

Method Detail

toString

public String toString()

Overrides:

toString in class Object

setValueToRangeMap

public void setValueToRangeMap(@NotNull
                               Map<DATA_TYPE,long[]> valueToRangeMap)

Parameters:

valueToRangeMap - Map from unique, boxed column values to long[2] position ranges.

force

public void force()

Description copied from interface: BufferedAppendable

Force all flushed data to be persisted to permanent storage. Will consistently and atomically persist the last prepared checkpoint in implementations that implement BufferedAppendable.prepareCheckpoint(). Does not imply BufferedAppendable.flush(), as this is a distinct operation in all implementations. May be called concurrently by threads other than the "writing thread".

Specified by:

force in interface AppendableColumn<DATA_TYPE>

Specified by:

force in interface BufferedAppendable

close

public void close()

Description copied from interface: BufferedAppendable

Flush all appended data to the underlying store, release any resources held, and force all appended data to be persisted to permanent storage. This should be the final access to this appendable (if successful) with the exception of any asynchronous BufferedAppendable.force() operations. A BufferedAppendable.release() is appropriate afterwards, especially on error.

Specified by:

close in interface AppendableColumn<DATA_TYPE>

Specified by:

close in interface BufferedAppendable

flush

public void flush()

Description copied from interface: BufferedAppendable

Write all appended data to the underlying store and prepare for subsequent writes. Does not imply BufferedAppendable.force().

Specified by:

flush in interface BufferedAppendable

release

public void release()

Description copied from interface: BufferedAppendable

Release any resources held. Called after an error in preparation for termination. For external callers, this should be done as the final access to this column with the exception of any asynchronous BufferedAppendable.force() operations.

Specified by:

release in interface BufferedAppendable

inTransaction

public boolean inTransaction()

Specified by:

inTransaction in interface TableTransactionProcessor

Returns:

True if this processor is currently in a transaction, else false

startTransaction

public void startTransaction()

Description copied from interface: TableTransactionProcessor

Begin a new transaction. Causes any existing pending transaction to be aborted.

Specified by:

startTransaction in interface TableTransactionProcessor

abortTransaction

public void abortTransaction()

Description copied from interface: TableTransactionProcessor

Abort the current pending transaction.

This should not be called if there is no current transaction.

Specified by:

abortTransaction in interface TableTransactionProcessor

finishTransaction

public void finishTransaction()

Description copied from interface: TableTransactionProcessor

Finish the current pending transaction.

This makes the rows that were part of the transaction eligible to be made visible and durable, but does not in itself make them visible or durable.

This should not be called if there is no current transaction.

Specified by:

finishTransaction in interface TableTransactionProcessor

addByte

public void addByte(byte value)

Description copied from interface: AppendableColumn

Append a byte to this column.

Specified by:

addByte in interface AppendableColumn<DATA_TYPE>

Parameters:

value - The value to append

addChar

public void addChar(char value)

Description copied from interface: AppendableColumn

Append a char to this column.

Specified by:

addChar in interface AppendableColumn<DATA_TYPE>

Parameters:

value - The value to append

addDouble

public void addDouble(double value)

Description copied from interface: AppendableColumn

Append a double to this column.

Specified by:

addDouble in interface AppendableColumn<DATA_TYPE>

Parameters:

value - The value to append

addFloat

public void addFloat(float value)

Description copied from interface: AppendableColumn

Append a float to this column.

Specified by:

addFloat in interface AppendableColumn<DATA_TYPE>

Parameters:

value - The value to append

addInt

public void addInt(int value)

Description copied from interface: AppendableColumn

Append a int to this column.

Specified by:

addInt in interface AppendableColumn<DATA_TYPE>

Parameters:

value - The value to append

addLong

public void addLong(long value)

Description copied from interface: AppendableColumn

Append a long to this column.

Specified by:

addLong in interface AppendableColumn<DATA_TYPE>

Parameters:

value - The value to append

addShort

public void addShort(short value)

Description copied from interface: AppendableColumn

Append a short to this column.

Specified by:

addShort in interface AppendableColumn<DATA_TYPE>

Parameters:

value - The value to append

addBytes

public void addBytes(@NotNull
                     byte[] values,
                     int startIndex,
                     int length)

Description copied from interface: AppendableColumn

Add byte values from an array.

Specified by:

addBytes in interface AppendableColumn<DATA_TYPE>

Parameters:

values - The array of values

startIndex - The index of the first value to add

length - The total number of values to add

addBytes

public void addBytes(@NotNull
                     ByteBuffer inputBuffer)

Description copied from interface: AppendableColumn

Add byte values from a ByteBuffer, starting at buffer.position() and continuing to buffer.limit().

Specified by:

addBytes in interface AppendableColumn<DATA_TYPE>

Parameters:

inputBuffer - The buffer

addChars

public void addChars(@NotNull
                     char[] values,
                     int startIndex,
                     int length)

Description copied from interface: AppendableColumn

Add char values from an array.

Specified by:

addChars in interface AppendableColumn<DATA_TYPE>

Parameters:

values - The array of values

startIndex - The index of the first value to add

length - The total number of values to add

addDoubles

public void addDoubles(@NotNull
                       double[] values,
                       int startIndex,
                       int length)

Description copied from interface: AppendableColumn

Add double values from an array.

Specified by:

addDoubles in interface AppendableColumn<DATA_TYPE>

Parameters:

values - The array of values

startIndex - The index of the first value to add

length - The total number of values to add

addFloats

public void addFloats(@NotNull
                      float[] values,
                      int startIndex,
                      int length)

Description copied from interface: AppendableColumn

Add float values from an array.

Specified by:

addFloats in interface AppendableColumn<DATA_TYPE>

Parameters:

values - The array of values

startIndex - The index of the first value to add

length - The total number of values to add

addInts

public void addInts(@NotNull
                    int[] values,
                    int startIndex,
                    int length)

Description copied from interface: AppendableColumn

Add int values from an array.

Specified by:

addInts in interface AppendableColumn<DATA_TYPE>

Parameters:

values - The array of values

startIndex - The index of the first value to add

length - The total number of values to add

addLongs

public void addLongs(@NotNull
                     long[] values,
                     int startIndex,
                     int length)

Description copied from interface: AppendableColumn

Add long values from an array.

Specified by:

addLongs in interface AppendableColumn<DATA_TYPE>

Parameters:

values - The array of values

startIndex - The index of the first value to add

length - The total number of values to add

addShorts

public void addShorts(@NotNull
                      short[] values,
                      int startIndex,
                      int length)

Description copied from interface: AppendableColumn

Add short values from an array.

Specified by:

addShorts in interface AppendableColumn<DATA_TYPE>

Parameters:

values - The array of values

startIndex - The index of the first value to add

length - The total number of values to add