Package adams.core.option

Class AbstractDocumentationProducer<O>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.option.AbstractOptionProducer<O,I>

adams.core.option.AbstractRecursiveOptionProducer<O,I>

adams.core.option.AbstractRecursiveOptionProducerWithOptionHandling<O,StringBuilder>

adams.core.option.AbstractDocumentationProducer<O>

Type Parameters:

O - the type of output data that gets generated

I - the internal type used while nesting

All Implemented Interfaces:

CleanUpHandler, Destroyable, LoggingSupporter, OptionHandler, OptionProducer<O,StringBuilder>, OptionProducerWithOptionHandling<O,StringBuilder>, RecursiveOptionProducer, SizeOfHandler, Serializable

Direct Known Subclasses:

XhtmlProducer

public abstract class AbstractDocumentationProducer<O>
extends AbstractRecursiveOptionProducerWithOptionHandling<O,StringBuilder>

Ancestor for producers that generate documentation that is split into two parts: 1. structure of flow and 2. details of individual actors.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractDocumentationProducer.ActorPosition	Container object for generating the overview structure.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Index	the index in the structure.
protected HashMap<String,AbstractDocumentationProducer.ActorPosition>	m_NamePosition	the relation between full actor name and position container.
protected List<AbstractDocumentationProducer.ActorPosition>	m_Positions	the flat list of actors.

Fields inherited from class adams.core.option.AbstractRecursiveOptionProducerWithOptionHandling

m_OptionManager

Fields inherited from class adams.core.option.AbstractRecursiveOptionProducer

m_Nesting

Fields inherited from class adams.core.option.AbstractOptionProducer

m_Input, m_LastGenerated, m_Output, m_OutputVariableValues, m_SkippedProperties, m_UsePropertyNames

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractDocumentationProducer()

Method Summary

Modifier and Type	Method	Description
protected void	addPosition(Actor actor, int nesting, int index)	Adds the position to the internal list/map.
protected void	initialize()	Initializes the members.
protected void	preProduce()	Hook-method before starting visiting options.
StringBuilder	processOption(AbstractArgumentOption option)	Does nothing.
StringBuilder	processOption(BooleanOption option)	Does nothing.
StringBuilder	processOption(ClassOption option)	Visits a class option.

Methods inherited from class adams.core.option.AbstractRecursiveOptionProducerWithOptionHandling

cleanUpOptions, defineOptions, destroy, finishInit, getOptionManager, newOptionManager, toCommandLine

Methods inherited from class adams.core.option.AbstractRecursiveOptionProducer

cleanUp, generateLoggingString, getDebugIndentation, getDebugIndentation, getRecursionLevel, reset

Methods inherited from class adams.core.option.AbstractOptionProducer

checkInput, doProduce, doProduce, getCurrentValue, getInput, getOptionIdentifier, getOutput, getOutputVariableValues, getSkippedProperties, getUsePropertyNames, globalInfo, initOutput, isDefaultValue, loggingLevelTipText, main, outputVariableValuesTipText, postProduce, postProduce, preProduce, produce, produce, runProducer, setLoggingLevel, setOutputVariableValues, setSkippedProperties, toString, toString, write

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.option.OptionProducer

cleanUp, doProduce, getInput, getLoggingLevel, getOutput, getOutputVariableValues, getSkippedProperties, getUsePropertyNames, globalInfo, loggingLevelTipText, outputVariableValuesTipText, produce, setLoggingLevel, setOutputVariableValues, setSkippedProperties, toString, write

Field Detail

m_Index

protected int m_Index

the index in the structure.

m_Positions

protected List<AbstractDocumentationProducer.ActorPosition> m_Positions

the flat list of actors.

m_NamePosition

protected HashMap<String,AbstractDocumentationProducer.ActorPosition> m_NamePosition

the relation between full actor name and position container.

Constructor Detail

AbstractDocumentationProducer

public AbstractDocumentationProducer()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionProducer<O,StringBuilder>

processOption

public StringBuilder processOption(BooleanOption option)

Does nothing.

Specified by:

processOption in interface OptionProducer<O,StringBuilder>

Specified by:

processOption in class AbstractOptionProducer<O,StringBuilder>

Parameters:

option - the boolean option

Returns:

always null

addPosition

protected void addPosition(Actor actor,
                           int nesting,
                           int index)

Adds the position to the internal list/map.

Parameters:

actor - the actor to record the position for

nesting - the current nesting

index - the index of the actor

processOption

public StringBuilder processOption(ClassOption option)

Visits a class option.

Specified by:

processOption in interface OptionProducer<O,StringBuilder>

Specified by:

processOption in class AbstractOptionProducer<O,StringBuilder>

Parameters:

option - the class option

Returns:

always null

processOption

public StringBuilder processOption(AbstractArgumentOption option)

Does nothing.

Specified by:

processOption in interface OptionProducer<O,StringBuilder>

Specified by:

processOption in class AbstractOptionProducer<O,StringBuilder>

Parameters:

option - the argument option

Returns:

always null

preProduce

protected void preProduce()

Hook-method before starting visiting options.

Overrides:

preProduce in class AbstractOptionProducer<O,StringBuilder>

See Also:

AbstractOptionProducer.initOutput()