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

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

All Implemented Interfaces:

Expander

public class PersonListExpander
extends AbstractExpander
implements Expander

This expander will convert author/editor field values into BibtexPersonList objects.

Author:

henkel

Constructor Summary

PersonListExpander(boolean expandAuthors, boolean expandEditors)
Equivalent to PersonListExpander(expandAuthors,expandEditors,true).

PersonListExpander(boolean expandAuthors, boolean expandEditors, boolean throwAllExpansionExceptions)

Method Summary

void	expand(BibtexFile file) This method will expand all author and editor fields (if configured in the constructor) into BibtexPersonList values.

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

PersonListExpander

public PersonListExpander(boolean expandAuthors,
                          boolean expandEditors)

Equivalent to PersonListExpander(expandAuthors,expandEditors,true).

Parameters:

expandAuthors -

expandEditors -

PersonListExpander

public PersonListExpander(boolean expandAuthors,
                          boolean expandEditors,
                          boolean throwAllExpansionExceptions)

Parameters:

expandAuthors -

expandEditors -

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 file)
            throws ExpansionException

This method will expand all author and editor fields (if configured in the constructor) into BibtexPersonList values. Before you call this method, please make sure you have used the MacroReferenceExpander. If you use the flag throwAllExpansionExceptions set to false, you can retrieve all the exceptions using getExceptions()

Specified by:

expand in interface Expander

Parameters:

file -

Throws:

ExpansionException