com.ihr.xbrl.om.taxonomy

Class XBRLTuple

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.taxonomy.XMLElementDefinition

com.ihr.xbrl.om.taxonomy.XBRLElementDefinition

com.ihr.xbrl.om.taxonomy.XBRLTuple

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, 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 XBRLTuple
extends XBRLElementDefinition
implements XBRLValidation

The Class XBRLTuple.

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

XBRLValidation.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	substitutionGroup This is xbrli:tuple.

Fields inherited from class com.ihr.xbrl.om.taxonomy.XMLElementDefinition

abstract_, ALL, block, elementDocNode, EMPTY, EXTENSION, final_, fixed, name, nillable, nullConcept, RESTRICTION, SUBSTITUTION, type, UNDEFINED

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 net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
XBRLTuple(DTSContainer dts) Instantiates a new XBRL tuple.
XBRLTuple(XBRLTaxonomy tx, java.lang.String name, javax.xml.namespace.QName sg, java.lang.Boolean _abstract, java.lang.Boolean nillable, int block, int _final, XSDComposition comp) Creates a tuple definition in a taxonomy.
XBRLTuple(XMLElementDefinition node) Instantiates a new XBRL tuple.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XBRLTuple	generateNode() Generate node.
XSDComposition	getComposition() Access to the XSDComposition object.
java.util.Iterator<XMLFragment>	getElements() Gets the elements.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
java.lang.String	getFriendlyName() Gets the friendly name.
java.lang.String	getFriendlyName(int modifiers, LabelsProvider lp) Gets the friendly name.
java.util.Collection<XBRLTuple>	getInSubstitutionGroup() Gets the in substitution group.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLValidationReport	getValidationReport() Gets the validation report.
boolean	hasChildNodes()
void	invalidate() Invalidate.
boolean	invalidate(XBRLValidation.Direction dir) Invalidate.
boolean	isOnValidation() Checks if is on validation.
void	setComposition(XSDComposition comp) Sets the composition to a new XSDComposition instance.
XBRLValidationReport	validate(XBRLPlugInProcessor proc) Validate.

Methods inherited from class com.ihr.xbrl.om.taxonomy.XMLElementDefinition

equals, getAbstract, getAttributes, getBlock, getBlock, getBlock, getChildrenType, getContentValidator, getFinal, getFinal, getFinal, getFixed, getName, getNillable, getParentDocument, getQName, getSimpleContentValidator, getSubstitutionGroup, getSubstitutionGroupHierarchy, getType, getValueKey, hashCode, isAbstract, isInSubstitutionGroup, isTotal, setAbstract, setBlock, setElementDeclaration, setFinal, setFixed, setId, setName, setNillable, setSubstitutionGroup, setType

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, addChild, addChildArray, addChildAt, addChildNode, addChildNodeArray, addChildNodeAt, addChildNodeInBatch, addComment, addFromRelationship, addNamespace, addNamespace, addPropertyChangeListener, addToRelationship, changeBase, checkBase, childExists, clone, clone, 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, getFirstChildNoComment, getFragment, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentXBRL, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isHashDependsOnAtribute, 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, setRawParentXBRL, setValue, 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

substitutionGroup

public static final javax.xml.namespace.QName substitutionGroup

This is xbrli:tuple.

Constructor Detail

XBRLTuple

public XBRLTuple(DTSContainer dts)

Instantiates a new XBRL tuple.

Parameters:

dts - the dts

XBRLTuple

public XBRLTuple(XMLElementDefinition node)

Instantiates a new XBRL tuple.

Parameters:

node - the node

XBRLTuple

public XBRLTuple(XBRLTaxonomy tx,
                 java.lang.String name,
                 javax.xml.namespace.QName sg,
                 java.lang.Boolean _abstract,
                 java.lang.Boolean nillable,
                 int block,
                 int _final,
                 XSDComposition comp)

Creates a tuple definition in a taxonomy. Parameters are as follows:

Parameters:

tx - The parent taxonomy cannot be null.

name - tuple name

sg - substitution group

_abstract - boolean value

nillable - boolean value

block - int (see XMLElementDefinition)

_final - int (see XMLElementDefinition)

comp - XSDComposition object. This is the definition of the tuple content model.

Method Detail

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XMLElementDefinition

Throws:

java.lang.Throwable - the throwable

generateNode

public XBRLTuple generateNode()
                       throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XMLElementDefinition

Returns:

the XBRL tuple

Throws:

XBRLSerializationException - the XBRL serialization exception

getComposition

public XSDComposition getComposition()
                              throws XBRLValidationException

Access to the XSDComposition object. This is a compiled representation of the content model.

Remarks: If the type definition is local to the tuple (complexType is child to the tuple element declaration), then the returned XSDComposition object will be used for generating back the XML representation of the tuple content model. If the type definition is global, the returned XSDComposition represents the tuple content model but it will not be used for generating the back the XML nodes.

Returns:

XSDComposition

Throws:

XBRLValidationException - the XBRL validation exception

setComposition

public void setComposition(XSDComposition comp)

Sets the composition to a new XSDComposition instance.

By calling this method the type property is reset as if XMLElementDefinition.setType(XBRLXSDTypeDefinition) were called with null parameter.

Parameters:

comp - the new composition

Since:

2.6.7

getElements

public java.util.Iterator<XMLFragment> getElements()

Gets the elements.

Overrides:

getElements in class XMLFragment

Returns:

the elements

getInSubstitutionGroup

public java.util.Collection<XBRLTuple> getInSubstitutionGroup()

Gets the in substitution group.

Overrides:

getInSubstitutionGroup in class XMLElementDefinition

Returns:

Collection<XBRLTuple>

getFriendlyName

public java.lang.String getFriendlyName()

Gets the friendly name.

Overrides:

getFriendlyName in class XMLElementDefinition

Returns:

the friendly name

getFriendlyName

public java.lang.String getFriendlyName(int modifiers,
                                        LabelsProvider lp)

Gets the friendly name.

Overrides:

getFriendlyName in class XMLElementDefinition

Parameters:

modifiers - the modifiers

lp - the lp

Returns:

the friendly name

getValidationReport

public XBRLValidationReport getValidationReport()

Gets the validation report.

Specified by:

getValidationReport in interface XBRLValidation

Returns:

the validation report

validate

public XBRLValidationReport validate(XBRLPlugInProcessor proc)

Validate.

Specified by:

validate in interface XBRLValidation

Parameters:

proc - the proc

Returns:

the XBRL validation report

invalidate

public void invalidate()

Invalidate.

Specified by:

invalidate in interface XBRLValidation

invalidate

public boolean invalidate(XBRLValidation.Direction dir)

Invalidate.

Specified by:

invalidate in interface XBRLValidation

Parameters:

dir - the dir

Returns:

true, if successful

isOnValidation

public boolean isOnValidation()

Checks if is on validation.

Specified by:

isOnValidation in interface XBRLValidation

Returns:

true, if is on validation

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