EventRepository (ff4j-core 1.6.3 API)

All Known Implementing Classes:

AbstractEventRepository, InMemoryEventRepository, JdbcEventRepository
```
public interface EventRepository
```
Persistence store for Event messages.

Author:

Cedrick Lunven (@clunven)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`createSchema()` Initialize target database with expected schema if needed.
`EventSeries`	`getAuditTrail(EventQueryDefinition query)` Display audit trail as list of Event.
`Event`	`getEventByUUID(String uuid, Long timestamp)` Retrieve an event by its unique identifer.
`BarChart`	`getFeatureUsageBarChart(EventQueryDefinition query)` Get hit curves.
`TimeSeriesChart`	`getFeatureUsageHistory(EventQueryDefinition query, TimeUnit tu)` Create measure over time.
`Map<String,MutableHitCount>`	`getFeatureUsageHitCount(EventQueryDefinition query)` Count hit ratio of features between 2 dates.
`PieChart`	`getFeatureUsagePieChart(EventQueryDefinition query)` Draw a pie chart where each sector is for a feature.
`int`	`getFeatureUsageTotalHitCount(EventQueryDefinition query)` Get all events.
`BarChart`	`getHostBarChart(EventQueryDefinition query)` Use hit getHostHitCount() to draw a bar chart.
`Map<String,MutableHitCount>`	`getHostHitCount(EventQueryDefinition query)` Count hit for each host.
`PieChart`	`getHostPieChart(EventQueryDefinition query)` Use hit getHostHitCount() to draw a pie chart.
`BarChart`	`getSourceBarChart(EventQueryDefinition query)` Use hit getSourceHitCount() to draw a bar chart.
`Map<String,MutableHitCount>`	`getSourceHitCount(EventQueryDefinition query)` Count hit for each source (api...).
`PieChart`	`getSourcePieChart(EventQueryDefinition query)` Use hit getSourceHitCount() to draw a pie chart.
`BarChart`	`getUserBarChart(EventQueryDefinition query)` Use hit getHostHitCount() to draw a bar chart.
`Map<String,MutableHitCount>`	`getUserHitCount(EventQueryDefinition query)` Count hit for each host.
`PieChart`	`getUserPieChart(EventQueryDefinition query)` Use hit getHostHitCount() to draw a pie chart.
`void`	`purgeAuditTrail(EventQueryDefinition query)` Purge audit trail.
`void`	`purgeFeatureUsage(EventQueryDefinition query)` Purge feature usage.
`boolean`	`saveEvent(Event e)` Save event into store synchronously.
`EventSeries`	`searchFeatureUsageEvents(EventQueryDefinition query)` Search over events.

- Method Detail
  - saveEvent
```
boolean saveEvent(Event e)
```
    Save event into store synchronously.
    
    Parameters:
    
    e - target event to store
    
    Returns:
    
    if saving is OK
  - getEventByUUID
```
Event getEventByUUID(String uuid,
                     Long timestamp)
```
    Retrieve an event by its unique identifer.
    
    Parameters:
    
    uuid - get detail from a single event by its ID
    
    timestamp - help to find the UUID (optional).
    
    Returns:
    
    target event detail
  - getFeatureUsageHitCount
```
Map<String,MutableHitCount> getFeatureUsageHitCount(EventQueryDefinition query)
```
    Count hit ratio of features between 2 dates. This will be used for different charts.
    
    Parameters:
    
    startTime - start date
    
    endTime - end time
    
    Returns:
  - getFeatureUsagePieChart
```
PieChart getFeatureUsagePieChart(EventQueryDefinition query)
```
    Draw a pie chart where each sector is for a feature. The value of each sector is the number of execution of the feature during the period of time. Pie : Sector/Feature, value- number of check OK
    
    Parameters:
    
    startTime - start time of window
    
    endTime - end time of window
    
    Returns:
  - getFeatureUsageBarChart
```
BarChart getFeatureUsageBarChart(EventQueryDefinition query)
```
    Get hit curves.
    
    Parameters:
    
    filteredFeatureNames - target feature name set
    
    nbslot - number of measure
    
    startTime - starttime for measure
    
    endTime - endtime for measure
    
    Returns:
    
    map of curves
  - getFeatureUsageHistory
```
TimeSeriesChart getFeatureUsageHistory(EventQueryDefinition query,
                                       TimeUnit tu)
```
    Create measure over time.
    
    Parameters:
    
    startTime - time to begin measures
    
    endTime - time to end measures
    
    nbPoints - number of points.
    
    filteredFeatures - if you want to filtered feature usage
    
    Returns:
  - getFeatureUsageTotalHitCount
```
int getFeatureUsageTotalHitCount(EventQueryDefinition query)
```
    Get all events.
    
    Returns:
    
    all event in the repository
  - searchFeatureUsageEvents
```
EventSeries searchFeatureUsageEvents(EventQueryDefinition query)
```
    Search over events.
    
    Returns:
    
    a list of events
  - purgeFeatureUsage
```
void purgeFeatureUsage(EventQueryDefinition query)
```
    Purge feature usage.
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time
  - getHostHitCount
```
Map<String,MutableHitCount> getHostHitCount(EventQueryDefinition query)
```
    Count hit for each host.
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time return the hitcount
  - getHostPieChart
```
PieChart getHostPieChart(EventQueryDefinition query)
```
    Use hit getHostHitCount() to draw a pie chart.
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time return target Pie
  - getHostBarChart
```
BarChart getHostBarChart(EventQueryDefinition query)
```
    Use hit getHostHitCount() to draw a bar chart.
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time return target bar
  - getUserHitCount
```
Map<String,MutableHitCount> getUserHitCount(EventQueryDefinition query)
```
    Count hit for each host.
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time return the hitcount
  - getUserPieChart
```
PieChart getUserPieChart(EventQueryDefinition query)
```
    Use hit getHostHitCount() to draw a pie chart.
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time return target Pie
  - getUserBarChart
```
BarChart getUserBarChart(EventQueryDefinition query)
```
    Use hit getHostHitCount() to draw a bar chart.
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time return target bar
  - getSourceHitCount
```
Map<String,MutableHitCount> getSourceHitCount(EventQueryDefinition query)
```
    Count hit for each source (api...).
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time return the hitcount
  - getSourcePieChart
```
PieChart getSourcePieChart(EventQueryDefinition query)
```
    Use hit getSourceHitCount() to draw a pie chart.
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time return target Pie
  - getSourceBarChart
```
BarChart getSourceBarChart(EventQueryDefinition query)
```
    Use hit getSourceHitCount() to draw a bar chart.
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time return target bar
  - getAuditTrail
```
EventSeries getAuditTrail(EventQueryDefinition query)
```
    Display audit trail as list of Event.
    
    Parameters:
    
    startTime - time to begin measures
    
    endTime - time to end measures
    
    Returns:
    
    target list of event
  - purgeAuditTrail
```
void purgeAuditTrail(EventQueryDefinition query)
```
    Purge audit trail.
    
    Parameters:
    
    starTime - begin date
    
    endTime - end time
  - createSchema
```
void createSchema()
```
    Initialize target database with expected schema if needed.

Interface EventRepository

Method Summary

Method Detail

saveEvent

getEventByUUID

getFeatureUsageHitCount

getFeatureUsagePieChart

getFeatureUsageBarChart

getFeatureUsageHistory

getFeatureUsageTotalHitCount

searchFeatureUsageEvents

purgeFeatureUsage

getHostHitCount

getHostPieChart

getHostBarChart

getUserHitCount

getUserPieChart

getUserBarChart

getSourceHitCount

getSourcePieChart

getSourceBarChart

getAuditTrail

purgeAuditTrail

createSchema