com.ihr.xbrl.om.table.definition

Class XBRLAspectNode

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.exLinks.XLinkElement

com.ihr.xbrl.om.exLinks.XBRLPointerOfARelationship

com.ihr.xbrl.om.exLinks.XBRLResource

com.ihr.xbrl.om.table.XBRLTableResource

com.ihr.xbrl.om.table.definition.XBRLDefinitionNode

com.ihr.xbrl.om.table.definition.XBRLOpenDefinitionNode

com.ihr.xbrl.om.table.definition.XBRLAspectNode

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, HasBreakdownTree, HasFilters, HasParentChildAttribute, HasTableProcessor, StaticCheck, 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 XBRLAspectNode
extends XBRLOpenDefinitionNode
implements HasFilters, StaticCheck

The Class XBRLAspectNode.

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.table.HasParentChildAttribute

HasParentChildAttribute.ParentChildEnum

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	conceptAspectPWD20130517 The Constant conceptAspect.
static javax.xml.namespace.QName	conceptAspectREC20140318 The Constant conceptAspectREC20140318.
static javax.xml.namespace.QName	dimensionAspectPWD20130517 The Constant dimensionAspect.
static javax.xml.namespace.QName	dimensionAspectREC20140318 The Constant dimensionAspectREC20140318.
static javax.xml.namespace.QName	entityIdentifierAspectPWD20130517 The Constant entityIdentifierAspect.
static javax.xml.namespace.QName	entityIdentifierAspectREC20140318 The Constant entityIdentifierAspectREC20140318.
static javax.xml.namespace.QName	includeUnreportedValue The Constant includeUnreportedValue.
static javax.xml.namespace.QName	periodAspectPWD20130517 The Constant periodAspect.
static javax.xml.namespace.QName	periodAspectREC20140318 The Constant periodAspectREC20140318.
static javax.xml.namespace.QName	resourceName The Constant resourceName.
static javax.xml.namespace.QName	unitAspectPWD20130517 The Constant unitAspect.
static javax.xml.namespace.QName	unitAspectREC20140318 The Constant unitAspectREC20140318.

Fields inherited from class com.ihr.xbrl.om.table.definition.XBRLDefinitionNode

tagSelector

Fields inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

log, nullResource

Fields inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

actuate, ARC, arcrole, ETITLE, EXTENDED, from, href, label, LOCATOR, RESOURCE, role, show, SIMPLE, title, to, X_ACTUATE, X_ARCROLE, X_FROM, X_HREF, X_LABEL, X_ROLE, X_SHOW, X_TITLE, X_TO, X_TYPE, XLINKPREFIX

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 com.ihr.xbrl.om.table.HasParentChildAttribute

parentChilOrder

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
XBRLAspectNode(XBRLTableProcessor xbrlTableProcessor, XBRLResource res) Instantiates a new XBRL aspect node.

Method Summary

Modifier and Type	Method and Description
boolean	allowRollUps() Allow roll ups.
void	clear() Clear.
java.util.Collection<? extends java.lang.Object>	getAspectDistinctValuesFromDTS() When the isDTSDependantOnly() returns true, this method shall return the collection of objects that are evaluated as filter output.
int	getAspects() Gets the aspect.
ConceptsAspectInterface	getConceptAspectResolver() if this node defines the concept aspect this method returns the class that resolves the concept aspect otherwise this method returns null.
javax.xml.namespace.QName	getDimension() Gets the dimension.
DimensionsAspectInterface<?>	getDimensionAspectResolver() if this node defines the dimension aspect this method returns the class that resolves the dimension aspect otherwise this method returns null.
EntityIdentifiersAspectInterface	getEntityIdentifierAspectResolver() if this node defines the entity aspect this method returns the class that resolves the entity aspect otherwise this method returns null.
java.util.Iterator<XBRLFilterUse>	getFilters() Gets the filters.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
java.util.Collection<net.sf.saxon.s9api.QName>	getParameterNames() Gets the parameter names.
PeriodsAspectInterface	getPeriodAspectResolver() if this node defines the period aspect this method returns the class that resolves the period aspect otherwise this method returns null.
UnitsAspectInterface	getUnitAspectResolver() Gets the unit aspect resolver.
boolean	hasChildNodes()
boolean	isAbstract() Checks if is abstract.
boolean	isDTSDependantOnly() The resolution of the values for an open aspect are clear in the table specification.
boolean	isIncludeUnreportedValue() Checks if is include unreported value.
static XBRLAspectNode	make(XBRLTableProcessor xbrlTableProcessor, XBRLResource res) Make.
void	staticCheck() Static check.

Methods inherited from class com.ihr.xbrl.om.table.definition.XBRLOpenDefinitionNode

getNumberOfNodes, isAsClosed

Methods inherited from class com.ihr.xbrl.om.table.definition.XBRLDefinitionNode

getBreakdownTree, getParentChildOrder, getTagSelector, hasOpen, isLeaf, isOpen, isParentChildOrderDefined, readDefinitionNodeSubTree, resetTable

Methods inherited from class com.ihr.xbrl.om.table.XBRLTableResource

getFPXPathCompiler, getProcessor, getXPath, isSpecificationVersion

Methods inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

addChild, clone, clone, equals, generateNode, getAttributes, getCode, getDTSBase, getFriendlyName, getFriendlyName, getFriendlyName, getParentXBRL, getResourceIdentifier, getRoleType, getType, getValidationReport, getValueKey, hashCode, invalidate, invalidate, isComplexType, isHashDependsOnAtribute, isOnValidation, isSimpleType, setCode, setComplexType, setDTSBase, setId, setRawParentXBRL, setRole, setRoleType, setSimpleType, setValue, validate

Methods inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

getActuate, getArcrole, getFromTxt, getHRef, getHRefDocument, getHRefDocumentResolved, getHRefResolved, getLabel, getRawHRef, getReference, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo, validateXPointer

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, 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, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getContainerDocumentURI, getDocument, getElement, getElement, getElements, getFirstChildNoComment, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentDocument, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, 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, s_equal2, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, 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

includeUnreportedValue

public static final javax.xml.namespace.QName includeUnreportedValue

The Constant includeUnreportedValue.

resourceName

public static final javax.xml.namespace.QName resourceName

The Constant resourceName.

conceptAspectPWD20130517

public static final javax.xml.namespace.QName conceptAspectPWD20130517

The Constant conceptAspect.

conceptAspectREC20140318

public static final javax.xml.namespace.QName conceptAspectREC20140318

The Constant conceptAspectREC20140318.

unitAspectPWD20130517

public static final javax.xml.namespace.QName unitAspectPWD20130517

The Constant unitAspect.

unitAspectREC20140318

public static final javax.xml.namespace.QName unitAspectREC20140318

The Constant unitAspectREC20140318.

entityIdentifierAspectPWD20130517

public static final javax.xml.namespace.QName entityIdentifierAspectPWD20130517

The Constant entityIdentifierAspect.

entityIdentifierAspectREC20140318

public static final javax.xml.namespace.QName entityIdentifierAspectREC20140318

The Constant entityIdentifierAspectREC20140318.

periodAspectPWD20130517

public static final javax.xml.namespace.QName periodAspectPWD20130517

The Constant periodAspect.

periodAspectREC20140318

public static final javax.xml.namespace.QName periodAspectREC20140318

The Constant periodAspectREC20140318.

dimensionAspectPWD20130517

public static final javax.xml.namespace.QName dimensionAspectPWD20130517

The Constant dimensionAspect.

dimensionAspectREC20140318

public static final javax.xml.namespace.QName dimensionAspectREC20140318

The Constant dimensionAspectREC20140318.

Constructor Detail

XBRLAspectNode

public XBRLAspectNode(XBRLTableProcessor xbrlTableProcessor,
                      XBRLResource res)
               throws XTValidationException

Instantiates a new XBRL aspect node.

Parameters:

xbrlTableProcessor - the xbrl table processor

res - the res

Throws:

XTValidationException - the XT validation exception

Method Detail

make

public static XBRLAspectNode make(XBRLTableProcessor xbrlTableProcessor,
                                  XBRLResource res)
                           throws XTValidationException

Make.

Parameters:

xbrlTableProcessor - the xbrl table processor

res - the res

Returns:

the XBRL aspect node

Throws:

XTValidationException - the XT validation exception

isIncludeUnreportedValue

public boolean isIncludeUnreportedValue()

Checks if is include unreported value.

Specified by:

isIncludeUnreportedValue in class XBRLOpenDefinitionNode

Returns:

true, if is include unreported value

getFilters

public java.util.Iterator<XBRLFilterUse> getFilters()

Gets the filters.

Specified by:

getFilters in interface HasFilters

Returns:

the vFilters

getAspects

public int getAspects()

Gets the aspect.

Returns:

the aspect

getDimension

public javax.xml.namespace.QName getDimension()

Gets the dimension.

Returns:

the dimension

getConceptAspectResolver

public ConceptsAspectInterface getConceptAspectResolver()

if this node defines the concept aspect this method returns the class that resolves the concept aspect otherwise this method returns null.

Returns:

the conceptAspectResolver

See Also:

getAspects()

getDimensionAspectResolver

public DimensionsAspectInterface<?> getDimensionAspectResolver()

if this node defines the dimension aspect this method returns the class that resolves the dimension aspect otherwise this method returns null.

Returns:

the dimensionResolver

See Also:

getAspects()

getPeriodAspectResolver

public PeriodsAspectInterface getPeriodAspectResolver()

if this node defines the period aspect this method returns the class that resolves the period aspect otherwise this method returns null.

Returns:

the periodAspectResolver

See Also:

getAspects()

getUnitAspectResolver

public UnitsAspectInterface getUnitAspectResolver()

Gets the unit aspect resolver.

Returns:

the unit aspect resolver

getEntityIdentifierAspectResolver

public EntityIdentifiersAspectInterface getEntityIdentifierAspectResolver()

if this node defines the entity aspect this method returns the class that resolves the entity aspect otherwise this method returns null.

Returns:

the entityIdentifierAspectResolver

See Also:

getAspects()

getParameterNames

public java.util.Collection<net.sf.saxon.s9api.QName> getParameterNames()

Gets the parameter names.

Specified by:

getParameterNames in interface HasFilters

Returns:

the parameter names

isAbstract

public boolean isAbstract()

Checks if is abstract.

Specified by:

isAbstract in class XBRLDefinitionNode

Returns:

true, if is abstract

allowRollUps

public boolean allowRollUps()

Allow roll ups.

Specified by:

allowRollUps in class XBRLDefinitionNode

Returns:

true, if successful

staticCheck

public void staticCheck()
                 throws XTValidationException,
                        XFValidationException

Static check.

Specified by:

staticCheck in interface StaticCheck

Throws:

XTValidationException - the XT validation exception

XFValidationException - the XF validation exception

isDTSDependantOnly

public boolean isDTSDependantOnly()

The resolution of the values for an open aspect are clear in the table specification. But when the tool is able to provide values for creating a new instance, it is the case that the filters cannot provide values when the instance has no facts reported. This method shall return true when the XBRLAspectNode does not depends on reported values but depends only on the DTS. When this method returns true, it is legal to call getAspectDistinctValuesFromDTS() and the returned value can be cached because does not depends on the instance

Returns:

true, if is DTS dependant only

getAspectDistinctValuesFromDTS

public java.util.Collection<? extends java.lang.Object> getAspectDistinctValuesFromDTS()

When the isDTSDependantOnly() returns true, this method shall return the collection of objects that are evaluated as filter output.

Returns:

Collection of objects evaluated once from the filter when the filter does not depends on facts in an instance document

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XBRLResource

Throws:

java.lang.Throwable - the throwable

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