org.languagetool.openoffice

Class DocumentCache

java.lang.Object

org.languagetool.openoffice.DocumentCache

All Implemented Interfaces:

Serializable

public class DocumentCache
extends Object
implements Serializable

Class to store the Text of a LO document (document cache)

Since:

5.0

Author:

Fred Kruse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentCache.TextParagraph

Field Summary

Fields

Modifier and Type	Field and Description
static int	CURSOR_TYPE_ENDNOTE
static int	CURSOR_TYPE_FOOTNOTE
static int	CURSOR_TYPE_HEADER_FOOTER
static int	CURSOR_TYPE_SHAPE
static int	CURSOR_TYPE_TABLE
static int	CURSOR_TYPE_TEXT
static int	CURSOR_TYPE_UNKNOWN
static int	NUMBER_CURSOR_TYPES
protected List<DocumentCache.TextParagraph>	toTextMapping

Method Summary

Modifier and Type	Method and Description
int	correctStartPoint(int nStart, int nFPara) correct a start point to change of flat paragraph by zero space characters
DocumentCache.TextParagraph	createTextParagraph(int type, int paragraph)
static String	fixLinebreak(String text) Change manual linebreak to distinguish from end of paragraph
List<Integer>	getChangedUnsupportedParagraphs(org.languagetool.openoffice.DocumentCursorTools docCursor, org.languagetool.openoffice.ResultCache firstResultCache) get all paragraphs within unsupported text types (shapes, tables in frames) change the cache to new value return all changed paragraphs
String	getDocAsString() Gives Back the full Text as String
String	getDocAsString(DocumentCache.TextParagraph textParagraph, int parasToCheck, boolean checkOnlyParagraph, boolean useQueue, boolean hasFootnotes) Gives Back the full Text as String sorted by cursor types
com.sun.star.lang.Locale	getDocumentLocale()
int	getEndOfParaCheck(DocumentCache.TextParagraph textParagraph, int parasToCheck, boolean checkOnlyParagraph, boolean useQueue, boolean addParas) Gives back the end paragraph for text level check
String	getFlatParagraph(int n) get Flat Paragraph by Index
List<Integer>	getFlatParagraphDeletedCharacters(int n) get deleted characters (report changes) of Flat Paragraph by Index
int[]	getFlatParagraphFootnotes(int n) get footnotes of Flat Paragraph by Index
int	getFlatparagraphFromSortedTextId(int sortedTextId) Return Number of flat Paragraph from node index
com.sun.star.lang.Locale	getFlatParagraphLocale(int n) get Locale of Flat Paragraph by Index
int	getFlatParagraphNumber(DocumentCache.TextParagraph textParagraph) get Number of Flat Paragraph from Number of Text Paragraph
Map<Integer,Integer>	getHeadingMap() Get Map of Headings (only cursor type text)
int	getNearestSortedTextId(int sortedTextId) Return nearest sorted text Id
DocumentCache.TextParagraph	getNumberOfTextParagraph(int numberOfFlatParagraph) get Number of Text Paragraph from Number of Flat Paragraph
int	getParagraphType(int numberOfFlatParagraph) get Type of Paragraph from flat paragraph number
int	getStartOfParaCheck(DocumentCache.TextParagraph textParagraph, int parasToCheck, boolean checkOnlyParagraph, boolean useQueue, boolean addParas) Gives back the start paragraph for text level check
int	getStartOfParagraph(int nPara, DocumentCache.TextParagraph textParagraph, int parasToCheck, boolean checkOnlyParagraph, boolean useQueue, boolean hasFootnotes) Gives Back the StartPosition of Paragraph
String	getTextParagraph(DocumentCache.TextParagraph textParagraph) get the Content of a Text Paragraph
List<Integer>	getTextParagraphDeletedCharacters(DocumentCache.TextParagraph textParagraph) get deleted Characters of Text Paragraph
int[]	getTextParagraphFootnotes(DocumentCache.TextParagraph textParagraph) get footnotes of Text Paragraph by Index
com.sun.star.lang.Locale	getTextParagraphLocale(DocumentCache.TextParagraph textParagraph) get Locale of Text Paragraph by Index
boolean	hasNoContent(boolean lock) has no content
boolean	hasUnsupportedText()
boolean	isActual(int documentElementsCount) Return false if cache has to be actualized
boolean	isAutomaticGenerated(int n) get deleted characters (report changes) of Flat Paragraph by Index
boolean	isEmpty() is DocumentCache empty
boolean	isEqual(int n, String text, com.sun.star.lang.Locale locale) Text and local are equal to cache
boolean	isEqual(int n, String text, com.sun.star.lang.Locale locale, List<Integer> delChars) Text, deleted chars and local are equal to cache
boolean	isEqualCacheSize(org.languagetool.openoffice.DocumentCursorTools docCursor) size of cache has changed?
static boolean	isEqualText(String flatPara, String textPara, int[] footnotes)
boolean	isFinished() wait till reset is finished
boolean	isMultilingualFlatParagraph(int n) is multilingual Flat Paragraph
boolean	isResetRunning() wait till reset is finished
boolean	isSingleParagraph(int numberOfFlatParagraph) is flat paragraph a single paragraph
void	put(DocumentCache in) Replace a document Cache
void	refresh(SingleDocument document, com.sun.star.lang.Locale fixedLocale, com.sun.star.lang.Locale docLocale, com.sun.star.lang.XComponent xComponent, int fromWhere) Refresh the cache
org.languagetool.openoffice.DocumentCache.ChangedRange	refreshAndCompare(SingleDocument document, com.sun.star.lang.Locale fixedLocale, com.sun.star.lang.Locale docLocale, com.sun.star.lang.XComponent xComponent, int fromWhere) Refresh the cache and compare with the old Give back the range of difference and size
static String	removeZeroWidthSpace(String text) Change manual linebreak to distinguish from end of paragraph
void	setFlatParagraph(int n, String sPara) set Flat Paragraph at Index
void	setFlatParagraph(int n, String sPara, com.sun.star.lang.Locale locale) set Flat Paragraph and Locale at Index
void	setFlatParagraphDeletedCharacters(int n, List<Integer> deletedChars) set deleted characters (report changes) of Flat Paragraph by Index
void	setFlatParagraphFootnotes(int n, int[] footnotePos) set footnotes of Flat Paragraph by Index
void	setFlatParagraphLocale(int n, com.sun.star.lang.Locale locale) set Locale of Flat Paragraph by Index
void	setForTest(List<String> paragraphs, List<List<String>> textParagraphs, List<int[]> footnotes, List<List<Integer>> chapterBegins, com.sun.star.lang.Locale locale) set the cache only for test use
void	setMultilingualFlatParagraph(int n) set multilingual flag to Flat Paragraph
boolean	setSingleParagraphsCacheToNull(int numberFlatParagraph, List<org.languagetool.openoffice.ResultCache> paragraphsCache) Set text level cache for one paragraph to no errors for single paragraph text
void	setTextParagraphFootnotes(DocumentCache.TextParagraph textParagraph, int[] footnotePos) set footnotes of Text Paragraph
int	size() size of document cache (number of all flat paragraphs)
int	textSize(DocumentCache.TextParagraph textParagraph) size of text cache for a type of text
int	textSize(int type) size of text cache for a type of text

Methods inherited from class java.lang.Object

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

Field Detail

CURSOR_TYPE_UNKNOWN

public static final int CURSOR_TYPE_UNKNOWN

See Also:

Constant Field Values

CURSOR_TYPE_ENDNOTE

public static final int CURSOR_TYPE_ENDNOTE

See Also:

Constant Field Values

CURSOR_TYPE_FOOTNOTE

public static final int CURSOR_TYPE_FOOTNOTE

See Also:

Constant Field Values

CURSOR_TYPE_HEADER_FOOTER

public static final int CURSOR_TYPE_HEADER_FOOTER

See Also:

Constant Field Values

CURSOR_TYPE_SHAPE

public static final int CURSOR_TYPE_SHAPE

See Also:

Constant Field Values

CURSOR_TYPE_TEXT

public static final int CURSOR_TYPE_TEXT

See Also:

Constant Field Values

CURSOR_TYPE_TABLE

public static final int CURSOR_TYPE_TABLE

See Also:

Constant Field Values

NUMBER_CURSOR_TYPES

public static final int NUMBER_CURSOR_TYPES

See Also:

Constant Field Values

toTextMapping

protected final List<DocumentCache.TextParagraph> toTextMapping

Method Detail

setForTest

public void setForTest(List<String> paragraphs,
                       List<List<String>> textParagraphs,
                       List<int[]> footnotes,
                       List<List<Integer>> chapterBegins,
                       com.sun.star.lang.Locale locale)

set the cache only for test use

refresh

public void refresh(SingleDocument document,
                    com.sun.star.lang.Locale fixedLocale,
                    com.sun.star.lang.Locale docLocale,
                    com.sun.star.lang.XComponent xComponent,
                    int fromWhere)

Refresh the cache

hasUnsupportedText

public boolean hasUnsupportedText()

isEqualText

public static boolean isEqualText(String flatPara,
                                  String textPara,
                                  int[] footnotes)

setSingleParagraphsCacheToNull

public boolean setSingleParagraphsCacheToNull(int numberFlatParagraph,
                                              List<org.languagetool.openoffice.ResultCache> paragraphsCache)

Set text level cache for one paragraph to no errors for single paragraph text

isResetRunning

public boolean isResetRunning()

wait till reset is finished

isFinished

public boolean isFinished()

wait till reset is finished

getFlatParagraph

public String getFlatParagraph(int n)

get Flat Paragraph by Index

setFlatParagraph

public void setFlatParagraph(int n,
                             String sPara)

set Flat Paragraph at Index

setFlatParagraph

public void setFlatParagraph(int n,
                             String sPara,
                             com.sun.star.lang.Locale locale)

set Flat Paragraph and Locale at Index

isMultilingualFlatParagraph

public boolean isMultilingualFlatParagraph(int n)

is multilingual Flat Paragraph

setMultilingualFlatParagraph

public void setMultilingualFlatParagraph(int n)

set multilingual flag to Flat Paragraph

getFlatParagraphLocale

public com.sun.star.lang.Locale getFlatParagraphLocale(int n)

get Locale of Flat Paragraph by Index

setFlatParagraphLocale

public void setFlatParagraphLocale(int n,
                                   com.sun.star.lang.Locale locale)

set Locale of Flat Paragraph by Index

getFlatParagraphFootnotes

public int[] getFlatParagraphFootnotes(int n)

get footnotes of Flat Paragraph by Index

setFlatParagraphFootnotes

public void setFlatParagraphFootnotes(int n,
                                      int[] footnotePos)

set footnotes of Flat Paragraph by Index

getFlatParagraphDeletedCharacters

public List<Integer> getFlatParagraphDeletedCharacters(int n)

get deleted characters (report changes) of Flat Paragraph by Index

isAutomaticGenerated

public boolean isAutomaticGenerated(int n)

get deleted characters (report changes) of Flat Paragraph by Index

setFlatParagraphDeletedCharacters

public void setFlatParagraphDeletedCharacters(int n,
                                              List<Integer> deletedChars)

set deleted characters (report changes) of Flat Paragraph by Index

correctStartPoint

public int correctStartPoint(int nStart,
                             int nFPara)

correct a start point to change of flat paragraph by zero space characters

put

public void put(DocumentCache in)

Replace a document Cache

isEmpty

public boolean isEmpty()

is DocumentCache empty

hasNoContent

public boolean hasNoContent(boolean lock)

has no content

size

public int size()

size of document cache (number of all flat paragraphs)

getTextParagraph

public String getTextParagraph(DocumentCache.TextParagraph textParagraph)

get the Content of a Text Paragraph

getFlatParagraphNumber

public int getFlatParagraphNumber(DocumentCache.TextParagraph textParagraph)

get Number of Flat Paragraph from Number of Text Paragraph

getTextParagraphLocale

public com.sun.star.lang.Locale getTextParagraphLocale(DocumentCache.TextParagraph textParagraph)

get Locale of Text Paragraph by Index

getTextParagraphDeletedCharacters

public List<Integer> getTextParagraphDeletedCharacters(DocumentCache.TextParagraph textParagraph)

get deleted Characters of Text Paragraph

getTextParagraphFootnotes

public int[] getTextParagraphFootnotes(DocumentCache.TextParagraph textParagraph)

get footnotes of Text Paragraph by Index

setTextParagraphFootnotes

public void setTextParagraphFootnotes(DocumentCache.TextParagraph textParagraph,
                                      int[] footnotePos)

set footnotes of Text Paragraph

getNumberOfTextParagraph

public DocumentCache.TextParagraph getNumberOfTextParagraph(int numberOfFlatParagraph)

get Number of Text Paragraph from Number of Flat Paragraph

getParagraphType

public int getParagraphType(int numberOfFlatParagraph)

get Type of Paragraph from flat paragraph number

textSize

public int textSize(int type)

size of text cache for a type of text

textSize

public int textSize(DocumentCache.TextParagraph textParagraph)

size of text cache for a type of text

isEqual

public boolean isEqual(int n,
                       String text,
                       com.sun.star.lang.Locale locale)

Text and local are equal to cache

isEqual

public boolean isEqual(int n,
                       String text,
                       com.sun.star.lang.Locale locale,
                       List<Integer> delChars)

Text, deleted chars and local are equal to cache

isEqualCacheSize

public boolean isEqualCacheSize(org.languagetool.openoffice.DocumentCursorTools docCursor)

size of cache has changed?

getChangedUnsupportedParagraphs

public List<Integer> getChangedUnsupportedParagraphs(org.languagetool.openoffice.DocumentCursorTools docCursor,
                                                     org.languagetool.openoffice.ResultCache firstResultCache)

get all paragraphs within unsupported text types (shapes, tables in frames) change the cache to new value return all changed paragraphs

isSingleParagraph

public boolean isSingleParagraph(int numberOfFlatParagraph)

is flat paragraph a single paragraph

getStartOfParaCheck

public int getStartOfParaCheck(DocumentCache.TextParagraph textParagraph,
                               int parasToCheck,
                               boolean checkOnlyParagraph,
                               boolean useQueue,
                               boolean addParas)

Gives back the start paragraph for text level check

getEndOfParaCheck

public int getEndOfParaCheck(DocumentCache.TextParagraph textParagraph,
                             int parasToCheck,
                             boolean checkOnlyParagraph,
                             boolean useQueue,
                             boolean addParas)

Gives back the end paragraph for text level check

getDocAsString

public String getDocAsString(DocumentCache.TextParagraph textParagraph,
                             int parasToCheck,
                             boolean checkOnlyParagraph,
                             boolean useQueue,
                             boolean hasFootnotes)

Gives Back the full Text as String sorted by cursor types

getDocAsString

public String getDocAsString()

Gives Back the full Text as String

fixLinebreak

public static String fixLinebreak(String text)

Change manual linebreak to distinguish from end of paragraph

removeZeroWidthSpace

public static String removeZeroWidthSpace(String text)

Change manual linebreak to distinguish from end of paragraph

getStartOfParagraph

public int getStartOfParagraph(int nPara,
                               DocumentCache.TextParagraph textParagraph,
                               int parasToCheck,
                               boolean checkOnlyParagraph,
                               boolean useQueue,
                               boolean hasFootnotes)

Gives Back the StartPosition of Paragraph

createTextParagraph

public DocumentCache.TextParagraph createTextParagraph(int type,
                                                       int paragraph)

refreshAndCompare

public org.languagetool.openoffice.DocumentCache.ChangedRange refreshAndCompare(SingleDocument document,
                                                                                com.sun.star.lang.Locale fixedLocale,
                                                                                com.sun.star.lang.Locale docLocale,
                                                                                com.sun.star.lang.XComponent xComponent,
                                                                                int fromWhere)

Refresh the cache and compare with the old Give back the range of difference and size

getHeadingMap

public Map<Integer,Integer> getHeadingMap()

Get Map of Headings (only cursor type text)

getNearestSortedTextId

public int getNearestSortedTextId(int sortedTextId)

Return nearest sorted text Id

getFlatparagraphFromSortedTextId

public int getFlatparagraphFromSortedTextId(int sortedTextId)

Return Number of flat Paragraph from node index

isActual

public boolean isActual(int documentElementsCount)

Return false if cache has to be actualized

getDocumentLocale

public com.sun.star.lang.Locale getDocumentLocale()