io.thekraken.grok.api

Class Garbage

java.lang.Object

io.thekraken.grok.api.Garbage

public class Garbage
extends Object

The Leon the professional of Grok.
Garbage is use by grok to remove or rename elements before getting the final output

Since:

0.0.2

Author:

anthonycorbacho

Constructor Summary

Constructors

Constructor and Description
Garbage() Create a new Garbage object.

Method Summary

Modifier and Type	Method and Description
void	addToRemove(List<String> lst) Set a list of field name to be remove when exporting the final output.
void	addToRemove(String name) Set a field to be remove when exporting the final output.
void	addToRename(String origin, Object value) Set a new name to be change when exporting the final output.
int	remove(Map<String,Object> map) Remove from the map the unwilling items.
int	rename(Map<String,Object> map) Rename the item from the map.

Methods inherited from class java.lang.Object

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

Constructor Detail

Garbage

public Garbage()

Create a new Garbage object.

Method Detail

addToRename

public void addToRename(String origin,
                        Object value)

Set a new name to be change when exporting the final output.

Parameters:

origin - : original field name

value - : New field name to apply

addToRemove

public void addToRemove(String name)

Set a field to be remove when exporting the final output.

Parameters:

name - of the field to remove

addToRemove

public void addToRemove(List<String> lst)

Set a list of field name to be remove when exporting the final output.

Parameters:

lst - list of elem to remove

remove

public int remove(Map<String,Object> map)

Remove from the map the unwilling items.

Parameters:

map - to clean

Returns:

nb of deleted item

rename

public int rename(Map<String,Object> map)

Rename the item from the map.

Parameters:

map - elem to rename

Returns:

nb of renamed items