net.sourceforge.czt.parser.util

Class SectParentResolver

java.lang.Object

net.sourceforge.czt.parser.util.SectParentResolver

public class SectParentResolver
extends Object

A utility class to resolve section parents, taking cyclic relationships into account. The class provides static methods to check for cycles or collect parent relationships.

Author:

Andrius Velykis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SectParentResolver.CyclicSectionsException Exception to signal that cyclic parent sections have been found.
static interface	SectParentResolver.ParentCollector

Constructor Summary

Constructors

Constructor and Description
SectParentResolver()

Method Summary

Modifier and Type	Method and Description
static void	checkCyclicParents(String sectName, SectionInfo manager) Checks for cyclic parents of the given section, and throws an exception if a cyclic relationship is found.
static void	collectParents(String sectName, SectionInfo manager, SectParentResolver.ParentCollector collector) Collects the parent section names of the given sectName.
static void	collectParentsUnchecked(String sectName, SectionInfo manager, SectParentResolver.ParentCollector collector) The same as collectParents(String, SectionInfo, ParentCollector), but does not throw exception if cycles found.
static Map<String,Set<String>>	getParentDependencies(String sectName, SectionInfo manager) Calculates a parent dependency map.
static Set<String>	getParents(String sectName, SectionInfo manager) Collects all parents for the given section.

Methods inherited from class java.lang.Object

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

Constructor Detail

SectParentResolver

public SectParentResolver()

Method Detail

checkCyclicParents

public static void checkCyclicParents(String sectName,
                                      SectionInfo manager)
                               throws CommandException,
                                      SectParentResolver.CyclicSectionsException

Checks for cyclic parents of the given section, and throws an exception if a cyclic relationship is found. The section manager must have the sections already parsed.

Parameters:

sectName -

manager -

Throws:

CommandException

SectParentResolver.CyclicSectionsException

getParentDependencies

public static Map<String,Set<String>> getParentDependencies(String sectName,
                                                            SectionInfo manager)
                                                     throws CommandException,
                                                            SectParentResolver.CyclicSectionsException

Calculates a parent dependency map. The map contains sections mapping to sets of other sections, that depend on it (have the first section as their parent).

Parameters:

sectName -

manager -

Returns:

Throws:

CommandException

SectParentResolver.CyclicSectionsException

getParents

public static Set<String> getParents(String sectName,
                                     SectionInfo manager)
                              throws CommandException

Collects all parents for the given section. Ignores any cyclic dependencies.

Parameters:

sectName -

manager -

Returns:

Throws:

CommandException

collectParents

public static void collectParents(String sectName,
                                  SectionInfo manager,
                                  SectParentResolver.ParentCollector collector)
                           throws CommandException,
                                  SectParentResolver.CyclicSectionsException

Collects the parent section names of the given sectName. The collector is called first on the deepest parents, and goes up afterwards. Note that the collector may visit the same section several times if it is referenced in different "parent branches". The section manager must have the sections already parsed.

Parameters:

sectName -

manager -

collector -

Throws:

CommandException

SectParentResolver.CyclicSectionsException - if a cyclic parent relationships are found

collectParentsUnchecked

public static void collectParentsUnchecked(String sectName,
                                           SectionInfo manager,
                                           SectParentResolver.ParentCollector collector)
                                    throws CommandException

The same as collectParents(String, SectionInfo, ParentCollector), but does not throw exception if cycles found. If a cycle is visited, the repeated section is ignored.

Parameters:

sectName -

manager -

collector -

Throws:

CommandException