com.batavia.xbrl.taxonomy
Interface LinkbaseExtendedLink

All Superinterfaces:
java.lang.Comparable, ComparablePart, ExtendedLink, IdHolder, IdKeeper, LinkbaseContainer, java.io.Serializable, TaxonomyElement, org.relaxng.datatype.ValidationContext, XbrlElement, Xlink, XmlBaseHolder, XmlElement, XmlParticle

public interface LinkbaseExtendedLink
extends ExtendedLink, LinkbaseContainer

Interface for linkbase. This Linkbase IS An EXTENDEDLINK IN A SCHEMA ROOT and knows what types of extended links to expect in Taxonomy Linkbases.

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 elements for this linkbase.
 void addDocumentation(Documentation aPart)
          Add the given Documentation to the collection of Documentation elements for this linkbase.
 void addRoleRef(RoleRef aPart)
          Add the given RoleRef to the collection of RoleRef elements for this linkbase.
 void addXlink(ExtendedLink aPart)
          Add the given ExtendedLink to the collection of Xlink elements for this linkbase.
 ArcroleRef getArcroleRef(java.lang.String arcXlinkArcrole)
          Get the arcroleRef that hase the given roleUri.
 java.util.Collection getArcroleRefs()
          get the collection of ArcroleRef elements for this linkbase.
 java.util.List getDocumentations()
          get the collection of Documentation elements for this linkbase.
 RoleRef getRoleRef(java.lang.String roleUri)
          Get the RoleRef that hase the given roleUri.
 java.util.Collection getRoleRefs()
          get the collection of RoleRef elements for this linkbase.
 java.util.List getXlinks()
          get the collection of Xlink elements for this linkbase.
 void removeArcroleRef(ArcroleRef aPart)
          Remove the given ArcroleRef to the collection of ArcroleRef elements for this linkbase.
 void removeDocumentation(Documentation aPart)
          Remove the given Documentation from the collection of Documentation elements for this linkbase.
 void removeRoleRef(RoleRef aPart)
          Remove the given RoleRef to the collection of RoleRef elements for this linkbase.
 void removeXlink(ExtendedLink aPart)
          Remove the given ExtendedLink to the collection of Xlink elements for this linkbase.
 
Methods inherited from interface com.batavia.xbrl.taxonomy.xlink.ExtendedLink
addArc, addLocator, addResource, addTitle, createArc, createDocumentation, createLocator, createTitle, getArcs, getId, getLabelled, getLocators, getLocatorsList, getResources, getTitles, getXlinkRole, getXmlBase, removeArc, removeLocator, removeResource, removeTitle, setId, setXlinkRole, setXmlBase, validate
 
Methods inherited from interface com.batavia.xbrl.taxonomy.xlink.Xlink
getLinkbaseContainer, getXlinkType, setXlinkType
 
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
 
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
 
Methods inherited from interface com.batavia.xbrl.taxonomy.LinkbaseContainer
validate
 

Method Detail

addDocumentation

void addDocumentation(Documentation aPart)
Add the given Documentation to the collection of Documentation elements for this linkbase.

Specified by:
addDocumentation in interface ExtendedLink
Parameters:
Documentation -

addXlink

void addXlink(ExtendedLink aPart)
Add the given ExtendedLink to the collection of Xlink elements for this linkbase.

Parameters:
ExtendedLink -

getDocumentations

java.util.List getDocumentations()
get the collection of Documentation elements for this linkbase.

Specified by:
getDocumentations in interface ExtendedLink
Specified by:
getDocumentations in interface LinkbaseContainer
Returns:
List

getXlinks

java.util.List getXlinks()
get the collection of Xlink elements for this linkbase.

Specified by:
getXlinks in interface LinkbaseContainer
Returns:
List

removeDocumentation

void removeDocumentation(Documentation aPart)
Remove the given Documentation from the collection of Documentation elements for this linkbase.

Specified by:
removeDocumentation in interface ExtendedLink
Parameters:
Documentation -

removeXlink

void removeXlink(ExtendedLink aPart)
Remove the given ExtendedLink to the collection of Xlink elements for this linkbase.

Parameters:
ExtendedLink -

getRoleRefs

java.util.Collection getRoleRefs()
get the collection of RoleRef elements for this linkbase.

Specified by:
getRoleRefs in interface LinkbaseContainer
Returns:
List

addRoleRef

void addRoleRef(RoleRef aPart)
Add the given RoleRef to the collection of RoleRef elements for this linkbase.

Parameters:
RoleRef -

removeRoleRef

void removeRoleRef(RoleRef aPart)
Remove the given RoleRef to the collection of RoleRef elements for this linkbase.

Parameters:
RoleRef -

getRoleRef

RoleRef getRoleRef(java.lang.String roleUri)
Get the RoleRef that hase the given roleUri.

Specified by:
getRoleRef in interface LinkbaseContainer
Returns:
RoleRef

getArcroleRefs

java.util.Collection getArcroleRefs()
get the collection of ArcroleRef elements for this linkbase.

Specified by:
getArcroleRefs in interface LinkbaseContainer
Returns:
List

addArcroleRef

void addArcroleRef(ArcroleRef aPart)
Add the given ArcroleRef to the collection of ArcroleRef elements for this linkbase.

Parameters:
ArcroleRef -

removeArcroleRef

void removeArcroleRef(ArcroleRef aPart)
Remove the given ArcroleRef to the collection of ArcroleRef elements for this linkbase.

Parameters:
ArcroleRef -

getArcroleRef

ArcroleRef getArcroleRef(java.lang.String arcXlinkArcrole)
Get the arcroleRef that hase the given roleUri.

Specified by:
getArcroleRef in interface LinkbaseContainer
Returns:
ArcroleRef