org.xbrlapi.networks
Interface Storer

All Known Implementing Classes:

StorerImpl

public interface Storer

Classes implementing this interface support persistance of relationship information in a data store. This kind of persistence can reduce the query burden associated with network analysis.

Author:

Geoff Shuetrim (geoff@galexy.net)

Method Summary

void	deleteInactiveRelationships() Removes all persisted prohibited or overridden relationships from a network.
void	deleteInactiveRelationships(URI linkRole, URI arcrole) Removes persisted prohibited or overridden relationships from a network.
void	deleteRelationships() Deletes all persisted relationships in the data store.
void	deleteRelationships(URI document) Deletes the persisted relationships that are related to arcs in the specified document.
void	deleteRelationships(URI linkRole, URI arcrole) Deletes the persisted relationships with the given link and arc role from the data store.
void	storeAllRelationships() Stores all active relationships in the entire data store.
void	storeRelationship(Arc arc, Fragment source, Fragment target) Persist the relationship defined by the given fragments.
void	storeRelationship(Relationship relationship) When the relationship is persisted in the data store, any equivalent relationship will be removed from the data store.
void	storeRelationships(Collection<URI> documents)
void	storeRelationships(Network network)
void	storeRelationships(Networks networks)
void	storeRelationships(URI document)

Method Detail

storeRelationships

void storeRelationships(Networks networks)
                        throws XBRLException

Parameters:

networks - The set of networks from which all active relationships will be persisted in the data store.

Throws:

XBRLException

See Also:

Relationship

storeRelationships

void storeRelationships(Collection<URI> documents)
                        throws XBRLException

Parameters:

documents - The collection of URIs of the documents to store the relationships for. Relationships are sought among the XLink arcs in the documents. This is used by the discover to updated persisted relationships in the data store.

Throws:

XBRLException

storeRelationships

void storeRelationships(URI document)
                        throws XBRLException

Parameters:

document - The URI of the document to store the relationships for. Relationships are sought among the XLink arcs in the documents. This is used by the discover to updated persisted relationships in the data store.

Throws:

XBRLException

storeRelationships

void storeRelationships(Network network)
                        throws XBRLException

Parameters:

network - The network from which all relationships (active and inactive) will be persisted in the data store.

Throws:

XBRLException

See Also:

Relationship

storeRelationship

void storeRelationship(Relationship relationship)
                       throws XBRLException

When the relationship is persisted in the data store, any equivalent relationship will be removed from the data store. Equivalence is assessed on the basis of the relationship semantic key.

Parameters:

relationship - The relationship that will be be persisted in the data store.

Throws:

XBRLException

See Also:

Relationship.getSignature()

storeRelationship

void storeRelationship(Arc arc,
                       Fragment source,
                       Fragment target)
                       throws XBRLException

Persist the relationship defined by the given fragments.

Parameters:

arc - The relationship arc

source - The relationship source fragment

target - The relationship target fragment

Throws:

XBRLException

storeAllRelationships

void storeAllRelationships()
                           throws XBRLException

Stores all active relationships in the entire data store.

Throws:

XBRLException

deleteRelationships

void deleteRelationships(URI linkRole,
                         URI arcrole)
                         throws XBRLException

Deletes the persisted relationships with the given link and arc role from the data store. Note that this has no impact on the document fragments stored in the data store.

Parameters:

linkRole - The linkrole for relationships to be deleted.

arcrole - The arcrole for relationships to be deleted.

Throws:

XBRLException

deleteRelationships

void deleteRelationships(URI document)
                         throws XBRLException

Deletes the persisted relationships that are related to arcs in the specified document.

Parameters:

document - The URI of the document to delete the persisted relationships for.

Throws:

XBRLException

deleteRelationships

void deleteRelationships()
                         throws XBRLException

Deletes all persisted relationships in the data store.

Throws:

XBRLException

deleteInactiveRelationships

void deleteInactiveRelationships(URI linkRole,
                                 URI arcrole)
                                 throws XBRLException

Removes persisted prohibited or overridden relationships from a network.

Parameters:

linkRole - The linkRole of the network to purge.

arcrole - The arcrole of the network to purge.

Throws:

XBRLException

deleteInactiveRelationships

void deleteInactiveRelationships()
                                 throws XBRLException

Removes all persisted prohibited or overridden relationships from a network.

Throws:

XBRLException