Aggregation

java.lang.Object
- org.qbroker.jms.Aggregation

```
public class Aggregation
extends java.lang.Object
```
Aggregation contains a list of stateless operations for aggregations on the properties retrieved from either JMS messages or Events. The aggregation process will not touch the message body due to its different data types. For aggregation on the message body, Aggregation provides a bunch of assistant methods, such as merge(), and stores the aggregation map with various policies and operations. Together, they can be used to aggregate the message body externally.

In case of average, AveragedOver is required. Its referenced name should be defined before it. In case of standard deviation, VarianceOf is requires. Its referenced name should be defined before it. In case of max or min or first, the name of the field does not have to exist in the incoming message. But the referenced name by MaxOf or MinOf or FirstOf must be defined before it. If TimePattern is defined for max or min, Aggregation will parse the value to get the timestamp for comparisons.

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AGGR_APPEND`
`static int`	`AGGR_AVG`
`static int`	`AGGR_COUNT`
`static int`	`AGGR_END`
`static int`	`AGGR_FIRST`
`static int`	`AGGR_JOIN`
`static int`	`AGGR_LAST`
`static int`	`AGGR_MAX`
`static int`	`AGGR_MERGE`
`static int`	`AGGR_MIN`
`static int`	`AGGR_NONE`
`static int`	`AGGR_STD`
`static int`	`AGGR_SUM`
`static int`	`AGGR_UNION`
`static int`	`AGGR_XUNION`

Constructor Summary

Constructors
Constructor and Description

Aggregation(java.lang.String name, java.util.List list)

Constructors
Constructor and Description
`Aggregation(java.lang.String name, java.util.List list)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`aggregate(long currentTime, Event event, TextEvent msg)` It aggregates the incoming event with the aggregation message according to the aggregation options.
`int`	`aggregate(long currentTime, javax.jms.Message inMessage, javax.jms.Message msg)` It aggregates the incoming message with the aggregation message according to the aggregation options.
`Browser`	`browser()`
`void`	`clear()`
`void`	`clearBodyMap()` clears the bodyMap
`int`	`compare(int i, javax.jms.Message inMessage, javax.jms.Message msg)` It compares the value of the i-th property between the incoming message and the cached message to determine whose message body will be cached.
`boolean`	`containsKey(java.lang.String key)`
`java.lang.String`	`displayList(java.lang.String indent)` returns a text with all aggregate actions
`protected void`	`finalize()`
`int`	`getBodyDataType()` returns data type for body
`int`	`getBodyOperation()` returns aggregation id for body
`int`	`getBodyType()` returns result type for body
`java.lang.Object`	`getFromBody(java.lang.String key)` returns the object stored in the body map for the key
`java.lang.String`	`getKey(int id)`
`java.lang.String`	`getName()`
`int`	`getSize()`
`boolean`	`hasBody()` returns true if body aggregation map is NOT empty
`boolean`	`hasKeyInBody(java.lang.String key)` returns true if body aggregation Map contains the key
`int`	`initCache(org.w3c.dom.Document doc, java.util.Map map)`
`int`	`initCache(java.util.Map map)`
`int`	`initialize(long currentTime, Event event, TextEvent msg)` It initializes the aggregation event and aggregates the fisrt incoming event according to the aggregation operations.
`int`	`initialize(long currentTime, javax.jms.Message inMessage, javax.jms.Message msg)` It initializes the aggregation message and aggregates the fisrt incoming message according to the aggregation operations.
`int`	`merge(java.io.Reader sr, org.w3c.dom.Document doc, javax.xml.parsers.DocumentBuilder builder)` merges the xml content from the given reader to the xml doc and returns number of objects merged or -1 for failure
`int`	`merge(java.io.Reader sr, java.lang.String key, java.util.Map map)` merges the json content from the given reader to the parsed json map and returns 1 for success, 0 for empty source and -1 for failure
`int`	`rollback(long currentTime, javax.jms.Message inMessage, javax.jms.Message msg)` not implemented yet
`java.util.Map`	`setBodyMap(java.util.Map map)` sets the body map and returns the old one
`int`	`union(java.io.Reader sr, org.w3c.dom.Document doc, javax.xml.parsers.DocumentBuilder builder, java.util.Map map)` unions the xml content from the given reader to the parsed xml doc and returns 1 for success, 0 for empty source and -1 for failure
`int`	`union(java.io.Reader sr, java.util.Map map)` unions the json content from the given reader to the parsed json map and returns 1 for success, 0 for empty source and -1 for failure

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

- Field Detail
  - AGGR_NONE
```
public static final int AGGR_NONE
```
    See Also:
    
    Constant Field Values
  - AGGR_COUNT
```
public static final int AGGR_COUNT
```
    See Also:
    
    Constant Field Values
  - AGGR_SUM
```
public static final int AGGR_SUM
```
    See Also:
    
    Constant Field Values
  - AGGR_MIN
```
public static final int AGGR_MIN
```
    See Also:
    
    Constant Field Values
  - AGGR_MAX
```
public static final int AGGR_MAX
```
    See Also:
    
    Constant Field Values
  - AGGR_APPEND
```
public static final int AGGR_APPEND
```
    See Also:
    
    Constant Field Values
  - AGGR_FIRST
```
public static final int AGGR_FIRST
```
    See Also:
    
    Constant Field Values
  - AGGR_LAST
```
public static final int AGGR_LAST
```
    See Also:
    
    Constant Field Values
  - AGGR_AVG
```
public static final int AGGR_AVG
```
    See Also:
    
    Constant Field Values
  - AGGR_STD
```
public static final int AGGR_STD
```
    See Also:
    
    Constant Field Values
  - AGGR_MERGE
```
public static final int AGGR_MERGE
```
    See Also:
    
    Constant Field Values
  - AGGR_UNION
```
public static final int AGGR_UNION
```
    See Also:
    
    Constant Field Values
  - AGGR_XUNION
```
public static final int AGGR_XUNION
```
    See Also:
    
    Constant Field Values
  - AGGR_JOIN
```
public static final int AGGR_JOIN
```
    See Also:
    
    Constant Field Values
  - AGGR_END
```
public static final int AGGR_END
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Aggregation
```
public Aggregation(java.lang.String name,
                   java.util.List list)
```
- Method Detail
  - initialize
```
public int initialize(long currentTime,
                      Event event,
                      TextEvent msg)
```
    It initializes the aggregation event and aggregates the fisrt incoming event according to the aggregation operations. Upon success, it returns 0. Otherwise, it returns -1 to indicate errors.
  - aggregate
```
public int aggregate(long currentTime,
                     Event event,
                     TextEvent msg)
```
    It aggregates the incoming event with the aggregation message according to the aggregation options. It extracts data from the incoming message and aggregates the values into the cached text message. Upon success, it returns 0. Otherwise, it returns -1 to indicate errors.
  - rollback
```
public int rollback(long currentTime,
                    javax.jms.Message inMessage,
                    javax.jms.Message msg)
```
    not implemented yet
  - initialize
```
public int initialize(long currentTime,
                      javax.jms.Message inMessage,
                      javax.jms.Message msg)
               throws javax.jms.JMSException
```
    It initializes the aggregation message and aggregates the fisrt incoming message according to the aggregation operations. Upon success, it returns 0. Otherwise, it returns -1 to indicate errors.
    
    Throws:
    
    javax.jms.JMSException
  - aggregate
```
public int aggregate(long currentTime,
                     javax.jms.Message inMessage,
                     javax.jms.Message msg)
              throws javax.jms.JMSException
```
    It aggregates the incoming message with the aggregation message according to the aggregation options. It extracts data from the incoming message and aggregates the values into the cached text message. Upon success, it returns 0. Otherwise, it returns -1 to indicate errors.
    
    Throws:
    
    javax.jms.JMSException
  - compare
```
public int compare(int i,
                   javax.jms.Message inMessage,
                   javax.jms.Message msg)
```
    It compares the value of the i-th property between the incoming message and the cached message to determine whose message body will be cached. It returns 1 for update, 0 for same value, -1 for no update, -2 for failure.
  - getName
```
public java.lang.String getName()
```
  - getSize
```
public int getSize()
```
  - containsKey
```
public boolean containsKey(java.lang.String key)
```
  - getKey
```
public java.lang.String getKey(int id)
```
  - browser
```
public Browser browser()
```
  - hasBody
```
public boolean hasBody()
```
    returns true if body aggregation map is NOT empty
  - hasKeyInBody
```
public boolean hasKeyInBody(java.lang.String key)
```
    returns true if body aggregation Map contains the key
  - getFromBody
```
public java.lang.Object getFromBody(java.lang.String key)
```
    returns the object stored in the body map for the key
  - getBodyOperation
```
public int getBodyOperation()
```
    returns aggregation id for body
  - getBodyType
```
public int getBodyType()
```
    returns result type for body
  - getBodyDataType
```
public int getBodyDataType()
```
    returns data type for body
  - setBodyMap
```
public java.util.Map setBodyMap(java.util.Map map)
```
    sets the body map and returns the old one
  - clearBodyMap
```
public void clearBodyMap()
```
    clears the bodyMap
  - merge
```
public int merge(java.io.Reader sr,
                 org.w3c.dom.Document doc,
                 javax.xml.parsers.DocumentBuilder builder)
          throws java.io.IOException,
                 org.xml.sax.SAXException,
                 javax.xml.xpath.XPathExpressionException
```
    merges the xml content from the given reader to the xml doc and returns number of objects merged or -1 for failure
    
    Throws:
    
    java.io.IOException
    
    org.xml.sax.SAXException
    
    javax.xml.xpath.XPathExpressionException
  - merge
```
public int merge(java.io.Reader sr,
                 java.lang.String key,
                 java.util.Map map)
          throws java.io.IOException
```
    merges the json content from the given reader to the parsed json map and returns 1 for success, 0 for empty source and -1 for failure
    
    Throws:
    
    java.io.IOException
  - union
```
public int union(java.io.Reader sr,
                 org.w3c.dom.Document doc,
                 javax.xml.parsers.DocumentBuilder builder,
                 java.util.Map map)
          throws java.io.IOException,
                 org.xml.sax.SAXException,
                 javax.xml.xpath.XPathExpressionException
```
    unions the xml content from the given reader to the parsed xml doc and returns 1 for success, 0 for empty source and -1 for failure
    
    Throws:
    
    java.io.IOException
    
    org.xml.sax.SAXException
    
    javax.xml.xpath.XPathExpressionException
  - union
```
public int union(java.io.Reader sr,
                 java.util.Map map)
          throws java.io.IOException
```
    unions the json content from the given reader to the parsed json map and returns 1 for success, 0 for empty source and -1 for failure
    
    Throws:
    
    java.io.IOException
  - initCache
```
public int initCache(org.w3c.dom.Document doc,
                     java.util.Map map)
              throws java.io.IOException,
                     javax.xml.xpath.XPathExpressionException
```
    Throws:
    
    java.io.IOException
    
    javax.xml.xpath.XPathExpressionException
  - initCache
```
public int initCache(java.util.Map map)
              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - displayList
```
public java.lang.String displayList(java.lang.String indent)
```
    returns a text with all aggregate actions
  - clear
```
public void clear()
```
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object

Class Aggregation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AGGR_NONE

AGGR_COUNT

AGGR_SUM

AGGR_MIN

AGGR_MAX

AGGR_APPEND

AGGR_FIRST

AGGR_LAST

AGGR_AVG

AGGR_STD

AGGR_MERGE

AGGR_UNION

AGGR_XUNION

AGGR_JOIN

AGGR_END

Constructor Detail

Aggregation

Method Detail

initialize

aggregate

rollback

initialize

aggregate

compare

getName

getSize

containsKey

getKey

browser

hasBody

hasKeyInBody

getFromBody

getBodyOperation

getBodyType

getBodyDataType

setBodyMap

clearBodyMap

merge

merge

union

union

initCache

initCache

displayList

clear

finalize