ome.services.eventlogs

Class EventLogQueue

java.lang.Object

ome.services.eventlogs.EventLogLoader

ome.services.eventlogs.PersistentEventLogLoader

ome.services.eventlogs.EventLogQueue

All Implemented Interfaces:

Iterable<ome.model.meta.EventLog>, EventListener, Iterator<ome.model.meta.EventLog>, org.springframework.context.ApplicationListener

public class EventLogQueue
extends PersistentEventLogLoader

PersistentEventLogLoader implementation which loads many rows at the same time, culling out duplicates in order to speed up indexing. Many of the methods used by either PersistentEventLogLoader or its super-classes are not intended for use here. Instead, the Iterator interface is most critical. As with other implementations, hasNext() is used for loading data if necessary, while next() simply returns an object. In some cases, nulls may be returned, which consumers must contend with.

Since:

5.0.3

Author:

Josh Moore, josh at glencoesoftware.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX Default maximum for the number of rows that will be loaded in a single call to SqlAction.getEventLogPartitions(java.util.Collection, java.util.Collection, long, long) .

Fields inherited from class ome.services.eventlogs.PersistentEventLogLoader

key, sql

Fields inherited from class ome.services.eventlogs.EventLogLoader

batchSize, DEFAULT_BATCH_SIZE, excludes, log, query, queryService

Constructor Summary

Constructors

Constructor and Description
EventLogQueue()
EventLogQueue(Metrics metrics, int max, String[] types, String[] actions)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addEventLog(Class<? extends ome.model.IObject> cls, long id) Only schedule a new backlog event if there is no currently registered event of that type.
boolean	hasNext() Checks if either any Entry instances are available or tries to load them if not.
void	initialize() Do nothing.
protected int	load(List<Object[]> rows)
protected boolean	load(Long eventLogId, String type, Long objId, String action, Integer skipped) Guarantees that the given arguments are available somewhere in the queue returning true if they were newly added.
protected List<Object[]>	lookup()
long	more() In general, EventLogQueue will intend to use much larger batch sizes, and so further loops should likely not be attempted.
ome.model.meta.EventLog	next() Return a wrapped version of Data#next() which could possibly be null.
void	onApplicationEvent(org.springframework.context.ApplicationEvent arg0) Handle an application event.
protected ome.model.meta.EventLog	query()

Methods inherited from class ome.services.eventlogs.PersistentEventLogLoader

deleteCurrentId, getCurrentId, getKey, setCurrentId, setKey, setSqlAction, setTypes

Methods inherited from class ome.services.eventlogs.EventLogLoader

getBatchSize, isStopSet, iterator, lastEventLog, nextEventLog, remove, rollback, setBatchSize, setExcludes, setQueryService, setStop

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX

public static final int DEFAULT_MAX

Default maximum for the number of rows that will be loaded in a single call to SqlAction.getEventLogPartitions(java.util.Collection, java.util.Collection, long, long) . Currently 1 million.

See Also:

Constant Field Values

Constructor Detail

EventLogQueue

public EventLogQueue()

EventLogQueue

public EventLogQueue(Metrics metrics,
             int max,
             String[] types,
             String[] actions)

Method Detail

lookup

protected List<Object[]> lookup()

load

protected int load(List<Object[]> rows)

load

protected boolean load(Long eventLogId,
           String type,
           Long objId,
           String action,
           Integer skipped)

Guarantees that the given arguments are available somewhere in the queue returning true if they were newly added.

onApplicationEvent

public void onApplicationEvent(org.springframework.context.ApplicationEvent arg0)

Description copied from interface: org.springframework.context.ApplicationListener

Handle an application event.

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener

Overrides:

onApplicationEvent in class EventLogLoader

Parameters:

arg0 - the event to respond to

hasNext

public boolean hasNext()

Checks if either any Entry instances are available or tries to load them if not. Conditions which will lead this to return false include: "stop" being set, the batch size being met, the current id in the database being equivalent to the newest event log.

Specified by:

hasNext in interface Iterator<ome.model.meta.EventLog>

Overrides:

hasNext in class EventLogLoader

next

public ome.model.meta.EventLog next()

Return a wrapped version of Data#next() which could possibly be null.

Specified by:

next in interface Iterator<ome.model.meta.EventLog>

Overrides:

next in class EventLogLoader

query

protected ome.model.meta.EventLog query()

Overrides:

query in class PersistentEventLogLoader

more

public long more()

In general, EventLogQueue will intend to use much larger batch sizes, and so further loops should likely not be attempted.

Overrides:

more in class PersistentEventLogLoader

initialize

public void initialize()

Do nothing.

Specified by:

initialize in class PersistentEventLogLoader

addEventLog

public boolean addEventLog(Class<? extends ome.model.IObject> cls,
                  long id)

Only schedule a new backlog event if there is no currently registered event of that type.

Overrides:

addEventLog in class EventLogLoader