public interface Networks extends java.lang.Iterable<Network>
Modifier and Type | Method and Description |
---|---|
void |
addAll(java.util.List<Network> networks)
Merges the specified list of networks into this set of networks.
|
void |
addAll(Networks networks)
Merges the specified set of networks into this set of networks.
|
void |
addNetwork(Network network)
If the collection of networks already has a network with the
same role and arcrole, then the relationships from the added
network are added into the existing network.
|
void |
addRelationship(Relationship relationship) |
void |
addRelationships(java.util.Collection<Relationship> relationships) |
void |
addRelationships(java.lang.String arcrole)
Adds all relationships with the given arcrole to the set of networks.
|
void |
complete()
Complete the networks, finding all active relationships in the data store
that participate in the networks.
|
java.util.List<Relationship> |
getActiveRelationships() |
java.util.SortedSet<Relationship> |
getActiveRelationshipsFrom(java.lang.String index) |
java.util.SortedSet<Relationship> |
getActiveRelationshipsTo(java.lang.String index) |
java.util.List<java.lang.String> |
getArcroles() |
java.util.List<java.lang.String> |
getLinkRoles(java.lang.String arcrole) |
Network |
getNetwork(java.lang.String linkRole,
java.lang.String arcrole) |
Networks |
getNetworks(java.lang.String arcrole) |
int |
getSize() |
<F extends Fragment> |
getSources(java.lang.String targetIndex,
java.lang.String arcrole) |
<F extends Fragment> |
getSources(java.lang.String targetIndex,
java.lang.String linkRole,
java.lang.String arcrole) |
Store |
getStore() |
<F extends Fragment> |
getTargets(java.lang.String sourceIndex,
java.lang.String arcrole) |
<F extends Fragment> |
getTargets(java.lang.String sourceIndex,
java.lang.String linkRole,
java.lang.String arcrole) |
boolean |
hasNetwork(java.lang.String linkRole,
java.lang.String arcrole) |
java.util.List<Relationship> getActiveRelationships() throws XBRLException
XBRLException
java.util.SortedSet<Relationship> getActiveRelationshipsFrom(java.lang.String index) throws XBRLException
index
- The index of the source fragment.XBRLException
java.util.SortedSet<Relationship> getActiveRelationshipsTo(java.lang.String index) throws XBRLException
index
- The index of the target fragment.XBRLException
void complete() throws XBRLException
XBRLException
void addNetwork(Network network) throws XBRLException
network
- The network to add to the collection of networks.XBRLException
Network getNetwork(java.lang.String linkRole, java.lang.String arcrole) throws XBRLException
linkRole
- The link role of the network to get.arcrole
- The arc role of the network to get.XBRLException
Networks getNetworks(java.lang.String arcrole) throws XBRLException
arcrole
- The arc role to get the networks for.XBRLException
<F extends Fragment> java.util.List<F> getSources(java.lang.String targetIndex, java.lang.String arcrole) throws XBRLException
targetIndex
- The index of the fragment that is the target for the sources
being retrievedarcrole
- The arc role of the relationships to navigate from the given target
to the sources being retrieved.XBRLException
<F extends Fragment> java.util.List<F> getSources(java.lang.String targetIndex, java.lang.String linkRole, java.lang.String arcrole) throws XBRLException
targetIndex
- The index of the fragment that is the target for the sources
being retrievedlinkRole
- The arc role of the relationships to navigate from the given target
to the sources being retrieved.arcrole
- The arc role of the relationships to navigate from the given target
to the sources being retrieved.XBRLException
<F extends Fragment> java.util.List<F> getTargets(java.lang.String sourceIndex, java.lang.String arcrole) throws XBRLException
sourceIndex
- The index of the fragment that is the source for the targets
being retrievedarcrole
- The arc role of the relationships to navigate from the given source
to the targets being retrieved.XBRLException
<F extends Fragment> java.util.List<F> getTargets(java.lang.String sourceIndex, java.lang.String linkRole, java.lang.String arcrole) throws XBRLException
sourceIndex
- The index of the fragment that is the source for the targets
being retrievedlinkRole
- The arc role of the relationships to navigate from the given source
to the targets being retrieved.arcrole
- The arc role of the relationships to navigate from the given source
to the targets being retrieved.XBRLException
boolean hasNetwork(java.lang.String linkRole, java.lang.String arcrole)
linkRole
- The link role of the network to get.arcrole
- The arc role of the network to get.void addRelationship(Relationship relationship) throws XBRLException
relationship
- The relationship to add to the collection of networks.XBRLException
void addRelationships(java.util.Collection<Relationship> relationships) throws XBRLException
relationships
- THe list of relationships to add to the networksXBRLException
void addRelationships(java.lang.String arcrole) throws XBRLException
arcrole
- The required arcrole.XBRLException
java.util.List<java.lang.String> getArcroles() throws XBRLException
XBRLException
java.util.List<java.lang.String> getLinkRoles(java.lang.String arcrole) throws XBRLException
arcrole
- The arc role for which the link roles are required.XBRLException
int getSize() throws XBRLException
XBRLException
Store getStore()
void addAll(Networks networks) throws XBRLException
networks
- The networks to merge
into this collection of networks.XBRLException
void addAll(java.util.List<Network> networks) throws XBRLException
networks
- The networks to merge
into this collection of networks.XBRLException