Search this API

y.io.graphml.output
Interface GraphElementIdProvider

All Known Implementing Classes:
DefaultGraphElementIdProvider

public interface GraphElementIdProvider

Interface for classes that provide custom id's for core graphml elements

 

Method Summary
 java.lang.String getEdgeId(Edge edge, GraphMLWriteContext context)
          Get an ID for the specified edge Object
 java.lang.String getGraphId(Graph graph, GraphMLWriteContext context)
          Get an ID for the specified graph Object
 java.lang.String getNodeId(Node node, GraphMLWriteContext context)
          Get an ID for the specified node Object
 java.lang.String getPortId(Port port, Node owner, GraphMLWriteContext context)
          Get an ID for the specified port Object
 

Method Detail

getGraphId

java.lang.String getGraphId(Graph graph,
                            GraphMLWriteContext context)
Get an ID for the specified graph Object

Parameters:
graph - the current graph Object
context - the current write context, for further information to the provider
Returns:
an ID for the specified graph Object

getNodeId

java.lang.String getNodeId(Node node,
                           GraphMLWriteContext context)
Get an ID for the specified node Object

Parameters:
node - the current node Object
context - the current write context, for further information to the provider
Returns:
an ID for the specified node Object

getEdgeId

java.lang.String getEdgeId(Edge edge,
                           GraphMLWriteContext context)
Get an ID for the specified edge Object

Parameters:
edge - the current edge Object
context - the current write context, for further information to the provider
Returns:
an ID for the specified edge Object

getPortId

java.lang.String getPortId(Port port,
                           Node owner,
                           GraphMLWriteContext context)
Get an ID for the specified port Object

Parameters:
port - the current port Object
context - the current write context, for further information to the provider
owner - the node that owns the current port
Returns:
an ID for the specified port Object

© Copyright 2000-2022,
yWorks GmbH.
All rights reserved.