Package eu.bandm.tools.d2d2.base

Class DocOnly

java.lang.Object

eu.bandm.tools.tdom.runtime.BaseVisitor

eu.bandm.tools.d2d2.absy.Visitor

eu.bandm.tools.d2d2.base.DocOnly

All Implemented Interfaces:

PCDataVisitor

public class DocOnly
extends eu.bandm.tools.d2d2.absy.Visitor

A source file which only adds comments to existing modules. Uses a subset of the ddf parsing rules, and is fed into the documentation generation process of Def2Doc3.
Usage: create one fresh instance (no re-usage), invoke fromFile(File), invoke distribute(ModuleRegistry,String,boolean). This will modify the data of the (uninstalled) module contained in the ModuleRegistry.

(The code for parsing is just a modified subset of Reducer.)

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	dockey	Visitor register.
(package private) CheckedList<LocString>	docs	Visitor register.
protected String	fileName
protected File	inputFile
static final String	KEY_MODULE_DOC
protected Map<String,Location<XMLDocumentIdentifier>>	modLocations
protected String	moduleName
protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>>	msg

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

validating

Constructor Summary

Constructors

Constructor	Description
DocOnly(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg)

Method Summary

Modifier and Type	Method	Description
void	distribute(ModuleRegistry moduleReg, String key, boolean replace)
protected void	error(Location<XMLDocumentIdentifier> loc, String s)
protected void	error(Exception ex, String s)
protected void	error(String s)
void	fromFile(File inputFile)
protected void	log(String s)
protected void	splitdoctext(String text, Location<XMLDocumentIdentifier> startloc)
void	visit(eu.bandm.tools.d2d2.absy.Element_doctext element)
void	visit(eu.bandm.tools.d2d2.absy.Element_documentation element)	<!ELEMENT documentation (ident, reflist?, (doctext | longdoctext)) >
void	visit(eu.bandm.tools.d2d2.absy.Element_longdoctext element)
void	visit(eu.bandm.tools.d2d2.absy.Element_module element)
protected void	warning(Location<XMLDocumentIdentifier> loc, String s, Object... args)

Methods inherited from class eu.bandm.tools.d2d2.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, 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

KEY_MODULE_DOC

public static final String KEY_MODULE_DOC

See Also:

• Constant Field Values

msg

protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg

inputFile

protected File inputFile

fileName

protected String fileName

moduleName

protected String moduleName

modLocations

protected Map<String,Location<XMLDocumentIdentifier>> modLocations

dockey

String dockey

Visitor register.

docs

CheckedList<LocString> docs

Visitor register.

Constructor Details

DocOnly

public DocOnly(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg)

Method Details

fromFile

public void fromFile(File inputFile)

error

protected void error(String s)

error

protected void error(Exception ex,
 String s)

error

protected void error(Location<XMLDocumentIdentifier> loc,
 String s)

warning

protected void warning(Location<XMLDocumentIdentifier> loc,
 String s,
 Object... args)

log

protected void log(String s)

visit

public void visit(eu.bandm.tools.d2d2.absy.Element_module element)

Overrides:

visit in class eu.bandm.tools.d2d2.absy.Visitor

visit

public void visit(eu.bandm.tools.d2d2.absy.Element_documentation element)

<!ELEMENT documentation (ident, reflist?, (doctext | longdoctext)) >

Overrides:

visit in class eu.bandm.tools.d2d2.absy.Visitor

splitdoctext

protected void splitdoctext(String text,
 Location<XMLDocumentIdentifier> startloc)

visit

public void visit(eu.bandm.tools.d2d2.absy.Element_doctext element)

Overrides:

visit in class eu.bandm.tools.d2d2.absy.Visitor

visit

public void visit(eu.bandm.tools.d2d2.absy.Element_longdoctext element)

Overrides:

visit in class eu.bandm.tools.d2d2.absy.Visitor

distribute

public void distribute(ModuleRegistry moduleReg,
 String key,
 boolean replace)