com.ihr.xbrl.om.table.definition

Class XBRLTable

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

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, HasFilters, HasParentChildAttribute, HasTableProcessor, 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 XBRLTable
extends XBRLTableResource
implements HasParentChildAttribute, HasFilters

This is a table in the definition model.

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	aspectModel The Constant aspectModel.
static javax.xml.namespace.QName	resourceName The node name table:table in the REC_2014_03_18 namespace.

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
XBRLTable(XBRLTableProcessor xbrlTableProcessor, XBRLResource res) Creates a new table in the definition model.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XBRLVariablesHolder.ModelType	getAspectModel() Returns either XBRLVariablesHolder.MODEL_DIMENSIONAL or XBRLVariablesHolder.MODEL_NON_DIMENSIONAL
java.util.Iterator<Axis>	getAxis() Access to an iterator of the axis that exists in the table due to the existence of table-breakdown relationships.
java.util.Iterator<XBRLBreakdownUse>	getBreakdowns(Axis axis) Gets the breakdowns.
java.util.Iterator<XBRLFilterUse>	getFilters() Gets the filters.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLVariableParameter	getParameter(net.sf.saxon.s9api.QName parameterName) Access to a single table parameter from the parameter name.
java.util.Collection<java.util.Set<net.sf.saxon.s9api.QName>>	getParameterKeys() Access to all table parameter names
java.util.Collection<net.sf.saxon.s9api.QName>	getParameterNames() Access to all table parameter names
HasParentChildAttribute.ParentChildEnum	getParentChildOrder() Gets the parent child order.
java.util.Iterator<XBRLStructuralTable>	getStructuralTables() Returns an iterator over all structural tables defined from this table definition.
XBRLTableSet	getTableSet() Builds up the table set for this table.
boolean	hasChildNodes()
boolean	isAxisExplicitlyDefined(Axis axis) Returns true if the table contains an explicit definition of the axis passed in as the axis parameter.
boolean	isParentChildOrderDefined() Checks if is parent child order defined.
static XBRLTable	make(XBRLTableProcessor xbrlTableProcessor, XBRLResource res) Make.
void	resetTable() This method traverse all elements in the definition layer and cleans up all evaluated and cached resources so the table can be evaluated again. it is calles by the API automatically each time a table in the tableSet is evaluated

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

aspectModel

public static final javax.xml.namespace.QName aspectModel

The Constant aspectModel.

resourceName

public static final javax.xml.namespace.QName resourceName

The node name table:table in the REC_2014_03_18 namespace.

Constructor Detail

XBRLTable

public XBRLTable(XBRLTableProcessor xbrlTableProcessor,
                 XBRLResource res)
          throws XTValidationException

Creates a new table in the definition model.

Parameters:

xbrlTableProcessor - the xbrl table processor

res - the res

Throws:

XTValidationException - the XT validation exception

Method Detail

make

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

Make.

Parameters:

xbrlTableProcessor - the xbrl table processor

res - the res

Returns:

the XBRL table

Throws:

XTValidationException - the XT validation exception

getStructuralTables

public java.util.Iterator<XBRLStructuralTable> getStructuralTables()
                                                            throws XTValidationException,
                                                                   XFException

Returns an iterator over all structural tables defined from this table definition. At this point this method just creates one XBRLStructuralTable because the PWD-2013-05-17 contains no table parameters but at a later time, while implementing the REC, this method shall return a true iterator over a set of structural models This method is not stable and may be removed later. The point is that it may be more efficient to build the structural model only for the already know and selected table parameter values. At this point in the development (PWD-2013-05-17) we don't know how to evaluate all possible structural models and it looks like there is a 1 to 1 relationship between a Definition model and Structural model. This is the reason this method returns just one XBRLStructural model. But for sure this is not what is stated in the REC version.

Returns:

Iterator

Throws:

XTValidationException - raised only during DTS loading

XFException - the XF exception

getTableSet

public XBRLTableSet getTableSet()
                         throws XTValidationException,
                                XFException

Builds up the table set for this table. The editorSource parameter is optional. If it is null the editor source is ignored. If it is an instance of the EditorSource interface then during the generation of the table layout the editor source may inject values on the open definitions so new rows or columns or values in a dimension in the Z axis might appear

Returns:

XBRLTableSet new or cached

Throws:

XTValidationException - the XT validation exception

XFException - the XF exception

getAxis

public java.util.Iterator<Axis> getAxis()

Access to an iterator of the axis that exists in the table due to the existence of table-breakdown relationships.

Returns:

the axis

isAxisExplicitlyDefined

public boolean isAxisExplicitlyDefined(Axis axis)

Returns true if the table contains an explicit definition of the axis passed in as the axis parameter.

Parameters:

axis - the axis

Returns:

true, if is axis explicitly defined

getAspectModel

public XBRLVariablesHolder.ModelType getAspectModel()

Returns either XBRLVariablesHolder.MODEL_DIMENSIONAL or XBRLVariablesHolder.MODEL_NON_DIMENSIONAL

Returns:

one of the two constants

isParentChildOrderDefined

public boolean isParentChildOrderDefined()

Checks if is parent child order defined.

Specified by:

isParentChildOrderDefined in interface HasParentChildAttribute

Returns:

true, if is parent child order defined

getParentChildOrder

public HasParentChildAttribute.ParentChildEnum getParentChildOrder()

Gets the parent child order.

Specified by:

getParentChildOrder in interface HasParentChildAttribute

Returns:

the parent child order

getBreakdowns

public java.util.Iterator<XBRLBreakdownUse> getBreakdowns(Axis axis)

Gets the breakdowns.

Parameters:

axis - the axis

Returns:

the breakdowns

getFilters

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

Gets the filters.

Specified by:

getFilters in interface HasFilters

Returns:

the vFilters

getParameterKeys

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

Access to all table parameter names

Returns:

Collection of QNames, one for each parameter name defined on this table

See Also:

getParameter(QName)

getParameterNames

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

Access to all table parameter names

Specified by:

getParameterNames in interface HasFilters

Returns:

Collection of QNames, one for each parameter name defined on this table

See Also:

getParameter(QName)

getParameter

public XBRLVariableParameter getParameter(net.sf.saxon.s9api.QName parameterName)

Access to a single table parameter from the parameter name.

Parameters:

parameterName - a QName

Returns:

an XBRLVariableParameter instance

resetTable

public void resetTable()

This method traverse all elements in the definition layer and cleans up all evaluated and cached resources so the table can be evaluated again. it is calles by the API automatically each time a table in the tableSet is evaluated

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