Package eu.bandm.tools.option

Class Compiler.Phase_usage

java.lang.Object

eu.bandm.tools.tdom.runtime.BaseVisitor

eu.bandm.tools.option.absy.Visitor

eu.bandm.tools.option.Compiler.Phase

eu.bandm.tools.option.Compiler.Phase_usage

All Implemented Interfaces:

PCDataVisitor

Direct Known Subclasses:

Compiler.Phase_usage_enumerations, Compiler.Phase_usage_options

Enclosing class:

Compiler

protected class Compiler.Phase_usage
extends Compiler.Phase

Common superclass for Compiler.Phase_usage_enumerations and Compiler.Phase_usage_options.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Element_text	besttext	The text which matches best the user language or (as fall back) the default language or (as fall-back) any language.
(package private) final String	defaultLanguage	Input parameter: The preferred fall-back language.
(package private) final @Opt GeneratedMethod	gm	Input parameter: the usage() method under construction.
(package private) boolean	langhit	Whether the user language has been hit = no fall back was necessaty.
(package private) String	textfound	The contents of besttext, wrapped in parentheses if not langhit
(package private) final String	usage_lang	Input parameter: The (human) user language for which the usage method gm is under construction.

Fields inherited from class eu.bandm.tools.option.Compiler.Phase

abbrev, currentOptionElement, name, option_qualifier

Fields inherited from class eu.bandm.tools.tdom.runtime.BaseVisitor

validating

Constructor Summary

Constructors

Constructor	Description
Phase_usage(GeneratedMethod gm, String usage_lang, String defaultLanguage)	Compile the printing of a found text object to the growing method.

Method Summary

Modifier and Type	Method	Description
(package private) void	deliver(String s)	Add the text to the method under construction as a Java statement.
protected void	resetTextFound()	starts a new search for a best test.
void	visit(Element_desc el)	Descend and analyse all contained Element_text.
void	visit(Element_text el)	Finds the best fitting explanation translation.

Methods inherited from class eu.bandm.tools.option.Compiler.Phase

bothtags, bothtags_formatted, ERROR, longestname, longesttag, shortestname, shortesttag, visit, WARNING

Methods inherited from class eu.bandm.tools.option.absy.Visitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class eu.bandm.tools.tdom.runtime.BaseVisitor

visit

Methods inherited from class java.lang.Object

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

Field Details

besttext

Element_text besttext

The text which matches best the user language or (as fall back) the default language or (as fall-back) any language.

textfound

String textfound

The contents of besttext, wrapped in parentheses if not langhit

langhit

boolean langhit

Whether the user language has been hit = no fall back was necessaty.

gm

@Opt
final @Opt GeneratedMethod gm

Input parameter: the usage() method under construction.

usage_lang

final String usage_lang

Input parameter: The (human) user language for which the usage method gm is under construction.

defaultLanguage

final String defaultLanguage

Input parameter: The preferred fall-back language. Is equal to Compiler.LINGUA_FRANCA, if at least one entry into this exists. Otherwise arbitrarily chosen from the appearing languages.

Constructor Details

Phase_usage

Phase_usage(GeneratedMethod gm,
 String usage_lang,
 String defaultLanguage)

Compile the printing of a found text object to the growing method.

Parameters:

usage_lang - the selected language of the usage method do generate.

defaultLanguage - fall-back if no text version in user_lang exists

Method Details

deliver

void deliver(String s)

Add the text to the method under construction as a Java statement.

resetTextFound

protected void resetTextFound()

starts a new search for a best test. Is called by the callers immediately before calling visit(Element_desc).

visit

public void visit(Element_desc el)

Descend and analyse all contained Element_text. (There is at least one, due to DTD content definition.) Sets the global registers textfound, besttext, and langhit.

Overrides:

visit in class Visitor

visit

public void visit(Element_text el)

Finds the best fitting explanation translation. Namely usage_lang, then defaultLanguage, than arbitrary. (Comes here from Visitor.visit(Element_comment) explicitly, or from visit(Element_desc) implicitly.

Overrides:

visit in class Visitor