writer2latex.base

Class BibliographyGenerator

java.lang.Object

writer2latex.base.BibliographyGenerator

public abstract class BibliographyGenerator
extends java.lang.Object

This class is used to generate bibliographic references and a bibliography. Bibliographies are generated from a list of items (text:bibliograpy-mark), a global configuration (text:bibliography-configuration) and a formatting template (text:bibliography-source)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BibliographyGenerator(OfficeReader ofr, boolean bSkipKey) Create a new bibliography generator based on a bibliography configuration and a list of bibliography marks

Method Summary

Modifier and Type	Method and Description
protected void	generateBibliography(org.w3c.dom.Element bibSource) Generate a bibliography
java.lang.String	generateCitation(java.lang.String sKey) Get citation text for a reference to the bibliography
protected java.util.Collection<java.lang.String>	getLabels() Get all labels used in the bibliography
protected abstract void	insertBibliographyItem(java.lang.String sStyleName, java.lang.String sKey) Insert a new bibliography item
protected abstract void	insertBibliographyItemElement(java.lang.String sStyleName, java.lang.String sText) Insert an element of a bibliography item
protected boolean	isNumberedEntries() Check whether entries are numbered rather than labeled with the key

Methods inherited from class java.lang.Object

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

Constructor Detail

BibliographyGenerator

protected BibliographyGenerator(OfficeReader ofr,
                                boolean bSkipKey)

Create a new bibliography generator based on a bibliography configuration and a list of bibliography marks

Parameters:

ofr - the office reader used to access the source document

bSkipKey - set to true if the key should be excluded when applying templates

Method Detail

getLabels

protected java.util.Collection<java.lang.String> getLabels()

Get all labels used in the bibliography

Returns:

the set of labels

isNumberedEntries

protected boolean isNumberedEntries()

Check whether entries are numbered rather than labeled with the key

Returns:

true if the entries are numbered

generateCitation

public java.lang.String generateCitation(java.lang.String sKey)

Get citation text for a reference to the bibliography

Parameters:

sKey - the key of the bibliography item

Returns:

the citation text to be shown in the document

generateBibliography

protected void generateBibliography(org.w3c.dom.Element bibSource)

Generate a bibliography

Parameters:

bibSource - a text:bibliography-source element

insertBibliographyItem

protected abstract void insertBibliographyItem(java.lang.String sStyleName,
                                               java.lang.String sKey)

Insert a new bibliography item

Parameters:

sStyleName - a paragraph style to apply to the item

sKey - the key of the bibliography item

insertBibliographyItemElement

protected abstract void insertBibliographyItemElement(java.lang.String sStyleName,
                                                      java.lang.String sText)

Insert an element of a bibliography item

Parameters:

sStyleName - a character style to apply to the element

sText - the element text