org.xbrlapi.networks
Class NonProhibitedAnalyserImpl

java.lang.Object
  org.xbrlapi.networks.AnalyserImpl
      org.xbrlapi.networks.NonProhibitedAnalyserImpl

All Implemented Interfaces:

Serializable, Analyser

public class NonProhibitedAnalyserImpl
extends AnalyserImpl
implements Analyser

This Analyser returns information based upon all relationships that are not expressed by an arc with a use that is prohibited. Set this as the analyser used by a store when you want that store to produce query results where this set of relationships is relevant.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

protected static org.apache.log4j.Logger

logger

Constructor Summary

NonProhibitedAnalyserImpl(Store store)

Method Summary

protected List<Relationship>

getRelationships(String query) Filters out relationships with use=prohibited on the arcs expressing them.

Methods inherited from class org.xbrlapi.networks.AnalyserImpl

getAllRelationships, getArcroles, getArcroles, getLabelRelationships, getLabelRelationshipsByLanguage, getLabelRelationshipsByLanguageAndRole, getLabelRelationshipsByLanguages, getLabelRelationshipsByRole, getLabelRelationshipsByRoles, getLabelRelationshipsByRoles, getLinkRoles, getLinkRoles, getReferenceRelationships, getReferenceRelationshipsByLanguage, getReferenceRelationshipsByLanguageAndRole, getReferenceRelationshipsByLanguages, getReferenceRelationshipsByRole, getReferenceRelationshipsByRoles, getReferenceRelationshipsByRoles, getRelationships, getRelationships, getRelationships, getRelationships, getRelationships, getRelationshipsFrom, getRelationshipsFrom, getRelationshipsFrom, getRelationshipsFrom, getRelationshipsTo, getRelationshipsTo, getRelationshipsTo, getRelationshipsTo, getRootIndices, getRootRelationships, getRoots, getStore, hasAllRelationships

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xbrlapi.networks.Analyser

getAllRelationships, getArcroles, getArcroles, getLabelRelationships, getLabelRelationshipsByLanguage, getLabelRelationshipsByLanguageAndRole, getLabelRelationshipsByLanguages, getLabelRelationshipsByRole, getLabelRelationshipsByRoles, getLabelRelationshipsByRoles, getLinkRoles, getLinkRoles, getReferenceRelationships, getReferenceRelationshipsByLanguage, getReferenceRelationshipsByLanguageAndRole, getReferenceRelationshipsByLanguages, getReferenceRelationshipsByRole, getReferenceRelationshipsByRoles, getReferenceRelationshipsByRoles, getRelationships, getRelationships, getRelationships, getRelationships, getRelationships, getRelationshipsFrom, getRelationshipsFrom, getRelationshipsFrom, getRelationshipsFrom, getRelationshipsTo, getRelationshipsTo, getRelationshipsTo, getRelationshipsTo, getRootIndices, getRootRelationships, getRoots, hasAllRelationships

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Constructor Detail

NonProhibitedAnalyserImpl

public NonProhibitedAnalyserImpl(Store store)
                          throws XBRLException

Parameters:

store - The data store to use.

Throws:

XBRLException - if the store is null.

Method Detail

getRelationships

protected List<Relationship> getRelationships(String query)
                                       throws XBRLException

Filters out relationships with use=prohibited on the arcs expressing them. This requires the query to be a simple XPath expression that selects document roots for the persisted relationships in the data store. It works by appending an extra predicate onto the XPath selection criteria that selections only those relationships without a notUse attribute. Note that this attribute is omitted on persisted relationships unless the associated arc has a use=prohibited attribute value.

Overrides:

getRelationships in class AnalyserImpl

Parameters:

query - The query to run to get the relationships.

Returns:

the list of relationships returned by the query.

Throws:

XBRLException