com.fluxtion.generator.model

Class TopologicallySortedDependecyGraph

java.lang.Object

com.fluxtion.generator.model.TopologicallySortedDependecyGraph

All Implemented Interfaces:

NodeRegistry

public class TopologicallySortedDependecyGraph
extends Object
implements NodeRegistry

Creates a sorted set of dependencies from a supplied set of instances.

Author:

Greg Higgins

Constructor Summary

Constructors

Constructor and Description
TopologicallySortedDependecyGraph(DeclarativeNodeConiguration declarativeNodeConiguration)
TopologicallySortedDependecyGraph(List nodes)
TopologicallySortedDependecyGraph(List nodes, Map<Object,String> publicNodes)
TopologicallySortedDependecyGraph(List nodes, Map<Object,String> publicNodes, DeclarativeNodeConiguration declarativeNodeConiguration, GenerationContext context, Map<String,com.fluxtion.api.audit.Auditor> auditorMap, SEPConfig config) Create a new TopologicallySortedDependecyGraph
TopologicallySortedDependecyGraph(Map<Object,String> publicNodes)
TopologicallySortedDependecyGraph(Object... obj)
TopologicallySortedDependecyGraph(SEPConfig config)

Method Summary

Modifier and Type	Method and Description
void	exportAsGraphMl(Writer writer, boolean addEvents) exports graph as graphml, can be exported with and without event as nodes on the graph.
<T> T	findOrCreateNode(Class<T> clazz, Map config, String variableName)
<T> T	findOrCreateNode(Class<T> clazz, Map config, String variableName, boolean isPublic)
<T> T	findOrCreatePublicNode(Class<T> clazz, Map config, String variableName)
void	generateDependencyTree() Generates the dependency tree for introspection.
SEPConfig	getConfig()
List<?>	getDirectChildren(Object parent) returns a list of the direct children of this object in the SEP.node in the SEP
List<?>	getDirectChildrenListeningForEvent(Object parent)
List<?>	getDirectParents(Object child) returns a list of the direct parents of this object in the SEP.
List<?>	getDirectParentsListeningForEvent(Object child)
List<Object>	getEventSortedDependents(Object obj)
Map<Object,String>	getInstanceMap()
Map<String,com.fluxtion.api.audit.Auditor>	getRegistrationListenerMap()
List<Object>	getSortedDependents()
List<Object>	getSortedDependents(Object obj)
boolean	isPublicNode(Object node)
<T extends com.fluxtion.api.audit.Auditor> T	registerAuditor(T node, String auditorName)
<T> T	registerNode(T node, String variableName)
<T> T	registerNode(T node, String variableName, boolean isPublic)
<T> T	registerPublicNode(T node, String variableName)
String	variableName(Object node) Accessor to the name mapping for an instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

TopologicallySortedDependecyGraph

public TopologicallySortedDependecyGraph(Object... obj)

TopologicallySortedDependecyGraph

public TopologicallySortedDependecyGraph(List nodes)

TopologicallySortedDependecyGraph

public TopologicallySortedDependecyGraph(Map<Object,String> publicNodes)

TopologicallySortedDependecyGraph

public TopologicallySortedDependecyGraph(DeclarativeNodeConiguration declarativeNodeConiguration)

TopologicallySortedDependecyGraph

public TopologicallySortedDependecyGraph(List nodes,
                                         Map<Object,String> publicNodes)

TopologicallySortedDependecyGraph

public TopologicallySortedDependecyGraph(SEPConfig config)

TopologicallySortedDependecyGraph

public TopologicallySortedDependecyGraph(List nodes,
                                         Map<Object,String> publicNodes,
                                         DeclarativeNodeConiguration declarativeNodeConiguration,
                                         GenerationContext context,
                                         Map<String,com.fluxtion.api.audit.Auditor> auditorMap,
                                         SEPConfig config)

Create a new TopologicallySortedDependecyGraph

Parameters:

nodes - The set of nodes that will be sorted as a list.

publicNodes - Map of public available instances, the value is the unique name of each instance. The names will override existing instances in the nodes List or add the node to the set.

declarativeNodeConiguration - factory description

strat - NodeNameProducer strategy

context - Generation context for this cycle

auditorMap - Auditors to inject

config - Config for this generation cycle

Method Detail

variableName

public String variableName(Object node)

Accessor to the name mapping for an instance.

Parameters:

node - The instance to for this lookup.

Returns:

the variable name of the instance.

getInstanceMap

public Map<Object,String> getInstanceMap()

getSortedDependents

public List<Object> getSortedDependents()
                                 throws Exception

Throws:

Exception

getRegistrationListenerMap

public Map<String,com.fluxtion.api.audit.Auditor> getRegistrationListenerMap()

getSortedDependents

public List<Object> getSortedDependents(Object obj)
                                 throws Exception

Parameters:

obj - The root object to search from in the graph.

Returns:

a sorted dependents list with this object as a root.

Throws:

Exception - when generating graph

getEventSortedDependents

public List<Object> getEventSortedDependents(Object obj)
                                      throws Exception

Throws:

Exception

getDirectChildren

public List<?> getDirectChildren(Object parent)

returns a list of the direct children of this object in the SEP.node in the SEP

Parameters:

parent - node in the SEP

Returns:

list of direct children of this node

getDirectChildrenListeningForEvent

public List<?> getDirectChildrenListeningForEvent(Object parent)

getDirectParents

public List<?> getDirectParents(Object child)

returns a list of the direct parents of this object in the SEP.

Parameters:

child - in the SEP

Returns:

direct parents of this node

getDirectParentsListeningForEvent

public List<?> getDirectParentsListeningForEvent(Object child)

registerPublicNode

public <T> T registerPublicNode(T node,
                                String variableName)

Specified by:

registerPublicNode in interface NodeRegistry

registerAuditor

public <T extends com.fluxtion.api.audit.Auditor> T registerAuditor(T node,
                                                                    String auditorName)

Specified by:

registerAuditor in interface NodeRegistry

registerNode

public <T> T registerNode(T node,
                          String variableName,
                          boolean isPublic)

registerNode

public <T> T registerNode(T node,
                          String variableName)

Specified by:

registerNode in interface NodeRegistry

findOrCreatePublicNode

public <T> T findOrCreatePublicNode(Class<T> clazz,
                                    Map config,
                                    String variableName)

Specified by:

findOrCreatePublicNode in interface NodeRegistry

findOrCreateNode

public <T> T findOrCreateNode(Class<T> clazz,
                              Map config,
                              String variableName)

Specified by:

findOrCreateNode in interface NodeRegistry

findOrCreateNode

public <T> T findOrCreateNode(Class<T> clazz,
                              Map config,
                              String variableName,
                              boolean isPublic)

generateDependencyTree

public void generateDependencyTree()
                            throws Exception

Generates the dependency tree for introspection.

Throws:

Exception - when problem generating the dependency tree

isPublicNode

public boolean isPublicNode(Object node)

getConfig

public SEPConfig getConfig()

exportAsGraphMl

public void exportAsGraphMl(Writer writer,
                            boolean addEvents)
                     throws SAXException,
                            TransformerConfigurationException

exports graph as graphml, can be exported with and without event as nodes on the graph.

Parameters:

writer - target

addEvents - flag to control inclusion of events as nodes

Throws:

SAXException - problem writing jpgraphMl

TransformerConfigurationException - problem writing jpgraphMl