XBRLTableProcessor

java.lang.Object
- com.ihr.xbrl.om.table.XBRLTableProcessor

All Implemented Interfaces:

HasDTSContainer, XBRLCompilableProcessor, XBRLPlugInProcessor, XBRLValidationConfiguration
```
public class XBRLTableProcessor
extends java.lang.Object
implements XBRLCompilableProcessor, XBRLValidationConfiguration
```
The Class XBRLTableProcessor.

Author:

Ignacio

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`XBRLTableProcessor.TableResourceSG` This enumeration contains an entry for each element definition that might have XML nodes in its substitution group.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`aspect_node_filter_PWD_2013_05_17_URI` http://xbrl.org/arcrole/PWD/2013-05-17/aspect-node-filter
`static java.lang.String`	`aspect_node_filter_REC_2014_03_18_URI` The Constant aspect_node_filter_REC_2014_03_18_URI.
`static javax.xml.namespace.QName`	`aspectNodeFilterArc_PWD_2013_05_17` The Constant aspectNodeFilterArc_PWD_2013_05_17.
`static javax.xml.namespace.QName`	`aspectNodeFilterArc_REC_2014_03_18` The Constant aspectNodeFilterArc_REC_2014_03_18.
`static java.lang.String`	`breakdown_tree_PWD_2013_05_17_URI` http://xbrl.org/arcrole/PWD/2013-05-17/breakdown-tree
`static java.lang.String`	`breakdown_tree_REC_2014_03_18_URI` The Constant breakdown_tree_REC_2014_03_18_URI.
`static javax.xml.namespace.QName`	`breakdownTreeArc_PWD_2013_05_17` The Constant breakdownTreeArc_PWD_2013_05_17.
`static javax.xml.namespace.QName`	`breakdownTreeArc_REC_2014_03_18` The Constant breakdownTreeArc_REC_2014_03_18.
`static java.lang.String`	`definition_node_subtree_PWD_2013_05_17_URI` http://xbrl.org/arcrole/PWD/2013-05-17/definition-node-subtree
`static java.lang.String`	`definition_node_subtree_REC_2014_03_18_URI` The Constant definition_node_subtree_REC_2014_03_18_URI.
`static javax.xml.namespace.QName`	`definitionNodeSubtreeArc_PWD_2013_05_17` The Constant definitionNodeSubtreeArc_PWD_2013_05_17.
`static javax.xml.namespace.QName`	`definitionNodeSubtreeArc_REC_2014_03_18` The Constant definitionNodeSubtreeArc_REC_2014_03_18.
`static java.lang.String`	`PROCESSORNAME` The Constant PROCESSORNAME.
`static int`	`PWD_2013_05_17` This constant identifies resources from the PWD 2013-05-17 table linkbase during the construction of the definition model, resources that belongs to this specification version are processed for the relationships defined in that specification version.
`static int`	`REC_2014_03_18` This constant identifies resources from the PWD 2013-05-17 table linkbase during the construction of the definition model, resources that belongs to this specification version are processed for the relationships defined in that specification version.
`static java.lang.String`	`table_breakdown_PWD_2013_05_17_URI` http://xbrl.org/arcrole/PWD/2013-05-17/table-breakdown
`static java.lang.String`	`table_breakdown_REC_2014_03_18_URI` The Constant table_breakdown_REC_2014_03_18_URI.
`static java.lang.String`	`table_filter_PWD_2013_05_17_URI` http://xbrl.org/arcrole/PWD/2013-05-17/table-filter
`static java.lang.String`	`table_filter_REC_2014_03_18_URI` The Constant table_filter_REC_2014_03_18_URI.
`static java.lang.String`	`table_parameter_URI` http://xbrl.org/arcrole/2014/table-parameter
`static java.lang.String`	`TABLE_VERSION` The TABLE_VERSION property indicates the version of the Specification document this processor is currently implementing The possible value is TABLE_VERSION_PWD_2013_05_17 More values will be added in the future.
`static java.lang.String`	`TABLE_VERSION_PWD_2013_05_17` The TABLE_VERSION_PWD_2013_05_17 property indicates the processor will use the PWD of 2013-05-17 specification version.
`static java.lang.String`	`TABLE_VERSION_REC_2014_03_18` The TABLE_VERSION_REC_2014_03_18 property indicates the processor will use the REC of 2014-03-18 specification version.
`static javax.xml.namespace.QName`	`tableBreakdownArc_PWD_2013_05_17` The Constant tableBreakdownArc_PWD_2013_05_17.
`static javax.xml.namespace.QName`	`tableBreakdownArc_REC_2014_03_18` The Constant tableBreakdownArc_REC_2014_03_18.
`static javax.xml.namespace.QName`	`tableFilterArc_PWD_2013_05_17` The Constant tableFilterArc_PWD_2013_05_17.
`static javax.xml.namespace.QName`	`tableFilterArc_REC_2014_03_18` The Constant tableFilterArc_REC_2014_03_18.
`static javax.xml.namespace.QName`	`tableParameterArc_PWD_2013_05_17` The Constant tableParameterArc_PWD_2013_05_17.
`static javax.xml.namespace.QName`	`tableParameterArc_REC_2014_03_18` The Constant tableParameterArc_REC_2014_03_18.

Fields inherited from interface com.ihr.xbrl.om.XBRLValidationConfiguration
VALIDATE_ALL_TABLES, VALIDATE_CYCLES, VALIDATE_DOCUMENT, VALIDATE_ESSENCE_ALIAS, VALIDATE_REPORT_ITEMS_AND_TUPLES, VALIDATE_REQUIRES_ELEMENT, VALIDATE_SUMMATION_ITEM, VALIDATE_TABLE_RELATIONSHIPS

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDefinitionNode(XBRLDefinitionNode definitionNode)` Adds the rule node.
`static void`	`addLabels(XMLFragment parent, XMLFragment node)` This method implements the following paragraphs of the specification: "When choosing a single label, the generic label with the standard resource role (http://www.xbrl.org/2008/role/label), if available, SHOULD be used in preference to other labels.
`void`	`addNode(net.sf.saxon.om.NodeInfo ni, XBRLTableProcessor.TableResourceSG resourceCode)` Adds a node to be compiled during the compileResources phase of this processor.
`void`	`addTable(XBRLTable table)` Adds the table.
`javax.xml.namespace.QName`	`checkValidQNameIsConcept(javax.xml.namespace.QName qname)` Validates the QName passed in in the QName parameter is a concept defined in the DTS and is not a dimension and not an hypercube.
`javax.xml.namespace.QName`	`checkValidQNameIsConceptOrDimension(javax.xml.namespace.QName qname, javax.xml.namespace.QName ifDimensionMustBeThis)` Validates the QName passed in in the QName parameter is a concept or a dimension defined in the DTS and not an hypercube.
`void`	`clear()` Clear.
`static net.sf.saxon.s9api.XPathExecutable`	`compileFormulaExpression(java.lang.String expression, XBRLTableResource resource, java.util.Collection<net.sf.saxon.s9api.QName> variablesInSet, java.util.Collection<javax.xml.namespace.QName> requiredVariables)` Compiles an XPath expression using the formula processor compiler and parameters.
`XBRLValidationReport`	`compileResources()` Compile resources.
`void`	`configure(java.util.Properties properties)` Configure.
`static XBRLTableProcessor`	`create(DTSContainer dts)` Creates or gets the instance of the table processor .
`XMLDocumentImpl`	`createModel(XBRLTable table)` Returns an XML document with the serialization of the table model as defined in the table specification.
`void`	`freeUnnecessary()` Free unnecessary.
`javax.xml.namespace.QName`	`getAspectNodeFilterArc()` Access to the QName of aspectNodeFilterArc arcs for the specification version recognized during the compilation process.
`XBRLArcroleType`	`getAspectNodeFilterArcroleType()` Gets the aspect node filter arcrole type.
`java.util.Iterator<DTSBase>`	`getBasesWithTables()` Access to an iterator over bases that defines tables.
`javax.xml.namespace.QName`	`getBreakdownTreeArc()` Access to the QName of breakdownTreeArc arcs for the specification version recognized during the compilation process.
`XBRLArcroleType`	`getBreakdownTreeArcroleType()` Gets the breakdown tree arcrole type.
`DTSContainer`	`getContainer()` Gets the container.
`javax.xml.namespace.QName`	`getDefinitionNodeSubtreeArc()` Access to the QName of definitionNodeSubtreeArc arcs for the specification version recognized during the compilation process.
`XBRLArcroleType`	`getDefinitionNodeSubtreeArcroleType()` Gets the definition node subtree arcrole type.
`java.lang.String`	`getDescription()` Gets the description.
`static java.lang.String`	`getDescriptionStatic()` Gets the description static.
`XBRLFilterOrderTool`	`getFilterOrderInstance()` Gets the filter order instance.
`java.lang.String`	`getName()` Gets the name.
`int`	`getSpecificationVersion()` Access to the specification version recognized in the incoming linkbases.
`XBRLTable`	`getTable(java.lang.String idTable)` Returns an XBRLTable instance that contains an id with the value of the idTable parameter.
`javax.xml.namespace.QName`	`getTableBreakdownArc()` Access to the QName of tableBreakdownArc arcs for the specification version recognized during the compilation process.
`XBRLArcroleType`	`getTableBreakdownArcroleType()` Gets the table breakdown arcrole type.
`javax.xml.namespace.QName`	`getTableFilterArc()` Access to the QName of tableFilterArc arcs for the specification version recognized during the compilation process.
`XBRLArcroleType`	`getTableFilterArcroleType()` Gets the table filter arcrole type.
`javax.xml.namespace.QName`	`getTablePamaterArc()` Access to the QName of tablePamaterArc arcs for the specification version recognized during the compilation process.
`XBRLArcroleType`	`getTableParameterArcroleType()` Access to the table-parameter arcrole defined in this DTS. returns null if the table_parameter arcrole is not defined.
`java.util.Iterator<XBRLTable>`	`getTables()` Gets the tables.
`java.util.Iterator<XBRLTable>`	`getTables(XBRLRoleType role)` Return an iterator over all tables defined in the role type received as parameter.
`int`	`getWhatToValidate()` Gets the what to validate.
`boolean`	`isHidden()` Checks if is hidden.
`static boolean`	`isNegated(XMLFragment node)` Returns true if the node XMLFragment has a label with a negated role.
`static boolean`	`isNet(XMLFragment node)` Returns true if the node XMLFragment has a label with a net role.
`boolean`	`isSpecificationVersion(int version)` returns true when the current DTSContainer contains resources for the specification version received in the version parameter.
`static boolean`	`isTotal(XMLFragment node)` Returns true if the node XMLFragment has a label with a total role.
`static java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>>`	`mergeAspects(CellHeader header1, CellHeader header2, java.util.Set<java.lang.String> sortedTagSelectors)` This method combines the aspects of two cell headers and returns an structure of combined aspects.
`static void`	`mergeAspects(java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> inputAspects, java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> outputAspects)` helper method that is used during the creation of the table structural nodes to merge aspects of the parent node with the child node.
`static void`	`mergeAspectsWithCellHeader(java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> returnValue, CellHeader header)` Combines the aspects in the first parameter with the aspects in the CellHeader.
`static void`	`registerProcessorStatic()` Register processor static.
`void`	`removeDefinitionNode(XBRLDefinitionNode definitionNode)` Removes the rule node.
`void`	`removeTable(XBRLTable table)` Removes the table.
`int`	`setWhatToValidate(int newValue)` Sets the what to validate.
`XBRLValidationReport`	`validate()` Validate.
`XBRLValidationReport`	`validate(XBRLDocument xDocument)` Validate.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROCESSORNAME
```
public static final java.lang.String PROCESSORNAME
```
    The Constant PROCESSORNAME.
    
    See Also:
    
    Constant Field Values
  - TABLE_VERSION_PWD_2013_05_17
```
public static final java.lang.String TABLE_VERSION_PWD_2013_05_17
```
    The TABLE_VERSION_PWD_2013_05_17 property indicates the processor will use the PWD of 2013-05-17 specification version.
    
    See Also:
    
    PWD 2013-05-17, Constant Field Values
  - TABLE_VERSION_REC_2014_03_18
```
public static final java.lang.String TABLE_VERSION_REC_2014_03_18
```
    The TABLE_VERSION_REC_2014_03_18 property indicates the processor will use the REC of 2014-03-18 specification version.
    
    See Also:
    
    REC 2014-03-18, Constant Field Values
  - TABLE_VERSION
```
public static final java.lang.String TABLE_VERSION
```
    The TABLE_VERSION property indicates the version of the Specification document this processor is currently implementing The possible value is TABLE_VERSION_PWD_2013_05_17 More values will be added in the future.
    The value of the TABLE_VERSION constant is "http://www.reportingstandard.com/properties/table-version".
    The default value for the property it refers to is TABLE_VERSION_PWD_2013_05_17 which is the latest release.
    
    See Also:
    
    Constant Field Values
  - table_breakdown_PWD_2013_05_17_URI
```
public static final java.lang.String table_breakdown_PWD_2013_05_17_URI
```
    http://xbrl.org/arcrole/PWD/2013-05-17/table-breakdown
    
    See Also:
    
    Constant Field Values
  - table_breakdown_REC_2014_03_18_URI
```
public static final java.lang.String table_breakdown_REC_2014_03_18_URI
```
    The Constant table_breakdown_REC_2014_03_18_URI.
    
    See Also:
    
    Constant Field Values
  - table_filter_PWD_2013_05_17_URI
```
public static final java.lang.String table_filter_PWD_2013_05_17_URI
```
    http://xbrl.org/arcrole/PWD/2013-05-17/table-filter
    
    See Also:
    
    Constant Field Values
  - table_filter_REC_2014_03_18_URI
```
public static final java.lang.String table_filter_REC_2014_03_18_URI
```
    The Constant table_filter_REC_2014_03_18_URI.
    
    See Also:
    
    Constant Field Values
  - definition_node_subtree_PWD_2013_05_17_URI
```
public static final java.lang.String definition_node_subtree_PWD_2013_05_17_URI
```
    http://xbrl.org/arcrole/PWD/2013-05-17/definition-node-subtree
    
    See Also:
    
    Constant Field Values
  - definition_node_subtree_REC_2014_03_18_URI
```
public static final java.lang.String definition_node_subtree_REC_2014_03_18_URI
```
    The Constant definition_node_subtree_REC_2014_03_18_URI.
    
    See Also:
    
    Constant Field Values
  - breakdown_tree_PWD_2013_05_17_URI
```
public static final java.lang.String breakdown_tree_PWD_2013_05_17_URI
```
    http://xbrl.org/arcrole/PWD/2013-05-17/breakdown-tree
    
    See Also:
    
    Constant Field Values
  - breakdown_tree_REC_2014_03_18_URI
```
public static final java.lang.String breakdown_tree_REC_2014_03_18_URI
```
    The Constant breakdown_tree_REC_2014_03_18_URI.
    
    See Also:
    
    Constant Field Values
  - aspect_node_filter_PWD_2013_05_17_URI
```
public static final java.lang.String aspect_node_filter_PWD_2013_05_17_URI
```
    http://xbrl.org/arcrole/PWD/2013-05-17/aspect-node-filter
    
    See Also:
    
    Constant Field Values
  - aspect_node_filter_REC_2014_03_18_URI
```
public static final java.lang.String aspect_node_filter_REC_2014_03_18_URI
```
    The Constant aspect_node_filter_REC_2014_03_18_URI.
    
    See Also:
    
    Constant Field Values
  - tableBreakdownArc_PWD_2013_05_17
```
public static final javax.xml.namespace.QName tableBreakdownArc_PWD_2013_05_17
```
    The Constant tableBreakdownArc_PWD_2013_05_17.
  - tableBreakdownArc_REC_2014_03_18
```
public static final javax.xml.namespace.QName tableBreakdownArc_REC_2014_03_18
```
    The Constant tableBreakdownArc_REC_2014_03_18.
  - breakdownTreeArc_PWD_2013_05_17
```
public static final javax.xml.namespace.QName breakdownTreeArc_PWD_2013_05_17
```
    The Constant breakdownTreeArc_PWD_2013_05_17.
  - breakdownTreeArc_REC_2014_03_18
```
public static final javax.xml.namespace.QName breakdownTreeArc_REC_2014_03_18
```
    The Constant breakdownTreeArc_REC_2014_03_18.
  - definitionNodeSubtreeArc_PWD_2013_05_17
```
public static final javax.xml.namespace.QName definitionNodeSubtreeArc_PWD_2013_05_17
```
    The Constant definitionNodeSubtreeArc_PWD_2013_05_17.
  - definitionNodeSubtreeArc_REC_2014_03_18
```
public static final javax.xml.namespace.QName definitionNodeSubtreeArc_REC_2014_03_18
```
    The Constant definitionNodeSubtreeArc_REC_2014_03_18.
  - tableFilterArc_PWD_2013_05_17
```
public static final javax.xml.namespace.QName tableFilterArc_PWD_2013_05_17
```
    The Constant tableFilterArc_PWD_2013_05_17.
  - tableFilterArc_REC_2014_03_18
```
public static final javax.xml.namespace.QName tableFilterArc_REC_2014_03_18
```
    The Constant tableFilterArc_REC_2014_03_18.
  - tableParameterArc_PWD_2013_05_17
```
public static final javax.xml.namespace.QName tableParameterArc_PWD_2013_05_17
```
    The Constant tableParameterArc_PWD_2013_05_17.
  - tableParameterArc_REC_2014_03_18
```
public static final javax.xml.namespace.QName tableParameterArc_REC_2014_03_18
```
    The Constant tableParameterArc_REC_2014_03_18.
  - aspectNodeFilterArc_PWD_2013_05_17
```
public static final javax.xml.namespace.QName aspectNodeFilterArc_PWD_2013_05_17
```
    The Constant aspectNodeFilterArc_PWD_2013_05_17.
  - aspectNodeFilterArc_REC_2014_03_18
```
public static final javax.xml.namespace.QName aspectNodeFilterArc_REC_2014_03_18
```
    The Constant aspectNodeFilterArc_REC_2014_03_18.
  - table_parameter_URI
```
public static final java.lang.String table_parameter_URI
```
    http://xbrl.org/arcrole/2014/table-parameter
    
    See Also:
    
    Constant Field Values
  - PWD_2013_05_17
```
public static final int PWD_2013_05_17
```
    This constant identifies resources from the PWD 2013-05-17 table linkbase during the construction of the definition model, resources that belongs to this specification version are processed for the relationships defined in that specification version.
    
    See Also:
    
    isSpecificationVersion(int), Constant Field Values
  - REC_2014_03_18
```
public static final int REC_2014_03_18
```
    This constant identifies resources from the PWD 2013-05-17 table linkbase during the construction of the definition model, resources that belongs to this specification version are processed for the relationships defined in that specification version.
    
    See Also:
    
    isSpecificationVersion(int), Constant Field Values
- Method Detail
  - isSpecificationVersion
```
public boolean isSpecificationVersion(int version)
```
    returns true when the current DTSContainer contains resources for the specification version received in the version parameter.
    
    Parameters:
    
    version - one of the versions supported.
    
    Returns:
    
    true or false
    
    See Also:
    
    PWD_2013_05_17, REC_2014_03_18
  - getSpecificationVersion
```
public int getSpecificationVersion()
```
    Access to the specification version recognized in the incoming linkbases. It is not legal to merge resources from more than one specification version in the same DTS
    
    Returns:
    
    integer constant
    
    See Also:
    
    PWD_2013_05_17, REC_2014_03_18
  - registerProcessorStatic
```
public static void registerProcessorStatic()
```
    Register processor static.
  - getTableBreakdownArc
```
public javax.xml.namespace.QName getTableBreakdownArc()
```
    Access to the QName of tableBreakdownArc arcs for the specification version recognized during the compilation process.
    
    Returns:
    
    the table breakdown arc
  - getBreakdownTreeArc
```
public javax.xml.namespace.QName getBreakdownTreeArc()
```
    Access to the QName of breakdownTreeArc arcs for the specification version recognized during the compilation process.
    
    Returns:
    
    the breakdown tree arc
  - getAspectNodeFilterArc
```
public javax.xml.namespace.QName getAspectNodeFilterArc()
```
    Access to the QName of aspectNodeFilterArc arcs for the specification version recognized during the compilation process.
    
    Returns:
    
    the aspect node filter arc
  - getTablePamaterArc
```
public javax.xml.namespace.QName getTablePamaterArc()
```
    Access to the QName of tablePamaterArc arcs for the specification version recognized during the compilation process.
    
    Returns:
    
    the table pamater arc
  - getTableFilterArc
```
public javax.xml.namespace.QName getTableFilterArc()
```
    Access to the QName of tableFilterArc arcs for the specification version recognized during the compilation process.
    
    Returns:
    
    the table filter arc
  - getDefinitionNodeSubtreeArc
```
public javax.xml.namespace.QName getDefinitionNodeSubtreeArc()
```
    Access to the QName of definitionNodeSubtreeArc arcs for the specification version recognized during the compilation process.
    
    Returns:
    
    the definition node subtree arc
  - getTableBreakdownArcroleType
```
public XBRLArcroleType getTableBreakdownArcroleType()
```
    Gets the table breakdown arcrole type.
    
    Returns:
    
    the table breakdown arcrole type
  - getTableFilterArcroleType
```
public XBRLArcroleType getTableFilterArcroleType()
```
    Gets the table filter arcrole type.
    
    Returns:
    
    the table filter arcrole type
  - getBreakdownTreeArcroleType
```
public XBRLArcroleType getBreakdownTreeArcroleType()
```
    Gets the breakdown tree arcrole type.
    
    Returns:
    
    the breakdown tree arcrole type
  - getDefinitionNodeSubtreeArcroleType
```
public XBRLArcroleType getDefinitionNodeSubtreeArcroleType()
```
    Gets the definition node subtree arcrole type.
    
    Returns:
    
    the definition node subtree arcrole type
  - getAspectNodeFilterArcroleType
```
public XBRLArcroleType getAspectNodeFilterArcroleType()
```
    Gets the aspect node filter arcrole type.
    
    Returns:
    
    the aspect node filter arcrole type
  - getTableParameterArcroleType
```
public XBRLArcroleType getTableParameterArcroleType()
```
    Access to the table-parameter arcrole defined in this DTS. returns null if the table_parameter arcrole is not defined. Note this arcrole exists on the REC 2014-03-18 but does not exists in the PWD 2013-05-17
    
    Returns:
    
    XBRLArcroleType or null
  - validate
```
public XBRLValidationReport validate()
```
    Validate.
    
    Specified by:
    
    validate in interface XBRLPlugInProcessor
    
    Returns:
    
    the XBRL validation report
  - validate
```
public XBRLValidationReport validate(XBRLDocument xDocument)
```
    Validate.
    
    Specified by:
    
    validate in interface XBRLPlugInProcessor
    
    Parameters:
    
    xDocument - the x document
    
    Returns:
    
    the XBRL validation report
  - getName
```
public java.lang.String getName()
```
    Gets the name.
    
    Specified by:
    
    getName in interface XBRLPlugInProcessor
    
    Returns:
    
    the name
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description.
    
    Specified by:
    
    getDescription in interface XBRLPlugInProcessor
    
    Returns:
    
    the description
  - configure
```
public void configure(java.util.Properties properties)
```
    Configure.
    
    Specified by:
    
    configure in interface XBRLPlugInProcessor
    
    Parameters:
    
    properties - the properties
  - compileResources
```
public XBRLValidationReport compileResources()
```
    Compile resources.
    
    Specified by:
    
    compileResources in interface XBRLCompilableProcessor
    
    Returns:
    
    the XBRL validation report
  - addNode
```
public void addNode(net.sf.saxon.om.NodeInfo ni,
                    XBRLTableProcessor.TableResourceSG resourceCode)
```
    Adds a node to be compiled during the compileResources phase of this processor. This method is called during SAX parsing to register a node that requires transformation by this processor. It might be called from this processor if resources are discovered using XPath (the old style)
    
    Parameters:
    
    ni - the NodeInfo representing the resource to be transoformed into an specific table resource
    
    resourceCode - the resource code
  - getTables
```
public java.util.Iterator<XBRLTable> getTables()
```
    Gets the tables.
    
    Returns:
    
    the vTables
  - getTables
```
public java.util.Iterator<XBRLTable> getTables(XBRLRoleType role)
```
    Return an iterator over all tables defined in the role type received as parameter. If no tables exists for the indicated role an empty iterator is returned
    
    Parameters:
    
    role - the role
    
    Returns:
    
    the tables
  - removeDefinitionNode
```
public void removeDefinitionNode(XBRLDefinitionNode definitionNode)
```
    Removes the rule node.
    
    Parameters:
    
    definitionNode - the rule node
  - addDefinitionNode
```
public void addDefinitionNode(XBRLDefinitionNode definitionNode)
```
    Adds the rule node.
    
    Parameters:
    
    definitionNode - the definition node
  - addTable
```
public void addTable(XBRLTable table)
```
    Adds the table.
    
    Parameters:
    
    table - the table
  - removeTable
```
public void removeTable(XBRLTable table)
```
    Removes the table.
    
    Parameters:
    
    table - the table
  - getContainer
```
public DTSContainer getContainer()
```
    Gets the container.
    
    Specified by:
    
    getContainer in interface HasDTSContainer
    
    Returns:
    
    the container
  - freeUnnecessary
```
public void freeUnnecessary()
                     throws com.rs.lic.LicenseVerificationException,
                            XBRLValidationException
```
    Free unnecessary.
    
    Specified by:
    
    freeUnnecessary in interface XBRLCompilableProcessor
    
    Throws:
    
    com.rs.lic.LicenseVerificationException - the license verification exception
    
    XBRLValidationException - the XBRL validation exception
  - create
```
public static XBRLTableProcessor create(DTSContainer dts)
                                 throws com.rs.lic.LicenseVerificationException,
                                        XBRLValidationException
```
    Creates or gets the instance of the table processor .
    
    Parameters:
    
    dts - the DTSContainer to create/get the XBRLTableProcessor from
    
    Returns:
    
    the XBRLTableProcessor associated with this DTSContainer
    
    Throws:
    
    com.rs.lic.LicenseVerificationException - the license verification exception
    
    XBRLValidationException - the XBRL validation exception
  - getDescriptionStatic
```
public static java.lang.String getDescriptionStatic()
```
    Gets the description static.
    
    Returns:
    
    the description static
  - checkValidQNameIsConcept
```
public javax.xml.namespace.QName checkValidQNameIsConcept(javax.xml.namespace.QName qname)
                                                   throws XTxbrlteInvalidQNameAspectValue
```
    Validates the QName passed in in the QName parameter is a concept defined in the DTS and is not a dimension and not an hypercube.
    
    Parameters:
    
    qname - the concept to check
    
    Returns:
    
    the q name
    
    Throws:
    
    XTxbrlteInvalidQNameAspectValue - in case the concept does not exists or is a dimension or is an hypercube
  - checkValidQNameIsConceptOrDimension
```
public javax.xml.namespace.QName checkValidQNameIsConceptOrDimension(javax.xml.namespace.QName qname,
                                                                     javax.xml.namespace.QName ifDimensionMustBeThis)
                                                              throws XTxbrlteInvalidQNameAspectValue
```
    Validates the QName passed in in the QName parameter is a concept or a dimension defined in the DTS and not an hypercube.
    
    Parameters:
    
    qname - the concept to check
    
    ifDimensionMustBeThis - the if dimension must be this
    
    Returns:
    
    the q name
    
    Throws:
    
    XTxbrlteInvalidQNameAspectValue - in case the concept does not exists or is a dimension or is an hypercube
  - getFilterOrderInstance
```
public XBRLFilterOrderTool getFilterOrderInstance()
```
    Gets the filter order instance.
    
    Returns:
    
    the filter order instance
  - getBasesWithTables
```
public java.util.Iterator<DTSBase> getBasesWithTables()
```
    Access to an iterator over bases that defines tables. The DTSBase contains a role type that is unique in the DTS for the linkbase type and role URI
    
    Returns:
    
    Iterator over DTSBase with tables, note only valid tables are returned
  - compileFormulaExpression
```
public static net.sf.saxon.s9api.XPathExecutable compileFormulaExpression(java.lang.String expression,
                                                                          XBRLTableResource resource,
                                                                          java.util.Collection<net.sf.saxon.s9api.QName> variablesInSet,
                                                                          java.util.Collection<javax.xml.namespace.QName> requiredVariables)
```
    Compiles an XPath expression using the formula processor compiler and parameters.
    
    Parameters:
    
    expression - XPath expression to be compiled
    
    resource - the table resource
    
    variablesInSet - the variables in set
    
    requiredVariables - (OUT) this is a collection of QName with variable names that are required to evaluate the expression
    
    Returns:
    
    the x path executable
  - isHidden
```
public boolean isHidden()
```
    Checks if is hidden.
    
    Specified by:
    
    isHidden in interface XBRLPlugInProcessor
    
    Returns:
    
    true, if is hidden
  - clear
```
public void clear()
```
    Clear.
    
    Specified by:
    
    clear in interface XBRLPlugInProcessor
  - createModel
```
public XMLDocumentImpl createModel(XBRLTable table)
                            throws XTValidationException,
                                   XFException
```
    Returns an XML document with the serialization of the table model as defined in the table specification. This method is used for validating the model producen against the XBRL Table Specification conformance suite.
    
    Parameters:
    
    table - the table to produce the document for
    
    Returns:
    
    a XMLDocumentImpl document
    
    Throws:
    
    XTValidationException - the XT validation exception
    
    XFException - the XF exception
  - isTotal
```
public static boolean isTotal(XMLFragment node)
```
    Returns true if the node XMLFragment has a label with a total role.
    
    Parameters:
    
    node - the node
    
    Returns:
    
    true, if is total
  - isNegated
```
public static boolean isNegated(XMLFragment node)
```
    Returns true if the node XMLFragment has a label with a negated role.
    
    Parameters:
    
    node - the node
    
    Returns:
    
    true, if is negated
  - isNet
```
public static boolean isNet(XMLFragment node)
```
    Returns true if the node XMLFragment has a label with a net role.
    
    Parameters:
    
    node - the node
    
    Returns:
    
    true, if is net
  - addLabels
```
public static void addLabels(XMLFragment parent,
                             XMLFragment node)
```
    This method implements the following paragraphs of the specification: "When choosing a single label, the generic label with the standard resource role (http://www.xbrl.org/2008/role/label), if available, SHOULD be used in preference to other labels. If multiple labels for the same header cell are rendered, the @order attribute MUST be honored.
    
    Parameters:
    
    parent - parent node to attach labels to
    
    node - the Object to search labels from
  - mergeAspects
```
public static void mergeAspects(java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> inputAspects,
                                java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> outputAspects)
```
    helper method that is used during the creation of the table structural nodes to merge aspects of the parent node with the child node.
    
    Parameters:
    
    inputAspects - this is a hash table indexed by tag of all source aspects to merge. Aspects here will be combined to the outputAspects. May be null
    
    outputAspects - this is the target of the merge operation. Must not be null
  - mergeAspects
```
public static java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects(CellHeader header1,
                                                                                                                   CellHeader header2,
                                                                                                                   java.util.Set<java.lang.String> sortedTagSelectors)
```
    This method combines the aspects of two cell headers and returns an structure of combined aspects. It is used to build cells and combine constraints from column header and row header and z axis header
    
    Parameters:
    
    header1 - the header 1
    
    header2 - the header 2
    
    sortedTagSelectors - the sorted tag selectors
    
    Returns:
    
    the map
  - mergeAspectsWithCellHeader
```
public static void mergeAspectsWithCellHeader(java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> returnValue,
                                              CellHeader header)
```
    Combines the aspects in the first parameter with the aspects in the CellHeader. The combined aspects remains in the first parameter
    
    Parameters:
    
    returnValue - the return value
    
    header - the header
  - setWhatToValidate
```
public int setWhatToValidate(int newValue)
```
    Sets the what to validate.
    
    Specified by:
    
    setWhatToValidate in interface XBRLValidationConfiguration
    
    Parameters:
    
    newValue - the new value
    
    Returns:
    
    the int
  - getWhatToValidate
```
public int getWhatToValidate()
```
    Gets the what to validate.
    
    Specified by:
    
    getWhatToValidate in interface XBRLValidationConfiguration
    
    Returns:
    
    the what to validate
  - getTable
```
public XBRLTable getTable(java.lang.String idTable)
```
    Returns an XBRLTable instance that contains an id with the value of the idTable parameter.
    
    Parameters:
    
    idTable - the id table
    
    Returns:
    
    XBRLTable or null if no table contains that id

Class XBRLTableProcessor

Nested Class Summary

Field Summary

Fields inherited from interface com.ihr.xbrl.om.XBRLValidationConfiguration

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROCESSORNAME

TABLE_VERSION_PWD_2013_05_17

TABLE_VERSION_REC_2014_03_18

TABLE_VERSION

table_breakdown_PWD_2013_05_17_URI

table_breakdown_REC_2014_03_18_URI

table_filter_PWD_2013_05_17_URI

table_filter_REC_2014_03_18_URI

definition_node_subtree_PWD_2013_05_17_URI

definition_node_subtree_REC_2014_03_18_URI

breakdown_tree_PWD_2013_05_17_URI

breakdown_tree_REC_2014_03_18_URI

aspect_node_filter_PWD_2013_05_17_URI

aspect_node_filter_REC_2014_03_18_URI

tableBreakdownArc_PWD_2013_05_17

tableBreakdownArc_REC_2014_03_18

breakdownTreeArc_PWD_2013_05_17

breakdownTreeArc_REC_2014_03_18

definitionNodeSubtreeArc_PWD_2013_05_17

definitionNodeSubtreeArc_REC_2014_03_18

tableFilterArc_PWD_2013_05_17

tableFilterArc_REC_2014_03_18

tableParameterArc_PWD_2013_05_17

tableParameterArc_REC_2014_03_18

aspectNodeFilterArc_PWD_2013_05_17

aspectNodeFilterArc_REC_2014_03_18

table_parameter_URI

PWD_2013_05_17

REC_2014_03_18

Method Detail

isSpecificationVersion

getSpecificationVersion

registerProcessorStatic

getTableBreakdownArc

getBreakdownTreeArc

getAspectNodeFilterArc

getTablePamaterArc

getTableFilterArc

getDefinitionNodeSubtreeArc

getTableBreakdownArcroleType

getTableFilterArcroleType

getBreakdownTreeArcroleType

getDefinitionNodeSubtreeArcroleType

getAspectNodeFilterArcroleType

getTableParameterArcroleType

validate

validate

getName

getDescription

configure

compileResources

addNode

getTables

getTables

removeDefinitionNode

addDefinitionNode

addTable

removeTable

getContainer

freeUnnecessary

create

getDescriptionStatic

checkValidQNameIsConcept

checkValidQNameIsConceptOrDimension

getFilterOrderInstance

getBasesWithTables

compileFormulaExpression

isHidden

clear

createModel

isTotal

isNegated

isNet