descriptionfiles

Class DescriptionFile

java.lang.Object

descriptionfiles.DescriptionFile

public class DescriptionFile
extends java.lang.Object

Associated with one file containing multiple descriptions. The descriptions are accessed via keywords.

Constructor Summary

Constructors

Constructor and Description
DescriptionFile(java.lang.String filename, DescriptionFiles descFiles) Creates a new instance by loading a description file.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<Description>	getDesciptions() Returns an Iterable to iterate over all descriptions of the file
Description	getDescription(java.lang.String descKey) Returns the description associated with the given key or null, if there is no such description
java.lang.String	getDescription(java.lang.String descKey, DescSourceType sourceType) Returns the description associated with the given key in the chosen syntax
static java.lang.String	getHyperRef(java.lang.String key, DescriptionType descType) Creates a reference to the given key
static java.lang.String	toLatexKey(java.lang.String string, DescriptionType descType) Creates a valid latex key for example to use it as a label key in latex.
static java.lang.String	toLatexKey(java.lang.String prefix, java.lang.String string, boolean toLowerCase) Converts the given string to a valid latex key for example to use it as a label key in latex.

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptionFile

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

Creates a new instance by loading a description file.

Parameters:

filename - the name of the file to load

descFiles - the instance containing all description files

Throws:

HelpFileException - if an error occurs while parsing the file

Method Detail

toLatexKey

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

Converts the given string to a valid latex key for example to use it as a label key in latex.

Parameters:

prefix - will be attached at the beginning of the string together with an underscore

string - the string to convert

toLowerCase - if true, then the result will be in lower case.

Returns:

the resulting latex key

toLatexKey

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

Creates a valid latex key for example to use it as a label key in latex.

Parameters:

string - the string to convert

descType - the type of the description associated with the key. This determines the prefix of the key.

Returns:

the resulting latex key

getHyperRef

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

Creates a reference to the given key

Parameters:

key - the key to reference

descType - the type of the description associated with the key

Returns:

the resulting reference in latex syntax

getDescription

public Description getDescription(java.lang.String descKey)

Returns the description associated with the given key or null, if there is no such description

getDescription

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

Returns the description associated with the given key in the chosen syntax

Parameters:

descKey - the key associated with the description to receive

sourceType - the syntax in which to receive the description

Returns:

the description in the chosen syntax

getDesciptions

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

Returns an Iterable to iterate over all descriptions of the file