descriptionfiles

Class DescriptionFile

java.lang.Object

descriptionfiles.DescriptionFile

public class DescriptionFile
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DescriptionFile(java.lang.String filename, DescriptionFiles descFiles)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Iterable<Description>	getDesciptions()
Description	getDescription(java.lang.String descKey)
java.lang.String	getDescription(java.lang.String descKey, DescSourceType sourceType)
void	getDescText(javax.xml.stream.XMLEventReader xmlReader, Description target, boolean isMath)
static java.lang.String	getHyperRef(java.lang.String text, DescriptionType descType)
static java.lang.String	toLatexKey(java.lang.String string, DescriptionType descType)
static java.lang.String	toLatexKey(java.lang.String prefix, java.lang.String string, boolean toLowerCase)

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptionFile

public DescriptionFile(java.lang.String filename,
               DescriptionFiles descFiles)
                throws HelpFileException

Throws:

HelpFileException

Method Detail

toLatexKey

public static java.lang.String toLatexKey(java.lang.String prefix,
                          java.lang.String string,
                          boolean toLowerCase)

toLatexKey

public static java.lang.String toLatexKey(java.lang.String string,
                          DescriptionType descType)

getHyperRef

public static java.lang.String getHyperRef(java.lang.String text,
                           DescriptionType descType)

getDescText

public void getDescText(javax.xml.stream.XMLEventReader xmlReader,
               Description target,
               boolean isMath)
                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getDescription

public Description getDescription(java.lang.String descKey)

getDescription

public java.lang.String getDescription(java.lang.String descKey,
                              DescSourceType sourceType)

getDesciptions

public java.lang.Iterable<Description> getDesciptions()