descriptionfiles

Class Description

java.lang.Object

descriptionfiles.Description

public class Description
extends java.lang.Object

Contains a description of an operation, a term or others. The descriptions are stored in plain ascii text as well as in latex code.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOSOLO
static int	ONLYLATEX
static int	ONLYPLAIN

Constructor Summary

Constructors

Constructor and Description
Description(java.lang.String key, DescriptionType descType, java.lang.String section) Creates a new description instance.
Description(java.lang.String key, java.lang.String descType, java.lang.String section) Creates a new description instance.

Method Summary

Modifier and Type	Method and Description
void	append(java.lang.String asPlain, java.lang.String asLatex) Appends the two given strings each to the plain version and to the latex version.
void	appendAsLatex(java.lang.String s) Appends the given string to the latex version of the description.
void	appendAsPlain(java.lang.String s) Appends the given string to the plain version of the description.
java.lang.String	getAsLatex()
java.lang.String	getAsPlain()
DescriptionType	getDescriptionType()
java.lang.String	getDescText(DescSourceType sourceType) Returns the description text in the chosen syntax
java.lang.String	getKey() Returns the key with which this description is associated
java.lang.String	getSection()
boolean	hasKey() Returns true, if and only if, this description is associated with a key
boolean	hasRuntime() Returns true, if and only if, this description has an attached runtime
boolean	isOperation() Returns true, if and only if, this description describes an operation
boolean	isTerm() Returns true, if and only if, this description describes a term
boolean	isText() Returns true, if and only if, this description is a general text description
boolean	isType() Returns true, if and only if, this description describes a type

Methods inherited from class java.lang.Object

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

Field Detail

NOSOLO

public static final int NOSOLO

See Also:

Constant Field Values

ONLYPLAIN

public static final int ONLYPLAIN

See Also:

Constant Field Values

ONLYLATEX

public static final int ONLYLATEX

See Also:

Constant Field Values

Constructor Detail

Description

public Description(java.lang.String key,
                   DescriptionType descType,
                   java.lang.String section)

Creates a new description instance.

Parameters:

key - the key of the description

descType - the type of the description

section - the key of the section which the description is part of.

Description

public Description(java.lang.String key,
                   java.lang.String descType,
                   java.lang.String section)
            throws HelpFileException

Creates a new description instance.

Parameters:

key - the key of the description

descType - the type of the description coded as a string key

section - the section which the description is part of

Throws:

HelpFileException - thrown, if the type key is invalid

Method Detail

getSection

public java.lang.String getSection()

getDescriptionType

public DescriptionType getDescriptionType()

getAsPlain

public java.lang.String getAsPlain()

getAsLatex

public java.lang.String getAsLatex()

appendAsPlain

public void appendAsPlain(java.lang.String s)

Appends the given string to the plain version of the description.

Parameters:

s - the string to append

appendAsLatex

public void appendAsLatex(java.lang.String s)

Appends the given string to the latex version of the description.

Parameters:

s - the string to append

append

public void append(java.lang.String asPlain,
                   java.lang.String asLatex)

Appends the two given strings each to the plain version and to the latex version.

Parameters:

asPlain - the plain string to append

asLatex - the latex string to append

getDescText

public java.lang.String getDescText(DescSourceType sourceType)

Returns the description text in the chosen syntax

Parameters:

sourceType - the syntax

getKey

public java.lang.String getKey()

Returns the key with which this description is associated

hasKey

public boolean hasKey()

Returns true, if and only if, this description is associated with a key

hasRuntime

public boolean hasRuntime()

Returns true, if and only if, this description has an attached runtime

isText

public boolean isText()

Returns true, if and only if, this description is a general text description

isTerm

public boolean isTerm()

Returns true, if and only if, this description describes a term

isOperation

public boolean isOperation()

Returns true, if and only if, this description describes an operation

isType

public boolean isType()

Returns true, if and only if, this description describes a type