net.sourceforge.czt.session

Class DefaultSectionParentsCommand

java.lang.Object

net.sourceforge.czt.session.AbstractCommand

net.sourceforge.czt.session.DefaultSectionParentsCommand

All Implemented Interfaces:

Command, DefaultSectionParents

public abstract class DefaultSectionParentsCommand
extends AbstractCommand
implements DefaultSectionParents

Constructor Summary

Constructors

Constructor and Description
DefaultSectionParentsCommand()

Method Summary

Modifier and Type	Method and Description
protected void	calculateDefaultParents(String sectName) High level method used by the command computation chain to calculate the default parents of a given section name.
Set<String>	defaultParents(String sectName) Returns the default set of parents for a given section name for this dialect.
protected abstract boolean	doCalculateDefaultAnonymousParents(Set<String> result) Delegates calculation of parents for Section.ANONYMOUS sections, collecting the results in the parameter.
protected abstract boolean	doCalculateDefaultParents(String sectName, Set<String> result) Delegates calculation of parents for named sections, collecting the results in the parameter.
protected boolean	doCompute(String name, SectionManager manager) Computes the calculation for default section parents for the given section name and stores in the section manager.
protected Set<String>	knownToolkits() Each dialect has a set of known toolkits.
protected Set<String>	knownToolkits(String dialect)

Methods inherited from class net.sourceforge.czt.session.AbstractCommand

compute, processProperties, traceInfo, traceLog

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.czt.session.DefaultSectionParents

getDialect

Constructor Detail

DefaultSectionParentsCommand

public DefaultSectionParentsCommand()

Method Detail

doCalculateDefaultAnonymousParents

protected abstract boolean doCalculateDefaultAnonymousParents(Set<String> result)

Delegates calculation of parents for Section.ANONYMOUS sections, collecting the results in the parameter.

Parameters:

result - set of parents for anonymous section

Returns:

true if calculation is finished; false if should continue.

doCalculateDefaultParents

protected abstract boolean doCalculateDefaultParents(String sectName,
                                                     Set<String> result)

Delegates calculation of parents for named sections, collecting the results in the parameter. As different dialects are often extensions of each other, one might want to stop in between dialects for some cases (i.e. circus dialect handling Z's set_toolkit might not want to add circus_prelude).

Parameters:

result - set of parents for named section.

Returns:

true if calculation is finished; false if should continue.

knownToolkits

protected Set<String> knownToolkits()

Each dialect has a set of known toolkits. By default we use the static information from the Section file. Extensions might want to change this behaviour. This can be used by extending classes to control whether or not to stop calculating default parents. Care needs to be taken in special cases and more complicated extensions, where the information from util.Section is not enough to determine what are the standard sections to be considered.

Returns:

set of known toolkits for the current dialect.

knownToolkits

protected Set<String> knownToolkits(String dialect)

calculateDefaultParents

protected void calculateDefaultParents(String sectName)

High level method used by the command computation chain to calculate the default parents of a given section name. It implements the common features for all extensions and then delegate the actual work to abstract methods.

Parameters:

sectName -

doCompute

protected boolean doCompute(String name,
                            SectionManager manager)
                     throws CommandException

Computes the calculation for default section parents for the given section name and stores in the section manager. This result can than be accessed by the defaultParents(String) method.

Specified by:

doCompute in class AbstractCommand

Throws:

CommandException - whenever the command dialect does not agree with the section manager's.

defaultParents

public final Set<String> defaultParents(String sectName)

Returns the default set of parents for a given section name for this dialect. Calculations are cached. If called directly, calculation will take place. Otherwise, the cached results from previous calculation from the Command computation will be returned.

Specified by:

defaultParents in interface DefaultSectionParents