XBRLFactsList

All Known Implementing Classes:

XBRLFactsListImpl, XBRLFactTuple, XBRLInstanceRootNode
```
public interface XBRLFactsList
```
This interface provides methods for objects that contains a list of facts in document order and also possible accelerator functions to facts indexed by fact name

Author:

Ignacio

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`add(int index, XBRLFact fact)` Adds the fact to the facts list at the indicated position.
`boolean`	`add(XBRLFact fact)` Adds a new fact to the end of this list of facts.
`void`	`clear()` Removes all children elements in this XBRLFactList.
`boolean`	`equals(java.lang.Object obj)` This function should be implemented by sub classes in order to properly implement.
`XBRLFact`	`get(int index)` Returns the element at the selected index position.
`DTSContainer`	`getContainer()` Access to the surrounding container object.
`net.sf.saxon.s9api.XdmNode`	`getDocument()` Access to the surrounding XdmDocument from the XMLFragment.
`XBRLInstance`	`getInstance()` Access to the instance document on the top of this facts container hierarchy.
`java.util.Iterator<XBRLFactItem>`	`getItems()` Iterator over the items on this facts container.
`java.util.Iterator<XBRLFactItem>`	`getItems(XBRLItem itemFrom)` Iterator over fact items that are instances of the XBRLItem received as a parameter.
`java.util.Iterator<XBRLFactItem>`	`getItemsSg(XBRLItem itemFrom)` Iterator over fact items that are instances of the XBRLItem received as a parameter of in the substitution group of that item.
`int`	`getNumberOfItems()` Calculates and returns the number of items children of this facts container.
`int`	`getNumberOfTuples()` Calculates and returns the number of tuples children of this facts container.
`XMLFragment`	`getParentXBRL()` Access to the parent document, Instance or tuple.
`java.util.Iterator<XBRLFactTuple>`	`getTuples()` Iterator over the tuples on this facts container.
`java.util.Iterator<XBRLFactTuple>`	`getTuples(XBRLTuple tupleFrom)` Iterator over fact tuples that are instances of the XBRLTuple received as a parameter.
`java.util.Iterator<XBRLFactTuple>`	`getTuplesSg(XBRLTuple tupleFrom)` Iterator over fact tuples that are instances of the XBRLTuple received as a parameter of in the substitution group of that tuple.
`XPathOnXMLFragment`	`getXPath()` Returns an instance of the class to evaluate XPath expressions.
`java.lang.String`	`getXPathToRoot()` Access to the surrounding method from the XMLFragment.
`int`	`hashCode()` This is from the Object interface and must be implemented by sub classes in order to be able to provide hashCodes.
`int`	`indexOf(XBRLFact fact)` Returns the index position of a fact within this list.
`int`	`indexOf(XBRLFact fact, int index)` Returns the index position of a fact within this list starting at the position indicated by the index parameter.
`java.util.Iterator<XBRLFact>`	`iterator()` Iterator over this FactsList content.
`java.util.Iterator<XBRLFact>`	`iterator2()` Iterator over this FactsList content that goes nested inside tuple content.
`boolean`	`remove(java.util.Set<XBRLFact> facts)` Removes a set of facts from the facts container.
`boolean`	`remove(XBRLFact fact)` Removes a fact from the facts container.
`boolean`	`removeFact(XBRLFact fact)` Removes a fact from the parent XML element.
`boolean`	`removeFacts(java.util.Set<XBRLFact> facts)` Removes a fact from the parent XML element.
`void`	`setParent(XBRLFactsList parent)` Sets the parent of this facts container to a new parent.
`int`	`size()` Access to the number of elements in the XBRLFactList.

- Method Detail
  - getParentXBRL
```
XMLFragment getParentXBRL()
```
    Access to the parent document, Instance or tuple.
    
    Returns:
    
    XMLFragment that is a XBRLInstance or XBRLFactTuple
  - setParent
```
void setParent(XBRLFactsList parent)
```
    Sets the parent of this facts container to a new parent.
    
    Parameters:
    
    parent - the new parent
  - add
```
boolean add(XBRLFact fact)
```
    Adds a new fact to the end of this list of facts.
    
    Parameters:
    
    fact - the fact
    
    Returns:
    
    true, if successful
  - add
```
void add(int index,
         XBRLFact fact)
```
    Adds the fact to the facts list at the indicated position.
    
    Parameters:
    
    index - the index
    
    fact - the fact
  - get
```
XBRLFact get(int index)
```
    Returns the element at the selected index position. The first element is at position 0
    
    Parameters:
    
    index - integer
    
    Returns:
    
    XBRLFact at position indicated by index parameter
  - remove
```
boolean remove(XBRLFact fact)
```
    Removes a fact from the facts container.
    
    Parameters:
    
    fact - the fact
    
    Returns:
    
    boolean
  - removeFact
```
boolean removeFact(XBRLFact fact)
```
    Removes a fact from the parent XML element. This call is not intended to be used by external APIs and it is used by the generic remove method
    
    Parameters:
    
    fact - the fact
    
    Returns:
    
    true, if successful
  - remove
```
boolean remove(java.util.Set<XBRLFact> facts)
```
    Removes a set of facts from the facts container.
    
    Parameters:
    
    facts - the set of facts
    
    Returns:
    
    boolean
    
    Since:
    
    3.2.0
  - removeFacts
```
boolean removeFacts(java.util.Set<XBRLFact> facts)
```
    Removes a fact from the parent XML element. This call is not intended to be used by external APIs and it is used by the generic remove method
    
    Parameters:
    
    facts - the facts
    
    Returns:
    
    true, if successful
  - getInstance
```
XBRLInstance getInstance()
```
    Access to the instance document on the top of this facts container hierarchy.
    
    Returns:
    
    XBRLInstance
  - iterator
```
java.util.Iterator<XBRLFact> iterator()
```
    Iterator over this FactsList content.
    
    Returns:
    
    the iterator
  - iterator2
```
java.util.Iterator<XBRLFact> iterator2()
```
    Iterator over this FactsList content that goes nested inside tuple content.
    
    Returns:
    
    the iterator
  - size
```
int size()
```
    Access to the number of elements in the XBRLFactList.
    
    Returns:
    
    integer
  - getItems
```
java.util.Iterator<XBRLFactItem> getItems()
```
    Iterator over the items on this facts container.
    
    Returns:
    
    Iterator<XBRLFactItem>
  - getItems
```
java.util.Iterator<XBRLFactItem> getItems(XBRLItem itemFrom)
```
    Iterator over fact items that are instances of the XBRLItem received as a parameter.
    
    Parameters:
    
    itemFrom - XBRLItem
    
    Returns:
    
    Iterator<XBRLFactItem>
  - getItemsSg
```
java.util.Iterator<XBRLFactItem> getItemsSg(XBRLItem itemFrom)
```
    Iterator over fact items that are instances of the XBRLItem received as a parameter of in the substitution group of that item.
    
    Parameters:
    
    itemFrom - XBRLItem
    
    Returns:
    
    Iterator<XBRLFactItem>
  - getTuples
```
java.util.Iterator<XBRLFactTuple> getTuples()
```
    Iterator over the tuples on this facts container.
    
    Returns:
    
    Iterator<XBRLFactTuple>
  - getTuples
```
java.util.Iterator<XBRLFactTuple> getTuples(XBRLTuple tupleFrom)
```
    Iterator over fact tuples that are instances of the XBRLTuple received as a parameter.
    
    Parameters:
    
    tupleFrom - XBRLTuple
    
    Returns:
    
    Iterator<XBRLFactTuple>
  - getTuplesSg
```
java.util.Iterator<XBRLFactTuple> getTuplesSg(XBRLTuple tupleFrom)
```
    Iterator over fact tuples that are instances of the XBRLTuple received as a parameter of in the substitution group of that tuple.
    
    Parameters:
    
    tupleFrom - the tuple from
    
    Returns:
    
    Iterator<XBRLFactTuple>
  - getNumberOfItems
```
int getNumberOfItems()
```
    Calculates and returns the number of items children of this facts container.
    
    Returns:
    
    integer value
  - getNumberOfTuples
```
int getNumberOfTuples()
```
    Calculates and returns the number of tuples children of this facts container.
    
    Returns:
    
    integer value
  - getContainer
```
DTSContainer getContainer()
```
    Access to the surrounding container object.
    
    Returns:
    
    DTSContainer
  - getDocument
```
net.sf.saxon.s9api.XdmNode getDocument()
```
    Access to the surrounding XdmDocument from the XMLFragment.
    
    Returns:
    
    XdmNode according to saxon s9api
  - getXPathToRoot
```
java.lang.String getXPathToRoot()
```
    Access to the surrounding method from the XMLFragment.
    
    Returns:
    
    String
  - indexOf
```
int indexOf(XBRLFact fact)
```
    Returns the index position of a fact within this list.
    
    Parameters:
    
    fact - XBRLFact
    
    Returns:
    
    integer
  - indexOf
```
int indexOf(XBRLFact fact,
            int index)
```
    Returns the index position of a fact within this list starting at the position indicated by the index parameter.
    
    Parameters:
    
    fact - XBRLFact
    
    index - integer
    
    Returns:
    
    integer
  - clear
```
void clear()
    throws java.lang.Throwable
```
    Removes all children elements in this XBRLFactList.
    
    Throws:
    
    java.lang.Throwable - the throwable
  - hashCode
```
int hashCode()
```
    This is from the Object interface and must be implemented by sub classes in order to be able to provide hashCodes.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    integer
  - equals
```
boolean equals(java.lang.Object obj)
```
    This function should be implemented by sub classes in order to properly implement.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - Object to compare to
    
    Returns:
    
    boolean value
  - getXPath
```
XPathOnXMLFragment getXPath()
```
    Returns an instance of the class to evaluate XPath expressions.
    
    Returns:
    
    the x path

Interface XBRLFactsList

Method Summary

Method Detail

getParentXBRL

setParent

add

add

get

remove

removeFact

remove

removeFacts

getInstance

iterator

iterator2

size

getItems

getItems

getItemsSg

getTuples

getTuples

getTuplesSg

getNumberOfItems

getNumberOfTuples

getContainer

getDocument

getXPathToRoot

indexOf

indexOf

clear

hashCode

equals

getXPath