AbstractWriter (GemFire XD Java API Documentation)

java.lang.Object
- util.AbstractWriter

Direct Known Subclasses:

BWCTestWriter, CMWriter, ConverterWriter, ETWriter, GemFireDBWriter, GemFireTxWriter, ImportWriter, JtaDBWriter, JtaTxWriter, LogWriter, MixedRegionWriter, TestWriter, TxLogWriter, TxWriter
```
public abstract class AbstractWriter
extends Object
```
An abstract writer class that provides methods to subclasses for logging events, incrementing counters for invoked events, and keeping information about the VM where the writer was created.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`CntrName_BeforeCreate_isDist` To use counter increment methods defined in this class, the blackboard that is passed to the increment method must have counters defined with these names, such as util.WriterCountersBB.java
`String`	`CntrName_BeforeCreate_isExp`
`String`	`CntrName_BeforeCreate_isLoad`
`String`	`CntrName_BeforeCreate_isLocalLoad`
`String`	`CntrName_BeforeCreate_isNetLoad`
`String`	`CntrName_BeforeCreate_isNetSearch`
`String`	`CntrName_BeforeCreate_isNotDist`
`String`	`CntrName_BeforeCreate_isNotExp`
`String`	`CntrName_BeforeCreate_isNotLoad`
`String`	`CntrName_BeforeCreate_isNotLocalLoad`
`String`	`CntrName_BeforeCreate_isNotNetLoad`
`String`	`CntrName_BeforeCreate_isNotNetSearch`
`String`	`CntrName_BeforeCreate_isNotRemote`
`String`	`CntrName_BeforeCreate_isRemote`
`String`	`CntrName_BeforeDestroy_isDist`
`String`	`CntrName_BeforeDestroy_isExp`
`String`	`CntrName_BeforeDestroy_isLoad`
`String`	`CntrName_BeforeDestroy_isLocalLoad`
`String`	`CntrName_BeforeDestroy_isNetLoad`
`String`	`CntrName_BeforeDestroy_isNetSearch`
`String`	`CntrName_BeforeDestroy_isNotDist`
`String`	`CntrName_BeforeDestroy_isNotExp`
`String`	`CntrName_BeforeDestroy_isNotLoad`
`String`	`CntrName_BeforeDestroy_isNotLocalLoad`
`String`	`CntrName_BeforeDestroy_isNotNetLoad`
`String`	`CntrName_BeforeDestroy_isNotNetSearch`
`String`	`CntrName_BeforeDestroy_isNotRemote`
`String`	`CntrName_BeforeDestroy_isRemote`
`String`	`CntrName_BeforeRegionClear_isDist`
`String`	`CntrName_BeforeRegionClear_isExp`
`String`	`CntrName_BeforeRegionClear_isNotDist`
`String`	`CntrName_BeforeRegionClear_isNotExp`
`String`	`CntrName_BeforeRegionClear_isNotRemote`
`String`	`CntrName_BeforeRegionClear_isRemote`
`String`	`CntrName_BeforeRegionDestroy_isDist`
`String`	`CntrName_BeforeRegionDestroy_isExp`
`String`	`CntrName_BeforeRegionDestroy_isNotDist`
`String`	`CntrName_BeforeRegionDestroy_isNotExp`
`String`	`CntrName_BeforeRegionDestroy_isNotRemote`
`String`	`CntrName_BeforeRegionDestroy_isRemote`
`String`	`CntrName_BeforeUpdate_isDist`
`String`	`CntrName_BeforeUpdate_isExp`
`String`	`CntrName_BeforeUpdate_isLoad`
`String`	`CntrName_BeforeUpdate_isLocalLoad`
`String`	`CntrName_BeforeUpdate_isNetLoad`
`String`	`CntrName_BeforeUpdate_isNetSearch`
`String`	`CntrName_BeforeUpdate_isNotDist`
`String`	`CntrName_BeforeUpdate_isNotExp`
`String`	`CntrName_BeforeUpdate_isNotLoad`
`String`	`CntrName_BeforeUpdate_isNotLocalLoad`
`String`	`CntrName_BeforeUpdate_isNotNetLoad`
`String`	`CntrName_BeforeUpdate_isNotNetSearch`
`String`	`CntrName_BeforeUpdate_isNotRemote`
`String`	`CntrName_BeforeUpdate_isRemote`
`int`	`whereIWasRegistered` The process ID of the VM that created this writer

Constructor Summary

Constructors
Constructor and Description

AbstractWriter()
Constructor

Constructors
Constructor and Description
`AbstractWriter()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getNewValueStr(com.gemstone.gemfire.cache.EntryEvent eEvent)`
`String`	`getOldValueStr(com.gemstone.gemfire.cache.EntryEvent eEvent)`
`void`	`incrementBeforeCreateCounters(com.gemstone.gemfire.cache.EntryEvent event, Blackboard bb)` Increment appropriate blackboard counters for a beforeCreate event
`void`	`incrementBeforeDestroyCounters(com.gemstone.gemfire.cache.EntryEvent event, Blackboard bb)` Increment appropriate blackboard counters for a beforeDestroy event
`void`	`incrementBeforeRegionClearCounters(com.gemstone.gemfire.cache.RegionEvent event, Blackboard bb)` Increment appropriate blackboard counters for a beforeRegionClear event
`void`	`incrementBeforeRegionDestroyCounters(com.gemstone.gemfire.cache.RegionEvent event, Blackboard bb)` Increment appropriate blackboard counters for a beforeRegionDestroy event
`void`	`incrementBeforeUpdateCounters(com.gemstone.gemfire.cache.EntryEvent event, Blackboard bb)` Increment appropriate blackboard counters for a beforeUpdate event
`String`	`logCall(String methodName, com.gemstone.gemfire.cache.CacheEvent event)` Log that an event occurred.
`String`	`logTxEvent(String methodName, com.gemstone.gemfire.cache.TransactionEvent event)` Log that a transaction event occurred.
`String`	`toString(String methodName, com.gemstone.gemfire.cache.CacheEvent event)` Return a string description of the event.
`String`	`toString(String methodName, com.gemstone.gemfire.cache.TransactionEvent event)` Return a string description of the TransactionEvent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CntrName_BeforeCreate_isDist
```
public final String CntrName_BeforeCreate_isDist
```
    To use counter increment methods defined in this class, the blackboard that is passed to the increment method must have counters defined with these names, such as util.WriterCountersBB.java
    
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isNotDist
```
public final String CntrName_BeforeCreate_isNotDist
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isExp
```
public final String CntrName_BeforeCreate_isExp
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isNotExp
```
public final String CntrName_BeforeCreate_isNotExp
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isRemote
```
public final String CntrName_BeforeCreate_isRemote
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isNotRemote
```
public final String CntrName_BeforeCreate_isNotRemote
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isLoad
```
public final String CntrName_BeforeCreate_isLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isNotLoad
```
public final String CntrName_BeforeCreate_isNotLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isLocalLoad
```
public final String CntrName_BeforeCreate_isLocalLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isNotLocalLoad
```
public final String CntrName_BeforeCreate_isNotLocalLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isNetLoad
```
public final String CntrName_BeforeCreate_isNetLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isNotNetLoad
```
public final String CntrName_BeforeCreate_isNotNetLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isNetSearch
```
public final String CntrName_BeforeCreate_isNetSearch
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeCreate_isNotNetSearch
```
public final String CntrName_BeforeCreate_isNotNetSearch
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isDist
```
public final String CntrName_BeforeDestroy_isDist
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isNotDist
```
public final String CntrName_BeforeDestroy_isNotDist
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isExp
```
public final String CntrName_BeforeDestroy_isExp
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isNotExp
```
public final String CntrName_BeforeDestroy_isNotExp
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isRemote
```
public final String CntrName_BeforeDestroy_isRemote
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isNotRemote
```
public final String CntrName_BeforeDestroy_isNotRemote
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isLoad
```
public final String CntrName_BeforeDestroy_isLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isNotLoad
```
public final String CntrName_BeforeDestroy_isNotLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isLocalLoad
```
public final String CntrName_BeforeDestroy_isLocalLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isNotLocalLoad
```
public final String CntrName_BeforeDestroy_isNotLocalLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isNetLoad
```
public final String CntrName_BeforeDestroy_isNetLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isNotNetLoad
```
public final String CntrName_BeforeDestroy_isNotNetLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isNetSearch
```
public final String CntrName_BeforeDestroy_isNetSearch
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeDestroy_isNotNetSearch
```
public final String CntrName_BeforeDestroy_isNotNetSearch
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isDist
```
public final String CntrName_BeforeUpdate_isDist
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isNotDist
```
public final String CntrName_BeforeUpdate_isNotDist
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isExp
```
public final String CntrName_BeforeUpdate_isExp
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isNotExp
```
public final String CntrName_BeforeUpdate_isNotExp
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isRemote
```
public final String CntrName_BeforeUpdate_isRemote
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isNotRemote
```
public final String CntrName_BeforeUpdate_isNotRemote
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isLoad
```
public final String CntrName_BeforeUpdate_isLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isNotLoad
```
public final String CntrName_BeforeUpdate_isNotLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isLocalLoad
```
public final String CntrName_BeforeUpdate_isLocalLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isNotLocalLoad
```
public final String CntrName_BeforeUpdate_isNotLocalLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isNetLoad
```
public final String CntrName_BeforeUpdate_isNetLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isNotNetLoad
```
public final String CntrName_BeforeUpdate_isNotNetLoad
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isNetSearch
```
public final String CntrName_BeforeUpdate_isNetSearch
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeUpdate_isNotNetSearch
```
public final String CntrName_BeforeUpdate_isNotNetSearch
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionDestroy_isDist
```
public final String CntrName_BeforeRegionDestroy_isDist
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionDestroy_isNotDist
```
public final String CntrName_BeforeRegionDestroy_isNotDist
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionDestroy_isExp
```
public final String CntrName_BeforeRegionDestroy_isExp
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionDestroy_isNotExp
```
public final String CntrName_BeforeRegionDestroy_isNotExp
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionDestroy_isRemote
```
public final String CntrName_BeforeRegionDestroy_isRemote
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionDestroy_isNotRemote
```
public final String CntrName_BeforeRegionDestroy_isNotRemote
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionClear_isDist
```
public final String CntrName_BeforeRegionClear_isDist
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionClear_isNotDist
```
public final String CntrName_BeforeRegionClear_isNotDist
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionClear_isExp
```
public final String CntrName_BeforeRegionClear_isExp
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionClear_isNotExp
```
public final String CntrName_BeforeRegionClear_isNotExp
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionClear_isRemote
```
public final String CntrName_BeforeRegionClear_isRemote
```
    See Also:
    
    Constant Field Values
  - CntrName_BeforeRegionClear_isNotRemote
```
public final String CntrName_BeforeRegionClear_isNotRemote
```
    See Also:
    
    Constant Field Values
  - whereIWasRegistered
```
public int whereIWasRegistered
```
    The process ID of the VM that created this writer
- Constructor Detail
  - AbstractWriter
```
public AbstractWriter()
```
    Constructor
- Method Detail
  - toString
```
public String toString(String methodName,
                       com.gemstone.gemfire.cache.CacheEvent event)
```
    Return a string description of the event.
    
    Parameters:
    
    methodName - The name of the CacheEvent method that was invoked.
    
    event - The event object that was passed to the event.
    
    Returns:
    
    A String description of the invoked event.
  - getOldValueStr
```
public String getOldValueStr(com.gemstone.gemfire.cache.EntryEvent eEvent)
```
    Parameters:
    
    eEvent -
    
    Returns:
  - getNewValueStr
```
public String getNewValueStr(com.gemstone.gemfire.cache.EntryEvent eEvent)
```
    Returns:
  - toString
```
public String toString(String methodName,
                       com.gemstone.gemfire.cache.TransactionEvent event)
```
    Return a string description of the TransactionEvent.
    
    Parameters:
    
    methodName - The name of the TransactionEvent method that was invoked.
    
    event - The TransactionEvent object that was passed to the Transaction Writer.
    
    Returns:
    
    A String description of the invoked transaction event.
  - logTxEvent
```
public String logTxEvent(String methodName,
                         com.gemstone.gemfire.cache.TransactionEvent event)
```
    Log that a transaction event occurred.
    
    Parameters:
    
    methodName - The name of the TransactionEvent method that was invoked. (beforeCommit)
    
    event - The TransactionEvent object that was passed to the event.
  - logCall
```
public String logCall(String methodName,
                      com.gemstone.gemfire.cache.CacheEvent event)
```
    Log that an event occurred.
    
    Parameters:
    
    methodName - The name of the CacheEvent method that was invoked.
    
    event - The event object that was passed to the event.
  - incrementBeforeCreateCounters
```
public void incrementBeforeCreateCounters(com.gemstone.gemfire.cache.EntryEvent event,
                                          Blackboard bb)
```
    Increment appropriate blackboard counters for a beforeCreate event
    
    Parameters:
    
    event - The event object for this event.
    
    bb - Any blackboard object containing event counters with names specified by the names defined in this class.
  - incrementBeforeDestroyCounters
```
public void incrementBeforeDestroyCounters(com.gemstone.gemfire.cache.EntryEvent event,
                                           Blackboard bb)
```
    Increment appropriate blackboard counters for a beforeDestroy event
    
    Parameters:
    
    event - The event object for this event.
    
    bb - Any blackboard object containing event counters with names specified by the names defined in this class.
  - incrementBeforeUpdateCounters
```
public void incrementBeforeUpdateCounters(com.gemstone.gemfire.cache.EntryEvent event,
                                          Blackboard bb)
```
    Increment appropriate blackboard counters for a beforeUpdate event
    
    Parameters:
    
    event - The event object for this event.
    
    bb - Any blackboard object containing event counters with names specified by the names defined in this class.
  - incrementBeforeRegionDestroyCounters
```
public void incrementBeforeRegionDestroyCounters(com.gemstone.gemfire.cache.RegionEvent event,
                                                 Blackboard bb)
```
    Increment appropriate blackboard counters for a beforeRegionDestroy event
    
    Parameters:
    
    event - The event object for this event.
    
    bb - Any blackboard object containing event counters with names specified by the names defined in this class.
  - incrementBeforeRegionClearCounters
```
public void incrementBeforeRegionClearCounters(com.gemstone.gemfire.cache.RegionEvent event,
                                               Blackboard bb)
```
    Increment appropriate blackboard counters for a beforeRegionClear event
    
    Parameters:
    
    event - The event object for this event.
    
    bb - Any blackboard object containing event counters with names specified by the names defined in this class.

Class AbstractWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CntrName_BeforeCreate_isDist

CntrName_BeforeCreate_isNotDist

CntrName_BeforeCreate_isExp

CntrName_BeforeCreate_isNotExp

CntrName_BeforeCreate_isRemote

CntrName_BeforeCreate_isNotRemote

CntrName_BeforeCreate_isLoad

CntrName_BeforeCreate_isNotLoad

CntrName_BeforeCreate_isLocalLoad

CntrName_BeforeCreate_isNotLocalLoad

CntrName_BeforeCreate_isNetLoad

CntrName_BeforeCreate_isNotNetLoad

CntrName_BeforeCreate_isNetSearch

CntrName_BeforeCreate_isNotNetSearch

CntrName_BeforeDestroy_isDist

CntrName_BeforeDestroy_isNotDist

CntrName_BeforeDestroy_isExp

CntrName_BeforeDestroy_isNotExp

CntrName_BeforeDestroy_isRemote

CntrName_BeforeDestroy_isNotRemote

CntrName_BeforeDestroy_isLoad

CntrName_BeforeDestroy_isNotLoad

CntrName_BeforeDestroy_isLocalLoad

CntrName_BeforeDestroy_isNotLocalLoad

CntrName_BeforeDestroy_isNetLoad

CntrName_BeforeDestroy_isNotNetLoad

CntrName_BeforeDestroy_isNetSearch

CntrName_BeforeDestroy_isNotNetSearch

CntrName_BeforeUpdate_isDist

CntrName_BeforeUpdate_isNotDist

CntrName_BeforeUpdate_isExp

CntrName_BeforeUpdate_isNotExp

CntrName_BeforeUpdate_isRemote

CntrName_BeforeUpdate_isNotRemote

CntrName_BeforeUpdate_isLoad

CntrName_BeforeUpdate_isNotLoad

CntrName_BeforeUpdate_isLocalLoad

CntrName_BeforeUpdate_isNotLocalLoad

CntrName_BeforeUpdate_isNetLoad

CntrName_BeforeUpdate_isNotNetLoad

CntrName_BeforeUpdate_isNetSearch

CntrName_BeforeUpdate_isNotNetSearch

CntrName_BeforeRegionDestroy_isDist

CntrName_BeforeRegionDestroy_isNotDist

CntrName_BeforeRegionDestroy_isExp

CntrName_BeforeRegionDestroy_isNotExp

CntrName_BeforeRegionDestroy_isRemote

CntrName_BeforeRegionDestroy_isNotRemote

CntrName_BeforeRegionClear_isDist

CntrName_BeforeRegionClear_isNotDist

CntrName_BeforeRegionClear_isExp

CntrName_BeforeRegionClear_isNotExp

CntrName_BeforeRegionClear_isRemote

CntrName_BeforeRegionClear_isNotRemote

whereIWasRegistered

Constructor Detail

AbstractWriter

Method Detail

toString

getOldValueStr

getNewValueStr

toString

logTxEvent

logCall

incrementBeforeCreateCounters

incrementBeforeDestroyCounters

incrementBeforeUpdateCounters

incrementBeforeRegionDestroyCounters

incrementBeforeRegionClearCounters