com.batavia.xbrl.taxonomy.xlink
Interface Linkbase

All Superinterfaces:

java.lang.Comparable, ComparablePart, IdHolder, IdKeeper, java.io.Serializable, TaxonomyElement, org.relaxng.datatype.ValidationContext, XbrlElement, XmlBaseHolder, XmlElement, XmlParticle

All Known Subinterfaces:

LinkbaseRoot

public interface Linkbase
extends TaxonomyElement, IdHolder, XmlBaseHolder

The [XLINK] specification defines linkbases in the following way:

“documents containing collections of inbound and third-party links are called link databases, or linkbases” [XLINK] (http://www.w3.org/TR/2001/REC-xlink-20010627/#dt-linkbase).

While the syntax for concepts is defined in taxonomy schemas, the semantics of those concepts are defined in XBRL linkbases. Linkbases are extended links or they are elements that contain extended links. Linkbases MAY also contain documentation elements.

The linkbase element is intended to be used as a linkbase container.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	addArcroleRef(ArcroleRef aPart) Add the given ArcroleRef to the collection of ArcroleRef of this linkbase
void	addDocumentation(Documentation aPart) Add the given Documentation to the collection of Documentation of this linkbase
void	addRoleRef(RoleRef aPart) Add the given RoleRef to the collection of RoleRef of this linkbase
void	addXlink(ExtendedLink aPart) Add the given ExtendedLink to the collection of ExtendedLinks of this linkbase
ArcroleRef	createArcRoleRef(java.lang.String xlinkArcrole, java.lang.String xlinkHref, java.lang.String xlinkRole) Create a child ArcroleRef and add it to the XbrlElement.
Documentation	createDocumentation(java.lang.String value) Create a child Documentation and add it to the XbrlElement.
RoleRef	createRoleRef(java.lang.String xlinkArcrole, java.lang.String xlinkHref, java.lang.String xlinkRole) Create a child RoleRef and add it to the XbrlElement.
java.util.Collection	getArcroleRefs() get the collection of ArcroleRefs elements of this linkbase
java.util.Map	getArcroleRefsMap() get the collection of ArcroleRefs elements of this linkbase mapped to their uris
java.util.List	getDocumentations() get the collection of Documentation elements of this linkbase
XmlAttribute	getId()
RoleRef	getRoleRef(java.lang.String roleUri) get the RolRef that has the given rolUri if it is contained by this linkbase
java.util.Collection	getRoleRefs() get the collection of RoleRef elements of this linkbase
java.util.List	getXlinks() get the collection of ExtendedLinks of this linkbase
XmlAttribute	getXmlBase()
void	removeArcroleRef(ArcroleRef aPart) Remove the given ArcroleREf from the collection of ArcroleRef elements of this linkbase
void	removeDocumentation(Documentation aPart) Remove the given Documentation from the collection of Documentation elements of this linkbase
void	removeRoleRef(RoleRef aPart) Remove the given RoleRef from the collection of ReoleRef elements of this linkbase
void	removeXlink(ExtendedLink aPart) Remove the given ExtendedLink from the collection of ExtendedLinks of this linkbase
void	setId(XmlAttribute id)
void	setXmlBase(XmlAttribute xmlBase)

Methods inherited from interface com.batavia.xbrl.taxonomy.TaxonomyElement

getRoot, hasDecendantsWithAttribute, hasUnknownDecendants

Methods inherited from interface com.batavia.xbrl.XbrlElement

addChild, fromXbrl, getMyDiscoverableTaxonomySet, getXbrlElementNameSpace, removeChild, toXbrlStream, toXbrlString

Methods inherited from interface com.batavia.xml.XmlElement

addAttribute, addChild, addChildren, addComment, addMessage, addNameSpace, clearMessages, fromXml, getAttribute, getAttribute, getAttributeSet, getChild, getChildren, getChildren, getDefaultNameSpace, getDocumentHref, getErrorMessage, getFullyQualifiedNameValue, getMappedChildren, getMessages, getName, getNameSpace, getNameSpacePrefixes, getNameSpaces, getPointedElement, getValidXmlBase, getValue, getXmlElementNameSpace, getXmlRoot, isValid, moveChild, removeAttribute, removeChild, resolvePointedValue, resolvePointedXmlParticle, setAttributeValue, setChildren, setDocumentHref, setErrorMessage, setInit, setName, setTargetNameSpace, setValue, toXml, toXml, toXmlStream, toXmlString, toXstringBuffer, validate

Methods inherited from interface com.batavia.xml.XmlParticle

destroy, getBaseUri, getParent, getPrefix, getTargetNameSpace, isBoolean, isNumber, p_equal, resolveNamespacePrefix, setParent, toXstring

Methods inherited from interface com.batavia.xml.ComparablePart

c_equal, identical, s_equal, u_equal, v_equal, x_equal

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.relaxng.datatype.ValidationContext

isNotation, isUnparsedEntity

Methods inherited from interface com.batavia.xml.IdKeeper

addIdHolder, getHolder, removeIdHolder

Method Detail

createArcRoleRef

ArcroleRef createArcRoleRef(java.lang.String xlinkArcrole,
                            java.lang.String xlinkHref,
                            java.lang.String xlinkRole)

Create a child ArcroleRef and add it to the XbrlElement. Return it so that the caller can influence the childs value/children/attributes

Parameters:

arcrolUri -

Returns:

ArcroleRef new child that is already added to parent when returned

createDocumentation

Documentation createDocumentation(java.lang.String value)

Create a child Documentation and add it to the XbrlElement. Return it so that the caller can influence the childs value/children/attributes

Parameters:

value -

Returns:

Documentation new child that is already added to parent when returned

createRoleRef

RoleRef createRoleRef(java.lang.String xlinkArcrole,
                      java.lang.String xlinkHref,
                      java.lang.String xlinkRole)

Create a child RoleRef and add it to the XbrlElement. Return it so that the caller can influence the childs value/children/attributes

Parameters:

roleUri -

Returns:

RoleRef new child that is already added to parent when returned

getXlinks

java.util.List getXlinks()

get the collection of ExtendedLinks of this linkbase

Returns:

List

addXlink

void addXlink(ExtendedLink aPart)

Add the given ExtendedLink to the collection of ExtendedLinks of this linkbase

Parameters:

aPart -

removeXlink

void removeXlink(ExtendedLink aPart)

Remove the given ExtendedLink from the collection of ExtendedLinks of this linkbase

Parameters:

aPart -

getDocumentations

java.util.List getDocumentations()

get the collection of Documentation elements of this linkbase

Returns:

List

addDocumentation

void addDocumentation(Documentation aPart)

Add the given Documentation to the collection of Documentation of this linkbase

Parameters:

aPart -

removeDocumentation

void removeDocumentation(Documentation aPart)

Remove the given Documentation from the collection of Documentation elements of this linkbase

Parameters:

aPart -

getRoleRefs

java.util.Collection getRoleRefs()

get the collection of RoleRef elements of this linkbase

Returns:

List

addRoleRef

void addRoleRef(RoleRef aPart)

Add the given RoleRef to the collection of RoleRef of this linkbase

Parameters:

aPart -

removeRoleRef

void removeRoleRef(RoleRef aPart)

Remove the given RoleRef from the collection of ReoleRef elements of this linkbase

Parameters:

aPart -

removeArcroleRef

void removeArcroleRef(ArcroleRef aPart)

Remove the given ArcroleREf from the collection of ArcroleRef elements of this linkbase

Parameters:

aPart -

getId

XmlAttribute getId()

Specified by:

getId in interface IdHolder

Returns:

Returns the id.

getXmlBase

XmlAttribute getXmlBase()

Specified by:

getXmlBase in interface XmlBaseHolder

Returns:

Returns the xmlBase.

setId

void setId(XmlAttribute id)

Parameters:

id - The id to set.

setXmlBase

void setXmlBase(XmlAttribute xmlBase)

Parameters:

xmlBase - The xmlBase to set.

addArcroleRef

void addArcroleRef(ArcroleRef aPart)

Add the given ArcroleRef to the collection of ArcroleRef of this linkbase

Parameters:

aPart -

getRoleRef

RoleRef getRoleRef(java.lang.String roleUri)

get the RolRef that has the given rolUri if it is contained by this linkbase

Parameters:

roleUri -

Returns:

getArcroleRefs

java.util.Collection getArcroleRefs()

get the collection of ArcroleRefs elements of this linkbase

Returns:

Collection

getArcroleRefsMap

java.util.Map getArcroleRefsMap()

get the collection of ArcroleRefs elements of this linkbase mapped to their uris

Returns:

List