com.fluxtion.compiler.generation.model

Class TopologicallySortedDependencyGraph

java.lang.Object

com.fluxtion.compiler.generation.model.TopologicallySortedDependencyGraph

All Implemented Interfaces:

NodeRegistry

public class TopologicallySortedDependencyGraph
extends Object
implements NodeRegistry

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

Author:

Greg Higgins

Field Summary

Fields

Modifier and Type	Field and Description
static com.fluxtion.runtime.callback.CallbackDispatcherImpl	CALLBACK_DISPATCHER

Constructor Summary

Constructors

Constructor and Description
TopologicallySortedDependencyGraph(EventProcessorConfig config)
TopologicallySortedDependencyGraph(List<?> nodes)
TopologicallySortedDependencyGraph(List<?> nodes, Map<Object,String> publicNodes, NodeFactoryRegistration nodeFactoryRegistration, GenerationContext context, Map<String,com.fluxtion.runtime.audit.Auditor> auditorMap, EventProcessorConfig config) Create a new TopologicallySortedDependecyGraph
TopologicallySortedDependencyGraph(Map<Object,String> publicNodes)
TopologicallySortedDependencyGraph(Object... obj)

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<String,Object> config, String variableName) Find or create a node using a registered NodeFactory.
<T> T	findOrCreateNode(Class<T> clazz, Map<String,Object> config, String variableName, boolean isPublic)
<T> T	findOrCreatePublicNode(Class<T> clazz, Map<String,Object> config, String variableName) Find or create a node using a registered NodeFactory.
void	generateDependencyTree() Generates the dependency tree for introspection.
EventProcessorConfig	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()
List<Object>	getObjectSortedDependents()
Map<String,com.fluxtion.runtime.audit.Auditor>	getRegistrationListenerMap()
List<Object>	getSortedDependents()
List<Object>	getSortedDependents(Object obj)
boolean	isPublicNode(Object node)
<T extends com.fluxtion.runtime.audit.Auditor> T	registerAuditor(T node, String auditorName) Register an Auditor with Fluxtion generator.
<T> T	registerNode(T node, String variableName) Register a user created node with Fluxtion generator, no NodeFactory's will be used in this operation.
<T> T	registerNode(T node, String variableName, boolean isPublic)
<T> T	registerPublicNode(T node, String variableName) Register a user created node with Fluxtion generator, no NodeFactory's will be used in this operation.
static boolean	trySetAccessible(Field field)
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

Field Detail

CALLBACK_DISPATCHER

public static final com.fluxtion.runtime.callback.CallbackDispatcherImpl CALLBACK_DISPATCHER

Constructor Detail

TopologicallySortedDependencyGraph

public TopologicallySortedDependencyGraph(Object... obj)

TopologicallySortedDependencyGraph

public TopologicallySortedDependencyGraph(List<?> nodes)

TopologicallySortedDependencyGraph

public TopologicallySortedDependencyGraph(Map<Object,String> publicNodes)

TopologicallySortedDependencyGraph

public TopologicallySortedDependencyGraph(EventProcessorConfig config)

TopologicallySortedDependencyGraph

public TopologicallySortedDependencyGraph(List<?> nodes,
                                          Map<Object,String> publicNodes,
                                          NodeFactoryRegistration nodeFactoryRegistration,
                                          GenerationContext context,
                                          Map<String,com.fluxtion.runtime.audit.Auditor> auditorMap,
                                          EventProcessorConfig 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.

nodeFactoryRegistration - factory description

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

getObjectSortedDependents

public List<Object> getObjectSortedDependents()
                                       throws Exception

Throws:

Exception

getRegistrationListenerMap

public Map<String,com.fluxtion.runtime.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)

Description copied from interface: NodeRegistry

Register a user created node with Fluxtion generator, no NodeFactory's will be used in this operation. The node will have public scope and the name will be generated from a NodeNameProducer strategy if the supplied name is null.

Specified by:

registerPublicNode in interface NodeRegistry

Type Parameters:

T - The type of the node to be created.

Parameters:

node - The node to add to the SEP

variableName - the variableName name of the node

Returns:

registerAuditor

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

Description copied from interface: NodeRegistry

Register an Auditor with Fluxtion generator. The Auditor will have public scope registered with the name provided.

Specified by:

registerAuditor in interface NodeRegistry

Type Parameters:

T - The Auditor class

Parameters:

node - The Auditor to register

auditorName - the public name of the Auditor

Returns:

The registered Auditor

registerNode

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

registerNode

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

Description copied from interface: NodeRegistry

Register a user created node with Fluxtion generator, no NodeFactory's will be used in this operation. The node will have private scope and the name will be generated from a NodeNameProducer strategy if the supplied name is null.

Specified by:

registerNode in interface NodeRegistry

Type Parameters:

T - The type of the node to be created.

Parameters:

node - The node to add to the SEP

variableName - the variableName name of the node

Returns:

findOrCreatePublicNode

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

Description copied from interface: NodeRegistry

Find or create a node using a registered NodeFactory. The generated node will have public scope and the name will be generated from a NodeNameProducer strategy if the supplied name is null.

Specified by:

findOrCreatePublicNode in interface NodeRegistry

Type Parameters:

T - The type of the node to be created.

Parameters:

clazz - The class of type T

config - a map used by a NodeFactory to create a node.

variableName - the variable name in the SEP

Returns:

The node that is referenced by the config map.

findOrCreateNode

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

Description copied from interface: NodeRegistry

Find or create a node using a registered NodeFactory. The generated node will have private scope and the name will be generated from a NodeNameProducer strategy if the supplied name is null.

Specified by:

findOrCreateNode in interface NodeRegistry

Type Parameters:

T - The type of the node to be created.

Parameters:

clazz - The class of type T

config - a map used by a NodeFactory to create a node.

variableName - the variable name in the SEP

Returns:

The node that is referenced by the config map.

findOrCreateNode

public <T> T findOrCreateNode(Class<T> clazz,
                              Map<String,Object> 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 EventProcessorConfig 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

trySetAccessible

public static boolean trySetAccessible(Field field)