org.qbroker.event

Class EventUtils

java.lang.Object

org.qbroker.event.EventUtils

public class EventUtils
extends java.lang.Object

EventUtils has some utilities for Event processing

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	defaultCategory
static java.lang.String	defaultName
static java.lang.String	defaultSite
static java.lang.String	defaultType
static java.lang.String	FILE_SEPARATOR
static java.lang.String	LINE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
EventUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	collectible(Event event)
static java.lang.String	collectible(Event event, java.util.Map change) It returns a formatted string of the event in the collectible format.
static java.lang.String	compact(Event event)
static java.lang.String	compact(Event event, java.util.Map change) It returns a formatted string of the event in the compact format.
static Event	duplicate(Event event)
static java.lang.String	format(Event event, Template template) returns a formatted string of the event with a given template
static java.lang.String	format(Event event, Template template, java.util.Map subMap) returns a formatted string of the event with a given template and a set of substitutions
static java.util.Map<java.lang.String,java.lang.Object>	getChange(Event event, TextSubstitution[] sub) returns a Map contains changes only from the substitution
static TextSubstitution[]	initSubstitutions(java.util.List sub) returns an array of TextSubstitution for a list of maps for Sub
static java.lang.String	postable(Event event)
static java.lang.String	postable(Event event, java.util.Map change) It returns a formatted string of the event in the postable format.
static java.lang.String	pretty(Event event)
static java.lang.String	pretty(Event event, java.util.Map change) It returns a formatted string of the event in the compact format.
static Event	runScript(java.lang.String program, int timeout) runs a script within the timeout and return an event.
static java.lang.String	substitute(java.lang.String input, Template template)
static java.lang.String	substitute(java.lang.String input, Template template, java.util.Map map)

Methods inherited from class java.lang.Object

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

Field Detail

LINE_SEPARATOR

public static final java.lang.String LINE_SEPARATOR

FILE_SEPARATOR

public static final java.lang.String FILE_SEPARATOR

defaultName

public static final java.lang.String defaultName

See Also:

Constant Field Values

defaultSite

public static final java.lang.String defaultSite

See Also:

Constant Field Values

defaultCategory

public static final java.lang.String defaultCategory

See Also:

Constant Field Values

defaultType

public static final java.lang.String defaultType

See Also:

Constant Field Values

Constructor Detail

EventUtils

public EventUtils()

Method Detail

pretty

public static java.lang.String pretty(Event event)

pretty

public static java.lang.String pretty(Event event,
                                      java.util.Map change)

It returns a formatted string of the event in the compact format. The Map of change should contain only key-value pairs for add/replace/delete. value = null: delete
key in event: replace
no key in event: add
NB. change will be cleared at the return

compact

public static java.lang.String compact(Event event)

compact

public static java.lang.String compact(Event event,
                                       java.util.Map change)

It returns a formatted string of the event in the compact format. The Map of change should contain only key-value pairs for add/replace/delete. value = null: delete
key in event: replace
no key in event: add
NB. change will be cleared at the return

postable

public static java.lang.String postable(Event event)

postable

public static java.lang.String postable(Event event,
                                        java.util.Map change)

It returns a formatted string of the event in the postable format. The postable format of an event is a uri query string ready to be posted to a web server. The Map of change should contain only key-value pairs for add/replace/delete.
value = null: delete
key in event: replace
no key in event: add

NB. change will be cleared at the return

collectible

public static java.lang.String collectible(Event event)

collectible

public static java.lang.String collectible(Event event,
                                           java.util.Map change)

It returns a formatted string of the event in the collectible format. The collectible format of an event is a log string ready to be parsed into an event by EventParser. But it does not contain the trailing newline chararcter and the leading timestamp as well as the IP address. The change should contain only key-value pairs for add/replace/delete
value = null: delete
key in event: replace
no key in event: add

NB. change will be cleared at the return

initSubstitutions

public static TextSubstitution[] initSubstitutions(java.util.List sub)

returns an array of TextSubstitution for a list of maps for Sub

getChange

public static java.util.Map<java.lang.String,java.lang.Object> getChange(Event event,
                                                                         TextSubstitution[] sub)

returns a Map contains changes only from the substitution

duplicate

public static Event duplicate(Event event)

format

public static java.lang.String format(Event event,
                                      Template template)

returns a formatted string of the event with a given template

format

public static java.lang.String format(Event event,
                                      Template template,
                                      java.util.Map subMap)

returns a formatted string of the event with a given template and a set of substitutions

runScript

public static Event runScript(java.lang.String program,
                              int timeout)

runs a script within the timeout and return an event. Caller is supposed to add name, site and other fields to the event and sends it

substitute

public static java.lang.String substitute(java.lang.String input,
                                          Template template)

substitute

public static java.lang.String substitute(java.lang.String input,
                                          Template template,
                                          java.util.Map map)