Top Description Methods
de.undercouch.citeproc.csl.internal.format

public Interface Format

Known Direct Implementers
de.undercouch.citeproc.csl.internal.format.BaseFormat
Imports
de.undercouch.citeproc.csl.internal.RenderContext, .SBibliography, de.undercouch.citeproc.output.Bibliography

An output format converts the result of a RenderContext to a formatted String.
Author
Michel Kraemer

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the formatted entry
formatBibliographyEntry
(RenderContext
the render context containing the bibliography entry
ctx
,
int
the index of the entry
index
)

Format a bibliography entry

public String

Returns:

the formatted citation
formatCitation
(RenderContext
the render context containing the citation to format
ctx
)

Format a citation

public String

Returns:

the name
getName
()

Get the format's name

public Bibliography

Returns:

the Bibliography object
makeBibliography
(String[]
the entries
entries
,
SBibliography
the bibliography element from the style file
bibliographyElement
)

Create a Bibliography object with the given entries and default parameters specified by this format

Method Detail

formatBibliographyEntryback to summary
public String formatBibliographyEntry(RenderContext ctx, int index)

Format a bibliography entry

Parameters
ctx:RenderContext

the render context containing the bibliography entry

index:int

the index of the entry

Returns:String

the formatted entry

formatCitationback to summary
public String formatCitation(RenderContext ctx)

Format a citation

Parameters
ctx:RenderContext

the render context containing the citation to format

Returns:String

the formatted citation

getNameback to summary
public String getName()

Get the format's name

Returns:String

the name

makeBibliographyback to summary
public Bibliography makeBibliography(String[] entries, SBibliography bibliographyElement)

Create a Bibliography object with the given entries and default parameters specified by this format

Parameters
entries:String[]

the entries

bibliographyElement:SBibliography

the bibliography element from the style file

Returns:Bibliography

the Bibliography object