com.ihr.xbrl.om.table.structural

Class AspectsConsolidator

java.lang.Object

com.ihr.xbrl.om.table.structural.AspectsConsolidator

All Implemented Interfaces:

java.lang.Cloneable

public class AspectsConsolidator
extends java.lang.Object
implements java.lang.Cloneable

The Class AspectsConsolidator.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
AspectsConsolidator(AspectsConsolidator other) Instantiates a new aspects consolidator.
AspectsConsolidator(XBRLDefinitionNodeUse base) Instantiates a new aspects consolidator.

Method Summary

Modifier and Type	Method and Description
void	addMergeAspect(Aspect<?> as) Adds the merge aspect.
void	clear() Clear.
void	clearMergeAspects() Clear merge aspects.
AspectsConsolidator	clone() Clone.
java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>>	collectAspects() Collect aspects on this node and returns a structure with aspects indexed by tag.
java.util.Iterator<AspectAndDistanceToLeaf>	getLocalAspects(java.lang.String tag) Allows to iterate all aspects on this node.
java.util.Iterator<java.lang.String>	getLocalTags() Gets the local tags.
java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>>	getMergeAspects() Gets the merge aspects.
boolean	hasAspect(Aspect<?> aspect) if this structural node contains the aspect passed in as a parameter, then the cell header in header is returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

AspectsConsolidator

public AspectsConsolidator(XBRLDefinitionNodeUse base)

Instantiates a new aspects consolidator.

Parameters:

base - the base

AspectsConsolidator

public AspectsConsolidator(AspectsConsolidator other)

Instantiates a new aspects consolidator.

Parameters:

other - the other

Method Detail

clone

public AspectsConsolidator clone()

Clone.

Overrides:

clone in class java.lang.Object

Returns:

the aspects consolidator

collectAspects

public java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> collectAspects()

Collect aspects on this node and returns a structure with aspects indexed by tag.

Returns:

the map

hasAspect

public boolean hasAspect(Aspect<?> aspect)

if this structural node contains the aspect passed in as a parameter, then the cell header in header is returned. Otherwise the same aspect is passed to the parent header for resolution. The method return null if the aspect is not in the cell hierarchy

Parameters:

aspect - the aspect

Returns:

header that contains the aspect

getLocalTags

public java.util.Iterator<java.lang.String> getLocalTags()

Gets the local tags.

Returns:

the local tags

getLocalAspects

public java.util.Iterator<AspectAndDistanceToLeaf> getLocalAspects(java.lang.String tag)

Allows to iterate all aspects on this node. If no aspects are defined this returns an empty iterator

Parameters:

tag - the tag

Returns:

Iterator on all aspects

addMergeAspect

public void addMergeAspect(Aspect<?> as)

Adds the merge aspect.

Parameters:

as - the as

getMergeAspects

public java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> getMergeAspects()

Gets the merge aspects.

Returns:

the merge aspects

clearMergeAspects

public void clearMergeAspects()

Clear merge aspects.

clear

public void clear()

Clear.