Top Description Fields Constructors Methods
de.undercouch.citeproc.csl.internal

public Class SStyle

extends Object
Class Inheritance
Imports
de.undercouch.citeproc.csl.internal.locale.LLocale, de.undercouch.citeproc.csl.internal.rendering.SNameInheritableAttributes, de.undercouch.citeproc.helper.NodeHelper, org.w3c.dom.Document, .Element, .Node, .NodeList, java.util.ArrayList, .HashMap, .List, .Map

A citation style
Author
Michel Kraemer

Field Summary

Modifier and TypeField and Description
private final SBibliography
private final SCitation
private final String
private final SNameInheritableAttributes
private final List<LLocale>
private final Map<String, SMacro>
private final String

Constructor Summary

AccessConstructor and Description
public
SStyle(Document
the XML document
styleDocument
)

Creates the citation style from an XML document

Method Summary

Modifier and TypeMethod and Description
public SBibliography

Returns:

the bibliography element or null if the style file does not have one
getBibliography
()

Get the bibliography element defined in the style file

public SCitation

Returns:

the citation element or null if the style file does not have one
getCitation
()

Get the citation element defined in the style file

public String

Returns:

the default locale or null if no default locale is defined in this style
getDefaultLocale
()

Get the default locale for this style if defined

public SNameInheritableAttributes

Returns:

the name attributes
getInheritableNameAttributes
()

Get attributes that can be inherited to name elements

public List<LLocale>

Returns:

the additional localization data (or an empty list if there is no additional information in the style file)
getLocales
()

Get additional localization data defined in the style file.

public Map<String, SMacro>

Returns:

the macros
getMacros
()

Get the macros defined in the citation style file

public String

Returns:

the format or null if no value has been defined
getPageRangeFormat
()

Get the page range format defined for this style

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

bibliographyback to summary
private final SBibliography bibliography
citationback to summary
private final SCitation citation
defaultLocaleback to summary
private final String defaultLocale
inheritableNameAttributesback to summary
private final SNameInheritableAttributes inheritableNameAttributes
localesback to summary
private final List<LLocale> locales
macrosback to summary
private final Map<String, SMacro> macros
pageRangeFormatback to summary
private final String pageRangeFormat

Constructor Detail

SStyleback to summary
public SStyle(Document styleDocument)

Creates the citation style from an XML document

Parameters
styleDocument:Document

the XML document

Method Detail

getBibliographyback to summary
public SBibliography getBibliography()

Get the bibliography element defined in the style file

Returns:SBibliography

the bibliography element or null if the style file does not have one

getCitationback to summary
public SCitation getCitation()

Get the citation element defined in the style file

Returns:SCitation

the citation element or null if the style file does not have one

getDefaultLocaleback to summary
public String getDefaultLocale()

Get the default locale for this style if defined

Returns:String

the default locale or null if no default locale is defined in this style

getInheritableNameAttributesback to summary
public SNameInheritableAttributes getInheritableNameAttributes()

Get attributes that can be inherited to name elements

Returns:SNameInheritableAttributes

the name attributes

getLocalesback to summary
public List<LLocale> getLocales()

Get additional localization data defined in the style file. This data may override or augments information from the locale file

Returns:List<LLocale>

the additional localization data (or an empty list if there is no additional information in the style file)

getMacrosback to summary
public Map<String, SMacro> getMacros()

Get the macros defined in the citation style file

Returns:Map<String, SMacro>

the macros

getPageRangeFormatback to summary
public String getPageRangeFormat()

Get the page range format defined for this style

Returns:String

the format or null if no value has been defined