com.ihr.xbrl.om.exLinks

Class DTSBaseSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.HashSet<E>

java.util.LinkedHashSet<XBRLRelationship>

com.ihr.xbrl.om.exLinks.DTSBaseSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<XBRLRelationship>, java.util.Collection<XBRLRelationship>, java.util.Set<XBRLRelationship>

public class DTSBaseSet
extends java.util.LinkedHashSet<XBRLRelationship>

The Class DTSBaseSet. A DTSBaseSet is a LinkedHashSet of relationships.

During the DTS load process all relationships in a DTSBase are classified by its arc role and a DTSBaseSet instance is created to contain relationships for that arc role.

This class registers events on the relationships to track changes in the relationship hash value and maintain consistency of the model at the cost of maintaining the event registration overload. If this is not desired use your own class instead. If you use this class, be aware of calling clear() when the DTSBaseSet is no longer required to prevent memory leaks.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DTSBaseSet()

Method Summary

Modifier and Type	Method and Description
boolean	add(XBRLRelationship e) Adds the.
boolean	addTopProhibitedArc(XBRLArc arc) Internal method to add a new arc to the set of top prohibiting arcs.
void	clear() Clear.
java.util.Set<XBRLArc>	getTopProhibitingArcs() When an arc has use="prohibit" and it is the top arc in the priority classification of multiple similar arcs, the arc is effectively eliminating the other arcs from the infoset.
boolean	isEmpty() Checks if is empty.
boolean	remove(java.lang.Object o) Removes the.
int	size() Size.

Methods inherited from class java.util.LinkedHashSet

spliterator

Methods inherited from class java.util.HashSet

clone, contains, iterator

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, contains, containsAll, equals, hashCode, iterator, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

DTSBaseSet

public DTSBaseSet()

Method Detail

add

public boolean add(XBRLRelationship e)

Adds the.

Specified by:

add in interface java.util.Collection<XBRLRelationship>

Specified by:

add in interface java.util.Set<XBRLRelationship>

Overrides:

add in class java.util.HashSet<XBRLRelationship>

Parameters:

e - the e

Returns:

true, if successful

remove

public boolean remove(java.lang.Object o)

Removes the.

Specified by:

remove in interface java.util.Collection<XBRLRelationship>

Specified by:

remove in interface java.util.Set<XBRLRelationship>

Overrides:

remove in class java.util.HashSet<XBRLRelationship>

Parameters:

o - the o

Returns:

true, if successful

clear

public void clear()

Clear.

Specified by:

clear in interface java.util.Collection<XBRLRelationship>

Specified by:

clear in interface java.util.Set<XBRLRelationship>

Overrides:

clear in class java.util.HashSet<XBRLRelationship>

getTopProhibitingArcs

public java.util.Set<XBRLArc> getTopProhibitingArcs()

When an arc has use="prohibit" and it is the top arc in the priority classification of multiple similar arcs, the arc is effectively eliminating the other arcs from the infoset. And they do not appear in the normal DTSBaseSet nor are required for anything

This class collects the top prohibiting arcs in a base set to allow for two purposes

1. Serializing back the extended link with the same (or equivalent) arcs it had
2. Provide access to the top prohibiting arcs for the FRTA validation rules that requires them

Returns:

the set of top prohibiting arcs

Since:

3.1.0

addTopProhibitedArc

public boolean addTopProhibitedArc(XBRLArc arc)

Internal method to add a new arc to the set of top prohibiting arcs.

Parameters:

arc - the arc

Returns:

true, if successful

Since:

3.1.0

isEmpty

public boolean isEmpty()

Checks if is empty.

Specified by:

isEmpty in interface java.util.Collection<XBRLRelationship>

Specified by:

isEmpty in interface java.util.Set<XBRLRelationship>

Overrides:

isEmpty in class java.util.HashSet<XBRLRelationship>

Returns:

true, if is empty

size

public int size()

Size.

Specified by:

size in interface java.util.Collection<XBRLRelationship>

Specified by:

size in interface java.util.Set<XBRLRelationship>

Overrides:

size in class java.util.HashSet<XBRLRelationship>

Returns:

the int