public interface Network
Modifier and Type | Method and Description |
---|---|
void |
add(Network network)
Adds relationships from the supplied network
to this network where they are not already included.
|
void |
addRelationship(Relationship relationship)
Adds the relationship to the network.
|
void |
addRelationships(java.util.Collection<Relationship> relationship)
Adds the set of relationships to the network.
|
void |
complete()
Complete the network, finding all active relationships in the data store
that participate in the network.
|
boolean |
contains(java.lang.String index) |
Fragment |
get(java.lang.String index) |
java.util.SortedSet<Relationship> |
getActiveRelationshipsFrom(java.lang.String index) |
java.util.SortedSet<Relationship> |
getActiveRelationshipsTo(java.lang.String index) |
java.util.List<Relationship> |
getAllActiveRelationships() |
java.util.List<Relationship> |
getAllRelationships() |
java.lang.String |
getArcrole() |
<F extends Fragment> |
getChildren(java.lang.String index) |
java.lang.String |
getLinkRole() |
int |
getNumberOfActiveRelationships() |
int |
getNumberOfRelationships() |
<F extends Fragment> |
getParents(java.lang.String index)
Note that a fragment can have more than one parent fragment given
that the networks are not just trees.
|
java.util.Set<java.lang.String> |
getRootFragmentIndices() |
<F extends Fragment> |
getRootFragments() |
Store |
getStore() |
boolean |
hasActiveRelationshipsFrom(java.lang.String index) |
boolean |
hasActiveRelationshipsTo(java.lang.String index) |
boolean |
hasFragment(java.lang.String index) |
boolean |
hasSingleParent(java.lang.String index) |
boolean |
isLeaf(java.lang.String index) |
boolean |
isRoot(java.lang.String index) |
void |
setArcrole(java.lang.String arcrole) |
void |
setLinkRole(java.lang.String linkRole) |
Store getStore()
java.lang.String getArcrole()
void setArcrole(java.lang.String arcrole) throws XBRLException
arcrole
- the arc role to set.XBRLException
- if the arc role is null.java.lang.String getLinkRole()
void setLinkRole(java.lang.String linkRole) throws XBRLException
linkRole
- the linkRole to set.XBRLException
- if the link role is null.boolean hasFragment(java.lang.String index) throws XBRLException
index
- The index of the fragment to check.XBRLException
boolean hasActiveRelationshipsFrom(java.lang.String index)
index
- The index of the fragment to check.boolean hasSingleParent(java.lang.String index) throws XBRLException
index
- the index of the fragment.XBRLException
boolean isRoot(java.lang.String index) throws XBRLException
index
- the index of the fragment.XBRLException
boolean isLeaf(java.lang.String index) throws XBRLException
index
- the index of the fragment.XBRLException
boolean hasActiveRelationshipsTo(java.lang.String index)
index
- The index of the fragment to check.Fragment get(java.lang.String index) throws XBRLException
index
- The index of the fragment to get from the set
of fragments already participating in the network.XBRLException
<F extends Fragment> java.util.List<F> getRootFragments()
F
- The type of fragment to use for the fragments in the list.java.util.Set<java.lang.String> getRootFragmentIndices()
void addRelationship(Relationship relationship) throws XBRLException
relationship
- The relationship to add.XBRLException
void addRelationships(java.util.Collection<Relationship> relationship) throws XBRLException
relationship
- The relationship to add.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
java.util.List<Relationship> getAllRelationships() throws XBRLException
XBRLException
java.util.List<Relationship> getAllActiveRelationships() throws XBRLException
XBRLException
<F extends Fragment> java.util.List<F> getChildren(java.lang.String index) throws XBRLException
F
- The type of org.xbrlapi.Fragmentindex
- The parent fragment indexXBRLException
<F extends Fragment> java.util.List<F> getParents(java.lang.String index) throws XBRLException
F
- The type of org.xbrlapi.Fragmentindex
- The child fragment indexXBRLException
int getNumberOfRelationships()
int getNumberOfActiveRelationships()
void complete() throws XBRLException
XBRLException
boolean contains(java.lang.String index)
index
- The index of the fragment to check for in the
network.void add(Network network) throws XBRLException
network
- The network to be merged into this
network.XBRLException