com.continuent.tungsten.replicator.event
Class DBMSEvent

java.lang.Object
  extended by com.continuent.tungsten.replicator.event.DBMSEvent
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
DBMSEmptyEvent

public class DBMSEvent
extends java.lang.Object
implements java.io.Serializable

Contains SQL row updates and/or statements that must be replicated. Extractors generate updates using this class and appliers receive updates in it. Each instance is implicitly a single transaction.

Version:
1.0
Author:
Teemu Ollakka
See Also:
Serialized Form

Constructor Summary
DBMSEvent()
          Constructor for dummy DBMSEvents.
DBMSEvent(java.lang.String id)
          Constructor for dummy DBMSEvent with an event ID only; all other values are defaults
DBMSEvent(java.lang.String id, java.util.ArrayList<DBMSData> data, boolean lastFrag, java.sql.Timestamp sourceTstamp)
           
DBMSEvent(java.lang.String id, java.util.ArrayList<DBMSData> data, java.sql.Timestamp sourceTstamp)
           
DBMSEvent(java.lang.String id, java.util.LinkedList<ReplOption> metadata, java.util.ArrayList<DBMSData> data, boolean lastFrag, java.sql.Timestamp sourceTstamp)
          Creates a new instance of raw replicated data.
DBMSEvent(java.lang.String id, java.util.LinkedList<ReplOption> metadata, java.util.ArrayList<DBMSData> data, java.sql.Timestamp sourceTstamp)
           
 
Method Summary
 void addMetadataOption(java.lang.String name, java.lang.String value)
          Adds a metadata option, which is assumed not to exist previously.
 void addOption(java.lang.String name, java.lang.String value)
           
 java.util.ArrayList<DBMSData> getData()
          Returns all database updates.
 java.lang.String getEventId()
          Returns the native event ID.
 java.util.LinkedList<ReplOption> getMetadata()
          Returns the metadata options.
 ReplOption getMetadataOption(java.lang.String name)
          Gets a metadata option.
 java.lang.String getMetadataOptionValue(java.lang.String name)
          Gets a metadata value..
 java.util.List<ReplOption> getOptions()
           
 java.sql.Timestamp getSourceTstamp()
          Returns the source timestamp, i.e., when the transaction occurred.
 boolean isLastFrag()
          Returns true if this is the last fragment of a transaction.
 void setMetaDataOption(java.lang.String name, java.lang.String value)
          Sets an existing metadata option or if absent adds it.
 void setOptions(java.util.LinkedList<ReplOption> savedOptions)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DBMSEvent

public DBMSEvent(java.lang.String id,
                 java.util.LinkedList<ReplOption> metadata,
                 java.util.ArrayList<DBMSData> data,
                 boolean lastFrag,
                 java.sql.Timestamp sourceTstamp)
Creates a new instance of raw replicated data.

Parameters:
id - Native transaction ID
metadata - List of name/value pairs containing metadata about this event
data - List of SQL statements or row updates
lastFrag - True if this is the last fragment of a transaction
sourceTstamp - Time of the transaction

DBMSEvent

public DBMSEvent(java.lang.String id,
                 java.util.ArrayList<DBMSData> data,
                 java.sql.Timestamp sourceTstamp)

DBMSEvent

public DBMSEvent(java.lang.String id,
                 java.util.ArrayList<DBMSData> data,
                 boolean lastFrag,
                 java.sql.Timestamp sourceTstamp)

DBMSEvent

public DBMSEvent(java.lang.String id,
                 java.util.LinkedList<ReplOption> metadata,
                 java.util.ArrayList<DBMSData> data,
                 java.sql.Timestamp sourceTstamp)

DBMSEvent

public DBMSEvent(java.lang.String id)
Constructor for dummy DBMSEvent with an event ID only; all other values are defaults


DBMSEvent

public DBMSEvent()
Constructor for dummy DBMSEvents. All values are defaults.

Method Detail

getEventId

public java.lang.String getEventId()
Returns the native event ID.

Returns:
id

getMetadata

public java.util.LinkedList<ReplOption> getMetadata()
Returns the metadata options.

Returns:
metadata

addMetadataOption

public void addMetadataOption(java.lang.String name,
                              java.lang.String value)
Adds a metadata option, which is assumed not to exist previously.


setMetaDataOption

public void setMetaDataOption(java.lang.String name,
                              java.lang.String value)
Sets an existing metadata option or if absent adds it.


getMetadataOption

public ReplOption getMetadataOption(java.lang.String name)
Gets a metadata option.


getMetadataOptionValue

public java.lang.String getMetadataOptionValue(java.lang.String name)
Gets a metadata value..


getData

public java.util.ArrayList<DBMSData> getData()
Returns all database updates.

Returns:
data

isLastFrag

public boolean isLastFrag()
Returns true if this is the last fragment of a transaction.


getSourceTstamp

public java.sql.Timestamp getSourceTstamp()
Returns the source timestamp, i.e., when the transaction occurred.

Returns:
Returns the sourceTstamp.

setOptions

public void setOptions(java.util.LinkedList<ReplOption> savedOptions)

getOptions

public java.util.List<ReplOption> getOptions()

addOption

public void addOption(java.lang.String name,
                      java.lang.String value)