com.batavia.xbrl.network
Interface NetworkNode

All Superinterfaces:

java.lang.Comparable, ComparablePart, java.io.Serializable

public interface NetworkNode
extends ComparablePart, java.io.Serializable

Interface for Node in a network of Nodes connected by arcs.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	addArcFrom(NetworkArc arc) Add the arc to the collection of Arcs that depart FROM this node.
void	addArcTo(NetworkArc arc) Add the arc to the collection of Arcs that direct TO this node.
java.lang.String	createOccurencesReport(java.lang.String indent) Create a String with a text message that indicates how many facts were found for concepts in the network.
Labelled	getContent()
java.lang.String	getFriends(NetworkNode me, Set theGroup, boolean cyclesAllowedNone) Add every friend of the NetworkNode me to the group and ask his friend for their friends.
java.util.List	getNetworkArcsFrom()
java.util.List	getNetworkArcsTo()
NetworkIndicator	getNetworkIndicator()
IdHolder	getReferencedContent() return either the resource if the content itself is a resource or the xbrl element that is referenced by the locators xlinkhref
java.util.List	getRelatedNodesPointingToNode()
java.util.List	getRelatedNodesReferredByNode()
java.lang.String	isValidAccordingTo(java.lang.String cyclesAllowed) Determine if this node is conforming to the given cyclesAllowed value.
void	removeArcFrom(NetworkArc arc) Remove the arc from the collection of Arcs that depart FROM this node.
void	removeArcTo(NetworkArc arc) Remove the arc from the collection of Arcs that direct TO this node.
void	setContent(Labelled content)
void	setNetworkArcsFrom(java.util.List networkArcsFrom)
void	setNetworkArcsTo(java.util.List networkArcsTo)
void	setReferencedContent(IdHolder referencedContent)
java.lang.String	toString() Create String rep for debug

Methods inherited from interface com.batavia.xml.ComparablePart

c_equal, identical, s_equal, u_equal, v_equal, x_equal

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

addArcTo

void addArcTo(NetworkArc arc)

Add the arc to the collection of Arcs that direct TO this node.

Parameters:

arc -

addArcFrom

void addArcFrom(NetworkArc arc)

Add the arc to the collection of Arcs that depart FROM this node.

Parameters:

arc -

removeArcTo

void removeArcTo(NetworkArc arc)

Remove the arc from the collection of Arcs that direct TO this node.

Parameters:

arc -

removeArcFrom

void removeArcFrom(NetworkArc arc)

Remove the arc from the collection of Arcs that depart FROM this node.

Parameters:

arc -

isValidAccordingTo

java.lang.String isValidAccordingTo(java.lang.String cyclesAllowed)

Determine if this node is conforming to the given cyclesAllowed value. If not the reason why not is to be returned

Parameters:

cyclesAllowed - is null when node is valid for cyclesAllowed.

setReferencedContent

void setReferencedContent(IdHolder referencedContent)

Parameters:

referencedContent - The referencedContent to set.

getReferencedContent

IdHolder getReferencedContent()

return either the resource if the content itself is a resource or the xbrl element that is referenced by the locators xlinkhref

Returns:

IdHolder

getContent

Labelled getContent()

Returns:

Returns the content.

setContent

void setContent(Labelled content)

Parameters:

content - The content to set.

getNetworkArcsFrom

java.util.List getNetworkArcsFrom()

Returns:

Returns the networkArcsFrom.

setNetworkArcsFrom

void setNetworkArcsFrom(java.util.List networkArcsFrom)

Parameters:

networkArcsFrom - The networkArcsFrom to set.

getNetworkArcsTo

java.util.List getNetworkArcsTo()

Returns:

Returns the networkArcsTo.

setNetworkArcsTo

void setNetworkArcsTo(java.util.List networkArcsTo)

Parameters:

networkArcsTo - The networkArcsTo to set.

getFriends

java.lang.String getFriends(NetworkNode me,
                            Set theGroup,
                            boolean cyclesAllowedNone)

Add every friend of the NetworkNode me to the group and ask his friend for their friends. When the group of friends violates the cyclesAllowedNone param the reason why is returned in a String.

Parameters:

me -

theGroup -

cyclesAllowedNone -

Returns:

String When the group of friends violates the cyclesAllowedNone param the reason why is returned.

toString

java.lang.String toString()

Create String rep for debug

Overrides:

toString in class java.lang.Object

Returns:

createOccurencesReport

java.lang.String createOccurencesReport(java.lang.String indent)

Create a String with a text message that indicates how many facts were found for concepts in the network.

Parameters:

indent -

Returns:

getNetworkIndicator

NetworkIndicator getNetworkIndicator()

Returns:

Returns the networkIndicator.

getRelatedNodesPointingToNode

java.util.List getRelatedNodesPointingToNode()

getRelatedNodesReferredByNode

java.util.List getRelatedNodesReferredByNode()