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.
The code is just a modified subset of Reducer.

Field Summary

Fields

Modifier and Type	Field and Description
AdditionalDocs	data
protected String	fileName
protected File	inputFile
static 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 and Description
DocOnly(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg)

Method Summary

Modifier and Type	Method and Description
void	distribute(ModuleRegistry moduleReg, String key, boolean replace)
protected void	error(Exception ex, String s)
protected void	error(Location<XMLDocumentIdentifier> loc, 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)

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 Detail

KEY_MODULE_DOC

public static final String KEY_MODULE_DOC

See Also:

Constant Field Values

data

public AdditionalDocs data

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

Constructor Detail

DocOnly

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

Method Detail

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)

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)