org.graphdrawing.graphml
Interface DocumentRoot

All Superinterfaces:
EObject, Notifier
All Known Implementing Classes:
DocumentRootImpl

public interface DocumentRoot
extends EObject

A representation of the model object 'Document Root'.

The following features are supported:

See Also:
GraphMLPackage.getDocumentRoot()
Rating red
Generated:
This code was automatically generated.
Model element:
extendedMetaData="name=''
kind='mixed'"

Method Summary
 DataType getData()
          Returns the value of the 'Data' containment reference.
 DefaultType getDefault()
          Returns the value of the 'Default' containment reference.
 String getDesc()
          Returns the value of the 'Desc' attribute.
 EdgeType getEdge()
          Returns the value of the 'Edge' containment reference.
 EndpointType getEndpoint()
          Returns the value of the 'Endpoint' containment reference.
 GraphType getGraph()
          Returns the value of the 'Graph' containment reference.
 GraphmlType getGraphml()
          Returns the value of the 'Graphml' containment reference.
 HyperedgeType getHyperedge()
          Returns the value of the 'Hyperedge' containment reference.
 KeyType getKey()
          Returns the value of the 'Key' containment reference.
 LocatorType getLocator()
          Returns the value of the 'Locator' containment reference.
 FeatureMap getMixed()
          Returns the value of the 'Mixed' attribute list.
 NodeType getNode()
          Returns the value of the 'Node' containment reference.
 PortType getPort()
          Returns the value of the 'Port' containment reference.
 EMap<String,String> getXMLNSPrefixMap()
          Returns the value of the 'XMLNS Prefix Map' map.
 EMap<String,String> getXSISchemaLocation()
          Returns the value of the 'XSI Schema Location' map.
 void setData(DataType value)
          Sets the value of the 'Data' containment reference.
 void setDefault(DefaultType value)
          Sets the value of the 'Default' containment reference.
 void setDesc(String value)
          Sets the value of the 'Desc' attribute.
 void setEdge(EdgeType value)
          Sets the value of the 'Edge' containment reference.
 void setEndpoint(EndpointType value)
          Sets the value of the 'Endpoint' containment reference.
 void setGraph(GraphType value)
          Sets the value of the 'Graph' containment reference.
 void setGraphml(GraphmlType value)
          Sets the value of the 'Graphml' containment reference.
 void setHyperedge(HyperedgeType value)
          Sets the value of the 'Hyperedge' containment reference.
 void setKey(KeyType value)
          Sets the value of the 'Key' containment reference.
 void setLocator(LocatorType value)
          Sets the value of the 'Locator' containment reference.
 void setNode(NodeType value)
          Sets the value of the 'Node' containment reference.
 void setPort(PortType value)
          Sets the value of the 'Port' containment reference.
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getMixed

FeatureMap getMixed()
Returns the value of the 'Mixed' attribute list. The list contents are of type FeatureMap.Entry.

If the meaning of the 'Mixed' attribute list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Mixed' attribute list.
See Also:
GraphMLPackage.getDocumentRoot_Mixed()
Generated:
This code was automatically generated.
Model element:
unique=false
dataType=org.eclipse.emf.ecore.EFeatureMapEntry
many=true
extendedMetaData="kind='elementWildcard'
name=':mixed'"

getXMLNSPrefixMap

EMap<String,String> getXMLNSPrefixMap()
Returns the value of the 'XMLNS Prefix Map' map. The key is of type String, and the value is of type String,

If the meaning of the 'XMLNS Prefix Map' map isn't clear, there really should be more of a description here...

Returns:
the value of the 'XMLNS Prefix Map' map.
See Also:
GraphMLPackage.getDocumentRoot_XMLNSPrefixMap()
Generated:
This code was automatically generated.
Model element:
mapType="org.eclipse.emf.ecore.EStringToStringMapEntry
transient=true
extendedMetaData="kind='attribute'
name='xmlns:prefix'"

getXSISchemaLocation

EMap<String,String> getXSISchemaLocation()
Returns the value of the 'XSI Schema Location' map. The key is of type String, and the value is of type String,

If the meaning of the 'XSI Schema Location' map isn't clear, there really should be more of a description here...

Returns:
the value of the 'XSI Schema Location' map.
See Also:
GraphMLPackage.getDocumentRoot_XSISchemaLocation()
Generated:
This code was automatically generated.
Model element:
mapType="org.eclipse.emf.ecore.EStringToStringMapEntry
transient=true
extendedMetaData="kind='attribute'
name='xsi:schemaLocation'"

getData

DataType getData()
Returns the value of the 'Data' containment reference. Description: In GraphML there may be data-functions attached to graphs, nodes, ports, edges, hyperedges and endpoint and to the whole collection of graphs described by the content of <graphml>. These functions are declared by <key> elements (children of <graphml>) and defined by <data> elements. Occurence: <graphml>, <graph>, <node>, <port>, <edge>, <hyperedge>, and <endpoint>.

Returns:
the value of the 'Data' containment reference.
See Also:
setData(DataType), GraphMLPackage.getDocumentRoot_Data()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='data'
namespace='##targetNamespace'"

setData

void setData(DataType value)
Sets the value of the 'Data' containment reference.

Parameters:
value - the new value of the 'Data' containment reference.
See Also:
getData()
Generated:
This code was automatically generated.

getDefault

DefaultType getDefault()
Returns the value of the 'Default' containment reference. Description: In GraphML there may be data-functions attached to graphs, nodes, ports, edges, hyperedges and endpoint and to the whole collection of graphs described by the content of <graphml>. These functions are declared by <key> elements (children of <graphml>) and defined by <data> elements. The (optional) <default> child of <key> gives the default value for the corresponding function. Occurence: <key>.

Returns:
the value of the 'Default' containment reference.
See Also:
setDefault(DefaultType), GraphMLPackage.getDocumentRoot_Default()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='default'
namespace='##targetNamespace'"

setDefault

void setDefault(DefaultType value)
Sets the value of the 'Default' containment reference.

Parameters:
value - the new value of the 'Default' containment reference.
See Also:
getDefault()
Generated:
This code was automatically generated.

getDesc

String getDesc()
Returns the value of the 'Desc' attribute. Description: Provides human-readable descriptions for the GraphML element containing this <desc> as its first child. Occurence: <key>, <graphml>, <graph>, <node>, <port>, <edge>, <hyperedge>, and <endpoint>.

Returns:
the value of the 'Desc' attribute.
See Also:
setDesc(String), GraphMLPackage.getDocumentRoot_Desc()
Generated:
This code was automatically generated.
Model element:
unique=false
dataType=org.eclipse.emf.ecore.xml.type.String
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='desc'
namespace='##targetNamespace'"

setDesc

void setDesc(String value)
Sets the value of the 'Desc' attribute.

Parameters:
value - the new value of the 'Desc' attribute.
See Also:
getDesc()
Generated:
This code was automatically generated.

getEdge

EdgeType getEdge()
Returns the value of the 'Edge' containment reference. Description: Describes an edge in the <graph> which contains this <edge>. Occurence: <graph>.

Returns:
the value of the 'Edge' containment reference.
See Also:
setEdge(EdgeType), GraphMLPackage.getDocumentRoot_Edge()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='edge'
namespace='##targetNamespace'"

setEdge

void setEdge(EdgeType value)
Sets the value of the 'Edge' containment reference.

Parameters:
value - the new value of the 'Edge' containment reference.
See Also:
getEdge()
Generated:
This code was automatically generated.

getEndpoint

EndpointType getEndpoint()
Returns the value of the 'Endpoint' containment reference. Description: The list of <endpoints> within a hyperedge points to the nodes contained in this hyperedge. Occurence: <hyperedge>.

Returns:
the value of the 'Endpoint' containment reference.
See Also:
setEndpoint(EndpointType), GraphMLPackage.getDocumentRoot_Endpoint()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='endpoint'
namespace='##targetNamespace'"

setEndpoint

void setEndpoint(EndpointType value)
Sets the value of the 'Endpoint' containment reference.

Parameters:
value - the new value of the 'Endpoint' containment reference.
See Also:
getEndpoint()
Generated:
This code was automatically generated.

getGraph

GraphType getGraph()
Returns the value of the 'Graph' containment reference. Description: Describes one graph in this document. Occurence: <graphml>, <node>, <edge>, <hyperedge>.

Returns:
the value of the 'Graph' containment reference.
See Also:
setGraph(GraphType), GraphMLPackage.getDocumentRoot_Graph()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='graph'
namespace='##targetNamespace'"

setGraph

void setGraph(GraphType value)
Sets the value of the 'Graph' containment reference.

Parameters:
value - the new value of the 'Graph' containment reference.
See Also:
getGraph()
Generated:
This code was automatically generated.

getGraphml

GraphmlType getGraphml()
Returns the value of the 'Graphml' containment reference. Description: <graphml> is the root element of each GraphML document. Occurence: root.

Returns:
the value of the 'Graphml' containment reference.
See Also:
setGraphml(GraphmlType), GraphMLPackage.getDocumentRoot_Graphml()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='graphml'
namespace='##targetNamespace'"

setGraphml

void setGraphml(GraphmlType value)
Sets the value of the 'Graphml' containment reference.

Parameters:
value - the new value of the 'Graphml' containment reference.
See Also:
getGraphml()
Generated:
This code was automatically generated.

getHyperedge

HyperedgeType getHyperedge()
Returns the value of the 'Hyperedge' containment reference. Description: While edges describe relations between two nodes, a hyperedge describes a relation between an arbitrary number of nodes. Occurence: <graph>.

Returns:
the value of the 'Hyperedge' containment reference.
See Also:
setHyperedge(HyperedgeType), GraphMLPackage.getDocumentRoot_Hyperedge()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='hyperedge'
namespace='##targetNamespace'"

setHyperedge

void setHyperedge(HyperedgeType value)
Sets the value of the 'Hyperedge' containment reference.

Parameters:
value - the new value of the 'Hyperedge' containment reference.
See Also:
getHyperedge()
Generated:
This code was automatically generated.

getKey

KeyType getKey()
Returns the value of the 'Key' containment reference. Description: In GraphML there may be data-functions attached to graphs, nodes, ports, edges, hyperedges and endpoint and to the whole collection of graphs described by the content of <graphml>. These functions are declared by <key> elements (children of <graphml>) and defined by <data> elements. Occurence: <graphml>.

Returns:
the value of the 'Key' containment reference.
See Also:
setKey(KeyType), GraphMLPackage.getDocumentRoot_Key()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='key'
namespace='##targetNamespace'"

setKey

void setKey(KeyType value)
Sets the value of the 'Key' containment reference.

Parameters:
value - the new value of the 'Key' containment reference.
See Also:
getKey()
Generated:
This code was automatically generated.

getLocator

LocatorType getLocator()
Returns the value of the 'Locator' containment reference. Description: Graphs and nodes are declared by the elements <graph> and <node>, respectively. The optional <locator>-child of these elements point to their definition. (If there is no <locator>-child the graphs/nodes are defined by their content). Occurence: <graph>, and <node>.

Returns:
the value of the 'Locator' containment reference.
See Also:
setLocator(LocatorType), GraphMLPackage.getDocumentRoot_Locator()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='locator'
namespace='##targetNamespace'"

setLocator

void setLocator(LocatorType value)
Sets the value of the 'Locator' containment reference.

Parameters:
value - the new value of the 'Locator' containment reference.
See Also:
getLocator()
Generated:
This code was automatically generated.

getNode

NodeType getNode()
Returns the value of the 'Node' containment reference. Description: Describes one node in the <graph> containing this <node>. Occurence: <graph>.

Returns:
the value of the 'Node' containment reference.
See Also:
setNode(NodeType), GraphMLPackage.getDocumentRoot_Node()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='node'
namespace='##targetNamespace'"

setNode

void setNode(NodeType value)
Sets the value of the 'Node' containment reference.

Parameters:
value - the new value of the 'Node' containment reference.
See Also:
getNode()
Generated:
This code was automatically generated.

getPort

PortType getPort()
Returns the value of the 'Port' containment reference. Description: Nodes may be structured by ports; thus edges are not only attached to a node but to a certain port in this node. Occurence: <node>, <port>.

Returns:
the value of the 'Port' containment reference.
See Also:
setPort(PortType), GraphMLPackage.getDocumentRoot_Port()
Generated:
This code was automatically generated.
Model element:
containment=true
upper=-2
transient=true
volatile=true
derived=true
extendedMetaData="kind='element'
name='port'
namespace='##targetNamespace'"

setPort

void setPort(PortType value)
Sets the value of the 'Port' containment reference.

Parameters:
value - the new value of the 'Port' containment reference.
See Also:
getPort()
Generated:
This code was automatically generated.