com.ihr.xbrl.om.instance

Class XBRLFact

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.instance.XBRLFact

All Implemented Interfaces:

HasDTSContainer, ObtainHistoryInterface, StoreHistoryInterface, XBRLRelationshipPoint, HasChangeHashSupport, XBRLValidation, java.io.Serializable, java.lang.Cloneable, javax.xml.namespace.NamespaceContext, javax.xml.transform.Source, javax.xml.transform.SourceLocator, net.sf.saxon.evpull.PullEvent, net.sf.saxon.om.FingerprintedNode, net.sf.saxon.om.Item, net.sf.saxon.om.MutableNodeInfo, net.sf.saxon.om.NamespaceResolver, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>, net.sf.saxon.tree.wrapper.SiblingCountingNode

Direct Known Subclasses:

XBRLFactItem, XBRLFactTuple

public abstract class XBRLFact
extends XMLFragment
implements XBRLValidation, StoreHistoryInterface

Abstract class to represent a fact item in an instance document or inside a tuple. Concreate classes of this class are: XBRLFactItem and XBRLFactTuple

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ihr.xbrl.om.XMLFragment

XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation

XBRLValidation.Direction

Field Summary

Fields inherited from class com.ihr.xbrl.om.XMLFragment

ADD_NAMESPACE_INHERIT, baseQName, CONCEPT_LABEL, CONCEPT_QNAME, EASY_TO_READ, ELEMENT_LABEL, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, FACT_VALUE, HIDE_COMMON_ACCURACY, idQName, langQName, nil, NO_POSITION, OrderComparator, OrderComparator2, OrderComparatorReverse, PERIOD_BOP, PERIOD_TYPE, PERIOD_VALUE, RELATIONSHIP_TYPE, RESOURCE_TYPE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl

NODE_LETTER

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Method Summary

Modifier and Type	Method and Description
void	addEvent(HistoricalEventInterface event) Adds the event.
void	clear() Eliminates all this fact content.
XBRLFact	clone() Clone.
XBRLFact	clone(DTSContainer newDTS) Clone current fact but in a new DTSContainer.
static XBRLFactNumeric	createFractionItemInstance(XBRLFactsList facts, XBRLItem el, XBRLContext ctx, XBRLUnit unit, java.lang.Number numerator, java.lang.Number denominator, boolean addToParentNow) Creates a tupleInstance of a itemInstance depending on the data type of the el parameter and extra information provided in other parameters.
static XBRLFact	createItemOrTupleInstance(DTSContainer dts, XBRLFactsList facts, XMLFragment node) Creates a tupleInstance or a itemInstance depending on the node content.
static XBRLFactNonNumeric	createNonNumericItemInstance(XBRLFactsList facts, XBRLItem el, XBRLContext ctx, java.lang.String value, boolean addToParentNow) Creates a tupleInstance of a itemInstance depending on the data type of the el parameter and extra information provided in other parameters.
static XBRLFactNumeric	createNumericItemInstance(XBRLFactsList facts, XBRLItem el, XBRLContext ctx, XBRLUnit unit, java.lang.Number value, XBRLNumber.ExactitudeMode format, int formatValue, boolean addToParentNow) Creates a tupleInstance of a itemInstance depending on the data type of the el parameter and extra information provided in other parameters.
static XBRLFactTuple	createTupleInstance(XBRLFactsList facts, XBRLTuple el, boolean addToParentNow) Creates a tupleInstance of a itemInstance depending on the data type of the el parameter and extra information provided in other parameters.
void	delete() Delete.
boolean	equals(java.lang.Object obj) Equals.
XBRLFact	generateNode() Generates the XBRLFact jdom node.
int	getCode() Gets the code.
XMLElementDefinition	getElementDefinition() Access to the element definition behind this fact.
java.util.Iterator<XMLFragment>	getElements() Gets the elements.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
java.lang.String	getFriendlyName() Gets the friendly name.
java.lang.String	getFriendlyName(int modifiers, LabelsProvider lp) Gets the friendly name.
java.util.Collection<HistoricalEventInterface>	getHistory() Gets the history.
java.lang.String	getHistoryAsHTMLString() Gets the history as HTML string.
java.lang.String	getHistoryAsString() Gets the history as string.
XBRLInstance	getInstance() The instance document where this fact exists.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XMLFragment	getParentXBRL() The parent of a fact is always a facts container.
XBRLFactsList	getParentXBRLFactsList() Gets the parent XBRL facts list.
XBRLTaxonomy	getTaxonomy() The XBRLTaxonomy in which this fact is defined.
XBRLValidationReport	getValidationReport() Gets the validation report.
net.sf.saxon.s9api.XdmValue	getValue() Gets the value.
java.lang.String	getXPathToRoot() Gets the x path to root.
boolean	hasChildNodes()
int	hashCode() Hash code.
void	invalidate() Invalidate.
boolean	invalidate(XBRLValidation.Direction dir) Invalidate.
boolean	isBlank() true if the fact item has no value assigned.
abstract boolean	isDuplicate(XBRLFact otherFact) Check if two items are duplicates as defined in the XBRL 2.1 specification
boolean	isOnValidation() Checks if is on validation.
boolean	pEqual(XBRLFact toFact) Implementation of the p-equality as defined in the XBRL 2.1 specification.
void	setBlank(boolean value) Sets the indicator that this fact item is blank.
void	setCode(int newCode) Sets the code.
void	setId(java.lang.String id) Sets the id.
void	setInstance(XBRLInstance instance) Sets the instance.
boolean	setNil(boolean newValue) Sets the nil attribute to true or false according to the param value.
void	setParent(XBRLFactsList parent) Sets the parent of this XBRLFact to be the XBRLFactsList object used as a parameter.
void	setValue(net.sf.saxon.value.AtomicValue value) Sets the value.
void	setValue(net.sf.saxon.s9api.QName value) Sets the value.
void	setValue(javax.xml.namespace.QName value) Sets the value.
void	setValue(java.lang.String value) Sets the value.
void	setValue(java.lang.String value, net.sf.saxon.type.BuiltInAtomicType type) Sets the value.
void	setValue(net.sf.saxon.s9api.XdmAtomicValue value) Sets the value.
void	setValue(net.sf.saxon.s9api.XdmValue value) Sets the value.
XBRLValidationReport	validate(XBRLPlugInProcessor proc) Validate.

Methods inherited from class com.ihr.xbrl.om.XMLFragment

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addChild, addChildArray, addChildAt, addChildNode, addChildNodeArray, addChildNodeAt, addChildNodeInBatch, addComment, addFromRelationship, addNamespace, addNamespace, addPropertyChangeListener, addToRelationship, changeBase, checkBase, childExists, commitBatch, copy, createComment, delAttribute, delAttribute, equalXdmValues, findFirstNodeOfClass, findPosition, firePropertyChangeEvent, generateId, generateLocatorToNode, generatePrefix, getAllAttributes, getAttribute, getAttributeAtomicValue, getAttributeBooleanValue, getAttributeGroundedValue, getAttributeQNameValue, getAttributes, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getContainerDocumentURI, getDocument, getElement, getElement, getFirstChildNoComment, getFragment, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentDocument, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isHashDependsOnAtribute, isNamespaceDefined, isNil, moveNamespacesUp, objEquals, objHashCode, reindex, removeChild, removeChildNode, removeFromRelationship, removeNamespace, removePropertyChangeListener, removeToRelationship, replace, replaceChild, replaceStringValue, resetElements, resolveHRef, s_equal2_xp2, s_equal2_xp2, s_equal2, s_equal2, s_equal2, s_equal2, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNodeName, setRawParentXBRL, setValue, toString, valueEquals, xEqual

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl

addAttribute, addNamespace, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, isId, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, setLocation, setNameCode, setNamespaceList, setSystemId, setTypeAnnotation

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

atomize, compareOrder, comparePosition, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getSuccessorElement, getURI, head, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterate, iterateAxis, iterateAxis, newBuilder, replace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

clone

public XBRLFact clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL fact

getCode

public int getCode()

Gets the code.

Returns:

the code

setCode

public void setCode(int newCode)

Sets the code.

Parameters:

newCode - the new code

clone

public XBRLFact clone(DTSContainer newDTS)

Clone current fact but in a new DTSContainer.

Overrides:

clone in class XMLFragment

Parameters:

newDTS - the new dts

Returns:

cloned XBRLFact

isBlank

public boolean isBlank()

true if the fact item has no value assigned. No value assigned is different from being null

Returns:

boolean value

setBlank

public void setBlank(boolean value)

Sets the indicator that this fact item is blank.

Parameters:

value - the new blank

setParent

public void setParent(XBRLFactsList parent)

Sets the parent of this XBRLFact to be the XBRLFactsList object used as a parameter.

Setting the parent does not adds the fact as child of the parent element. This function do the following steps:

1. if there are no changes (current parent is the same object as the object used as a parameter) then the function does nothing
2. inform the old parent to remove the reference to the children
3. sets parent of this object to be the object submitted as a parameter
4. if the fact was assigned from a different instance document. Then relationships in the original instance document are removed from the new item.

Parameters:

parent - the new parent

setId

public void setId(java.lang.String id)
           throws XBRLInconsistentDTSException

Sets the id.

Overrides:

setId in class XMLFragment

Parameters:

id - the new id

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent DTS exception

getParentXBRL

public XMLFragment getParentXBRL()

The parent of a fact is always a facts container. The facts container can exist inside a tuple or inside an instance document.

Overrides:

getParentXBRL in class XMLFragment

Returns:

XMLFragment

getParentXBRLFactsList

public XBRLFactsList getParentXBRLFactsList()

Gets the parent XBRL facts list.

Returns:

the parent XBRL facts list

getXPathToRoot

public java.lang.String getXPathToRoot()

Gets the x path to root.

Overrides:

getXPathToRoot in class XMLFragment

Returns:

the x path to root

delete

public void delete()

Delete.

Specified by:

delete in interface net.sf.saxon.om.MutableNodeInfo

Overrides:

delete in class XMLFragment

getElementDefinition

public XMLElementDefinition getElementDefinition()

Access to the element definition behind this fact.

Returns:

XMLElementDefinition

getInstance

public XBRLInstance getInstance()

The instance document where this fact exists.

Returns:

XBRLInstance

setInstance

public void setInstance(XBRLInstance instance)

Sets the instance.

Parameters:

instance - the new instance

getTaxonomy

public XBRLTaxonomy getTaxonomy()

The XBRLTaxonomy in which this fact is defined.

Returns:

XBRLTaxonomy

pEqual

public boolean pEqual(XBRLFact toFact)

Implementation of the p-equality as defined in the XBRL 2.1 specification.

p-equality means parent-equality. two facts are p-equal if they have the same parent node

Parameters:

toFact - the other fact to compare this fact to

Returns:

boolean value, true means this and toFact are p-equal

createItemOrTupleInstance

public static XBRLFact createItemOrTupleInstance(DTSContainer dts,
                                                 XBRLFactsList facts,
                                                 XMLFragment node)
                                          throws XBRLValidationException

Creates a tupleInstance or a itemInstance depending on the node content.

Parameters:

dts - DTSContainer

facts - XBRLFactsList

node - XMLFragment

Returns:

XBRLFact

Throws:

XBRLValidationException - the XBRL validation exception

createNumericItemInstance

public static XBRLFactNumeric createNumericItemInstance(XBRLFactsList facts,
                                                        XBRLItem el,
                                                        XBRLContext ctx,
                                                        XBRLUnit unit,
                                                        java.lang.Number value,
                                                        XBRLNumber.ExactitudeMode format,
                                                        int formatValue,
                                                        boolean addToParentNow)

Creates a tupleInstance of a itemInstance depending on the data type of the el parameter and extra information provided in other parameters.

Parameters:

facts - XBRLFactsContainer if null, the fact will not be part of any factsList

el - XBRLElementDefinition must be either XBRLTuple or XBRLItem, Cannot be null

ctx - XBRLContext, if element is a tuple this parameter can be null

unit - XBRLUnit, if element is not numeric or is a tuple this parameter can be null

value - the value

format - the format

formatValue - the format value

addToParentNow - if this is true, the new fact will be added to the instance. If this is false, call container.add(...) later

Returns:

a new XBRLFact

createNonNumericItemInstance

public static XBRLFactNonNumeric createNonNumericItemInstance(XBRLFactsList facts,
                                                              XBRLItem el,
                                                              XBRLContext ctx,
                                                              java.lang.String value,
                                                              boolean addToParentNow)

Creates a tupleInstance of a itemInstance depending on the data type of the el parameter and extra information provided in other parameters.

Parameters:

facts - XBRLFactsContainer if null, the fact will not be part of any factsList

el - XBRLElementDefinition must be either XBRLTuple or XBRLItem, Cannot be null

ctx - XBRLContext, if element is a tuple this parameter can be null

value - the value

addToParentNow - if this is true, the new fact will be added to the instance. If this is false, call container.add(...) later

Returns:

a new XBRLFact

createTupleInstance

public static XBRLFactTuple createTupleInstance(XBRLFactsList facts,
                                                XBRLTuple el,
                                                boolean addToParentNow)

Creates a tupleInstance of a itemInstance depending on the data type of the el parameter and extra information provided in other parameters.

Parameters:

facts - XBRLFactsContainer if null, the fact will not be part of any factsList

el - XBRLElementDefinition must be either XBRLTuple or XBRLItem, Cannot be null

addToParentNow - if this is true, the new fact will be added to the instance. If this is false, call container.add(...) later

Returns:

a new XBRLFact

createFractionItemInstance

public static XBRLFactNumeric createFractionItemInstance(XBRLFactsList facts,
                                                         XBRLItem el,
                                                         XBRLContext ctx,
                                                         XBRLUnit unit,
                                                         java.lang.Number numerator,
                                                         java.lang.Number denominator,
                                                         boolean addToParentNow)

Creates a tupleInstance of a itemInstance depending on the data type of the el parameter and extra information provided in other parameters.

Parameters:

facts - XBRLFactsContainer if null, the fact will not be part of any factsList

el - XBRLElementDefinition must be either XBRLTuple or XBRLItem, Cannot be null

ctx - XBRLContext, if element is a tuple this parameter can be null

unit - XBRLUnit, if element is not numeric or is a tuple this parameter can be null

numerator - the numerator

denominator - the denominator

addToParentNow - if this is true, the new fact will be added to the instance. If this is false, call container.add(...) later

Returns:

a new XBRLFact

validate

public XBRLValidationReport validate(XBRLPlugInProcessor proc)

Validate.

Specified by:

validate in interface XBRLValidation

Parameters:

proc - the proc

Returns:

the XBRL validation report

invalidate

public void invalidate()

Invalidate.

Specified by:

invalidate in interface XBRLValidation

invalidate

public boolean invalidate(XBRLValidation.Direction dir)

Invalidate.

Specified by:

invalidate in interface XBRLValidation

Parameters:

dir - the dir

Returns:

true, if successful

getValidationReport

public XBRLValidationReport getValidationReport()

Gets the validation report.

Specified by:

getValidationReport in interface XBRLValidation

Returns:

the validation report

isOnValidation

public boolean isOnValidation()

Checks if is on validation.

Specified by:

isOnValidation in interface XBRLValidation

Returns:

true, if is on validation

isDuplicate

public abstract boolean isDuplicate(XBRLFact otherFact)

Check if two items are duplicates as defined in the XBRL 2.1 specification

Parameters:

otherFact - the other XBRLFactItem

Returns:

boolean

setNil

public boolean setNil(boolean newValue)

Sets the nil attribute to true or false according to the param value.

Overrides:

setNil in class XMLFragment

Parameters:

newValue - the new nil

Returns:

true, if successful

setValue

public void setValue(net.sf.saxon.value.AtomicValue value)

Sets the value.

Overrides:

setValue in class XMLFragment

Parameters:

value - the new value

setValue

public void setValue(net.sf.saxon.s9api.XdmValue value)

Sets the value.

Overrides:

setValue in class XMLFragment

Parameters:

value - the new value

setValue

public void setValue(net.sf.saxon.s9api.XdmAtomicValue value)

Sets the value.

Overrides:

setValue in class XMLFragment

Parameters:

value - the new value

setValue

public void setValue(java.lang.String value)

Sets the value.

Overrides:

setValue in class XMLFragment

Parameters:

value - the new value

setValue

public void setValue(java.lang.String value,
                     net.sf.saxon.type.BuiltInAtomicType type)

Sets the value.

Overrides:

setValue in class XMLFragment

Parameters:

value - the value

type - the type

setValue

public void setValue(net.sf.saxon.s9api.QName value)

Sets the value.

Overrides:

setValue in class XMLFragment

Parameters:

value - the new value

setValue

public void setValue(javax.xml.namespace.QName value)

Sets the value.

Overrides:

setValue in class XMLFragment

Parameters:

value - the new value

generateNode

public XBRLFact generateNode()
                      throws XBRLSerializationException

Generates the XBRLFact jdom node. adds the xsi:nil attribute if required

Overrides:

generateNode in class XMLFragment

Returns:

the element

Throws:

XBRLSerializationException - the XBRL serialization exception

getElements

public java.util.Iterator<XMLFragment> getElements()

Gets the elements.

Overrides:

getElements in class XMLFragment

Returns:

the elements

getFriendlyName

public java.lang.String getFriendlyName()

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Returns:

the friendly name

getFriendlyName

public java.lang.String getFriendlyName(int modifiers,
                                        LabelsProvider lp)

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Parameters:

modifiers - the modifiers

lp - the lp

Returns:

a String representation of this fact.

addEvent

public void addEvent(HistoricalEventInterface event)

Adds the event.

Specified by:

addEvent in interface StoreHistoryInterface

Parameters:

event - the event

getHistory

public java.util.Collection<HistoricalEventInterface> getHistory()

Gets the history.

Specified by:

getHistory in interface ObtainHistoryInterface

Returns:

the history

getHistoryAsString

public java.lang.String getHistoryAsString()

Gets the history as string.

Specified by:

getHistoryAsString in interface ObtainHistoryInterface

Returns:

the history as string

getHistoryAsHTMLString

public java.lang.String getHistoryAsHTMLString()

Gets the history as HTML string.

Specified by:

getHistoryAsHTMLString in interface ObtainHistoryInterface

Returns:

the history as HTML string

clear

public void clear()
           throws java.lang.Throwable

Eliminates all this fact content.

Overrides:

clear in class XMLFragment

Throws:

java.lang.Throwable - the throwable

hashCode

public int hashCode()

Hash code.

Specified by:

hashCode in interface net.sf.saxon.om.NodeInfo

Overrides:

hashCode in class XMLFragment

Returns:

the int

getValue

public net.sf.saxon.s9api.XdmValue getValue()

Gets the value.

Overrides:

getValue in class XMLFragment

Returns:

the value

equals

public boolean equals(java.lang.Object obj)

Equals.

Specified by:

equals in interface net.sf.saxon.om.NodeInfo

Overrides:

equals in class XMLFragment

Parameters:

obj - the obj

Returns:

true, if successful

hasChildNodes

public final boolean hasChildNodes()

Specified by:

hasChildNodes in interface net.sf.saxon.om.NodeInfo

Overrides:

hasChildNodes in class net.sf.saxon.tree.linked.NodeImpl

getNumberOfChildren

public final int getNumberOfChildren()

getFirstChild

public final net.sf.saxon.tree.linked.NodeImpl getFirstChild()

Specified by:

getFirstChild in interface net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>

Overrides:

getFirstChild in class net.sf.saxon.tree.linked.NodeImpl

getLastChild

public final net.sf.saxon.tree.linked.NodeImpl getLastChild()

Overrides:

getLastChild in class net.sf.saxon.tree.linked.NodeImpl