org.qbroker.json

Class JSONFilter

java.lang.Object

org.qbroker.json.JSONFilter

All Implemented Interfaces:

Filter<java.util.Map>

public class JSONFilter
extends java.lang.Object
implements Filter<java.util.Map>

JSONFilter is a client side filter with an internal formatter. The method of evaluate() returns true if the filter matches the JSON data. Otherwise, it returns false. The method of format is to format the JSON data with the internal formatter.

The filter part contains two sets of EvalMaps. One set is for positive match to include certain patterns. The other set is for negtive match to exclude certain patterns. An EvalMap contains key-value pairs to supports 3 types of evaluations: Perl5 pattern match, number range testing and evaluations on variables. If a key is like "v:xxx:, the evaluation is on a variable where "xxx" is the json path and the value determines the operation. Currently, only "==" is supported. The dynamic value will be stored in parameter map at the key of "v:xxx". For keys without namespace, they are json paths to retrieve data to be evaluated. The value will be either a Perl5 Pattern or a list of number ranges.

The template part supports JSONSection for keys with the namespace of "s:". In this case, the list of sections must be provided for the format method. The parameter map is supposed to contain the root JSON doc at the key of "r:_JSON_".

It also supports the dynamic pattern or value for keys with the namespace of "v:". In this case, the parameter map is supposed to contain the value of the variable under the key of "v:xxx".

Author:

yannanlu@yahoo.com

Constructor Summary

Constructors

Constructor and Description
JSONFilter(java.lang.String prefix, java.util.Map props)
JSONFilter(java.lang.String prefix, java.util.Map props, org.apache.oro.text.regex.Perl5Compiler pc)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	evaluate(java.util.List json, java.util.Map<java.lang.String,java.lang.Object> params) It evaluates the JSON list data with the internal predefined filters and the given parameter map.
boolean	evaluate(long tm, java.util.Map json) It evaluates the JSON map data with the internal predefined filters and returns true if there is a hit or false otherwise.
boolean	evaluate(java.util.Map json, java.util.Map<java.lang.String,java.lang.Object> params) It evaluates the JSON map data with the internal predefined filters and the given parameter map.
boolean	evaluate(java.lang.String json, java.util.Map<java.lang.String,java.lang.Object> params) It evaluates the JSON text with the internal predefined filters and the given parameter map.
protected void	finalize()
java.lang.String	format(java.util.List json, AssetList list, java.util.Map<java.lang.String,java.lang.Object> params) formats the JSON list with the predefined formatters, a given list of JSONSections and a given parameter map.
java.lang.String	format(java.util.Map json, AssetList list, java.util.Map<java.lang.String,java.lang.Object> params) formats the JSON map with the predefined formatters, a given list of JSONSections and a given parameter map.
java.lang.String	format(java.lang.String json, AssetList list, java.util.Map<java.lang.String,java.lang.Object> params) formats the JSON text with the predefined formatters, a given list of JSONSections and a given parameter map.
boolean	hasFormatter()
boolean	hasSection()
protected static JSONFilter[]	initFilters(java.lang.String prefix, java.lang.String name, java.util.Map ph)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSONFilter

public JSONFilter(java.lang.String prefix,
                  java.util.Map props,
                  org.apache.oro.text.regex.Perl5Compiler pc)

JSONFilter

public JSONFilter(java.lang.String prefix,
                  java.util.Map props)

Method Detail

format

public java.lang.String format(java.util.Map json,
                               AssetList list,
                               java.util.Map<java.lang.String,java.lang.Object> params)

formats the JSON map with the predefined formatters, a given list of JSONSections and a given parameter map. It returns formatted content upon success.

format

public java.lang.String format(java.util.List json,
                               AssetList list,
                               java.util.Map<java.lang.String,java.lang.Object> params)

formats the JSON list with the predefined formatters, a given list of JSONSections and a given parameter map. It returns formatted content upon success.

format

public java.lang.String format(java.lang.String json,
                               AssetList list,
                               java.util.Map<java.lang.String,java.lang.Object> params)

formats the JSON text with the predefined formatters, a given list of JSONSections and a given parameter map. It returns formatted content upon success.

evaluate

public boolean evaluate(long tm,
                        java.util.Map json)

It evaluates the JSON map data with the internal predefined filters and returns true if there is a hit or false otherwise.

Specified by:

evaluate in interface Filter<java.util.Map>

evaluate

public boolean evaluate(java.util.Map json,
                        java.util.Map<java.lang.String,java.lang.Object> params)

It evaluates the JSON map data with the internal predefined filters and the given parameter map. It returns true if there is a hit or false otherwise.

evaluate

public boolean evaluate(java.util.List json,
                        java.util.Map<java.lang.String,java.lang.Object> params)

It evaluates the JSON list data with the internal predefined filters and the given parameter map. It returns true if there is a hit or false otherwise.

evaluate

public boolean evaluate(java.lang.String json,
                        java.util.Map<java.lang.String,java.lang.Object> params)

It evaluates the JSON text with the internal predefined filters and the given parameter map. It returns true if there is a hit or false otherwise.

hasFormatter

public boolean hasFormatter()

hasSection

public boolean hasSection()

clear

public void clear()

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

initFilters

protected static JSONFilter[] initFilters(java.lang.String prefix,
                                          java.lang.String name,
                                          java.util.Map ph)