Package com.levigo.jadice.server.documentplatform

Class DefaultReshapeListener

java.lang.Object

com.levigo.jadice.server.documentplatform.DefaultReshapeListener

All Implemented Interfaces:

ReshapeListener

public class DefaultReshapeListener
extends Object
implements ReshapeListener

A simple ReshapeListener the logs the progress of the ReshapeWorker.

In order not to flood the logging files the more pages a document has the less progress is logged. The progress is logged only if one the two conditions is met:

1. The page index is relevant.
2. The last log entry has been emitted more then n ms ago

Since:

jadice server 5.4.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.levigo.jadice.server.documentplatform.ReshapeListener

ReshapeListener.Context

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_MINIMUM_LOG_INTERVAL	The default minimum interval in which the logging shall be performed.

Constructor Summary

Constructors

Constructor	Description
DefaultReshapeListener()

Method Summary

Modifier and Type	Method	Description
void	done(ReshapeListener.Context context)	Called each time a reshape process is successfully completed.
void	failed(ReshapeListener.Context context, Exception cause)	Called each time a reshape process is unsuccessfully terminated.
long	getLogInterval()
protected static boolean	isRelevantIndex(int idx)	Check if a page index is relevant for logging.
void	pageDone(ReshapeListener.Context context, com.levigo.jadice.document.Page page)	Called each time a reshape process successfully finishes reshaping a Page.
void	pageFailed(ReshapeListener.Context context, com.levigo.jadice.document.Page page, Exception cause)	Called each time a reshape process unsuccessfully terminates reshaping a Page.
void	pageStarted(ReshapeListener.Context ctx, com.levigo.jadice.document.Page page)	Called each time a reshape process starts reshaping a Page.
void	setLogInterval(long logInterval)	Set the minimum time interval for which the logging events shall be generated.
void	started(ReshapeListener.Context context)	Called when a reshape process is started.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MINIMUM_LOG_INTERVAL

public static final long DEFAULT_MINIMUM_LOG_INTERVAL

The default minimum interval in which the logging shall be performed. I.e. at least every n a logging event will be emitted.

Constructor Detail

DefaultReshapeListener

public DefaultReshapeListener()

Method Detail

pageStarted

public void pageStarted(ReshapeListener.Context ctx,
                        com.levigo.jadice.document.Page page)

Description copied from interface: ReshapeListener

Called each time a reshape process starts reshaping a Page.

Specified by:

pageStarted in interface ReshapeListener

Parameters:

ctx - the ReshapeListener.Context of this action

page - the current page being reshaped

isRelevantIndex

protected static boolean isRelevantIndex(int idx)

Check if a page index is relevant for logging.

This algorithm uses a logarithmic threshold, i.e.

• for the first 10 pages every index is relevant,
• for the pages 10 to 99 only every tenth page is relevant,
• for the pages 100 to 999 only every 100th page is relevant,
• and so on.

Parameters:

idx - the page index

Returns:

true iff the given index is relevant

getLogInterval

public long getLogInterval()

setLogInterval

public void setLogInterval(long logInterval)

Set the minimum time interval for which the logging events shall be generated.

Parameters:

logInterval - minimum time interval for which the logging events shall be generated

started

public void started(ReshapeListener.Context context)

Description copied from interface: ReshapeListener

Called when a reshape process is started.

Specified by:

started in interface ReshapeListener

Parameters:

context - the ReshapeListener.Context of this action

done

public void done(ReshapeListener.Context context)

Description copied from interface: ReshapeListener

Called each time a reshape process is successfully completed.

Specified by:

done in interface ReshapeListener

Parameters:

context - the ReshapeListener.Context of this action

failed

public void failed(ReshapeListener.Context context,
                   Exception cause)

Description copied from interface: ReshapeListener

Called each time a reshape process is unsuccessfully terminated.

Specified by:

failed in interface ReshapeListener

Parameters:

context - the ReshapeListener.Context of this action

cause - gives the reason for the unsuccessful termination

pageDone

public void pageDone(ReshapeListener.Context context,
                     com.levigo.jadice.document.Page page)

Description copied from interface: ReshapeListener

Called each time a reshape process successfully finishes reshaping a Page.

Specified by:

pageDone in interface ReshapeListener

Parameters:

context - the ReshapeListener.Context of this action

page - the page being reshaped

pageFailed

public void pageFailed(ReshapeListener.Context context,
                       com.levigo.jadice.document.Page page,
                       Exception cause)

Description copied from interface: ReshapeListener

Called each time a reshape process unsuccessfully terminates reshaping a Page.

Specified by:

pageFailed in interface ReshapeListener

Parameters:

context - the ReshapeListener.Context of this action

page - the page being reshaped

cause - gives the reason for the unsuccessful termination