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

int getAction ()
 This can be either Drop or Merge. More...
 
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) throws nIllegalArgumentException
 Creates a conflation attribute specifying the action as either drop or merge within the time interval specified. More...
 

Static Public Attributes

static final int sDropEvents = 0
 used in the constructor of nConflationAttributes to represent that action that should be taken during the conflation interval
 
static final int sMergeEvents = 1
 used in the constructor of nConflationAttributes to represent that action that should be taken during the conflation interval
 

Protected Member Functions

void setAction (int action) throws nIllegalArgumentException
 Sets the action for this conflation attribute. 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 
) throws nIllegalArgumentException

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
nIllegalArgumentExceptionif conflation action is illegal

Member Function Documentation

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

This can be either Drop or Merge.

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

The time that the configured resource will conflate events.

Returns
time in milliseconds
void com.pcbsys.nirvana.client.nConflationAttributes.setAction ( int  action) throws nIllegalArgumentException
protected

Sets the action for this conflation attribute.

Parameters
actionto use to set
Exceptions
nIllegalArgumentExceptionif conflation action is illegal