com.pcbsys.nirvana.client.nConflationAttributes Class Reference

This class represents the conflation attributes that can be used when creating resources which allow conflation. More...

Public Member Functions

virtual int getAction ()
 This can be either Drop or Merge More...
 
virtual long getInterval ()
 The time that the configured resource will conflate events More...
 
 nConflationAttributes (long interval)
 Creates a conflation attributes object defaulting the action to merging of events within the conflation interval More...
 
 nConflationAttributes (int action, long interval)
 Creates a conflation attribute specifying the action as either drop or merge within the time interval specified More...
 

Data Fields

const int sDropEvents = 0
 Used in the constructor of nConflationAttributes to represent that action that should be taken during the conflation interval More...
 
const int sMergeEvents = 1
 Used in the constructor of nConflationAttributes to represent that action that should be taken during the conflation interval More...
 

Detailed Description

This class represents the conflation attributes that can be used when creating resources which allow conflation.

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nConflationAttributes.nConflationAttributes ( long  interval)

Creates a conflation attributes object defaulting the action to merging of events within the conflation interval

Parameters
intervaltime in milliseconds that events will be conflated
com.pcbsys.nirvana.client.nConflationAttributes.nConflationAttributes ( int  action,
long  interval 
)

Creates a conflation attribute specifying the action as either drop or merge within the time interval specified

Parameters
actionSet the action to either drop or merge events
intervaltime in milliseconds that events will be conflated
Exceptions
nIllegalArgumentException

Member Function Documentation

virtual int com.pcbsys.nirvana.client.nConflationAttributes.getAction ( )
virtual

This can be either Drop or Merge

Returns
the configured action
virtual long com.pcbsys.nirvana.client.nConflationAttributes.getInterval ( )
virtual

The time that the configured resource will conflate events

Returns
time in milliseconds

Field Documentation

const int com.pcbsys.nirvana.client.nConflationAttributes.sDropEvents = 0

Used in the constructor of nConflationAttributes to represent that action that should be taken during the conflation interval

const int com.pcbsys.nirvana.client.nConflationAttributes.sMergeEvents = 1

Used in the constructor of nConflationAttributes to represent that action that should be taken during the conflation interval