ome.services.fulltext

Class FullTextIndexer

java.lang.Object

ome.services.util.Executor.Descriptive

ome.services.util.Executor.SimpleWork

ome.services.fulltext.FullTextIndexer

All Implemented Interfaces:

Executor.Work, org.springframework.context.ApplicationContextAware

public class FullTextIndexer
extends Executor.SimpleWork
implements org.springframework.context.ApplicationContextAware

Simple action which can be done in an asynchronous thread in order to index Hibernate entities. Attempts to index each EventLog passed from the EventLogLoader multiple times on failure. Eventually

Since:

3.0-Beta3

Author:

Josh Moore, josh at glencoesoftware.com

Field Summary

Fields

Modifier and Type	Field and Description
protected long	batch
protected Timer	batchTimer
protected Histogram	completeFast
protected Histogram	completeSlow
protected OmeroContext	context
static int	DEFAULT_REPORTING_LOOPS Default number of loops to wait if no external value is set.
protected boolean	dryRun
protected EventLogLoader	loader
protected ParserSession	parserSession
protected int	reportingLoops Frequency with which the percentage done should be calculated.
protected int	reps

Fields inherited from class ome.services.util.Executor.Descriptive

description

Constructor Summary

Constructors

Constructor and Description
FullTextIndexer(EventLogLoader ll)
FullTextIndexer(EventLogLoader ll, Metrics metrics)

Method Summary

Methods

Modifier and Type	Method and Description
protected Class	asClassOrNull(String str)
int	doIndexing(org.hibernate.search.FullTextSession session)
boolean	doMore(int count) Default implementation suggests doing more if fewer than reps runs have been made and if there are still more than EventLogLoader.batchSize x 100 backlog entries.
Object	doWork(org.hibernate.Session session, ServiceFactory sf) Runs doIndexing(FullTextSession) within a Lucene transaction.
protected IObject	get(org.hibernate.Session session, Class type, long id)
protected void	handleEventLog(org.hibernate.search.FullTextSession session, EventLog eventLog)
void	setApplicationContext(org.springframework.context.ApplicationContext ctx) Set the ApplicationContext that this object runs in.
void	setDryRun(boolean dryRun)
void	setRepetitions(int reps) Spring injector.
void	setReportingLoops(int loops)
void	setSqlAction(SqlAction sql) Since these instances are used repeatedly, we need to check for already set SqlAction

Methods inherited from class ome.services.util.Executor.SimpleWork

getSqlAction

Methods inherited from class ome.services.util.Executor.Descriptive

description

Methods inherited from class java.lang.Object

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

Methods inherited from interface ome.services.util.Executor.Work

description

Field Detail

DEFAULT_REPORTING_LOOPS

public static final int DEFAULT_REPORTING_LOOPS

Default number of loops to wait if no external value is set.

See Also:

Constant Field Values

loader

protected final EventLogLoader loader

parserSession

protected final ParserSession parserSession

batchTimer

protected final Timer batchTimer

completeSlow

protected final Histogram completeSlow

completeFast

protected final Histogram completeFast

reps

protected int reps

batch

protected long batch

reportingLoops

protected int reportingLoops

Frequency with which the percentage done should be calculated.

dryRun

protected boolean dryRun

context

protected OmeroContext context

Constructor Detail

FullTextIndexer

public FullTextIndexer(EventLogLoader ll)

FullTextIndexer

public FullTextIndexer(EventLogLoader ll,
               Metrics metrics)

Method Detail

setRepetitions

public void setRepetitions(int reps)

Spring injector. Sets the number of indexing runs will be made if there is a substantial backlog.

setReportingLoops

public void setReportingLoops(int loops)

setDryRun

public void setDryRun(boolean dryRun)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext ctx)

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

Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.

Invoked after population of normal bean properties but before an init callback such as InitializingBean.afterPropertiesSet() or a custom init-method. Invoked after ResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader), ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher) and MessageSourceAware, if applicable.

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Parameters:

ctx - the ApplicationContext object to be used by this object

See Also:

BeanInitializationException

setSqlAction

public void setSqlAction(SqlAction sql)

Since these instances are used repeatedly, we need to check for already set SqlAction

Overrides:

setSqlAction in class Executor.SimpleWork

doWork

@Transactional(readOnly=false,
               isolation=SERIALIZABLE)
public Object doWork(org.hibernate.Session session,
                          ServiceFactory sf)

Runs doIndexing(FullTextSession) within a Lucene transaction. doIndexing(FullTextSession) will also be called

Specified by:

doWork in interface Executor.Work

Parameters:

session - non null.

sf - non null.

Returns:

Any results which will be used by non-wrapped code.

doIndexing

public int doIndexing(org.hibernate.search.FullTextSession session)

handleEventLog

protected void handleEventLog(org.hibernate.search.FullTextSession session,
                  EventLog eventLog)

doMore

public boolean doMore(int count)

Default implementation suggests doing more if fewer than reps runs have been made and if there are still more than EventLogLoader.batchSize x 100 backlog entries. This is based on the assumption that indexing runs roughly 120 times an hour, so if there are more than an hours worth of batches, do extra work to catch up.

asClassOrNull

protected Class asClassOrNull(String str)

get

protected IObject get(org.hibernate.Session session,
          Class type,
          long id)