net.sf.jabref.oo

Class OOBibBase

java.lang.Object

net.sf.jabref.oo.OOBibBase

public class OOBibBase
extends java.lang.Object

Class for manipulating the Bibliography of the currently start document in OpenOffice.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.regex.Pattern	citePattern

Constructor Summary

Constructors

Constructor and Description
OOBibBase(java.lang.String pathToOO, boolean atEnd)

Method Summary

Modifier and Type	Method and Description
void	clearBibTextSectionContent()
void	clearBibTextSectionContent2()
void	combineCiteMarkers(java.util.List<BibtexDatabase> databases, OOBibStyle style)
boolean	createBibTextSection(boolean end) This method creates and inserts an XTextSection named as determined by the string BIB_SECTION_NAME.
void	createBibTextSection2(boolean end)
java.util.LinkedHashMap<BibtexEntry,BibtexDatabase>	findCitedEntries(java.util.List<BibtexDatabase> databases, java.util.List<java.lang.String> keys, java.util.HashMap<java.lang.String,BibtexDatabase> linkSourceBase)
int[]	findCitedEntryIndex(java.lang.String citRefName, java.util.List<java.lang.String> keys) Resolve the bibtex key from a citation reference marker name, and look up the index of the key in a list of keys.
java.util.List<java.lang.String>	findCitedKeys()
com.sun.star.awt.Point	findPosition(com.sun.star.text.XTextViewCursor cursor, com.sun.star.text.XTextRange range)
com.sun.star.text.XTextRange	getBookmarkRange(java.lang.String name) Get the XTextRange corresponding to the named bookmark.
java.lang.String	getCitationContext(com.sun.star.container.XNameAccess nameAccess, java.lang.String refMarkName, int charBefore, int charAfter, boolean htmlMarkup)
java.lang.String	getCurrentDocumentTitle()
java.lang.String	getCustomProperty(java.lang.String property)
java.lang.String[]	getJabRefReferenceMarks(com.sun.star.container.XNameAccess nameAccess)
com.sun.star.container.XNameAccess	getReferenceMarks()
java.util.LinkedHashMap<BibtexEntry,BibtexDatabase>	getSortedEntriesFromSortedRefMarks(java.lang.String[] names, java.util.Map<BibtexEntry,BibtexDatabase> entries, java.util.HashMap<java.lang.String,BibtexDatabase> linkSourceBase)
java.lang.String[]	getSortedReferenceMarks(com.sun.star.container.XNameAccess nameAccess)
java.util.List<com.sun.star.text.XTextDocument>	getTextDocuments()
java.lang.String	getUniqueReferenceMarkName(java.lang.String bibtexKey, int type)
com.sun.star.text.XTextContent	insertBookMark(java.lang.String name, com.sun.star.text.XTextCursor position)
void	insertEntry(BibtexEntry[] entries, BibtexDatabase database, java.util.List<BibtexDatabase> allBases, OOBibStyle style, boolean inParenthesis, boolean withText, java.lang.String pageInfo, boolean sync) This method inserts a cite marker in the text for the given BibtexEntry, and may refresh the bibliography.
void	insertFootnote(java.lang.String name, java.lang.String citText, com.sun.star.text.XTextCursor position)
void	insertFullReferenceAtCursor(com.sun.star.text.XTextCursor cursor, java.util.Map<BibtexEntry,BibtexDatabase> entries, OOBibStyle style, java.lang.String parFormat)
void	insertFullReferenceAtViewCursor(java.util.Map<BibtexEntry,BibtexDatabase> entries, OOBibStyle style, java.lang.String parFormat)
void	insertMarkedUpTextAtViewCursor(java.lang.String lText, java.lang.String parFormat)
void	insertReferenceMark(java.lang.String name, java.lang.String citText, com.sun.star.text.XTextCursor position, boolean withText, OOBibStyle style)
boolean	isConnectedToDocument()
java.util.List<java.lang.String>	parseRefMarkName(java.lang.String name) Extract the list of bibtex keys from a reference mark name.
void	populateBibTextSection(java.util.Map<BibtexEntry,BibtexDatabase> entries, OOBibStyle style)
void	printBookmarkNames()
void	rebuildBibTextSection(java.util.List<BibtexDatabase> databases, OOBibStyle style)
java.util.List<java.lang.String>	refreshCiteMarkers(java.util.List<BibtexDatabase> databases, OOBibStyle style) Refresh all cite markers in the document.
void	removeBookMark(java.lang.String name)
void	removeReferenceMark(java.lang.String name)
void	selectDocument()
void	setCustomProperty(java.lang.String property, java.lang.String value)
void	setFocus() Focus the active OO document.
com.sun.star.frame.XDesktop	simpleBootstrap(java.lang.String pathToExecutable)
void	testCustomProperties()
void	testFootnote()
void	testFrameHandling()
void	updateSortedReferenceMarks()

Methods inherited from class java.lang.Object

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

Field Detail

citePattern

public final java.util.regex.Pattern citePattern

Constructor Detail

OOBibBase

public OOBibBase(java.lang.String pathToOO,
                 boolean atEnd)
          throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

isConnectedToDocument

public boolean isConnectedToDocument()

getCurrentDocumentTitle

public java.lang.String getCurrentDocumentTitle()

selectDocument

public void selectDocument()
                    throws java.lang.Exception

Throws:

java.lang.Exception

simpleBootstrap

public com.sun.star.frame.XDesktop simpleBootstrap(java.lang.String pathToExecutable)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getTextDocuments

public java.util.List<com.sun.star.text.XTextDocument> getTextDocuments()
                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

testCustomProperties

public void testCustomProperties()
                          throws java.lang.Exception

Throws:

java.lang.Exception

setCustomProperty

public void setCustomProperty(java.lang.String property,
                              java.lang.String value)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getCustomProperty

public java.lang.String getCustomProperty(java.lang.String property)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

updateSortedReferenceMarks

public void updateSortedReferenceMarks()
                                throws java.lang.Exception

Throws:

java.lang.Exception

insertEntry

public void insertEntry(BibtexEntry[] entries,
                        BibtexDatabase database,
                        java.util.List<BibtexDatabase> allBases,
                        OOBibStyle style,
                        boolean inParenthesis,
                        boolean withText,
                        java.lang.String pageInfo,
                        boolean sync)
                 throws java.lang.Exception

This method inserts a cite marker in the text for the given BibtexEntry, and may refresh the bibliography.

Parameters:

entries - The entries to cite.

database - The database the entry belongs to.

style - The bibliography style we are using.

inParenthesis - Indicates whether it is an in-text citation or a citation in parenthesis. This is not relevant if numbered citations are used.

withText - Indicates whether this should be a normal citation (true) or an empty (invisible) citation (false).

sync - Indicates whether the reference list should be refreshed.

Throws:

java.lang.Exception

refreshCiteMarkers

public java.util.List<java.lang.String> refreshCiteMarkers(java.util.List<BibtexDatabase> databases,
                                                           OOBibStyle style)
                                                    throws java.lang.Exception

Refresh all cite markers in the document.

Parameters:

databases - The databases to get entries from.

style - The bibliography style to use.

Returns:

A list of those referenced BibTeX keys that could not be resolved.

Throws:

java.lang.Exception

getReferenceMarks

public com.sun.star.container.XNameAccess getReferenceMarks()

getJabRefReferenceMarks

public java.lang.String[] getJabRefReferenceMarks(com.sun.star.container.XNameAccess nameAccess)

getSortedReferenceMarks

public java.lang.String[] getSortedReferenceMarks(com.sun.star.container.XNameAccess nameAccess)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

rebuildBibTextSection

public void rebuildBibTextSection(java.util.List<BibtexDatabase> databases,
                                  OOBibStyle style)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getUniqueReferenceMarkName

public java.lang.String getUniqueReferenceMarkName(java.lang.String bibtexKey,
                                                   int type)

findCitedEntries

public java.util.LinkedHashMap<BibtexEntry,BibtexDatabase> findCitedEntries(java.util.List<BibtexDatabase> databases,
                                                                            java.util.List<java.lang.String> keys,
                                                                            java.util.HashMap<java.lang.String,BibtexDatabase> linkSourceBase)

findCitedKeys

public java.util.List<java.lang.String> findCitedKeys()
                                               throws com.sun.star.container.NoSuchElementException,
                                                      com.sun.star.lang.WrappedTargetException

Throws:

com.sun.star.container.NoSuchElementException

com.sun.star.lang.WrappedTargetException

getSortedEntriesFromSortedRefMarks

public java.util.LinkedHashMap<BibtexEntry,BibtexDatabase> getSortedEntriesFromSortedRefMarks(java.lang.String[] names,
                                                                                              java.util.Map<BibtexEntry,BibtexDatabase> entries,
                                                                                              java.util.HashMap<java.lang.String,BibtexDatabase> linkSourceBase)
                                                                                       throws BibtexEntryNotFoundException

Throws:

BibtexEntryNotFoundException

findPosition

public com.sun.star.awt.Point findPosition(com.sun.star.text.XTextViewCursor cursor,
                                           com.sun.star.text.XTextRange range)

parseRefMarkName

public java.util.List<java.lang.String> parseRefMarkName(java.lang.String name)

Extract the list of bibtex keys from a reference mark name.

Parameters:

name - The reference mark name.

Returns:

The list of bibtex keys encoded in the name.

findCitedEntryIndex

public int[] findCitedEntryIndex(java.lang.String citRefName,
                                 java.util.List<java.lang.String> keys)

Resolve the bibtex key from a citation reference marker name, and look up the index of the key in a list of keys.

Parameters:

citRefName - The name of the ReferenceMark representing the citation.

keys - A List of bibtex keys representing the entries in the bibliography.

Returns:

the indices of the cited keys, -1 if a key is not found. Returns null if the ref name could not be resolved as a citation.

getCitationContext

public java.lang.String getCitationContext(com.sun.star.container.XNameAccess nameAccess,
                                           java.lang.String refMarkName,
                                           int charBefore,
                                           int charAfter,
                                           boolean htmlMarkup)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

insertFullReferenceAtCursor

public void insertFullReferenceAtCursor(com.sun.star.text.XTextCursor cursor,
                                        java.util.Map<BibtexEntry,BibtexDatabase> entries,
                                        OOBibStyle style,
                                        java.lang.String parFormat)
                                 throws UndefinedParagraphFormatException,
                                        java.lang.Exception

Throws:

UndefinedParagraphFormatException

java.lang.Exception

insertFullReferenceAtViewCursor

public void insertFullReferenceAtViewCursor(java.util.Map<BibtexEntry,BibtexDatabase> entries,
                                            OOBibStyle style,
                                            java.lang.String parFormat)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

insertMarkedUpTextAtViewCursor

public void insertMarkedUpTextAtViewCursor(java.lang.String lText,
                                           java.lang.String parFormat)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

createBibTextSection

public boolean createBibTextSection(boolean end)
                             throws java.lang.Exception

This method creates and inserts an XTextSection named as determined by the string BIB_SECTION_NAME.

Parameters:

end - true to indicate that the section should be put at the end of the document, false to indicate that it should be put at the cursor position.

Returns:

true if the bibliography already existed, false otherwise..

Throws:

java.lang.Exception

createBibTextSection2

public void createBibTextSection2(boolean end)
                           throws java.lang.Exception

Throws:

java.lang.Exception

clearBibTextSectionContent2

public void clearBibTextSectionContent2()
                                 throws java.lang.Exception

Throws:

java.lang.Exception

clearBibTextSectionContent

public void clearBibTextSectionContent()
                                throws java.lang.Exception

Throws:

java.lang.Exception

populateBibTextSection

public void populateBibTextSection(java.util.Map<BibtexEntry,BibtexDatabase> entries,
                                   OOBibStyle style)
                            throws UndefinedParagraphFormatException,
                                   java.lang.Exception

Throws:

UndefinedParagraphFormatException

java.lang.Exception

insertBookMark

public com.sun.star.text.XTextContent insertBookMark(java.lang.String name,
                                                     com.sun.star.text.XTextCursor position)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

insertReferenceMark

public void insertReferenceMark(java.lang.String name,
                                java.lang.String citText,
                                com.sun.star.text.XTextCursor position,
                                boolean withText,
                                OOBibStyle style)
                         throws java.lang.Exception

Throws:

java.lang.Exception

testFootnote

public void testFootnote()
                  throws java.lang.Exception

Throws:

java.lang.Exception

insertFootnote

public void insertFootnote(java.lang.String name,
                           java.lang.String citText,
                           com.sun.star.text.XTextCursor position)
                    throws java.lang.Exception

Throws:

java.lang.Exception

removeBookMark

public void removeBookMark(java.lang.String name)
                    throws java.lang.Exception

Throws:

java.lang.Exception

removeReferenceMark

public void removeReferenceMark(java.lang.String name)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getBookmarkRange

public com.sun.star.text.XTextRange getBookmarkRange(java.lang.String name)
                                              throws java.lang.Exception

Get the XTextRange corresponding to the named bookmark.

Parameters:

name - The name of the bookmark to find.

Returns:

The XTextRange for the bookmark.

Throws:

java.lang.Exception

printBookmarkNames

public void printBookmarkNames()
                        throws java.lang.Exception

Throws:

java.lang.Exception

setFocus

public void setFocus()

Focus the active OO document.

combineCiteMarkers

public void combineCiteMarkers(java.util.List<BibtexDatabase> databases,
                               OOBibStyle style)
                        throws java.lang.Exception

Throws:

java.lang.Exception

testFrameHandling

public void testFrameHandling()
                       throws java.lang.Exception

Throws:

java.lang.Exception