public class XBRLTable extends XBRLTableResource implements HasParentChildAttribute, HasFilters
HasParentChildAttribute.ParentChildEnumXBRLValidation.Direction| Modifier and Type | Field and Description |
|---|---|
static javax.xml.namespace.QName |
aspectModel
The Constant aspectModel.
|
static javax.xml.namespace.QName |
table
The Constant table.
|
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 |
|---|
XBRLTable(XBRLTableProcessor xbrlTableProcessor,
XBRLResource res)
Creates a new table in the definition model.
|
| Modifier and Type | Method and Description |
|---|---|
int |
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.
|
XBRLVariableParameter |
getParameter(net.sf.saxon.s9api.QName parameterName)
Access to a single table parameter from the parameter name.
|
java.util.Collection<net.sf.saxon.s9api.QName> |
getParameterNames()
Access to all table parameter names
|
HasParentChildAttribute.ParentChildEnum |
getParentChildOrder()
Returns the value of the parentChildOrder attribute
as one value of the ParentChildEnum enumeration.
|
java.util.Iterator<XBRLStructuralTable> |
getStructuralTables(EditorSource editorSource,
OpenAspectValueResolver externalResolver)
Returns an iterator over all structural tables defined from this table definition.
|
XBRLTableSet |
getTableSet(EditorSource editorSource,
OpenAspectValueResolver externalResolver)
Builds up the table set for this table.
|
boolean |
isAxisExplicitlyDefined(Axis axis)
Returns true if the table contains an explicit definition of the axis passed in
as the axis parameter.
|
boolean |
isParentChildOrderDefined()
Returns true when the resource contains an attribute with explicit
definition of the parentChildOrder.
|
void |
prepare(EditorSource editorSource,
OpenAspectValueResolver externalResolver)
For this table, this method prepares the entire table set and for each table in
the table set it prepares the structural table.
|
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
|
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 aspectModel
public static final javax.xml.namespace.QName table
public XBRLTable(XBRLTableProcessor xbrlTableProcessor, XBRLResource res) throws XTValidationException
xbrlTableProcessor - the xbrl table processorres - the resXTValidationException - the XT validation exceptionpublic java.util.Iterator<XBRLStructuralTable> getStructuralTables(EditorSource editorSource, OpenAspectValueResolver externalResolver) throws XTValidationException, XFException
editorSource - optional EditorSoruce to inject values that belongs to the editor
and are still not part of the instance documentexternalResolver - optional, class that will provide user selected values for
dimensions in the Z axisXTValidationException - raised only during DTS loadingXFException - the XF exceptionpublic XBRLTableSet getTableSet(EditorSource editorSource, OpenAspectValueResolver externalResolver) throws XTValidationException, XFException
editorSource - optional EditorSoruce to inject values that belongs to the editor
and are still not part of the instance documentexternalResolver - optional, class that will provide user selected values for
dimensions in the Z axisXTValidationException - the XT validation exceptionXFException - the XF exceptionpublic java.util.Iterator<Axis> getAxis()
public boolean isAxisExplicitlyDefined(Axis axis)
axis - the axispublic int getAspectModel()
public boolean isParentChildOrderDefined()
HasParentChildAttributeisParentChildOrderDefined in interface HasParentChildAttributepublic HasParentChildAttribute.ParentChildEnum getParentChildOrder()
HasParentChildAttributegetParentChildOrder in interface HasParentChildAttributepublic java.util.Iterator<XBRLBreakdownUse> getBreakdowns(Axis axis)
axis - the axispublic java.util.Iterator<XBRLFilterUse> getFilters()
getFilters in interface HasFilterspublic java.util.Collection<net.sf.saxon.s9api.QName> getParameterNames()
getParameterNames in interface HasFiltersgetParameter(QName)public XBRLVariableParameter getParameter(net.sf.saxon.s9api.QName parameterName)
parameterName - a QNamepublic void resetTable()
public void prepare(EditorSource editorSource, OpenAspectValueResolver externalResolver) throws XFException, XTValidationException
editorSource - optional EditorSoruce to inject values that belongs to the editor
and are still not part of the instance documentexternalResolver - optional, class that will provide user selected values for
dimensions in the Z axisXFException - the XF exceptionXTValidationException - the XT validation exception