de.hpi.fgis.dude.util.bibtex.expander
Class CrossReferenceExpander

java.lang.Object
  de.hpi.fgis.dude.util.bibtex.expander.AbstractExpander
      de.hpi.fgis.dude.util.bibtex.expander.CrossReferenceExpander

All Implemented Interfaces:

Expander

public final class CrossReferenceExpander
extends AbstractExpander
implements Expander

This expander expands the crossreferences defined by the crossref fields - you should run the MacroReferenceExpander first.

Author:

henkel

Constructor Summary

CrossReferenceExpander()
Equivalent to CrossReferenceExpander(true)

CrossReferenceExpander(boolean throwAllExpansionExceptions)

Method Summary

void	expand(BibtexFile bibtexFile) Note: If you don't use the MacroReferenceExpander first, this function may lead to inconsistent macro references.

Methods inherited from class de.hpi.fgis.dude.util.bibtex.expander.AbstractExpander

finishExpansion, getExceptions, throwExpansionException, throwExpansionException

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hpi.fgis.dude.util.bibtex.expander.Expander

getExceptions

Constructor Detail

CrossReferenceExpander

public CrossReferenceExpander()

Equivalent to CrossReferenceExpander(true)

CrossReferenceExpander

public CrossReferenceExpander(boolean throwAllExpansionExceptions)

Parameters:

throwAllExpansionExceptions - Setting this to true means that all exceptions will be thrown immediately. Otherwise, the expander will skip over things it can't expand and you can use getExceptions to retrieve the exceptions later

Method Detail

expand

public void expand(BibtexFile bibtexFile)
            throws ExpansionException

Note: If you don't use the MacroReferenceExpander first, this function may lead to inconsistent macro references. If you use the flag throwAllExpansionExceptions set to false, you can retrieve all the exceptions using getExceptions()

Specified by:

expand in interface Expander

Parameters:

bibtexFile -

Throws:

ExpansionException