org.languagetool.openoffice

Class TextLevelCheckQueue

java.lang.Object

org.languagetool.openoffice.TextLevelCheckQueue

public class TextLevelCheckQueue
extends Object

Class of a queue to handle parallel check of text level rules

Since:

4.9

Author:

Fred Kruse

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISPOSE_FLAG
static int	NO_FLAG
static int	RESET_FLAG
static int	STOP_FLAG

Method Summary

Modifier and Type	Method and Description
void	addQueueEntry(DocumentCache.TextParagraph nStart, DocumentCache.TextParagraph nEnd, int nCache, int nCheck, String docId, boolean overrideRunning) Add a new entry to queue add it only if the new entry is not identical with the last entry or the running
org.languagetool.openoffice.TextLevelCheckQueue.QueueEntry	createQueueEntry(DocumentCache.TextParagraph nStart, DocumentCache.TextParagraph nEnd, int cacheNum, int nCheck, String docId)
org.languagetool.openoffice.TextLevelCheckQueue.QueueEntry	createQueueEntry(DocumentCache.TextParagraph nStart, DocumentCache.TextParagraph nEnd, int nCache, int nCheck, String docId, boolean overrideRunning) Create and give back a new queue entry
void	interruptCheck(String docId, boolean wait) remove all entries for the disposed docId (gone document)
boolean	isInterrupted() gives back information if queue is interrupted
boolean	isRunning() gives back information if queue is running
boolean	isWaiting() gives back information if queue is waiting
void	setReset() Reset the queue all entries are removed; LanguageTool is new initialized
void	setStop() Set a stop flag to get a definite ending of the iteration
void	wakeupQueue(String docId) wake up the waiting iteration of the queue for a specific document

Methods inherited from class java.lang.Object

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

Field Detail

NO_FLAG

public static final int NO_FLAG

See Also:

Constant Field Values

RESET_FLAG

public static final int RESET_FLAG

See Also:

Constant Field Values

STOP_FLAG

public static final int STOP_FLAG

See Also:

Constant Field Values

DISPOSE_FLAG

public static final int DISPOSE_FLAG

See Also:

Constant Field Values

Method Detail

addQueueEntry

public void addQueueEntry(DocumentCache.TextParagraph nStart,
                          DocumentCache.TextParagraph nEnd,
                          int nCache,
                          int nCheck,
                          String docId,
                          boolean overrideRunning)

Add a new entry to queue add it only if the new entry is not identical with the last entry or the running

createQueueEntry

public org.languagetool.openoffice.TextLevelCheckQueue.QueueEntry createQueueEntry(DocumentCache.TextParagraph nStart,
                                                                                   DocumentCache.TextParagraph nEnd,
                                                                                   int nCache,
                                                                                   int nCheck,
                                                                                   String docId,
                                                                                   boolean overrideRunning)

Create and give back a new queue entry

createQueueEntry

public org.languagetool.openoffice.TextLevelCheckQueue.QueueEntry createQueueEntry(DocumentCache.TextParagraph nStart,
                                                                                   DocumentCache.TextParagraph nEnd,
                                                                                   int cacheNum,
                                                                                   int nCheck,
                                                                                   String docId)

wakeupQueue

public void wakeupQueue(String docId)

wake up the waiting iteration of the queue for a specific document

setStop

public void setStop()

Set a stop flag to get a definite ending of the iteration

setReset

public void setReset()

Reset the queue all entries are removed; LanguageTool is new initialized

interruptCheck

public void interruptCheck(String docId,
                           boolean wait)

remove all entries for the disposed docId (gone document)

Parameters:

docId -

isInterrupted

public boolean isInterrupted()

gives back information if queue is interrupted

isRunning

public boolean isRunning()

gives back information if queue is running

isWaiting

public boolean isWaiting()

gives back information if queue is waiting