com.ihr.xbrl.om.exLinks

Class XBRLLinkbase

java.lang.Object

com.ihr.xbrl.om.XMLDocumentURI

com.ihr.xbrl.om.XBRLDocument

com.ihr.xbrl.om.exLinks.XBRLLinkbase

All Implemented Interfaces:

XBRLAllowsDocumentation, XBRLDTSDocument, XBRLHasDTSTarget, XBRLValidation, java.io.Serializable

public class XBRLLinkbase
extends XBRLDocument
implements java.io.Serializable, XBRLAllowsDocumentation

Provides the properties of the XBRL Linkbase information item

The [Parent] property is the parent class XBRLDocument

An XBRL Linkbase is just the container of documentation and extended links. The extended links contains the locators, arcs and resources that are connected with the concept definitions in the taxonomy. The Linkbase is just the container element.

According to the XBRL 2.1 specification an XBRL Linkbase can be the root element in a separate document (called external linkbases) or can exist inside an XML schema in xs:annotation/xs:appinfo/link:linkbase elements called embedded linkbases.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

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

XBRLDocument.LockInfo, XBRLDocument.XBRLDocumentType

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	linkbaseDocNode The Constant linkbaseDocNode.
static net.sf.saxon.om.StructuredQName	sqnLinkbaseDocNode The Constant sqnLinkbaseDocNode.

Constructor Summary

Constructors

Constructor and Description
XBRLLinkbase(DTSContainer dts, boolean isDynamic) Creates a XBRLLinkbase that will contain extended links created later.
XBRLLinkbase(DTSContainer dts, XBRLDocument parent) Creates a XBRLLinkbase that will contain extended links created later.
XBRLLinkbase(XBRLDocument parent) Creates a XBRLLinkbase that will contain extended links created later.
XBRLLinkbase(XBRLDocument parent, XMLDocumentURI combinedDocument) Creates a linkbase, the parent XBRLDocumentURI Item is an XBRL Taxonomy Used to create embedded linkbases, Parent is the parent taxonomy and XMLDocumentURI is the link:linkbase element.
XBRLLinkbase(XMLDocumentURI other, boolean bAddToCache) Creates a linkbase, the parent XBRLDocumentInformation Item is this object Used to create external linkbases.

Method Summary

Modifier and Type	Method and Description
void	addDocumentation(XBRLDocumentation newDoc) Adds a new XBRLDocumentation object to the array of documentation objects.
void	clear() Clear.
void	discoverDTS(XBRLDTSDocument parent) Discover DTS.
boolean	equals(java.lang.Object obj) Equals.
XMLDocumentImpl	generateDocNode() Generate doc node.
java.util.Iterator<XBRLDocumentation>	getDocumentation() Access to the [Documentation] property.
XBRLDocument.XBRLDocumentType	getDTSDocumentType() Gets the DTS document type.
java.lang.String	getDTSDocumentTypeName() Gets the DTS document type name.
java.lang.String	getId() Gets the id.
XBRLLinkbaseRef	getLinkbaseRef() Obtains an XBRLLinkbaseRef object pointing to this taxonomy.
XBRLLinkbaseRootNode	getLinkbaseRootNode() Gets the linkbase root node.
XBRLDocument	getParentDocument() Gets the parent document.
java.lang.String	getRoleRef() Returns a string representing the standard role for linkbaseRef elements pointing to this linkbase object.
int	hashCode() Hash code.
boolean	isEmbedded() Checks if is embedded.
void	readInfoset() Read infoset.
void	removeDocumentation(XBRLDocumentation doc) Removes a XBRLDocumentation object from the array of documentation objects of this linkbase.
void	setId(java.lang.String id) Sets the id.
void	setParent(XBRLDocument newParent) Sets the parent of this XBRLLinkbase to a new document.
void	setRootNode(XBRLLinkbaseRootNode linkbase) Sets the root node.

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

addComment, addIdOfElement, addIdOfElement, addParent, changeElementId, checkCleanDocumentInfo, createDocument, createDocument, createDocument, createDynamicDocument, delParent, generateId, getAllUsedIds, getComments, getDocumentInfo, getDTS, getElementById, getElementsById, getOrCreateTableId, getParents, getRoleRef, getTreeModel, isContentModified, isDynamic, isIdUsed, isOfficialURI, lock, registerChangeIdListener, registerChangeIdListener, release, removeComments, removeIdOfElement, removeIdOfElement, resolveURI, save, save, save, setComments, setLockInfo, setModified, setReadingInfoset, toString, unregisterChangeIdListener, unsetLockInfo, updateXML

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

addChild, delChild, evaluateList, getBase, getChildren, getContainer, getDocument, getDocumentRootNode, getDocumentURI, getDocumentURICode, getDTSDiscoveryInfo, getDTSKey, getFriendlyName, getLocalFile, getOldDocument, getPackageName, getPackageVersion, getPrefix, getPrefixes, getValidationReport, getXBRLDocumentInfo, getXPathToRoot, invalidate, invalidate, isInDTS, isOnValidation, setContainer, setDocumentURICode, setDTSDiscoveryInfo, setDTSKey, setNodeName, setRootNode, setURI, setXBRLDocumentInfo, validate

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getContainer

Field Detail

linkbaseDocNode

public static final javax.xml.namespace.QName linkbaseDocNode

The Constant linkbaseDocNode.

sqnLinkbaseDocNode

public static final net.sf.saxon.om.StructuredQName sqnLinkbaseDocNode

The Constant sqnLinkbaseDocNode.

Constructor Detail

XBRLLinkbase

public XBRLLinkbase(XMLDocumentURI other,
                    boolean bAddToCache)
             throws DTSDiscoveryException

Creates a linkbase, the parent XBRLDocumentInformation Item is this object Used to create external linkbases. The parent of this linkbase will be this document itself.

Parameters:

other - XMLDocumentURI

bAddToCache - boolean

Throws:

DTSDiscoveryException - the DTS discovery exception

XBRLLinkbase

public XBRLLinkbase(DTSContainer dts,
                    boolean isDynamic)

Creates a XBRLLinkbase that will contain extended links created later. Initially this is an external linkbase

Parameters:

dts - The DTSContainer object that will own this linkbase

isDynamic - true when the document is created programatically

XBRLLinkbase

public XBRLLinkbase(DTSContainer dts,
                    XBRLDocument parent)

Creates a XBRLLinkbase that will contain extended links created later. Sets the parent of the new linkbase to the document in the parent parameter.

For the creation of an embedded linkbase set parent parameter to the taxonomy where this linkbase will be embeded

For the creation of exetarnal taxonomies use null as the parent. The parent wil be set to this document so the linkbase will be external.

Parameters:

dts - The DTSContainer object that will own this linkbase

parent - the linkbase parent document

XBRLLinkbase

public XBRLLinkbase(XBRLDocument parent)

Creates a XBRLLinkbase that will contain extended links created later. Sets the parent to the document in the parameter.

This is the creator for the creation of an embedded linkbase set parent parameter to the taxonomy where this linkbase will be embedded

Parameters:

parent - Actually only the XBRLTaxonomy object where this linkbase will be embedded

XBRLLinkbase

public XBRLLinkbase(XBRLDocument parent,
                    XMLDocumentURI combinedDocument)
             throws DTSDiscoveryException

Creates a linkbase, the parent XBRLDocumentURI Item is an XBRL Taxonomy Used to create embedded linkbases, Parent is the parent taxonomy and XMLDocumentURI is the link:linkbase element.

Parameters:

parent - XBRLDocument

combinedDocument - XMLDocumentURI

Throws:

DTSDiscoveryException - the DTS discovery exception

Method Detail

clear

public void clear()
           throws java.lang.Throwable

Clear.

Specified by:

clear in interface XBRLDTSDocument

Overrides:

clear in class XBRLDocument

Throws:

java.lang.Throwable - the throwable

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class XBRLDocument

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Overrides:

equals in class XBRLDocument

Parameters:

obj - the obj

Returns:

true, if successful

getDTSDocumentType

public XBRLDocument.XBRLDocumentType getDTSDocumentType()

Gets the DTS document type.

Specified by:

getDTSDocumentType in class XBRLDocument

Returns:

the DTS document type

getDTSDocumentTypeName

public java.lang.String getDTSDocumentTypeName()

Gets the DTS document type name.

Specified by:

getDTSDocumentTypeName in class XBRLDocument

Returns:

the DTS document type name

setParent

public void setParent(XBRLDocument newParent)

Sets the parent of this XBRLLinkbase to a new document.

The parent is not informed about this change.

Parameters:

newParent - XBRLDocument

setRootNode

public void setRootNode(XBRLLinkbaseRootNode linkbase)

Sets the root node.

Parameters:

linkbase - the new root node

getId

public java.lang.String getId()

Gets the id.

Returns:

the id

setId

public void setId(java.lang.String id)
           throws XBRLInconsistentDTSException

Sets the id.

Parameters:

id - the new id

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent DTS exception

getParentDocument

public XBRLDocument getParentDocument()

Gets the parent document.

Returns:

the parent document

isEmbedded

public boolean isEmbedded()

Checks if is embedded.

Returns:

true if this linkbase root node corresponds with an embedded linkbase

getLinkbaseRef

public XBRLLinkbaseRef getLinkbaseRef()

Obtains an XBRLLinkbaseRef object pointing to this taxonomy. This method is used internally by the API.

Returns:

XBRLLinkbaseRef

getLinkbaseRootNode

public XBRLLinkbaseRootNode getLinkbaseRootNode()

Gets the linkbase root node.

Returns:

the linkbase root node

discoverDTS

public void discoverDTS(XBRLDTSDocument parent)
                 throws DTSDiscoveryException

Discover DTS.

Specified by:

discoverDTS in interface XBRLDTSDocument

Specified by:

discoverDTS in class XBRLDocument

Parameters:

parent - the parent

Throws:

DTSDiscoveryException - the DTS discovery exception

getDocumentation

public java.util.Iterator<XBRLDocumentation> getDocumentation()

Access to the [Documentation] property.

Returns:

Iterator<XBRLDocumentation>

addDocumentation

public void addDocumentation(XBRLDocumentation newDoc)

Adds a new XBRLDocumentation object to the array of documentation objects.

Specified by:

addDocumentation in interface XBRLAllowsDocumentation

Parameters:

newDoc - the new XBRLDocumentation to add

removeDocumentation

public void removeDocumentation(XBRLDocumentation doc)

Removes a XBRLDocumentation object from the array of documentation objects of this linkbase.

Specified by:

removeDocumentation in interface XBRLAllowsDocumentation

Parameters:

doc - the existing XBRLDocumentation to remove

readInfoset

public void readInfoset()
                 throws XBRLValidationException

Read infoset.

Specified by:

readInfoset in class XBRLDocument

Throws:

XBRLValidationException - the XBRL validation exception

getRoleRef

public java.lang.String getRoleRef()
                            throws XBRLSerializationException

Returns a string representing the standard role for linkbaseRef elements pointing to this linkbase object.

Returns:

a standard role ref or null if there are inconsistencies or it is not possible to obtain one

Throws:

XBRLSerializationException - the XBRL serialization exception

generateDocNode

public XMLDocumentImpl generateDocNode()
                                throws XBRLSerializationException

Generate doc node.

Specified by:

generateDocNode in class XBRLDocument

Returns:

the XML document impl

Throws:

XBRLSerializationException - the XBRL serialization exception