com.ihr.xbrl.om.instance

Class XBRLFactItem

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

com.ihr.xbrl.om.instance.XBRLFactItem

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:

XBRLFactNonNumeric, XBRLFactNumeric

public abstract class XBRLFactItem
extends XBRLFact

This class represents the instantiation of an xbrli:item on an instance document.

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

Modifier and Type	Field and Description
static javax.xml.namespace.QName	contextRef The Constant contextRef.

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
boolean	cEqual(XBRLFactItem factTotal) Evaluates if the two instantiation of the items are c-equal.
XBRLFactItem	clone() Clone.
XBRLFactItem	clone(DTSContainer newDTS) Clone.
static XBRLFactNumeric	createFractionItemInstance(XBRLFactsList container, XBRLContext ctx, XBRLItem xf, XBRLUnit unit, java.lang.Number numerator, java.lang.Number denominator, boolean addToParentNow) creates an XBRLFactItem that can be either a XBRLFactNumeric or XBRLFactNonNumeric depending on the information provided in extra parameters.
static XBRLFact	createItemInstance(XBRLFactsList parent, XBRLItem xf, XBRLFactItem otherFact, boolean addToParentNow) Creates the item instance.
static XBRLFactItem	createItemInstance(XBRLFactsList container, XMLFragment node, XMLFragment xf) Creates an XBRLFactItem that can be either a XBRLFactNumeric or XBRLFactNonNumeric depending on the data type (derivation included) of the concept definition.
static XBRLFactNonNumeric	createNonNumericItemInstance(XBRLFactsList container, XBRLContext ctx, XBRLItem xf, java.lang.String value, boolean bAddToParentNow) creates an XBRLFactItem that can be either a XBRLFactNumeric or XBRLFactNonNumeric depending on the information provided in extra parameters.
static XBRLFactNumeric	createNumericItemInstance(XBRLFactsList container, XBRLContext ctx, XBRLItem xf, XBRLUnit unit, java.lang.Number value, XBRLNumber.ExactitudeMode format, int formatValue, boolean addToParentNow) creates an XBRLFactItem that can be either a XBRLFactNumeric or XBRLFactNonNumeric depending on the information provided in extra parameters.
boolean	equals(java.lang.Object obj) Equals.
XBRLFactItem	generateNode() Generates the XBRLFactItem node.
java.util.Iterator<XBRLAttribute>	getAttributes() Removes the contextRef attribute from the FactItem Parent iterators already removes the id attribute if any.
XBRLContext	getContext() Access to the context object.
java.net.URI	getDocumentURI() Access to the URI property of the instance document for this fact item.
XBRLItem	getElementDefinition() Access to the surrounding item declaration for this item.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
java.lang.String	getStringValue() Gets the string value.
boolean	hasChildNodes()
int	hashCode() Hash code.
boolean	isDescendantOrSibling(XBRLFactItem otherFact) Returns true if otherFact is a descendant or sibling of this fact.
abstract boolean	isDuplicate(XBRLFactItem tTarget, boolean reversePEqual) For internal purposes only during the calculation of isDuplicate of tuple children elements.
boolean	isHashDependsOnAtribute(javax.xml.namespace.QName attributeName) Checks if is hash depends on atribute.
boolean	s_equal2(java.lang.Object other) S equal 2.
void	setContext(XBRLContext newContext) Sets the context of this fact.
abstract boolean	uEqual(XBRLFactItem toFact) Check if two items are unit equal as defined in the XBRL 2.1 specification
abstract boolean	vEqual(XBRLFactItem toFact) Check if two items are value equal as defined in the XBRL 2.1 specification

Methods inherited from class com.ihr.xbrl.om.instance.XBRLFact

addEvent, clear, createFractionItemInstance, createItemOrTupleInstance, createNonNumericItemInstance, createNumericItemInstance, createTupleInstance, delete, getCode, getElements, getFriendlyName, getFriendlyName, getHistory, getHistoryAsHTMLString, getHistoryAsString, getInstance, getParentXBRL, getParentXBRLFactsList, getTaxonomy, getValidationReport, getValue, getXPathToRoot, invalidate, invalidate, isBlank, isDuplicate, isOnValidation, pEqual, setBlank, setCode, setId, setInstance, setNil, setParent, setValue, setValue, setValue, setValue, setValue, setValue, setValue, 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, 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, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, 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, 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

Field Detail

contextRef

public static final javax.xml.namespace.QName contextRef

The Constant contextRef.

Method Detail

clone

public XBRLFactItem clone()

Clone.

Overrides:

clone in class XBRLFact

Returns:

the XBRL fact item

clone

public XBRLFactItem clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XBRLFact

Parameters:

newDTS - the new DTS

Returns:

the XBRL fact item

createItemInstance

public static XBRLFactItem createItemInstance(XBRLFactsList container,
                                              XMLFragment node,
                                              XMLFragment xf)
                                       throws XBRLValidationException

Creates an XBRLFactItem that can be either a XBRLFactNumeric or XBRLFactNonNumeric depending on the data type (derivation included) of the concept definition.

Parameters:

container - XBRLFactsContainer where the new fact will be added

node - NodeInfo to process while creating the fact item

xf - XBRLItem concept definition

Returns:

com.ihr.xbrl.om.instance.XBRLFactItem

Throws:

XBRLValidationException - the XBRL validation exception

createNonNumericItemInstance

public static XBRLFactNonNumeric createNonNumericItemInstance(XBRLFactsList container,
                                                              XBRLContext ctx,
                                                              XBRLItem xf,
                                                              java.lang.String value,
                                                              boolean bAddToParentNow)

creates an XBRLFactItem that can be either a XBRLFactNumeric or XBRLFactNonNumeric depending on the information provided in extra parameters.

Parameters:

container - XBRLFactsList container of the new fact

ctx - XBRLContext for the new fact

xf - XBRLItem definition

value - the value

bAddToParentNow - the b add to parent now

Returns:

a new XBRLFactItem

createNumericItemInstance

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

creates an XBRLFactItem that can be either a XBRLFactNumeric or XBRLFactNonNumeric depending on the information provided in extra parameters.

Parameters:

container - XBRLFactsList container of the new fact

ctx - XBRLContext for the new fact

xf - XBRLItem definition

unit - XBRLUnit may be null is item is string item type

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 XBRLFactItem

createFractionItemInstance

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

creates an XBRLFactItem that can be either a XBRLFactNumeric or XBRLFactNonNumeric depending on the information provided in extra parameters.

Parameters:

container - XBRLFactsList container of the new fact

ctx - XBRLContext for the new fact

xf - XBRLItem definition

unit - XBRLUnit may be null is item is string item type

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 XBRLFactItem

createItemInstance

public static XBRLFact createItemInstance(XBRLFactsList parent,
                                          XBRLItem xf,
                                          XBRLFactItem otherFact,
                                          boolean addToParentNow)

Creates the item instance.

Parameters:

parent - the parent

xf - the xf

otherFact - the other fact

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

Returns:

XBRLFact

getDocumentURI

public java.net.URI getDocumentURI()

Access to the URI property of the instance document for this fact item.

Returns:

URI from the instance or null if the instance contains no URI.

getStringValue

public java.lang.String getStringValue()

Gets the string value.

Specified by:

getStringValue in interface net.sf.saxon.om.Item

Specified by:

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

Overrides:

getStringValue in class XMLFragment

Returns:

the string value

getContext

public XBRLContext getContext()

Access to the context object.

Returns:

the XBRLContext if found. null if no context is set

setContext

public void setContext(XBRLContext newContext)

Sets the context of this fact.

Parameters:

newContext - the new context

getAttributes

public java.util.Iterator<XBRLAttribute> getAttributes()

Removes the contextRef attribute from the FactItem

Parent iterators already removes the id attribute if any.

Overrides:

getAttributes in class XMLFragment

Returns:

the attributes

See Also:

XMLFragment.getAttributes()

isHashDependsOnAtribute

public boolean isHashDependsOnAtribute(javax.xml.namespace.QName attributeName)

Checks if is hash depends on atribute.

Overrides:

isHashDependsOnAtribute in class XMLFragment

Parameters:

attributeName - the attribute name

Returns:

true, if is hash depends on atribute

getElementDefinition

public XBRLItem getElementDefinition()

Access to the surrounding item declaration for this item.

Overrides:

getElementDefinition in class XBRLFact

Returns:

XBRLItem or null if no item is found (very rare case)

cEqual

public boolean cEqual(XBRLFactItem factTotal)

Evaluates if the two instantiation of the items are c-equal.

Parameters:

factTotal - XBRLFactItem other fact

Returns:

boolean

vEqual

public abstract boolean vEqual(XBRLFactItem toFact)

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

Parameters:

toFact - the other XBRLFactItem

Returns:

boolean

uEqual

public abstract boolean uEqual(XBRLFactItem toFact)

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

Parameters:

toFact - the other XBRLFactItem

Returns:

boolean

isDescendantOrSibling

public boolean isDescendantOrSibling(XBRLFactItem otherFact)

Returns true if otherFact is a descendant or sibling of this fact.

Parameters:

otherFact - XBRLFactItem

Returns:

boolean

generateNode

public XBRLFactItem generateNode()
                          throws XBRLSerializationException

Generates the XBRLFactItem node. If neccesary, generates the footnotes defined for this node.

Overrides:

generateNode in class XBRLFact

Returns:

the element

Throws:

XBRLSerializationException - the XBRL serialization exception

hashCode

public int hashCode()

Hash code.

Specified by:

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

Overrides:

hashCode in class XBRLFact

Returns:

the int

s_equal2

public boolean s_equal2(java.lang.Object other)

S equal 2.

Overrides:

s_equal2 in class XMLFragment

Parameters:

other - the other

Returns:

true, if successful

equals

public boolean equals(java.lang.Object obj)

Equals.

Specified by:

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

Overrides:

equals in class XBRLFact

Parameters:

obj - the obj

Returns:

true, if successful

isDuplicate

public abstract boolean isDuplicate(XBRLFactItem tTarget,
                                    boolean reversePEqual)

For internal purposes only during the calculation of isDuplicate of tuple children elements.

Parameters:

tTarget - the t target

reversePEqual - the reverse p equal

Returns:

boolean value

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