com.ihr.xbrl.om.instance

Class XBRLFactsContainer

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList<XBRLFact>

com.ihr.xbrl.om.instance.XBRLFactsContainer

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<XBRLFact>, java.util.Collection<XBRLFact>, java.util.Deque<XBRLFact>, java.util.List<XBRLFact>, java.util.Queue<XBRLFact>

public class XBRLFactsContainer
extends java.util.LinkedList<XBRLFact>

a tuple and an instance document are derived classes of this class.

Author:

Ignacio

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XBRLFactsContainer(XBRLFactsList parent) Creates a facts container and sets the parent doc to the parent Instance.

Method Summary

Modifier and Type	Method and Description
void	add(int index, XBRLFact fact) Adds the.
boolean	add(XBRLFact fact) This is the implementation of the add method in the XBRLFactsList interface .
boolean	addNew(XBRLFact fact) Adds a sure new fact.
void	addNewFact(int index, XBRLFact fact) Adds the new fact.
void	clear() Clear.
void	clearFacts() The clear method removes all facts form the container and also sets the parent to null.
XBRLFactsContainer	clone() Clone.
boolean	equals(java.lang.Object obj) Equals.
DTSContainer	getContainer() Gets the container.
XBRLInstance	getInstance() Gets the single instance of XBRLFactsContainer.
java.util.Iterator<XBRLFactItem>	getItems() Gets the items on this and nested fact containers "tuples" inside this one.
java.util.Iterator<XBRLFactItem>	getItems(XBRLItem itemFrom) Gets the items.
java.util.Iterator<XBRLFactItem>	getItemsSg(XBRLItem itemFrom) Gets the items sg.
int	getNumberOfItems() Gets the number of items on this facts container.
int	getNumberOfTuples() Gets the number of tuples on this facts container.
XBRLFactsList	getParentXBRL() Gets the parent.
java.util.Iterator<XBRLFactTuple>	getTuples() Gets the tuples.
java.util.Iterator<XBRLFactTuple>	getTuples(XBRLTuple tupleFrom) Gets the tuples.
java.util.Iterator<XBRLFactTuple>	getTuplesSg(XBRLTuple tupleFrom) Gets the tuples sg.
int	hashCode() Hash code.
int	indexOf(XBRLFact fact, int index) Index of.
java.util.Iterator<XBRLFact>	iterator() Iterator.
java.util.Iterator<XBRLFact>	iterator2() This is a special iterator that iterate children facts recursively.
boolean	remove(java.util.Set<XBRLFact> facts) Removes the set of facts.
boolean	remove(XBRLFact fact) Removes the fact.
void	setParent(XBRLFactsList parent) Sets the parent.
int	size() Returns the number of elements on this list.

Methods inherited from class java.util.LinkedList

addAll, addAll, addFirst, addLast, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractList

listIterator, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, isEmpty, listIterator, removeAll, replaceAll, retainAll, sort, subList

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

XBRLFactsContainer

public XBRLFactsContainer(XBRLFactsList parent)

Creates a facts container and sets the parent doc to the parent Instance.

Parameters:

parent - the parent instance

Method Detail

clone

public XBRLFactsContainer clone()

Clone.

Overrides:

clone in class java.util.LinkedList<XBRLFact>

Returns:

the XBRL facts container

getParentXBRL

public XBRLFactsList getParentXBRL()

Gets the parent.

Returns:

the parent

setParent

public void setParent(XBRLFactsList parent)

Sets the parent.

Parameters:

parent - the new parent

add

public boolean add(XBRLFact fact)

This is the implementation of the add method in the XBRLFactsList interface .

Specified by:

add in interface java.util.Collection<XBRLFact>

Specified by:

add in interface java.util.Deque<XBRLFact>

Specified by:

add in interface java.util.List<XBRLFact>

Specified by:

add in interface java.util.Queue<XBRLFact>

Overrides:

add in class java.util.LinkedList<XBRLFact>

Parameters:

fact - the fact

Returns:

true, if successful

See Also:

XBRLFactsList.add(com.ihr.xbrl.om.instance.XBRLFact)

addNew

public boolean addNew(XBRLFact fact)

Adds a sure new fact. Used on XBRLFact derived constructors.

Parameters:

fact - the new fact

Returns:

true, if successful

add

public void add(int index,
                XBRLFact fact)

Adds the.

Specified by:

add in interface java.util.List<XBRLFact>

Overrides:

add in class java.util.LinkedList<XBRLFact>

Parameters:

index - the index

fact - the fact

clear

public void clear()

Clear.

Specified by:

clear in interface java.util.Collection<XBRLFact>

Specified by:

clear in interface java.util.List<XBRLFact>

Overrides:

clear in class java.util.LinkedList<XBRLFact>

remove

public boolean remove(XBRLFact fact)

Removes the fact.

Parameters:

fact - the fact

Returns:

true, if this set contained the fact

remove

public boolean remove(java.util.Set<XBRLFact> facts)

Removes the set of facts.

Parameters:

facts - the set of facts

Returns:

true, if this set contained any fact in facts

Since:

3.2.0

getInstance

public XBRLInstance getInstance()

Gets the single instance of XBRLFactsContainer.

Returns:

single instance of XBRLFactsContainer

iterator

public java.util.Iterator<XBRLFact> iterator()

Iterator.

Specified by:

iterator in interface java.lang.Iterable<XBRLFact>

Specified by:

iterator in interface java.util.Collection<XBRLFact>

Specified by:

iterator in interface java.util.Deque<XBRLFact>

Specified by:

iterator in interface java.util.List<XBRLFact>

Overrides:

iterator in class java.util.AbstractSequentialList<XBRLFact>

Returns:

the iterator

iterator2

public java.util.Iterator<XBRLFact> iterator2()

This is a special iterator that iterate children facts recursively. When a tuple is found, the returned element after the tuple will be the first tuple children. After all tuple facts are returned, the next fact will be the tuple sibling and so on.

Returns:

Iterator over XBRLFact, recursively.

getItems

public java.util.Iterator<XBRLFactItem> getItems()

Gets the items on this and nested fact containers "tuples" inside this one.

Returns:

the items

getItems

public java.util.Iterator<XBRLFactItem> getItems(XBRLItem itemFrom)

Gets the items.

Parameters:

itemFrom - the item from

Returns:

the items

getTuples

public java.util.Iterator<XBRLFactTuple> getTuples(XBRLTuple tupleFrom)

Gets the tuples.

Parameters:

tupleFrom - the tuple from

Returns:

the tuples

getItemsSg

public java.util.Iterator<XBRLFactItem> getItemsSg(XBRLItem itemFrom)

Gets the items sg.

Parameters:

itemFrom - the item from

Returns:

the items sg

getTuplesSg

public java.util.Iterator<XBRLFactTuple> getTuplesSg(XBRLTuple tupleFrom)

Gets the tuples sg.

Parameters:

tupleFrom - the tuple from

Returns:

the tuples sg

getTuples

public java.util.Iterator<XBRLFactTuple> getTuples()

Gets the tuples.

Returns:

the tuples

getNumberOfItems

public int getNumberOfItems()

Gets the number of items on this facts container.

Returns:

the number of items

getNumberOfTuples

public int getNumberOfTuples()

Gets the number of tuples on this facts container.

Returns:

the number of tuples

addNewFact

public void addNewFact(int index,
                       XBRLFact fact)

Adds the new fact.

Parameters:

index - the index

fact - the fact

getContainer

public DTSContainer getContainer()

Gets the container.

Returns:

the container

hashCode

public int hashCode()

Hash code.

Specified by:

hashCode in interface java.util.Collection<XBRLFact>

Specified by:

hashCode in interface java.util.List<XBRLFact>

Overrides:

hashCode in class java.util.AbstractList<XBRLFact>

Returns:

the int

size

public int size()

Returns the number of elements on this list.

Specified by:

size in interface java.util.Collection<XBRLFact>

Specified by:

size in interface java.util.Deque<XBRLFact>

Specified by:

size in interface java.util.List<XBRLFact>

Overrides:

size in class java.util.LinkedList<XBRLFact>

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Specified by:

equals in interface java.util.Collection<XBRLFact>

Specified by:

equals in interface java.util.List<XBRLFact>

Overrides:

equals in class java.util.AbstractList<XBRLFact>

Parameters:

obj - the obj

Returns:

true, if successful

clearFacts

public void clearFacts()

The clear method removes all facts form the container and also sets the parent to null. This call only removes all facts but does not sets the parent to null.

Since:

2.7.4

indexOf

public int indexOf(XBRLFact fact,
                   int index)

Index of.

Parameters:

fact - the fact

index - the index

Returns:

the int