com.ihr.xbrl.om.table.layout

Class FactsListClassifier

java.lang.Object

com.ihr.xbrl.om.table.layout.FactsListClassifier

public class FactsListClassifier
extends java.lang.Object

This class will maintain a set of facts indexed by the distinct values of the facts aspects. The idea is to use this class to rapidly find a fact from a set of aspects or a set of facts that satisfies some aspects.

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FactsListClassifier.SearchCriteria This class hold the parameters for a search.
static class	FactsListClassifier.SkipExplicitDimTest This is a class to create a singleton constant to serve as a parameter to the search method to disable search by explicit dimension value.
static class	FactsListClassifier.SkipTypedDimTest This is a class to create a singleton constant to serve as a parameter to the search method to disable search by typed dimension value.

Field Summary

Fields

Modifier and Type	Field and Description
static FactsListClassifier.SkipExplicitDimTest	SKIPEXPLICITDIMTESTS serves to disable search by dimensions in the search method.
static FactsListClassifier.SkipTypedDimTest	SKIPTYPEDDIMTESTS serves to disable search by dimensions in the search method.

Constructor Summary

Constructors

Constructor and Description
FactsListClassifier(XBRLFactsList input, DTSContainer dts) This class maintains a set of facts indexed by the distinct values of the facts aspects.
FactsListClassifier(XBRLFactsList input, int aspectsFocus, DTSContainer dts) This class maintains a set of facts indexed by the distinct values of the facts aspects.

Method Summary

Modifier and Type	Method and Description
void	addAspects(XBRLFactsList instance, int aspectsToCover) Adds the aspects.
void	addFact(XBRLFact fact) Adds the fact.
void	addFacts(XBRLFactsList input) Adds all facts in the input XBRLFactsList using the aspects already configured.
void	clear() Clear all content including references to external resolvers.
void	clearFacts() Clear only stored facts by all aspects stored.
FactsListClassifier.SearchCriteria	compileSeach(java.util.Collection<java.lang.Object> members) Compile seach.
void	delFact(XBRLFact fact) Del fact.
java.util.Set<XBRLFact>	getAllFacts() Returns all facts stored.
java.util.Set<?>	getAspectDistinctValues(Aspect ap) Gets the aspect distinct values.
java.util.Set<?>	getAspectDistinctValues(int aspect, javax.xml.namespace.QName dimension) Gets the aspect distinct values.
java.util.Set<Aspect>	getAspects(int aspectKey) Gets the aspects.
java.util.Iterator<Aspect>	getAspectsByDistribution() Returns an iterator over all aspects for which facts are classified Before returning the iterator, all analyzed aspects are classified by the number of distinct values for the aspect and the iterator returns first the aspect with higher number of distinct values This ensures a loop to find duplicates (for instance) will execute as less loops as possible .
java.util.Set<XBRLFact>	getByConcept(javax.xml.namespace.QName concept) Gets the by concept.
java.util.Set<XBRLFact>	getByExplicitDimension(javax.xml.namespace.QName dimension) Gets the by explicit dimension.
java.util.Set<XBRLFact>	getByExplicitDimensionAndMember(javax.xml.namespace.QName dimension, javax.xml.namespace.QName member) Gets the by explicit dimension and member.
java.util.Set<XBRLFact>	getByTypedDimension(javax.xml.namespace.QName dimension) Gets the by typed dimension.
CompanyKey	getFirstCompany() This method is required in order to work with multiple companies in the same XBRL report.
java.util.Collection<XBRLFact>	search(java.util.Collection<java.lang.Object> members) Searches for facts satisfying all aspects in the collection.
java.util.Collection<XBRLFact>	search(java.util.Collection<java.lang.Object> members, java.lang.StringBuilder log) Searches for facts satisfying all aspects in the collection.
boolean	searchByConcept(FactsListClassifier.SearchCriteria sc, java.util.Set<XBRLFact> allPass, java.lang.StringBuilder log) Search by concept.
java.util.Set<XBRLFactItem>	searchDimensionsANDAlt(java.util.Collection<DimensionAndMemberQNamesPair> input) Search classified facts for all facts that contains all dimensions indicated in the input.
java.util.Set<XBRLFactItem>	searchDimensionsOR(java.util.Collection<DimensionAndMemberQNamesPair> input) Search classified facts for all facts that contains at least one of the dimension and member pairs indicated in the input.
java.util.Set<XBRLFactItem>	searchExplicitDimensionsAND(java.util.Collection<DimensionAndMemberQNamesPair> input) Search classified facts for all facts that contains all dimensions indicated in the input.
java.util.Set<XBRLFactItem>	searchTypedDimensionsAND(java.util.Collection<DimensionAndFragmentMemberPair> input) Search classified facts for all facts that contains all dimensions indicated in the input.
void	setOpenAspectValueResolver(OpenAspectValueResolver externalResolver) Sets the open aspect value resolver.

Methods inherited from class java.lang.Object

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

Field Detail

SKIPEXPLICITDIMTESTS

public static final FactsListClassifier.SkipExplicitDimTest SKIPEXPLICITDIMTESTS

serves to disable search by dimensions in the search method.

SKIPTYPEDDIMTESTS

public static final FactsListClassifier.SkipTypedDimTest SKIPTYPEDDIMTESTS

serves to disable search by dimensions in the search method.

Constructor Detail

FactsListClassifier

public FactsListClassifier(XBRLFactsList input,
                           DTSContainer dts)

This class maintains a set of facts indexed by the distinct values of the facts aspects. The idea is to use this class to rapidly find a fact from a set of aspects or a set of facts that satisfies some aspects. All aspects of all facts in the input list are explored and indexed. If this causes performance issues determine the aspects that are required first and use the constructor #FactsListClassifier(XBRLFactsList, int) instead.

Parameters:

input - XBRLFactsList to process

dts - the DTSContainer. Can be null if input is not null and contains a DTSContainer

FactsListClassifier

public FactsListClassifier(XBRLFactsList input,
                           int aspectsFocus,
                           DTSContainer dts)

This class maintains a set of facts indexed by the distinct values of the facts aspects. The idea is to use this class to rapidly find a fact from a set of aspects or a set of facts that satisfies some aspects. This constructor focuses only on aspects indicated in the aspectsFocus parameter

Parameters:

input - XBRLFactsList to process

aspectsFocus - aspects this classifier will work on. Use an OR bitmap from constants defined in the CommonAspectRule class CommonAspectRule

dts - the DTSContainer. Can be null if input is not null and contains a DTSContainer

Method Detail

searchExplicitDimensionsAND

public java.util.Set<XBRLFactItem> searchExplicitDimensionsAND(java.util.Collection<DimensionAndMemberQNamesPair> input)

Search classified facts for all facts that contains all dimensions indicated in the input.

Parameters:

input - Collection of pairs of QName and Member

Returns:

HashSet with the intersection of all facts satisfying selection criteria

searchTypedDimensionsAND

public java.util.Set<XBRLFactItem> searchTypedDimensionsAND(java.util.Collection<DimensionAndFragmentMemberPair> input)

Search classified facts for all facts that contains all dimensions indicated in the input.

Parameters:

input - Collection of pairs of QName and Member

Returns:

HashSet with the intersection of all facts satisfying selection criteria

searchDimensionsANDAlt

public java.util.Set<XBRLFactItem> searchDimensionsANDAlt(java.util.Collection<DimensionAndMemberQNamesPair> input)

Search classified facts for all facts that contains all dimensions indicated in the input.

Parameters:

input - Collection of pairs of QName and Member

Returns:

HashSet with the intersection of all facts satisfying selection criteria

searchDimensionsOR

public java.util.Set<XBRLFactItem> searchDimensionsOR(java.util.Collection<DimensionAndMemberQNamesPair> input)

Search classified facts for all facts that contains at least one of the dimension and member pairs indicated in the input.

Parameters:

input - Collection of pairs of QName and Member

Returns:

HashSet with the intersection of all facts satisfying selection criteria

addFacts

public void addFacts(XBRLFactsList input)

Adds all facts in the input XBRLFactsList using the aspects already configured.

Parameters:

input - the input

addFact

public void addFact(XBRLFact fact)

Adds the fact.

Parameters:

fact - the fact

getAllFacts

public java.util.Set<XBRLFact> getAllFacts()

Returns all facts stored.

Returns:

the all facts

delFact

public void delFact(XBRLFact fact)

Del fact.

Parameters:

fact - the fact

clearFacts

public void clearFacts()

Clear only stored facts by all aspects stored.

clear

public void clear()

Clear all content including references to external resolvers.

getAspectDistinctValues

public java.util.Set<?> getAspectDistinctValues(Aspect ap)

Gets the aspect distinct values.

Parameters:

ap - the aspect

Returns:

the aspect distinct values

getAspectDistinctValues

public java.util.Set<?> getAspectDistinctValues(int aspect,
                                                javax.xml.namespace.QName dimension)

Gets the aspect distinct values.

Parameters:

aspect - the aspect

dimension - the dimension

Returns:

the aspect distinct values

search

public java.util.Collection<XBRLFact> search(java.util.Collection<java.lang.Object> members)

Searches for facts satisfying all aspects in the collection.

Parameters:

members - this is a collection of criteria members to satisfy. Every aspect has specific values.

• for the Concept aspect, the member is the concept QName as a QName instance.
• For the Location aspect, the member is the parent XBRLFactsList that is the fact parent.
• For the Period aspect, the member is the instance of the XBRLPeriod to filter.
• For the Entity aspect, the member is the specific XBRLEntity to search for.
• For the Unit aspect, the member is the XBRLUnit to filter.
• For filtering dimensions and dimension member values, use instances of DimensionAndMemberQNamesPair or DimensionAndFragmentMemberPair for explicit and typed dimensions respectively. Dimensions allow for multiple different values to be provided.
• For the CompleteContext aspect you can use an instance of XBRLContext.

This class also handles the open aspects indicated in the table linkbase specification using: Instances of the class ExplicitDimensionAspectNode for explicit dimensions and TypedDimensionAspectNode for typed dimensions

Returns:

the collection of facts that satisfy all members passed in as parameters

compileSeach

public FactsListClassifier.SearchCriteria compileSeach(java.util.Collection<java.lang.Object> members)

Compile seach.

Parameters:

members - the members

Returns:

the search criteria

searchByConcept

public boolean searchByConcept(FactsListClassifier.SearchCriteria sc,
                               java.util.Set<XBRLFact> allPass,
                               java.lang.StringBuilder log)

Search by concept.

Parameters:

sc - the sc

allPass - the all pass

log - the log

Returns:

true, if successful

getByConcept

public java.util.Set<XBRLFact> getByConcept(javax.xml.namespace.QName concept)

Gets the by concept.

Parameters:

concept - the concept

Returns:

the by concept

getByTypedDimension

public java.util.Set<XBRLFact> getByTypedDimension(javax.xml.namespace.QName dimension)

Gets the by typed dimension.

Parameters:

dimension - the dimension

Returns:

the by typed dimension

getByExplicitDimension

public java.util.Set<XBRLFact> getByExplicitDimension(javax.xml.namespace.QName dimension)

Gets the by explicit dimension.

Parameters:

dimension - the dimension

Returns:

the by explicit dimension

getByExplicitDimensionAndMember

public java.util.Set<XBRLFact> getByExplicitDimensionAndMember(javax.xml.namespace.QName dimension,
                                                               javax.xml.namespace.QName member)

Gets the by explicit dimension and member.

Parameters:

dimension - the dimension

member - the member

Returns:

the by explicit dimension and member

search

public java.util.Collection<XBRLFact> search(java.util.Collection<java.lang.Object> members,
                                             java.lang.StringBuilder log)

Searches for facts satisfying all aspects in the collection.

Parameters:

members - this is a collection of criteria members to satisfy. Every aspect has specific values for the concept aspect, the member is the concept QName as a QName instance. For the location aspect the member is the parent XBRLFactsList that is the fact parent. For the period aspect the member is the instance of the XBRLPeriod to filter. For the Entity aspect the member is the specific XBRLEntity to search for. For the Unit aspect the member is the XBRLUnit to filter. For filtering dimensions and dimension member values use instances of DimensionAndMemberQNamesPair or DimensionAndFragmentMemberPair for explicit and typed dimensions respectively. Dimensions allow for multiple different values to be provided. For the CompleteContext aspect you can use an instance of XBRLContext.

log - the log

Returns:

the collection

getFirstCompany

public CompanyKey getFirstCompany()

This method is required in order to work with multiple companies in the same XBRL report.

Returns:

the first company

setOpenAspectValueResolver

public void setOpenAspectValueResolver(OpenAspectValueResolver externalResolver)

Sets the open aspect value resolver.

Parameters:

externalResolver - the new open aspect value resolver

getAspects

public java.util.Set<Aspect> getAspects(int aspectKey)

Gets the aspects.

Parameters:

aspectKey - the aspect key

Returns:

the aspects

addAspects

public void addAspects(XBRLFactsList instance,
                       int aspectsToCover)

Adds the aspects.

Parameters:

instance - the instance

aspectsToCover - the aspects to cover

getAspectsByDistribution

public java.util.Iterator<Aspect> getAspectsByDistribution()

Returns an iterator over all aspects for which facts are classified

Before returning the iterator, all analyzed aspects are classified by the number of distinct values for the aspect and the iterator returns first the aspect with higher number of distinct values

This ensures a loop to find duplicates (for instance) will execute as less loops as possible .

Returns:

the aspects by distribution