org.xbrlapi
Interface NetworkGraph

All Superinterfaces:

Comparable<XML>, NonFragmentXML, Serializable, XML

All Known Implementing Classes:

NetworkGraphImpl

public interface NetworkGraph
extends NonFragmentXML

This interface defines the functions that can be used to interact with a data store XML resource that summarises the information expressed by an XLink network relationship graph. The nodes of the graph are the fragments connected by the XLink relationships. Each node in graph summary has a name that is the index of the node fragment, prefixed by an underscore '_'.

Author:

Geoff Shuetrim (geoff@galexy.net)

Method Summary

URI	getArcrole()
String	getArcroleIndex()
List<Element>	getChildren(Element parent)
ArcroleType	getCustomArcrole()
RoleType	getCustomLinkRole()
URI	getLinkRole()
String	getLinkRoleIndex()
Element	getParent(Element child)
Set<Element>	getRoots()

Methods inherited from interface org.xbrlapi.XML

appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getRoots

Set<Element> getRoots()
                      throws XBRLException

Returns:

the set of root elements in the graph. A root is defined as a node that has no relationships to it from other nodes.

Throws:

XBRLException

getCustomLinkRole

RoleType getCustomLinkRole()
                           throws XBRLException

Returns:

the custom type declaration for the XLink extended link role defining the graph.

Throws:

XBRLException

getCustomArcrole

ArcroleType getCustomArcrole()
                             throws XBRLException

Returns:

the custom type declaration for the XLink arcrole defining the graph.

Throws:

XBRLException

getLinkRoleIndex

String getLinkRoleIndex()
                        throws XBRLException

Returns:

the index of the XLink extended link role defining the graph.

Throws:

XBRLException

getArcroleIndex

String getArcroleIndex()
                       throws XBRLException

Returns:

the index of the Link arcrole defining the graph.

Throws:

XBRLException

getLinkRole

URI getLinkRole()
                throws XBRLException

Returns:

the XLink extended link role defining the graph.

Throws:

XBRLException

getArcrole

URI getArcrole()
               throws XBRLException

Returns:

the XLink arcrole defining the graph.

Throws:

XBRLException

getChildren

List<Element> getChildren(Element parent)
                          throws XBRLException

Parameters:

parent - The element in the graph resource representing the parent.

Returns:

the set elements in the graph resource representing the children. The children are ordered by the order attribute on the arcs expressing the relationships. Where the order attribute is identical for two relationships, the child index ordering cannot be relied upon to be consistent.

Throws:

XBRLException

getParent

Element getParent(Element child)
                  throws XBRLException

Parameters:

child - The index of the child fragment.

Returns:

the index of the child fragment's parent or null if the child fragment is a root.

Throws:

XBRLException