io.krakens.grok.api

Class Match

java.lang.Object

io.krakens.grok.api.Match

public class Match
extends java.lang.Object

Match is a representation in Grok world of your log.

Since:

0.0.1

Field Summary

Fields

Modifier and Type	Field and Description
static Match	EMPTY Create Empty grok matcher.

Constructor Summary

Constructors

Constructor and Description
Match(java.lang.CharSequence subject, Grok grok, java.util.regex.Matcher match, int start, int end) Create a new Match object.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	capture() Match to the subject the regex and save the matched element into a map.
java.util.Map<java.lang.String,java.lang.Object>	captureFlattened() Match to the subject the regex and save the matched element into a map Multiple values to the same key are flattened to one value: the sole non-null value will be captured.
int	getEnd()
java.util.regex.Matcher	getMatch()
int	getStart()
java.lang.CharSequence	getSubject() Retrurn the single line of log.
boolean	isKeepEmptyCaptures()
java.lang.Boolean	isNull() Util fct.
void	setKeepEmptyCaptures(boolean ignore) Ignore empty captures.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final Match EMPTY

Create Empty grok matcher.

Constructor Detail

Match

public Match(java.lang.CharSequence subject,
             Grok grok,
             java.util.regex.Matcher match,
             int start,
             int end)

Create a new Match object.

Method Detail

getMatch

public java.util.regex.Matcher getMatch()

getStart

public int getStart()

getEnd

public int getEnd()

setKeepEmptyCaptures

public void setKeepEmptyCaptures(boolean ignore)

Ignore empty captures.

isKeepEmptyCaptures

public boolean isKeepEmptyCaptures()

getSubject

public java.lang.CharSequence getSubject()

Retrurn the single line of log.

Returns:

the single line of log

capture

public java.util.Map<java.lang.String,java.lang.Object> capture()

Match to the subject the regex and save the matched element into a map. Multiple values for the same key are stored as list.

captureFlattened

public java.util.Map<java.lang.String,java.lang.Object> captureFlattened()
                                                                  throws GrokException

Match to the subject the regex and save the matched element into a map Multiple values to the same key are flattened to one value: the sole non-null value will be captured. Should there be multiple non-null values a RuntimeException is being thrown. This can be used in cases like: (foo (.*:message) bar|bar (.*:message) foo) where the regexp guarantees that only one value will be captured. See also capture which returns multiple values of the same key as list.

Returns:

the matched elements

Throws:

GrokException - if a keys has multiple non-null values.

isNull

public java.lang.Boolean isNull()

Util fct.

Returns:

boolean