XBRLExtendedLink

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

All Implemented Interfaces:

HasDTSContainer, XBRLAllowsDocumentation, XBRLRelationshipPoint, HasChangeHashSupport, XBRLDTSDocument, XBRLValidation, 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

Direct Known Subclasses:

CalculationLinkbase, DefinitionLinkbase, FootnoteLinkbase, FormulaLinkbase, GenericLinkbase, LabelLinkbase, OtherLinkbase, PresentationLinkbase, ReferenceLinkbase, VersionLinkbase
```
public abstract class XBRLExtendedLink
extends XLinkElement
implements java.io.Serializable, XBRLDTSDocument, XBRLAllowsDocumentation, XBRLValidation
```
The Class XBRLExtendedLink.

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 java.lang.String standard_role_URI
The standard role URI http://www.xbrl.org/2003/role/link
- 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, type, 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 net.sf.saxon.om.NodeInfo
  ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`standard_role_URI` The standard role URI http://www.xbrl.org/2003/role/link

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDocumentation(XBRLDocumentation doc)` Adds the documentation.
`boolean`	`addRelationship(XBRLRelationship relationship)` Adds the relationship.
`void`	`addResource(XBRLResource resource)` This method adds a XBRLResource to the Extended Link container.
`void`	`checkCountOfRelationships(java.lang.Integer arcrole)` When the method to read arcroles on this extended link is called it explores relationships and declared arcroleRefs.
`static boolean`	`checkValidArcroleOnLink(XBRLArcroleType arcrole, javax.xml.namespace.QName baseType)` This method checks if the arcrole can be used on the specified linkbase type according with the rules in the XBRL 2.1 specification.
`void`	`clear()` Clear.
`void`	`clearCaches()` Used to clear memory used during the DTS loading process.
`static XBRLExtendedLink`	`createExtendedLink(XBRLDocument parent, DTSBase base)` Creates the extended link.
`static XBRLExtendedLink`	`createExtendedLink(XBRLDocument parent, net.sf.saxon.om.NodeInfo ni)` Creates the extended link.
`static XBRLExtendedLink`	`createExtendedLink(XBRLDocument parent, javax.xml.namespace.QName rootElementName, XBRLRoleType role)` Creates the extended link.
`void`	`discoverDTS(XBRLDTSDocument parent)` Discover DTS.
`boolean`	`equals(java.lang.Object other)` Equals.
`XBRLExtendedLink`	`generateNode()` Generate node.
`java.util.Iterator<XBRLArcroleType>`	`getArcroles()` Access to all used arcroles.
`XBRLArcroleType`	`getArcroleType(java.lang.String arcrole)` Returns the arcroleType of an arc on this extended link resolved using the corresponding arcroleRef element or the static definition in the specifications.
`java.util.Iterator<XMLFragment>`	`getArcs()` Return an Iterator object over all arcs in the extended link.
`java.util.List<XBRLArc>`	`getArcsByArcrole(java.lang.Integer arcrole)` Gets the arcs by arcrole.
`java.util.Iterator<XBRLAttribute>`	`getAttributes()` Access to the [Attributes] property.
`java.util.Iterator<XBRLDocumentation>`	`getDocumentation()` Access to the [Documentation] property.
`DTSBase`	`getDTSBase()` Gets the DTS base.
`java.lang.Integer`	`getDTSKey()` Gets the DTS key.
`java.util.Iterator<XMLFragment>`	`getElements()` Gets the elements.
`abstract java.lang.String`	`getExtendedLinkTypeName()` Returns a localized constant string indicating the extended link type
`net.sf.saxon.tree.linked.NodeImpl`	`getFirstChild()`
`java.lang.String`	`getFriendlyName()` Gets the friendly name.
`net.sf.saxon.tree.linked.NodeImpl`	`getLastChild()`
`javax.xml.namespace.QName`	`getLinkbaseType()` Access to the [linkbaseType] property This is the QName of the extended link element which is the root ot this extended link.
`java.util.Iterator<XBRLLocator>`	`getLocators()` Access to all locators in an extended link.
`int`	`getNumberOfChildren()`
`int`	`getNumberOfResources()` Returns how many resources exists in this extended link.
`XBRLDocument`	`getParentDocument()` Access to the [Parent] property.
`java.util.Iterator<XBRLRelationship>`	`getRelationships()` Access to the [Relationships] information item.
`XBRLResource`	`getResource(java.lang.Integer resourceCode)` Gets the resource.
`abstract java.lang.Class<? extends XBRLResource>`	`getResourceClass(net.sf.saxon.om.NodeInfo ni)` Obtains a class that can be used to create a resource instance from the NodeInfo passed in the ni parameter.
`java.util.Iterator<XBRLResource>`	`getResources()` Return an iterator over all resources that exist on this extended link.
`XBRLRoleType`	`getRoleType()` Access to the [Role Type] property of this object Validates this extended link QName in on the used on list of the roleType.
`abstract java.util.Collection<java.lang.String>`	`getStandardDefinedRolesOnResources()` Returns a collection of role URIs that the XBRL 2.1 standard defines to be used on resources on this extended link
`abstract java.util.Collection<javax.xml.namespace.QName>`	`getStandardResourceNodeNames()` Returns a collection of resource node names that are allowed to exist on this extended link.
`abstract javax.xml.namespace.QName`	`getStaticLinkbaseType()` This function MUST be implemented by classes derived from this class.
`XBRLValidationReport`	`getValidationReport()` Gets the validation report.
`boolean`	`hasChildNodes()`
`int`	`hashCode()` Hash code.
`void`	`invalidate()` Invalidate.
`boolean`	`invalidate(XBRLValidation.Direction dir)` Invalidate.
`boolean`	`isHashDependsOnAtribute(javax.xml.namespace.QName attributeName)` Checks if is hash depends on atribute.
`boolean`	`isOnValidation()` Checks if is on validation.
`abstract boolean`	`isStandardExtendedLink()` Returns true if the extended link belongs to the XBRL 2.1 specification.
`void`	`removeDocumentation(XBRLDocumentation doc)` Removes the documentation.
`boolean`	`removeRelationship(XBRLRelationship relationship)` Removes the relationship.
`void`	`removeResource(XBRLResource resource)` This method removes a XBRLResource to the Extended Link container This method should not be used but the `XBRLResource.setRawParentXBRL(XMLFragment)` instead with null parameter that in turn calls this method when needed.
`void`	`resetHash()` Reset hash.
`void`	`setArcrolesMapCount(java.util.Map<java.lang.Integer,java.lang.Integer> arcroles)` This method is used during SAX paring phase to speedup reading the infoset later.
`void`	`setDTSBase(DTSBase base)` Sets the DTS base.
`void`	`setLocatorsByLabel(java.util.HashMap<java.lang.String,java.util.List<XBRLLocator>> cacheLocators)` This method is used by the SAX parser to add collected locators indexed by xlink:label.
`void`	`setRelationshipsByArcrole(java.util.Map<java.lang.String,java.util.List<XBRLArc>> relationshipsByArcroleMap)` This method is used by the SAX parser to add collected relationships indexed by arcrole.
`void`	`setResources(java.util.LinkedHashMap<java.lang.Integer,XBRLResource> resources)` This method is used by the SAX parser to add collected resources.
`void`	`setResourcesCache(java.util.HashMap<java.lang.String,java.util.List<XBRLResource>> cacheResources)` This method is used by the SAX parser to add collected resources indexed by xlink:label.
`void`	`setRole(java.lang.String newRole)` Sets the role.
`void`	`setRoleType(XBRLRoleType newRoleType)` Sets the role type on the extended link.
`void`	`setRoleTypeCode(int code)` This method sets the role type using the role code.
`XBRLValidationReport`	`validate(XBRLPlugInProcessor proc)` Validate.
`boolean`	`wouldBeDuplicateArc(XBRLRelationship rel)` Checks wether or not the relationship in the parameter will be a duplicate relationship in this extended link.

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, 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, 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, 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, setId, 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

Methods inherited from interface com.ihr.xbrl.om.XBRLDTSDocument
getContainer

Methods inherited from interface com.ihr.xbrl.om.exLinks.XBRLAllowsDocumentation
getContainer

- Field Detail
  - standard_role_URI
```
public static final java.lang.String standard_role_URI
```
    The standard role URI http://www.xbrl.org/2003/role/link
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDTSKey
```
public java.lang.Integer getDTSKey()
```
    Gets the DTS key.
    
    Specified by:
    
    getDTSKey in interface XBRLDTSDocument
    
    Returns:
    
    the DTS key
  - clear
```
public void clear()
           throws java.lang.Throwable
```
    Clear.
    
    Specified by:
    
    clear in interface XBRLDTSDocument
    
    Overrides:
    
    clear in class XLinkElement
    
    Throws:
    
    java.lang.Throwable - the throwable
  - getParentDocument
```
public XBRLDocument getParentDocument()
```
    Access to the [Parent] property.
    
    Overrides:
    
    getParentDocument in class XMLFragment
    
    Returns:
    
    XBRLDocument
  - setDTSBase
```
public void setDTSBase(DTSBase base)
                throws XBRLInconsistentDTSException
```
    Sets the DTS base.
    
    Parameters:
    
    base - the new DTS base
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent dts exception
  - getDTSBase
```
public DTSBase getDTSBase()
```
    Gets the DTS base.
    
    Returns:
    
    the DTS base
  - equals
```
public boolean equals(java.lang.Object other)
```
    Equals.
    
    Specified by:
    
    equals in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    equals in class XLinkElement
    
    Parameters:
    
    other - the other
    
    Returns:
    
    true, if successful
  - hashCode
```
public int hashCode()
```
    Hash code.
    
    Specified by:
    
    hashCode in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    hashCode in class XLinkElement
    
    Returns:
    
    the int
  - isHashDependsOnAtribute
```
public boolean isHashDependsOnAtribute(javax.xml.namespace.QName attributeName)
```
    Checks if is hash depends on atribute.
    
    Overrides:
    
    isHashDependsOnAtribute in class XLinkElement
    
    Parameters:
    
    attributeName - the attribute name
    
    Returns:
    
    true, if is hash depends on atribute
  - resetHash
```
public void resetHash()
```
    Reset hash.
  - createExtendedLink
```
public static XBRLExtendedLink createExtendedLink(XBRLDocument parent,
                                                  DTSBase base)
                                           throws XBRLInconsistentDTSException
```
    Creates the extended link.
    
    Parameters:
    
    parent - XBRLDocument
    
    base - DTSBase
    
    Returns:
    
    XBRLExtendedLink
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent dts exception
  - createExtendedLink
```
public static XBRLExtendedLink createExtendedLink(XBRLDocument parent,
                                                  javax.xml.namespace.QName rootElementName,
                                                  XBRLRoleType role)
                                           throws XBRLInconsistentDTSException
```
    Creates the extended link.
    
    Parameters:
    
    parent - the parent
    
    rootElementName - the root element name
    
    role - the role
    
    Returns:
    
    the XBRL extended link
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent dts exception
  - createExtendedLink
```
public static XBRLExtendedLink createExtendedLink(XBRLDocument parent,
                                                  net.sf.saxon.om.NodeInfo ni)
```
    Creates the extended link.
    
    Parameters:
    
    parent - the parent
    
    ni - the ni
    
    Returns:
    
    the XBRL extended link
  - getResourceClass
```
public abstract java.lang.Class<? extends XBRLResource> getResourceClass(net.sf.saxon.om.NodeInfo ni)
```
    Obtains a class that can be used to create a resource instance from the NodeInfo passed in the ni parameter.
    This method is internally used by the API
    
    Parameters:
    
    ni - the NodeInfo that is the source of the resource in the document
    
    Returns:
    
    the resource class
  - discoverDTS
```
public void discoverDTS(XBRLDTSDocument parent)
                 throws DTSDiscoveryException,
                        com.rs.lic.LicenseVerificationException
```
    Discover DTS.
    
    Specified by:
    
    discoverDTS in interface XBRLDTSDocument
    
    Parameters:
    
    parent - the parent
    
    Throws:
    
    DTSDiscoveryException - the DTS discovery exception
    
    com.rs.lic.LicenseVerificationException - the license verification exception
  - getStaticLinkbaseType
```
public abstract javax.xml.namespace.QName getStaticLinkbaseType()
```
    This function MUST be implemented by classes derived from this class.
    
    Returns:
    
    QName indicating the LinkbaseType like xbrli:footnoteLinkbase etc.
  - getExtendedLinkTypeName
```
public abstract java.lang.String getExtendedLinkTypeName()
```
    Returns a localized constant string indicating the extended link type
    
    Returns:
    
    String
    
    Since:
    
    2.6.10.31
  - getLinkbaseType
```
public javax.xml.namespace.QName getLinkbaseType()
```
    Access to the [linkbaseType] property This is the QName of the extended link element which is the root ot this extended link.
    
    Returns:
    
    QName
  - getDocumentation
```
public java.util.Iterator<XBRLDocumentation> getDocumentation()
```
    Access to the [Documentation] property.
    
    Returns:
    
    Iterator
  - addDocumentation
```
public void addDocumentation(XBRLDocumentation doc)
```
    Adds the documentation.
    
    Specified by:
    
    addDocumentation in interface XBRLAllowsDocumentation
    
    Parameters:
    
    doc - the doc
  - removeDocumentation
```
public void removeDocumentation(XBRLDocumentation doc)
```
    Removes the documentation.
    
    Specified by:
    
    removeDocumentation in interface XBRLAllowsDocumentation
    
    Parameters:
    
    doc - the doc
  - getAttributes
```
public java.util.Iterator<XBRLAttribute> getAttributes()
```
    Access to the [Attributes] property.
    
    Overrides:
    
    getAttributes in class XLinkElement
    
    Returns:
    
    Iterator
    
    See Also:
    
    XMLFragment.getAllAttributes()
  - getRoleType
```
public XBRLRoleType getRoleType()
```
    Access to the [Role Type] property of this object Validates this extended link QName in on the used on list of the roleType.
    
    Returns:
    
    XBRLRoleType
    
    Throws:
    
    XBRLRuntimeException - encapsulating XBRLValidationException if the role type is not in the target schema referenced by the content of the xlink:href attribute
  - setRoleType
```
public void setRoleType(XBRLRoleType newRoleType)
```
    Sets the role type on the extended link.
    
    Parameters:
    
    newRoleType - the new role type
  - setRoleTypeCode
```
public void setRoleTypeCode(int code)
```
    This method sets the role type using the role code. This method is called during the SAX parsing phase to accelerate DTSLoading
    
    Parameters:
    
    code - the new role type code
  - setRole
```
public void setRole(java.lang.String newRole)
```
    Sets the role.
    
    Overrides:
    
    setRole in class XLinkElement
    
    Parameters:
    
    newRole - the new role
  - setLocatorsByLabel
```
public void setLocatorsByLabel(java.util.HashMap<java.lang.String,java.util.List<XBRLLocator>> cacheLocators)
```
    This method is used by the SAX parser to add collected locators indexed by xlink:label.
    
    Parameters:
    
    cacheLocators - the cache locators
    
    Since:
    
    3.1
  - setResourcesCache
```
public void setResourcesCache(java.util.HashMap<java.lang.String,java.util.List<XBRLResource>> cacheResources)
```
    This method is used by the SAX parser to add collected resources indexed by xlink:label.
    
    Parameters:
    
    cacheResources - the cache resources
    
    Since:
    
    3.1
  - setRelationshipsByArcrole
```
public void setRelationshipsByArcrole(java.util.Map<java.lang.String,java.util.List<XBRLArc>> relationshipsByArcroleMap)
```
    This method is used by the SAX parser to add collected relationships indexed by arcrole.
    
    Parameters:
    
    relationshipsByArcroleMap - the relationships by arcrole map
    
    Since:
    
    3.1
  - getArcsByArcrole
```
public java.util.List<XBRLArc> getArcsByArcrole(java.lang.Integer arcrole)
```
    Gets the arcs by arcrole.
    
    Parameters:
    
    arcrole - the arcrole
    
    Returns:
    
    the arcs by arcrole
  - setResources
```
public void setResources(java.util.LinkedHashMap<java.lang.Integer,XBRLResource> resources)
```
    This method is used by the SAX parser to add collected resources.
    
    Parameters:
    
    resources - the resources
    
    Since:
    
    3.1
  - addRelationship
```
public boolean addRelationship(XBRLRelationship relationship)
                        throws XBRLInconsistentDTSException
```
    Adds the relationship.
    
    Parameters:
    
    relationship - the relationship
    
    Returns:
    
    true, if successful
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent dts exception
  - isStandardExtendedLink
```
public abstract boolean isStandardExtendedLink()
```
    Returns true if the extended link belongs to the XBRL 2.1 specification. This means it is a PresentationLinkbase, CalculationLinkbase, DefinitionLinkbase, LabelLinkbase, FootnoteLinkbase or ReferenceLinkbase
    
    Returns:
    
    a boolean value that is true for XBRL 2.1 extended links only
    
    Since:
    
    2.7.7
  - removeRelationship
```
public boolean removeRelationship(XBRLRelationship relationship)
                           throws XBRLInconsistentDTSException
```
    Removes the relationship.
    
    Parameters:
    
    relationship - the relationship
    
    Returns:
    
    true, if successful
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent dts exception
  - getFriendlyName
```
public java.lang.String getFriendlyName()
```
    Gets the friendly name.
    
    Overrides:
    
    getFriendlyName in class XMLFragment
    
    Returns:
    
    the friendly name
  - getArcroles
```
public java.util.Iterator<XBRLArcroleType> getArcroles()
```
    Access to all used arcroles. This resolves arcroleURI values to the correspodent arcroleType element The iterator contains XBRLArcroleType elements
    
    Returns:
    
    Iterator
  - setArcrolesMapCount
```
public void setArcrolesMapCount(java.util.Map<java.lang.Integer,java.lang.Integer> arcroles)
```
    This method is used during SAX paring phase to speedup reading the infoset later.
    
    Parameters:
    
    arcroles - the arcroles
  - getArcroleType
```
public XBRLArcroleType getArcroleType(java.lang.String arcrole)
```
    Returns the arcroleType of an arc on this extended link resolved using the corresponding arcroleRef element or the static definition in the specifications. Returns null if the arcrole is not used by relationships on this extended link (even for static arcroles).
    
    Parameters:
    
    arcrole - the arcrole
    
    Returns:
    
    the arcrole type
    
    Since:
    
    2.7.4
  - getRelationships
```
public java.util.Iterator<XBRLRelationship> getRelationships()
```
    Access to the [Relationships] information item.
    
    Returns:
    
    the relationships
  - getStandardResourceNodeNames
```
public abstract java.util.Collection<javax.xml.namespace.QName> getStandardResourceNodeNames()
```
    Returns a collection of resource node names that are allowed to exist on this extended link.
    
    Returns:
    
    collection of QNames, if no resources are allowed this is an empty collection of QNames
  - getStandardDefinedRolesOnResources
```
public abstract java.util.Collection<java.lang.String> getStandardDefinedRolesOnResources()
```
    Returns a collection of role URIs that the XBRL 2.1 standard defines to be used on resources on this extended link
    
    Returns:
    
    collection of strings
  - generateNode
```
public XBRLExtendedLink generateNode()
                              throws XBRLSerializationException
```
    Generate node.
    
    Overrides:
    
    generateNode in class XLinkElement
    
    Returns:
    
    the XBRL extended link
    
    Throws:
    
    XBRLSerializationException - the XBRL serialization exception
  - wouldBeDuplicateArc
```
public boolean wouldBeDuplicateArc(XBRLRelationship rel)
                            throws XBRLValidationException
```
    Checks wether or not the relationship in the parameter will be a duplicate relationship in this extended link.
    
    Parameters:
    
    rel - the relationship that is not in this link and will be tested
    
    Returns:
    
    true if this is the case
    
    Throws:
    
    XBRLValidationException - the XBRL validation exception
  - getArcs
```
public java.util.Iterator<XMLFragment> getArcs()
                                        throws XBRLValidationException
```
    Return an Iterator object over all arcs in the extended link. Arcs are not relationships. One arc may represent one or many relationships. Applications working with a DTS should use getRelationships instead. This method only serves applications that wants to access to the content of the extended link as it is serialized in the file. The Iterator over arcs is created each time this function is called.
    
    Returns:
    
    Iterator over XBRLArc objects
    
    Throws:
    
    XBRLValidationException - If there are unrecoverable XBRL errors in the arc
  - getResources
```
public java.util.Iterator<XBRLResource> getResources()
```
    Return an iterator over all resources that exist on this extended link.
    
    Returns:
    
    Iterator
  - getNumberOfResources
```
public int getNumberOfResources()
```
    Returns how many resources exists in this extended link.
    
    Returns:
    
    integer number
  - addResource
```
public void addResource(XBRLResource resource)
                 throws XBRLDuplicateException
```
    This method adds a XBRLResource to the Extended Link container.
    This method should not be used but the XBRLResource.setRawParentXBRL(XMLFragment) instead that in turn calls this method when needed
    
    Parameters:
    
    resource - the resource
    
    Throws:
    
    XBRLDuplicateException - the XBRL duplicate exception
  - removeResource
```
public void removeResource(XBRLResource resource)
```
    This method removes a XBRLResource to the Extended Link container
    This method should not be used but the XBRLResource.setRawParentXBRL(XMLFragment) instead with null parameter that in turn calls this method when needed.
    
    Parameters:
    
    resource - the resource
  - getLocators
```
public java.util.Iterator<XBRLLocator> getLocators()
```
    Access to all locators in an extended link. Locators are obtained form the locators cache that, in turn, are all locators in this extended link. Applications consuming the XBRL Infoset should not be used locators for anything. They are created automatically during the serialization phase. This method is here for applications that wants to access to the content of an extended link as it is serialized in an extended link.
    
    Returns:
    
    Iterator<XBRLLocator>
  - getElements
```
public java.util.Iterator<XMLFragment> getElements()
```
    Gets the elements.
    
    Overrides:
    
    getElements in class XMLFragment
    
    Returns:
    
    the elements
  - clearCaches
```
public void clearCaches()
```
    Used to clear memory used during the DTS loading process.
    For internal purposes only
    
    Since:
    
    2.6.8
  - getValidationReport
```
public XBRLValidationReport getValidationReport()
```
    Gets the validation report.
    
    Specified by:
    
    getValidationReport in interface XBRLValidation
    
    Returns:
    
    the 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
  - validate
```
public XBRLValidationReport validate(XBRLPlugInProcessor proc)
```
    Validate.
    
    Specified by:
    
    validate in interface XBRLValidation
    
    Parameters:
    
    proc - the proc
    
    Returns:
    
    the XBRL validation report
  - isOnValidation
```
public boolean isOnValidation()
```
    Checks if is on validation.
    
    Specified by:
    
    isOnValidation in interface XBRLValidation
    
    Returns:
    
    true, if is on validation
  - checkValidArcroleOnLink
```
public static boolean checkValidArcroleOnLink(XBRLArcroleType arcrole,
                                              javax.xml.namespace.QName baseType)
```
    This method checks if the arcrole can be used on the specified linkbase type according with the rules in the XBRL 2.1 specification. For example the parent-child arcrole can only be used on presentationArc relationships that must exists on presentationLink baseType.
    This method only checks for static information defined in the XBRL 2.1 specification.
    - If arcrole is not a standard arcrole the function returns true (valid combination)
    - If baseType os not a standard base type the function returns true (valid combination)
    - In any other case, the function returns true or false depending on the arcrole and baseTye
    Parameters:
    
    arcrole - the arcrole
    
    baseType - the base type
    
    Returns:
    
    true if the combination is well know to be valid as per XBRL 2.1 specification
  - checkCountOfRelationships
```
public void checkCountOfRelationships(java.lang.Integer arcrole)
```
    When the method to read arcroles on this extended link is called it explores relationships and declared arcroleRefs. It might be possible an extended link declares an arcroleRef that is not used by relationships. This method fix the counter of relationships and removes the reference to the arcrole if it is not required
    
    Parameters:
    
    arcrole - the arcrole
  - getResource
```
public XBRLResource getResource(java.lang.Integer resourceCode)
```
    Gets the resource.
    
    Parameters:
    
    resourceCode - the resource code
    
    Returns:
    
    the resource
  - 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

Class XBRLExtendedLink

Nested Class Summary

Nested classes/interfaces inherited from class com.ihr.xbrl.om.XMLFragment

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation

Field Summary

Fields inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

Fields inherited from class com.ihr.xbrl.om.XMLFragment

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl

Fields inherited from interface net.sf.saxon.om.NodeInfo

Method Summary

Methods inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

Methods inherited from class com.ihr.xbrl.om.XMLFragment

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

Methods inherited from class java.lang.Object

Methods inherited from interface com.ihr.xbrl.om.XBRLDTSDocument

Methods inherited from interface com.ihr.xbrl.om.exLinks.XBRLAllowsDocumentation

Field Detail

standard_role_URI

Method Detail

getDTSKey

clear

getParentDocument

setDTSBase

getDTSBase

equals

hashCode

isHashDependsOnAtribute

resetHash

createExtendedLink

createExtendedLink

createExtendedLink

getResourceClass

discoverDTS

getStaticLinkbaseType

getExtendedLinkTypeName

getLinkbaseType

getDocumentation

addDocumentation

removeDocumentation

getAttributes

getRoleType

setRoleType

setRoleTypeCode

setRole

setLocatorsByLabel

setResourcesCache

setRelationshipsByArcrole

getArcsByArcrole

setResources

addRelationship

isStandardExtendedLink

removeRelationship

getFriendlyName

getArcroles

setArcrolesMapCount

getArcroleType

getRelationships

getStandardResourceNodeNames

getStandardDefinedRolesOnResources

generateNode

wouldBeDuplicateArc

getArcs

getResources

getNumberOfResources

addResource

removeResource

getLocators

getElements

clearCaches

getValidationReport

invalidate

invalidate

validate

isOnValidation

checkValidArcroleOnLink

checkCountOfRelationships

getResource

hasChildNodes

getNumberOfChildren