public abstract class XBRLDefinitionNode extends XBRLTableResource implements HasBreakdownTree, HasParentChildAttribute
HasParentChildAttribute.ParentChildEnumXBRLValidation.Direction| Modifier and Type | Field and Description |
|---|---|
static javax.xml.namespace.QName |
tagSelector
This is the attribute name "tagSelector" represented as a QName.
|
log, nullResourceactuate, ACTUATE, ARC, arcrole, ARCROLE, ETITLE, EXTENDED, from, FROM, href, HREF, label, LABEL, LOCATOR, RESOURCE, role, ROLE, show, SHOW, SIMPLE, title, TITLE, to, TO, TYPECONCEPT_LABEL, CONCEPT_QNAME, EASY_TO_READ, ELEMENT_LABEL, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, HIDE_COMMON_ACCURACY, idQName, NO_POSITION, OrderComparator, OrderComparator2, PERIOD_TYPE, PERIOD_VALUE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTERparentChilOrder| Constructor and Description |
|---|
XBRLDefinitionNode(XBRLTableProcessor xbrlTableProcessor,
XBRLResource res)
Instantiates a new XBRL definition node.
|
| Modifier and Type | Method and Description |
|---|---|
abstract boolean |
allowRollUps()
Some nodes does not allow the creation of roll-up nodes. such as the aspect node.
|
java.util.Iterator<XBRLDefinitionNodeUse> |
getBreakdownTree()
Gets the breakdown tree.
|
int |
getNumberOfNodes()
Returns the number of root nodes in the tree.
|
HasParentChildAttribute.ParentChildEnum |
getParentChildOrder()
Returns the value of the parentChildOrder attribute
as one value of the ParentChildEnum enumeration.
|
java.lang.String |
getTagSelector()
returns the value of the tagSelector attribute on this definition node
if the tagSelector attribute is not present this method returns XBRLRuleNode.UNTAGGED_TAG_NAME
which is a constant defined for no tag defined
|
boolean |
hasOpen()
Returns true if this or down the tree from this node there is a node that isOpen() returns true.
|
abstract boolean |
isAbstract()
Returns true if this is a closed definition node and is abstract.
|
boolean |
isLeaf()
Returns true if this is a leaf node with no nested XBRLDefinitionNodeUse elements
in the iterator that would be returned by a call to getBreakdownTree().
|
boolean |
isOpen()
Returns true if this particular node is based on an XBRLOpenDefinitionNode and thus it is an open node.
|
boolean |
isParentChildOrderDefined()
Returns true when the resource contains an attribute with explicit
definition of the parentChildOrder.
|
void |
readDefinitionNodeSubTree()
Read definition node sub tree.
|
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 called by the API
automatically each time a table in the tableSet is evaluated
|
getFPXPathCompiler, getProcessor, isSpecificationVersionaddChild, clear, equals, generateLocatorToNode, generateNode, getAttributes, getDTSBase, getFriendlyName, getFriendlyName, getParent, getResourceIdentifier, getRoleType, getType, getValidationReport, getValueKey, hashCode, invalidate, invalidate, isComplexType, isOnValidation, isSimpleType, setComplexType, setDTSBase, setId, setParent, setRole, setRoleType, setSimpleType, setValue, validategetActuate, getArcrole, getFromTxt, getHRef, getLabel, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setToaddAttribute, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, clone, clone, delAttribute, delAttribute, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAllAttributes, getAttribute, getAttributeBooleanValue, getAttributeQNameValue, getAttributes, getAttributeStringValue, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getContainerDocumentURI, getDeclaredNamespaces, getDocument, getElements, getElementsHashCode, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getGenericLabelText, getId, getLang, getNamespaceURI, getNodeName, getNumberOfAttributes, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticContext, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathExecutable, getXPathNamespaceContext, getXPathToNode, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, isDead, isNamespaceDefined, isXdmDocumentAttached, objEquals, objHashCode, qNameToString, removeAttribute, removeChild, removeChild, removeFromRelationship, removeToRelationship, removeXMLChild, resetElements, resetHash, resolve_equal2, resolveHRef, resolveHRef, s_equal2, s_equal2, s_equal2, setAttributes, setBase, setDocument, setDocumentAndReload, setElements, setLang, setNamespaceContext, setNamespaces, setNode, setNodeName, setParent, setRegenerateNodeIfnotFound, setValue, setVariablesDefined, size, thin, toString, valueEquals, xEqualaddFromRelationship, addToRelationship, getFromRelationships, getToRelationships, removeFromRelationship, removeToRelationshippublic static final javax.xml.namespace.QName tagSelector
public XBRLDefinitionNode(XBRLTableProcessor xbrlTableProcessor, XBRLResource res) throws XTValidationException
xbrlTableProcessor - the xbrl table processorres - the resXTValidationException - the XT validation exceptionpublic void readDefinitionNodeSubTree()
public java.util.Iterator<XBRLDefinitionNodeUse> getBreakdownTree()
getBreakdownTree in interface HasBreakdownTreepublic boolean isLeaf()
HasBreakdownTreeisLeaf in interface HasBreakdownTreeHasBreakdownTree.getBreakdownTree()public int getNumberOfNodes()
HasBreakdownTreegetNumberOfNodes in interface HasBreakdownTreepublic boolean hasOpen()
HasBreakdownTreehasOpen in interface HasBreakdownTreepublic boolean isOpen()
HasBreakdownTreeisOpen in interface HasBreakdownTreepublic java.lang.String getTagSelector()
public boolean isParentChildOrderDefined()
HasParentChildAttributeisParentChildOrderDefined in interface HasParentChildAttributepublic HasParentChildAttribute.ParentChildEnum getParentChildOrder()
HasParentChildAttributegetParentChildOrder in interface HasParentChildAttributepublic abstract boolean isAbstract()
public abstract boolean allowRollUps()
public void resetTable()