com.ihr.xbrl.om.taxonomy

Class XBRLItem

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.taxonomy.XMLElementDefinition

com.ihr.xbrl.om.taxonomy.XBRLElementDefinition

com.ihr.xbrl.om.taxonomy.XBRLItem

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, XBRLValidation, XBRLValueKey, 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 XBRLItem
extends XBRLElementDefinition
implements java.io.Serializable, XBRLValidation

The Class XBRLItem.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XBRLItem.BalanceType Enumeration defining the possible content of the xbrli:balance attribute.
static class	XBRLItem.PeriodType Enumeration defining the content of the xbrli:periodType attribute but also used to report the type of a XBRLPeriod object inside an XBRLContext.

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	balance The value of the balance attribute if it is present.
static javax.xml.namespace.QName	default_ The [default] property.
static javax.xml.namespace.QName	periodTypeAttribute The [Period Type] property.
static javax.xml.namespace.QName	substitutionGroup This is xbrli:item.

Fields inherited from class com.ihr.xbrl.om.taxonomy.XMLElementDefinition

abstract_, ALL, block, elementDocNode, EMPTY, EXTENSION, final_, fixed, name, nillable, nullConcept, RESTRICTION, SUBSTITUTION, type, UNDEFINED

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
XBRLItem(DTSContainer dts) Creates an item using the properties of the concept received as a parameter Adds the new concept to the parent taxonomy schema.
XBRLItem(XBRLTaxonomy parent, java.lang.String name, java.lang.String _default, XBRLXSDTypeDefinition type, javax.xml.namespace.QName substitutionGroup, XBRLItem.PeriodType periodType, XBRLItem.BalanceType balance, java.lang.Boolean _abstract, java.lang.Boolean nillable, int block, int _final, java.lang.String fixed) Creates and XBRL Item definition.
XBRLItem(XMLElementDefinition node) Creates an item using the properties of the concept received as a parameter.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
boolean	equals(java.lang.Object other) Equals.
XBRLItem	generateNode() Generate node.
XBRLItem.BalanceType	getBalance() Access to the [Balance] property of the concept definition.
java.lang.String	getDefault() Access to the [Default] property.
java.util.Iterator<XMLFragment>	getElements() Gets the elements.
java.util.Iterator<DecoratedQName>	getExtensibleEnumerationValues() If this element is extensible enumerable type, this method returns an iterator of DecoratedQName instances with all available values.
java.util.regex.Pattern	getFilterExpression(XBRLFactItem referenceItem) RS API contains a Linked lists processor that allows to filter values in a list using a fact reported value, an item definition whose type is list (restriction based enumeration facet) and a regular expression token that might contain #{SOURCE} and will be replaced by the fact string value.
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<XBRLItem>	getInSubstitutionGroup() Gets the in substitution group.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLItem.PeriodType	getPeriodType() returns PeriodType.DURATION or PeriodType.INSTANT
XBRLValidationReport	getValidationReport() Gets the validation report.
boolean	hasChildNodes()
int	hashCode() Hash code.
void	invalidate() Invalidate.
boolean	invalidate(XBRLValidation.Direction dir) Invalidate.
boolean	isEnumerable() Returns true if this item is enumerable according with the extensible enumerations specification.
boolean	isFraction() Returns true or false depending on this XBRLItem is an XBRL fractionItemType or not This method has been added in order to facilitate the development of the formula specification.
boolean	isInSubstitutionGroup(javax.xml.namespace.QName name) Checks if is in substitution group.
boolean	isMonetaryType() Check if this concept definition is a monetaryItemType or derived from monetaryItemType in the type hierarchy and return true if this is the case.
boolean	isNumeric() Returns true if the type is derived from one of the list fractionItemType decimalItemType floatItemType doubleItemType monetaryItemType sharesItemType pureItemType integerItemType nonPositiveIntegerItemType negativeIntegerItemType longItemType intItemType shortItemType byteItemType nonNegativeIntegerItemType unsignedLongItemType unsignedIntItemType unsignedShortItemType unsignedByteItemType positiveIntegerItemType).
boolean	isOnValidation() Checks if is on validation.
boolean	isPercentageType() Checks if is percentage type.
boolean	isPureType() Check if this concept definition is a pureItemType or derived from pureItemType in the type hierarchy and return true if this is the case.
boolean	isSharesType() Check if this concept definition is a sharesItemType or derived from sharesItemType in the type hierarchy and return true if this is the case.
boolean	isXBRLType() Checks if is XBRL type.
static java.lang.Boolean	isXSDTypeNumeric(net.sf.saxon.type.SchemaType typeD, DTSContainer dts) Checks if is XSD type numeric.
XBRLItem.BalanceType	setBalance(XBRLItem.BalanceType newValue) Sets the value of the [Balance] property or reset it if newValue is null.
java.lang.String	setDefault(java.lang.String newValue) Sets the default.
void	setIsFraction(boolean newValue) Normally the information about isFraction is obtained from the element data type but when the element data type cannot be obtained this method can help in setting up a suitable value so applications can work as if the data type were obtained from the surrounding node.
void	setIsMonetaryType(boolean newValue) Sets the flag that indicates this item is of the monetary type.
void	setIsNumeric(boolean newValue) Normally the information about isNumeric is obtained from the element data type but when the element data type cannot be obtained this method can help in setting up a suitable value so applications can work as if the data type were obtained from the surrounding node.
void	setIsXBRLType(boolean newValue) Sets the flag that indicates if this concept is of the XBRL derived types or not.
XBRLItem.PeriodType	setPeriodType(XBRLItem.PeriodType newValue) Sets the value of the [Period Type] property or resets it if newValue is null.
XBRLXSDTypeDefinition	setType(XBRLXSDTypeDefinition type) Sets the type.
XBRLValidationReport	validate(XBRLPlugInProcessor proc) Validate.

Methods inherited from class com.ihr.xbrl.om.taxonomy.XMLElementDefinition

getAbstract, getAttributes, getBlock, getBlock, getBlock, getChildrenType, getContentValidator, getFinal, getFinal, getFinal, getFixed, getName, getNillable, getParentDocument, getQName, getSimpleContentValidator, getSubstitutionGroup, getSubstitutionGroupHierarchy, getType, getValueKey, isAbstract, isInSubstitutionGroup, isTotal, setAbstract, setBlock, setElementDeclaration, setFinal, setFixed, setId, setName, setNillable, setSubstitutionGroup

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, clone, clone, commitBatch, copy, createComment, delAttribute, delAttribute, delete, 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, 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, s_equal2, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, 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

substitutionGroup

public static final javax.xml.namespace.QName substitutionGroup

This is xbrli:item.

periodTypeAttribute

public static final javax.xml.namespace.QName periodTypeAttribute

The [Period Type] property.

default_

public static final javax.xml.namespace.QName default_

The [default] property.

balance

public static final javax.xml.namespace.QName balance

The value of the balance attribute if it is present.

Constructor Detail

XBRLItem

public XBRLItem(DTSContainer dts)

Creates an item using the properties of the concept received as a parameter Adds the new concept to the parent taxonomy schema.

Parameters:

dts - the dts

XBRLItem

public XBRLItem(XMLElementDefinition node)

Creates an item using the properties of the concept received as a parameter. This method does not adds the new concept to the parent taxonomy schema. call XBRLTaxonomyRootNode.addElement(XMLElementDefinition) if that is needed

Parameters:

node - the node

XBRLItem

public XBRLItem(XBRLTaxonomy parent,
                java.lang.String name,
                java.lang.String _default,
                XBRLXSDTypeDefinition type,
                javax.xml.namespace.QName substitutionGroup,
                XBRLItem.PeriodType periodType,
                XBRLItem.BalanceType balance,
                java.lang.Boolean _abstract,
                java.lang.Boolean nillable,
                int block,
                int _final,
                java.lang.String fixed)
         throws XBRLValidationException

Creates and XBRL Item definition. The new element is not added to the parent. It MUST be added to a taxonomy after creation.

Parameters:

parent - XBRLTaxonomy parent taxonomy

name - String concept name

_default - String default value, can be null

type - XBRLXSDTypeDefinition (xbrli based type)

substitutionGroup - QName (item or based on item)

periodType - PeriodType enum { UNDEFINED_PERIOD_TYPE | INSTANT | DURATION | FOREVER }

balance - BalanceType enum { DEBIT | CREDIT | NO_BALANCE }

_abstract - Boolean

nillable - Boolean

block - int (see XMLElementDefinition)

_final - int (see XMLElementDefinition)

fixed - String fixed value, can be null

Throws:

XBRLValidationException - if the new concept definition has XBRL errors

Method Detail

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XMLElementDefinition

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 XMLElementDefinition

Returns:

the int

equals

public boolean equals(java.lang.Object other)

Equals.

Specified by:

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

Overrides:

equals in class XMLElementDefinition

Parameters:

other - the other

Returns:

true, if successful

setType

public XBRLXSDTypeDefinition setType(XBRLXSDTypeDefinition type)

Sets the type.

Overrides:

setType in class XMLElementDefinition

Parameters:

type - the type

Returns:

the XBRLXSD type definition

getPeriodType

public XBRLItem.PeriodType getPeriodType()

returns PeriodType.DURATION or PeriodType.INSTANT

Returns:

PeriodType

setPeriodType

public XBRLItem.PeriodType setPeriodType(XBRLItem.PeriodType newValue)

Sets the value of the [Period Type] property or resets it if newValue is null.

Parameters:

newValue - the integer constant indicating the new value or null

Returns:

the old value or null

Since:

2.6.5

getDefault

public java.lang.String getDefault()

Access to the [Default] property.

Returns:

the default

setDefault

public java.lang.String setDefault(java.lang.String newValue)

Sets the default.

Parameters:

newValue - the new value

Returns:

the string

getBalance

public XBRLItem.BalanceType getBalance()

Access to the [Balance] property of the concept definition.

Returns:

BalanceType BalanceType.NO_BALANCE or BalanceType.DEBIT or BalanceType.CREDIT

setBalance

public XBRLItem.BalanceType setBalance(XBRLItem.BalanceType newValue)

Sets the value of the [Balance] property or reset it if newValue is null.

Parameters:

newValue - the new constant for the value of the balance attribute

Returns:

the old value

Since:

2.6.5

isPureType

public boolean isPureType()

Check if this concept definition is a pureItemType or derived from pureItemType in the type hierarchy and return true if this is the case.

Returns:

boolean

isPercentageType

public boolean isPercentageType()

Checks if is percentage type.

Returns:

true, if is percentage type

isSharesType

public boolean isSharesType()

Check if this concept definition is a sharesItemType or derived from sharesItemType in the type hierarchy and return true if this is the case.

Returns:

boolean

isMonetaryType

public boolean isMonetaryType()

Check if this concept definition is a monetaryItemType or derived from monetaryItemType in the type hierarchy and return true if this is the case.

Returns:

boolean

setIsMonetaryType

public void setIsMonetaryType(boolean newValue)

Sets the flag that indicates this item is of the monetary type. This information is normally extracted from the data type thus there is no need to call this method. This method is here because some applications may not have access to the data type, in these cases, if the information is available, applications can use this method to set the flag manually

Parameters:

newValue - boolean

isXBRLType

public boolean isXBRLType()

Checks if is XBRL type.

Returns:

boolean

setIsXBRLType

public void setIsXBRLType(boolean newValue)

Sets the flag that indicates if this concept is of the XBRL derived types or not. This information is normally extracted from the data type so there is no need to call this method if the object has been build from nodes or the type property has been set to a specific type based on XML nodes. Applications that does not have such information but have information about if this concept is XBRL or not can use this method to avoid future errors.

Parameters:

newValue - boolean

isNumeric

public boolean isNumeric()

Returns true if the type is derived from one of the list fractionItemType decimalItemType floatItemType doubleItemType monetaryItemType sharesItemType pureItemType integerItemType nonPositiveIntegerItemType negativeIntegerItemType longItemType intItemType shortItemType byteItemType nonNegativeIntegerItemType unsignedLongItemType unsignedIntItemType unsignedShortItemType unsignedByteItemType positiveIntegerItemType).

Returns:

boolean

isXSDTypeNumeric

public static java.lang.Boolean isXSDTypeNumeric(net.sf.saxon.type.SchemaType typeD,
                                                 DTSContainer dts)

Checks if is XSD type numeric.

Parameters:

typeD - the type D

dts - the dts

Returns:

the boolean

isFraction

public boolean isFraction()

Returns true or false depending on this XBRLItem is an XBRL fractionItemType or not This method has been added in order to facilitate the development of the formula specification.

Returns:

boolean true if the type is xbrli:fractionItemType or derived on xbrli:fractionItemType false otherwise

Since:

2.6.9

setIsNumeric

public void setIsNumeric(boolean newValue)

Normally the information about isNumeric is obtained from the element data type but when the element data type cannot be obtained this method can help in setting up a suitable value so applications can work as if the data type were obtained from the surrounding node.

Parameters:

newValue - boolean value

setIsFraction

public void setIsFraction(boolean newValue)

Normally the information about isFraction is obtained from the element data type but when the element data type cannot be obtained this method can help in setting up a suitable value so applications can work as if the data type were obtained from the surrounding node.

Parameters:

newValue - boolean value

isInSubstitutionGroup

public boolean isInSubstitutionGroup(javax.xml.namespace.QName name)

Checks if is in substitution group.

Parameters:

name - the name

Returns:

boolean

generateNode

public XBRLItem generateNode()
                      throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XMLElementDefinition

Returns:

the XBRL item

Throws:

XBRLSerializationException - the XBRL serialization exception

getElements

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

Gets the elements.

Overrides:

getElements in class XMLFragment

Returns:

the elements

getInSubstitutionGroup

public java.util.Collection<XBRLItem> getInSubstitutionGroup()

Gets the in substitution group.

Overrides:

getInSubstitutionGroup in class XMLElementDefinition

Returns:

Collection<XBRLItem>

getFriendlyName

public java.lang.String getFriendlyName()

Gets the friendly name.

Overrides:

getFriendlyName in class XMLElementDefinition

Returns:

the friendly name

getFriendlyName

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

Gets the friendly name.

Overrides:

getFriendlyName in class XMLElementDefinition

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

getFilterExpression

public java.util.regex.Pattern getFilterExpression(XBRLFactItem referenceItem)

RS API contains a Linked lists processor that allows to filter values in a list using a fact reported value, an item definition whose type is list (restriction based enumeration facet) and a regular expression token that might contain #{SOURCE} and will be replaced by the fact string value. In order to use this functionality, the taxonomy must link two item definitions using a generic arc with the arcroleType: http://reportingstandard.com/arcrole/2014/linked-list defined in the schema http://www.reportingstandard.com/2014/RSLinkedLists.xsd

Parameters:

referenceItem - the reference item

Returns:

compiled Pattern to allow for filtering a list of values

isEnumerable

public boolean isEnumerable()

Returns true if this item is enumerable according with the extensible enumerations specification.

Returns:

true, if is enumerable

getExtensibleEnumerationValues

public java.util.Iterator<DecoratedQName> getExtensibleEnumerationValues()

If this element is extensible enumerable type, this method returns an iterator of DecoratedQName instances with all available values.

Returns:

the extensible enumeration values

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