co.cask.tephra.persist

Class TransactionEdit

java.lang.Object

co.cask.tephra.persist.TransactionEdit

All Implemented Interfaces:

org.apache.hadoop.io.Writable

public class TransactionEdit
extends Object
implements org.apache.hadoop.io.Writable

Represents a transaction state change in the TransactionLog.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransactionEdit.State The possible state changes for a transaction.

Constructor Summary

Constructors

Constructor and Description
TransactionEdit()

Method Summary

Methods

Modifier and Type	Method and Description
static TransactionEdit	createAborted(long writePointer, TransactionType type, long[] checkpointPointers) Creates a new instance in the TransactionEdit.State.ABORTED state.
static TransactionEdit	createCheckpoint(long writePointer, long parentWritePointer) Creates a new instance in the TransactionEdit.State.CHECKPOINT state.
static TransactionEdit	createCommitted(long writePointer, Set<ChangeId> changes, long nextWritePointer, boolean canCommit) Creates a new instance in the TransactionEdit.State.COMMITTED state.
static TransactionEdit	createCommitting(long writePointer, Set<ChangeId> changes) Creates a new instance in the TransactionEdit.State.COMMITTING state.
static TransactionEdit	createInvalid(long writePointer) Creates a new instance in the TransactionEdit.State.INVALID state.
static TransactionEdit	createMoveWatermark(long writePointer) Creates a new instance in the TransactionEdit.State.MOVE_WATERMARK state.
static TransactionEdit	createStarted(long writePointer, long visibilityUpperBound, long expirationDate, TransactionType type) Creates a new instance in the TransactionEdit.State.INPROGRESS state.
static TransactionEdit	createTruncateInvalidTx(Set<Long> truncateInvalidTx) Creates a new instance in the TransactionEdit.State.TRUNCATE_INVALID_TX state.
static TransactionEdit	createTruncateInvalidTxBefore(long truncateInvalidTxTime) Creates a new instance in the TransactionEdit.State.TRUNCATE_INVALID_TX state.
boolean	equals(Object o)
boolean	getCanCommit() Returns whether or not the transaction should be moved to the committed set.
Set<ChangeId>	getChanges()
long[]	getCheckpointPointers() Returns the checkpoint write pointers for the edit.
long	getCommitPointer() Returns the write pointer used to commit the row key change set.
long	getExpiration() Returns any expiration timestamp (in milliseconds) associated with the state change.
long	getParentWritePointer() Returns the parent write pointer for a checkpoint operation.
TransactionEdit.State	getState() Returns the type of state change represented.
Set<Long>	getTruncateInvalidTx() Returns the transaction ids to be removed from invalid transaction list.
long	getTruncateInvalidTxTime() Returns the time until which the invalid transactions need to be truncated from invalid transaction list.
TransactionType	getType() Returns the transaction type.
long	getVisibilityUpperBound()
long	getWritePointer() Returns the transaction write pointer assigned for the state change.
int	hashCode()
void	readFields(DataInput in)
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionEdit

public TransactionEdit()

Method Detail

getWritePointer

public long getWritePointer()

Returns the transaction write pointer assigned for the state change.

getVisibilityUpperBound

public long getVisibilityUpperBound()

getState

public TransactionEdit.State getState()

Returns the type of state change represented.

getExpiration

public long getExpiration()

Returns any expiration timestamp (in milliseconds) associated with the state change. This should only be populated for changes of type TransactionEdit.State.INPROGRESS.

getChanges

public Set<ChangeId> getChanges()

Returns:

the set of changed row keys associated with the state change. This is only populated for edits of type TransactionEdit.State.COMMITTING or TransactionEdit.State.COMMITTED.

getCommitPointer

public long getCommitPointer()

Returns the write pointer used to commit the row key change set. This is only populated for edits of type TransactionEdit.State.COMMITTED.

getCanCommit

public boolean getCanCommit()

Returns whether or not the transaction should be moved to the committed set. This is only populated for edits of type TransactionEdit.State.COMMITTED.

getType

public TransactionType getType()

Returns the transaction type. This is only populated for edits of type TransactionEdit.State.INPROGRESS or TransactionEdit.State.ABORTED.

getTruncateInvalidTx

public Set<Long> getTruncateInvalidTx()

Returns the transaction ids to be removed from invalid transaction list. This is only populated for edits of type TransactionEdit.State.TRUNCATE_INVALID_TX

getTruncateInvalidTxTime

public long getTruncateInvalidTxTime()

Returns the time until which the invalid transactions need to be truncated from invalid transaction list. This is only populated for edits of type TransactionEdit.State.TRUNCATE_INVALID_TX

getParentWritePointer

public long getParentWritePointer()

Returns the parent write pointer for a checkpoint operation. This is only populated for edits of type TransactionEdit.State.CHECKPOINT

getCheckpointPointers

public long[] getCheckpointPointers()

Returns the checkpoint write pointers for the edit. This is only populated for edits of type TransactionEdit.State.ABORTED.

createStarted

public static TransactionEdit createStarted(long writePointer,
                            long visibilityUpperBound,
                            long expirationDate,
                            TransactionType type)

Creates a new instance in the TransactionEdit.State.INPROGRESS state.

createCommitting

public static TransactionEdit createCommitting(long writePointer,
                               Set<ChangeId> changes)

Creates a new instance in the TransactionEdit.State.COMMITTING state.

createCommitted

public static TransactionEdit createCommitted(long writePointer,
                              Set<ChangeId> changes,
                              long nextWritePointer,
                              boolean canCommit)

Creates a new instance in the TransactionEdit.State.COMMITTED state.

createAborted

public static TransactionEdit createAborted(long writePointer,
                            TransactionType type,
                            long[] checkpointPointers)

Creates a new instance in the TransactionEdit.State.ABORTED state.

createInvalid

public static TransactionEdit createInvalid(long writePointer)

Creates a new instance in the TransactionEdit.State.INVALID state.

createMoveWatermark

public static TransactionEdit createMoveWatermark(long writePointer)

Creates a new instance in the TransactionEdit.State.MOVE_WATERMARK state.

createTruncateInvalidTx

public static TransactionEdit createTruncateInvalidTx(Set<Long> truncateInvalidTx)

Creates a new instance in the TransactionEdit.State.TRUNCATE_INVALID_TX state.

createTruncateInvalidTxBefore

public static TransactionEdit createTruncateInvalidTxBefore(long truncateInvalidTxTime)

Creates a new instance in the TransactionEdit.State.TRUNCATE_INVALID_TX state.

createCheckpoint

public static TransactionEdit createCheckpoint(long writePointer,
                               long parentWritePointer)

Creates a new instance in the TransactionEdit.State.CHECKPOINT state.

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object