com.ihr.xbrl.om.instance

Class XBRLUnit

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.XBRLUnit

All Implemented Interfaces:

HasDTSContainer, 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 XBRLUnit
extends XMLFragment
implements XBRLValidation

The Class XBRLUnit.

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	divideQNameNode The Constant xbrli:divide.
static javax.xml.namespace.QName	PURE The Constant xbrli:pure.
static javax.xml.namespace.QName	SHARES The Constant xbrli:shares.
static net.sf.saxon.om.StructuredQName	sqnUnitQNameNode The Constant sqnUnitQNameNode.
static javax.xml.namespace.QName	unitDenominatorQNameNode The Constant xbrli:unitDenominator.
static javax.xml.namespace.QName	unitNumeratorQNameNode The Constant xbrli:unitNumerator.
static javax.xml.namespace.QName	unitQNameNode The Constant xbrli:unit.

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
XBRLUnit(DTSContainer dts, java.util.Collection<javax.xml.namespace.QName> numerator, java.util.Collection<javax.xml.namespace.QName> denominator) Creates an unit that can be used for XBRLFactNumeric objects.
XBRLUnit(DTSContainer dts, javax.xml.namespace.QName numerator) Helper method to create a simple unit for just one numerator.
XBRLUnit(DTSContainer dts, java.lang.String iso4217unit) Helper method to create a simple unit in the iso4217.
XBRLUnit(DTSContainer dts, java.lang.String iso4217unit, java.lang.Void v) Helper method to create a simple unit in the iso4217 divided by xbrli:shares.
XBRLUnit(DTSContainer dts, XMLFragment root) Instantiates a new XBRL unit.
XBRLUnit(XBRLInstance parent, XMLFragment node) Instantiates a new XBRL unit and adds it to the xbrl report passed in in the parent parameter.
XBRLUnit(XMLFragment node) Instantiates a new XBRL unit.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XBRLUnit	clone() Clone.
XBRLUnit	clone(DTSContainer newDTS) Clone.
boolean	equals(java.lang.Object other) Evaluates u-equality of two units.
XBRLUnit	generateNode() Generate node.
java.util.Collection<javax.xml.namespace.QName>	getDenominator() Reads the nodes of this unit and prepares a new Collection of QNames containing just the units in the denominator unit part.
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.lang.String	getFriendlyNameOnlyId() Gets the friendly name only id.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
java.util.Collection<javax.xml.namespace.QName>	getNumerator() Reads the nodes of this unit and prepares a new Collection of QNames containing just the units in the numerator unit part.
XBRLInstance	getParentDocument() Gets the parent document.
XBRLValidationReport	getValidationReport() Gets the validation report.
boolean	hasChildNodes()
int	hashCode() Hash code.
void	invalidate() Invalidate.
boolean	invalidate(XBRLValidation.Direction dir) Invalidate.
boolean	isMoneraty() Returns true if the unit is just a monetary value.
boolean	isOnValidation() Checks if is on validation.
boolean	isPure() Check if this unit is a single measure and is XBRLI.PURE
static XBRLUnit	make(DTSContainer dts) Make.
boolean	s_equal2(java.lang.Object other) S equal 2.
XBRLValidationReport	validate(XBRLPlugInProcessor proc) Validate.
void	validateISO4217() Validate is o4217.
void	validateShares() Validate shares.

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, delete, 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, getElements, 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, getParentXBRL, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, 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, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setId, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setRawParentXBRL, setValue, setValue, setValue, setValue, setValue, setValue, setValue, 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

unitQNameNode

public static final javax.xml.namespace.QName unitQNameNode

The Constant xbrli:unit.

sqnUnitQNameNode

public static final net.sf.saxon.om.StructuredQName sqnUnitQNameNode

The Constant sqnUnitQNameNode.

divideQNameNode

public static final javax.xml.namespace.QName divideQNameNode

The Constant xbrli:divide.

unitNumeratorQNameNode

public static final javax.xml.namespace.QName unitNumeratorQNameNode

The Constant xbrli:unitNumerator.

unitDenominatorQNameNode

public static final javax.xml.namespace.QName unitDenominatorQNameNode

The Constant xbrli:unitDenominator.

PURE

public static final javax.xml.namespace.QName PURE

The Constant xbrli:pure.

SHARES

public static final javax.xml.namespace.QName SHARES

The Constant xbrli:shares.

Constructor Detail

XBRLUnit

public XBRLUnit(DTSContainer dts,
                XMLFragment root)

Instantiates a new XBRL unit.

Parameters:

dts - the dts

root - the root

XBRLUnit

public XBRLUnit(DTSContainer dts,
                java.util.Collection<javax.xml.namespace.QName> numerator,
                java.util.Collection<javax.xml.namespace.QName> denominator)

Creates an unit that can be used for XBRLFactNumeric objects.

The unit is automatically simplified to the normal form.

Parameters:

dts - DTSContainer, the DTS of this unit

numerator - Collection<QName> elements in the numerator, cannot be null

denominator - Collection<QName> elements in the denominator, can be null

XBRLUnit

public XBRLUnit(XMLFragment node)

Instantiates a new XBRL unit.

Parameters:

node - the node

XBRLUnit

public XBRLUnit(XBRLInstance parent,
                XMLFragment node)
         throws XBRLInconsistentDTSException

Instantiates a new XBRL unit and adds it to the xbrl report passed in in the parent parameter.

Parameters:

parent - the parent

node - the node

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent dts exception

XBRLUnit

public XBRLUnit(DTSContainer dts,
                java.lang.String iso4217unit)

Helper method to create a simple unit in the iso4217.

Parameters:

dts - the dts

iso4217unit - the three letters of the iso4217 unit such as USD, EUR, etc

XBRLUnit

public XBRLUnit(DTSContainer dts,
                javax.xml.namespace.QName numerator)

Helper method to create a simple unit for just one numerator.

Parameters:

dts - the dts

numerator - a QName such as XBRLUnit.PURE etc.

XBRLUnit

public XBRLUnit(DTSContainer dts,
                java.lang.String iso4217unit,
                java.lang.Void v)

Helper method to create a simple unit in the iso4217 divided by xbrli:shares.

Parameters:

dts - the dts

iso4217unit - the three letters of the iso4217 unit such as USD, EUR, etc

v - this is used to distinguish between other constructors. Use null here

Method Detail

make

public static XBRLUnit make(DTSContainer dts)

Make.

Parameters:

dts - the dts

Returns:

the XBRL unit

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XMLFragment

Throws:

java.lang.Throwable - the throwable

getParentDocument

public XBRLInstance getParentDocument()

Gets the parent document.

Overrides:

getParentDocument in class XMLFragment

Returns:

the parent document

clone

public XBRLUnit clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL unit

clone

public XBRLUnit clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

newDTS - the new DTS

Returns:

the XBRL unit

validateISO4217

public void validateISO4217()
                     throws XBRLValidationException

Validate is o4217.

Throws:

XBRLValidationException - the XBRL validation exception

validateShares

public void validateShares()
                    throws XBRLValidationException

Validate shares.

Throws:

XBRLValidationException - the XBRL validation exception

hashCode

public int hashCode()

Hash code.

Specified by:

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

Overrides:

hashCode in class XMLFragment

Returns:

the int

equals

public boolean equals(java.lang.Object other)

Evaluates u-equality of two units.

Specified by:

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

Overrides:

equals in class XMLFragment

Parameters:

other - the other

Returns:

true, if successful

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

generateNode

public XBRLUnit generateNode()
                      throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XMLFragment

Returns:

the XBRL unit

Throws:

XBRLSerializationException - the XBRL serialization exception

getNumerator

public java.util.Collection<javax.xml.namespace.QName> getNumerator()

Reads the nodes of this unit and prepares a new Collection of QNames containing just the units in the numerator unit part. If the unit has no xbrli:divide child node this method returns the list of QNames in the xbrli:measure children. The return value is created on each call to this method

Returns:

Collection of QNames in the numerator side of the unit

getDenominator

public java.util.Collection<javax.xml.namespace.QName> getDenominator()

Reads the nodes of this unit and prepares a new Collection of QNames containing just the units in the denominator unit part. If the user has no xbrli:divide child node this method returns an empty list of QNames. The return value is created on each call to this method

Returns:

Collection of QNames in the denominator side of the unit

isMoneraty

public boolean isMoneraty()

Returns true if the unit is just a monetary value.

Returns:

boolean

getFriendlyName

public java.lang.String getFriendlyName()

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Returns:

the friendly name

getFriendlyNameOnlyId

public java.lang.String getFriendlyNameOnlyId()

Gets the friendly name only id.

Returns:

the friendly name only id

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:

the friendly name

getValidationReport

public XBRLValidationReport getValidationReport()

Gets the validation report.

Specified by:

getValidationReport in interface XBRLValidation

Returns:

the validation report

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

isOnValidation

public boolean isOnValidation()

Checks if is on validation.

Specified by:

isOnValidation in interface XBRLValidation

Returns:

true, if is on validation

isPure

public boolean isPure()

Check if this unit is a single measure and is XBRLI.PURE

Returns:

true, if is pure

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