com.ihr.xbrl.om.instance

Class XBRLFactNumeric

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

com.ihr.xbrl.om.instance.XBRLFactNumeric

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

public class XBRLFactNumeric
extends XBRLFactItem

The Class XBRLFactNumeric.

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	decimals The Constant decimals.
static javax.xml.namespace.QName	denominator The Constant denominator.
static javax.xml.namespace.QName	numerator The Constant numerator.
static javax.xml.namespace.QName	precision The Constant precision.
static javax.xml.namespace.QName	unitRef The Constant unitRef.

Fields inherited from class com.ihr.xbrl.om.instance.XBRLFactItem

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

Constructor Summary

Constructors

Constructor and Description
XBRLFactNumeric(DTSContainer dts) This is the constructor used while parsing the incoming XBRL instance through the SAX parser.
XBRLFactNumeric(XBRLFactsList container, XBRLContext context, XBRLItem item, XBRLUnit unit, boolean addToParentNow) Deprecated.
XBRLFactNumeric(XBRLFactsList container, XBRLContext context, XBRLItem item, XBRLUnit unit, java.lang.Number value, int precisionOrDecimals, XBRLNumber.ExactitudeMode format, java.lang.String strValue, boolean addToParentNow) Creates a numeric fact for a numeric item providing all required information.
XBRLFactNumeric(XBRLFactsList container, XBRLContext context, XBRLItem item, XBRLUnit unit, java.lang.Number numerator, java.lang.Number denominator, boolean addToParentNow) Creates a numeric fact for a fraction item providing all required information.
XBRLFactNumeric(XBRLFactsList container, XBRLContext context, XBRLItem item, XBRLUnit unit, XBRLNumber value, boolean addToParentNow) Deprecated.
XBRLFactNumeric(XBRLFactsList container, XMLFragment node, XBRLItem item) Instantiates a new XBRL fact numeric.

Method Summary

Modifier and Type	Method and Description
boolean	checkPrecision0() Check precision 0.
void	clear() Eliminates all this fact content.
XBRLFactNumeric	clone() Clone.
XBRLFactNumeric	clone(DTSContainer newDTS) Clone.
boolean	equals(java.lang.Object obj) Equals.
XBRLFactNumeric	generateNode() Generate node.
java.util.Iterator<XBRLAttribute>	getAttributes() Removes the unitRef,decimals and precision attributes from the XBRLFactNumeric Parent iterators already removes the id attribute and the contextRef attributes.
java.math.BigDecimal	getBigDecimal() Access to the value as a BigDecimal, this method only works if the XBRLFactNumeric is Number and not is Fraction.
java.lang.String	getDecimals() Gets the decimals.
int	getDecimalsRealOrInferred() Gets the decimals real or inferred.
java.lang.Number	getDenominator() Gets the denominator.
static int	getExponent(java.lang.String strValue) Gets the exponent.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
XBRLNumber.ExactitudeMode	getFormat() Returns the representation format of this element XBRLNumber.DECIMALS or XBRLNumber.PRECISION
double	getFractionValue() Gets the fraction value.
java.lang.String	getFriendlyName() Gets the friendly name.
java.lang.String	getFriendlyName(int modifiers, LabelsProvider lp) Gets the friendly name.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
double	getNonFractionValue(boolean bRoundNumeric) Gets the double value from a non fraction fact to export.
int	getNumberOfChildren()
java.lang.Number	getNumerator() Gets the numerator.
XBRLNumber	getNumericValue() Return the double representation of the value after dealing with @precision and @decimals This class returns either a XBRLNumericValue or an XBRLFractionValue depending on the surrounding value is a fraction or a number.
static net.sf.saxon.value.NumericValue	getNumericValue(XBRLXSDTypeDefinition type, java.lang.Object value) Returns a NumericValue representation of the value according to the type definition in the parameter.
java.lang.String	getNumericValueAsString() Return the String representation of the value.
java.lang.String	getPrecision() Gets the precision.
int	getPrecisionRealOrInferred() Gets the precision real or inferred.
XBRLUnit	getUnit() Obtains the unit of this fact.
net.sf.saxon.s9api.XdmValue	getValue() Gets the value.
boolean	hasChildNodes()
int	hashCode() Hash code.
static int	inferredDecimals(int precision, java.lang.String strValue) Inferred decimals.
static int	inferredDecimalsBug368(int precision, java.lang.String rawStrValue) Inferred decimals bug368.
static int	inferredPrecision(java.lang.String decimalsStr, java.lang.String strValue) Inferred precision.
boolean	isDecimals() Checks if is decimals.
boolean	isDuplicate(XBRLFact otherFact) Checks if is duplicate.
boolean	isDuplicate(XBRLFactItem otherFact, boolean reversePEqual) Checks if is duplicate.
boolean	isFraction() Checks if is fraction.
boolean	isHashDependsOnAtribute(javax.xml.namespace.QName attributeName) Checks if is hash depends on atribute.
boolean	isNumber() Checks if is a number (and not a fraction).
boolean	isPercent() Checks if a number is derived from xbrliPercentItemType.
boolean	isPrecision() Checks if is precision.
boolean	isPure() check when this numeric fact is based on pureItemType or derived from it .
static XBRLFactNumeric	make(XBRLFactsList container, XBRLContext context, XBRLItem item, XBRLUnit unit, boolean addToParent) Make.
static XBRLFactNumeric	make(XBRLFactsList container, XBRLContext context, XBRLItem item, XBRLUnit unit, java.lang.Number value, int precisionOrDecimals, XBRLNumber.ExactitudeMode format, java.lang.String strValue, boolean addToParentNow) Make.
static XBRLFactNumeric	make(XBRLFactsList container, XBRLContext context, XBRLItem item, XBRLUnit unit, java.lang.Number numerator, java.lang.Number denominator, boolean addToParentNow) Make.
static java.lang.String	numericValueToString(java.lang.Number value) Calculates a string representation of an object value.
static java.lang.String	parseExactitudeValue(int fromIntvalue) Transforms an INT value to string so the INF token is properly converted to "INF" and other values as integers.
static int	parseExactitudeValue(java.lang.String fromString) Transforms an string representation of the exactitude value to the int format.
void	setDecimals(java.lang.String sDecimals) At moment, used only on XBRLNumericValue.
boolean	setFormat(XBRLNumber.ExactitudeMode format) Sets the representation of this number to DECIMALS or PRECISION.
boolean	setNil(boolean newValue) Sets the nil.
void	setPrecision(java.lang.String sPrecision) At moment, used only on XBRLNumericValue.
void	setUnit(XBRLUnit newUnit) Sets a new unit for this fact.
void	setValue(net.sf.saxon.value.AtomicValue value) Sets the value.
XBRLNumber	setValue(java.lang.Number value, int precisionOrDecimals, XBRLNumber.ExactitudeMode format, java.lang.String strValue) Sets the value of this numeric fact to a new value.
XBRLNumber	setValue(java.lang.Number numerator, java.lang.Number denominator) Sets the value of this numeric fact to a new fraction value.
java.lang.Number	setValue(java.lang.Number value, java.lang.String strValue) Sets the value of this numeric fact to a new value.
void	setValue(java.lang.String value) Sets the value.
XBRLNumber	setValue(XBRLNumber value) Sets the value of this numeric fact to a new value.
void	setValue(net.sf.saxon.s9api.XdmValue value) Sets the value.
boolean	uEqual(XBRLFactItem factTotal) Evaluates it the two instantiation of the items are u-equal.
boolean	vEqual(XBRLFactItem toFact) V equal.

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

cEqual, createFractionItemInstance, createItemInstance, createItemInstance, createNonNumericItemInstance, createNumericItemInstance, getContext, getDocumentURI, getElementDefinition, getStringValue, isDescendantOrSibling, s_equal2, setContext

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

addEvent, createFractionItemInstance, createItemOrTupleInstance, createNonNumericItemInstance, createNumericItemInstance, createTupleInstance, delete, getCode, getElements, getHistory, getHistoryAsHTMLString, getHistoryAsString, getInstance, getParentXBRL, getParentXBRLFactsList, getTaxonomy, getValidationReport, getXPathToRoot, invalidate, invalidate, isBlank, isOnValidation, pEqual, setBlank, setCode, setId, setInstance, setParent, 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

unitRef

public static final javax.xml.namespace.QName unitRef

The Constant unitRef.

decimals

public static final javax.xml.namespace.QName decimals

The Constant decimals.

precision

public static final javax.xml.namespace.QName precision

The Constant precision.

numerator

public static final javax.xml.namespace.QName numerator

The Constant numerator.

denominator

public static final javax.xml.namespace.QName denominator

The Constant denominator.

Constructor Detail

XBRLFactNumeric

@Deprecated
public XBRLFactNumeric(XBRLFactsList container,
                                   XBRLContext context,
                                   XBRLItem item,
                                   XBRLUnit unit,
                                   XBRLNumber value,
                                   boolean addToParentNow)

Deprecated.

Creates a numeric fact item providing all required information. if the container parameter is not null, the fact will be added to it, note the container can be either an XBRL report, an XBRLInstanceRootNode which is the root node of an XBRL report or a tuple

Parameters:

container - the container

context - the context

item - the item

unit - the unit

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

XBRLFactNumeric

public XBRLFactNumeric(XBRLFactsList container,
                       XBRLContext context,
                       XBRLItem item,
                       XBRLUnit unit,
                       java.lang.Number numerator,
                       java.lang.Number denominator,
                       boolean addToParentNow)

Creates a numeric fact for a fraction item providing all required information.

Parameters:

container - the parent container for the new fact, can be null

context - the context

item - the item

unit - the unit

numerator - part

denominator - part

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

XBRLFactNumeric

public XBRLFactNumeric(XBRLFactsList container,
                       XBRLContext context,
                       XBRLItem item,
                       XBRLUnit unit,
                       java.lang.Number value,
                       int precisionOrDecimals,
                       XBRLNumber.ExactitudeMode format,
                       java.lang.String strValue,
                       boolean addToParentNow)

Creates a numeric fact for a numeric item providing all required information.

Parameters:

container - the parent container for the new fact, can be null

context - the context

item - the item

unit - the unit

value - the value

precisionOrDecimals - the precision or decimals

format - the format

strValue - maybe null

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

XBRLFactNumeric

@Deprecated
public XBRLFactNumeric(XBRLFactsList container,
                                   XBRLContext context,
                                   XBRLItem item,
                                   XBRLUnit unit,
                                   boolean addToParentNow)

Deprecated.

Creates a numeric fact item providing all required information.

Parameters:

container - the container

context - the context

item - the item

unit - the unit

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

XBRLFactNumeric

public XBRLFactNumeric(XBRLFactsList container,
                       XMLFragment node,
                       XBRLItem item)
                throws XBRLValidationException

Instantiates a new XBRL fact numeric.

Parameters:

container - the facts container this fact will be added to. It might be an instance or a tuple or might be null

node - the XMLFragment this node will replace in the container instance

item - the XBRL numeric fact item

Throws:

XBRLValidationException - if the item is not numeric

XBRLFactNumeric

public XBRLFactNumeric(DTSContainer dts)

This is the constructor used while parsing the incoming XBRL instance through the SAX parser.

Parameters:

dts - the dts

Method Detail

make

public static XBRLFactNumeric make(XBRLFactsList container,
                                   XBRLContext context,
                                   XBRLItem item,
                                   XBRLUnit unit,
                                   boolean addToParent)

Make. Make sure this is the right method or use #make(XBRLFactsList, XBRLContext, XBRLItem, XBRLUnit, Number, int, ExactitudeMode, String)

Parameters:

container - the container

context - the context

item - the item

unit - the unit

addToParent - the add to parent

Returns:

the XBRL fact numeric

make

public static XBRLFactNumeric make(XBRLFactsList container,
                                   XBRLContext context,
                                   XBRLItem item,
                                   XBRLUnit unit,
                                   java.lang.Number value,
                                   int precisionOrDecimals,
                                   XBRLNumber.ExactitudeMode format,
                                   java.lang.String strValue,
                                   boolean addToParentNow)

Make.

Parameters:

container - the container

context - the context

item - the item

unit - the unit

value - the value

precisionOrDecimals - the precision or decimals

format - the format

strValue - the str value

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

Returns:

the XBRL fact numeric

make

public static XBRLFactNumeric make(XBRLFactsList container,
                                   XBRLContext context,
                                   XBRLItem item,
                                   XBRLUnit unit,
                                   java.lang.Number numerator,
                                   java.lang.Number denominator,
                                   boolean addToParentNow)

Make.

Parameters:

container - the container

context - the context

item - the item

unit - the unit

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:

the XBRL fact numeric

clone

public XBRLFactNumeric clone()

Clone.

Overrides:

clone in class XBRLFactItem

Returns:

the XBRL fact numeric

clone

public XBRLFactNumeric clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XBRLFactItem

Parameters:

newDTS - the new DTS

Returns:

the XBRL fact numeric

clear

public void clear()
           throws java.lang.Throwable

Eliminates all this fact content.

Overrides:

clear in class XBRLFact

Throws:

java.lang.Throwable - the throwable

setUnit

public void setUnit(XBRLUnit newUnit)

Sets a new unit for this fact.

Parameters:

newUnit - the new unit

getUnit

public XBRLUnit getUnit()

Obtains the unit of this fact. Returns null if this fact has no value in the unitRef attribute or if the unit ID referenced in the unitRef attribute is not in the XBRLInstance this fact belongs to (or if the fact does not belongs to any instance)

Returns:

XBRLUnit

Throws:

XBRLRuntimeException - in case of XBRLValidationException produced during the getUnitById call on the instance

getAttributes

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

Removes the unitRef,decimals and precision attributes from the XBRLFactNumeric

Parent iterators already removes the id attribute and the contextRef attributes.

Overrides:

getAttributes in class XBRLFactItem

Returns:

the attributes

Since:

2.6.4

See Also:

XMLFragment.getAttributes()

isHashDependsOnAtribute

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

Checks if is hash depends on atribute.

Overrides:

isHashDependsOnAtribute in class XBRLFactItem

Parameters:

attributeName - the attribute name

Returns:

true, if is hash depends on atribute

setValue

public XBRLNumber setValue(XBRLNumber value)

Sets the value of this numeric fact to a new value. If current XBRLFactNumeric is nil a call to this method will reset to not nil except if newVal is null

Parameters:

value - the new val

Returns:

XBRLNumber the old value or null

setValue

public XBRLNumber setValue(java.lang.Number value,
                           int precisionOrDecimals,
                           XBRLNumber.ExactitudeMode format,
                           java.lang.String strValue)

Sets the value of this numeric fact to a new value.

Parameters:

value - the new Number value, can be null

precisionOrDecimals - the precision or decimals

format - the ExactitudeMode format

strValue - the string value, maybe null

Returns:

XBRLNumber the old value or null

setValue

public java.lang.Number setValue(java.lang.Number value,
                                 java.lang.String strValue)

Sets the value of this numeric fact to a new value.

Parameters:

value - the new Number value

strValue - the string value, maybe null

Returns:

Number the old value or null

setValue

public XBRLNumber setValue(java.lang.Number numerator,
                           java.lang.Number denominator)

Sets the value of this numeric fact to a new fraction value.

Parameters:

numerator - part

denominator - part

Returns:

XBRLNumer the old value or null

setNil

public boolean setNil(boolean newValue)

Sets the nil.

Overrides:

setNil in class XBRLFact

Parameters:

newValue - the new value

Returns:

true, if successful

setValue

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

Sets the value.

Overrides:

setValue in class XBRLFact

Parameters:

value - the new value

setValue

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

Sets the value.

Overrides:

setValue in class XBRLFact

Parameters:

value - the new value

setValue

public void setValue(java.lang.String value)

Sets the value.

Overrides:

setValue in class XBRLFact

Parameters:

value - the new value

getValue

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

Gets the value.

Overrides:

getValue in class XBRLFact

Returns:

the value

getNonFractionValue

public double getNonFractionValue(boolean bRoundNumeric)

Gets the double value from a non fraction fact to export.

Parameters:

bRoundNumeric - true to round the numerical values according to their accuracy

Returns:

the original or rounded value

getNumericValue

public XBRLNumber getNumericValue()

Return the double representation of the value after dealing with @precision and @decimals

This class returns either a XBRLNumericValue or an XBRLFractionValue depending on the surrounding value is a fraction or a number.

Returns:

XBRLNumericValue or XBRLFractionValue

getNumericValueAsString

public java.lang.String getNumericValueAsString()

Return the String representation of the value. Not valid for fraction values at moment.

Returns:

String value

uEqual

public boolean uEqual(XBRLFactItem factTotal)

Evaluates it the two instantiation of the items are u-equal.

Specified by:

uEqual in class XBRLFactItem

Parameters:

factTotal - the fact total

Returns:

boolean

vEqual

public boolean vEqual(XBRLFactItem toFact)

V equal.

Specified by:

vEqual in class XBRLFactItem

Parameters:

toFact - the to fact

Returns:

true, if successful

isDuplicate

public boolean isDuplicate(XBRLFact otherFact)

Checks if is duplicate.

Specified by:

isDuplicate in class XBRLFact

Parameters:

otherFact - the other fact

Returns:

true, if is duplicate

isDuplicate

public boolean isDuplicate(XBRLFactItem otherFact,
                           boolean reversePEqual)

Checks if is duplicate.

Specified by:

isDuplicate in class XBRLFactItem

Parameters:

otherFact - the other fact

reversePEqual - the reverse P equal

Returns:

true, if is duplicate

generateNode

public XBRLFactNumeric generateNode()
                             throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XBRLFactItem

Returns:

the XBRL fact numeric

Throws:

XBRLSerializationException - the XBRL serialization exception

isFraction

public boolean isFraction()

Checks if is fraction.

Returns:

true, if is fraction

isNumber

public boolean isNumber()

Checks if is a number (and not a fraction).

Returns:

true, if is a number

isPercent

public boolean isPercent()

Checks if a number is derived from xbrliPercentItemType.

Returns:

true if the value type is derived from xbrliPercentItemType

getBigDecimal

public java.math.BigDecimal getBigDecimal()

Access to the value as a BigDecimal, this method only works if the XBRLFactNumeric is Number and not is Fraction.

Returns:

BigDecimal value

See Also:

isFraction(), isNumber()

getFractionValue

public double getFractionValue()

Gets the fraction value.

Returns:

the fraction value

getFormat

public XBRLNumber.ExactitudeMode getFormat()

Returns the representation format of this element XBRLNumber.DECIMALS or XBRLNumber.PRECISION

Returns:

int

setFormat

public boolean setFormat(XBRLNumber.ExactitudeMode format)

Sets the representation of this number to DECIMALS or PRECISION. Also changes the exactitude attribute value to match the previous value in the new format.

Parameters:

format - the new format

Returns:

true if there was a change in the format (the fact had decimals and the format parameter was precision or vice versa) false if no changes were made

getFriendlyName

public java.lang.String getFriendlyName()

Gets the friendly name.

Overrides:

getFriendlyName in class XBRLFact

Returns:

the friendly name

getFriendlyName

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

Gets the friendly name.

Overrides:

getFriendlyName in class XBRLFact

Parameters:

modifiers - the modifiers

lp - the lp

Returns:

the friendly name

hashCode

public int hashCode()

Hash code.

Specified by:

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

Overrides:

hashCode in class XBRLFactItem

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Specified by:

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

Overrides:

equals in class XBRLFactItem

Parameters:

obj - the obj

Returns:

true, if successful

setPrecision

public void setPrecision(java.lang.String sPrecision)

At moment, used only on XBRLNumericValue.

Parameters:

sPrecision - the new precision

setDecimals

public void setDecimals(java.lang.String sDecimals)

At moment, used only on XBRLNumericValue.

Parameters:

sDecimals - the new decimals

getDecimals

public java.lang.String getDecimals()

Gets the decimals.

Returns:

the string value of the decimals attribute. If the numeric fact is reported on precision, this method returns null

See Also:

isDecimals(), parseExactitudeValue(String), XBRLNumber.getDecimalsRealOrInferred()

getPrecision

public java.lang.String getPrecision()

Gets the precision.

Returns:

the string value of the precision attribute. If the numeric fact is reported on decimals, this method returns null

See Also:

isPrecision(), parseExactitudeValue(String), XBRLNumber.getPrecisionRealOrInferred()

isDecimals

public boolean isDecimals()

Checks if is decimals.

Returns:

true if this numeric fact contains the decimals attribute

isPrecision

public boolean isPrecision()

Checks if is precision.

Returns:

true if this numeric fact contains the precision attribute

getNumericValue

public static net.sf.saxon.value.NumericValue getNumericValue(XBRLXSDTypeDefinition type,
                                                              java.lang.Object value)

Returns a NumericValue representation of the value according to the type definition in the parameter.

Parameters:

type - XBRLXSDTypeDefinition

value - the value

Returns:

a NumericValue

inferredDecimalsBug368

public static int inferredDecimalsBug368(int precision,
                                         java.lang.String rawStrValue)

Inferred decimals bug368.

Parameters:

precision - the precision

rawStrValue - the raw str value

Returns:

the int

inferredPrecision

public static int inferredPrecision(java.lang.String decimalsStr,
                                    java.lang.String strValue)

Inferred precision.

Parameters:

decimalsStr - the decimals str

strValue - the str value

Returns:

integer

parseExactitudeValue

public static int parseExactitudeValue(java.lang.String fromString)

Transforms an string representation of the exactitude value to the int format. "INF" is converted to the magin value INF

Parameters:

fromString - the from string

Returns:

the int

parseExactitudeValue

public static java.lang.String parseExactitudeValue(int fromIntvalue)

Transforms an INT value to string so the INF token is properly converted to "INF" and other values as integers.

Parameters:

fromIntvalue - the from intvalue

Returns:

the string

getNumerator

public java.lang.Number getNumerator()

Gets the numerator.

Returns:

the numerator

getDenominator

public java.lang.Number getDenominator()

Gets the denominator.

Returns:

the denominator

checkPrecision0

public boolean checkPrecision0()

Check precision 0.

Returns:

true if the fact value is reported for precision and the exactitude value for precision is 0

getPrecisionRealOrInferred

public int getPrecisionRealOrInferred()

Gets the precision real or inferred.

Returns:

an integer representing the real or inferred precision for this XBRLFactNumeric

getDecimalsRealOrInferred

public int getDecimalsRealOrInferred()

Gets the decimals real or inferred.

Returns:

an integer representing the real or inferred decimals for this XBRLFactNumeric

numericValueToString

public static java.lang.String numericValueToString(java.lang.Number value)

Calculates a string representation of an object value. The pattern for formatting the number is DecimalFormat("################################.00000000000000000000000000000000",new DecimalFormatSymbols(Locale.US)) NaN is an accepted input value; in this case, the returned string is NaN.

Parameters:

value - a Number

Returns:

a string

Since:

2.6.10

inferredDecimals

public static int inferredDecimals(int precision,
                                   java.lang.String strValue)

Inferred decimals.

Parameters:

precision - the precision

strValue - the str value

Returns:

integer

getExponent

public static int getExponent(java.lang.String strValue)

Gets the exponent.

Parameters:

strValue - capitalized so the exponent will be the number after E

Returns:

int

isPure

public boolean isPure()

check when this numeric fact is based on pureItemType or derived from it .

Returns:

true when this numeric fact is pureItemType or derived from it

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