com.batavia.xbrl.taxonomy.xlink
Interface ExtendedLink

All Superinterfaces:

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

All Known Subinterfaces:

CalculationLink, DeclaredLink, DefinitionLink, FootnoteLink, LabelLink, LinkbaseExtendedLink, PresentationLink, ReferenceLink, RelationLink

public interface ExtendedLink
extends Xlink, IdHolder, XmlBaseHolder

Extended links are [XLINK] annotated XML fragments that document a set of relationships between resources.

XBRL extended links document relationships between resources that are XML fragments.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	addArc(Arc aPart) Add the given Arc to the collections of Arc elements off this link
void	addDocumentation(Documentation aPart) Add the given Documentation to the collection of Documentation elements of this link.
void	addLocator(Locator aPart) make sure the labelled locators can be found through their label multiple locators can have the same label
void	addResource(Resource aPart) make sure the labelled Resources can be found through their label multiple resources can have the same label
void	addTitle(Title aPart) Add the given title to the collection of title elements for this link
Arc	createArc(java.lang.String xlinkFrom, java.lang.String xlinkTo) Create a child Arc and add it to the XbrlElement.
Documentation	createDocumentation(java.lang.String value) Create a child Documentation and add it to the XbrlElement.
Locator	createLocator(java.lang.String xlinkHref) Create a child Locator and add it to the XbrlElement.
Title	createTitle(java.lang.String value) Create a child Title and add it to the XbrlElement.
java.util.List	getArcs() Get the collection of arcs off this link
java.util.List	getDocumentations() Get the collection of documentation elements for this link
XmlAttribute	getId()
Set	getLabelled(java.lang.String labelValue) Find the labelled fragments within this link
java.util.Map	getLocators() Get the collection of locators off this link, contained by lists of locators with the same label that are mapped by that label value.
java.util.List	getLocatorsList() Get the collection of locator elements off this link
java.util.Map	getResources() Get the collection of resources off this link, contained by lists of resources with the same label that are mapped by that label value.
java.util.List	getTitles() Get the collection of title elements for this link
XmlAttribute	getXlinkRole()
XmlAttribute	getXmlBase()
void	removeArc(Arc aPart) Remove the given Arc from the collections of Arc elements off this link
void	removeDocumentation(Documentation aPart) Remove the given Documentation from the collection of Documentation elements of this link.
void	removeLocator(Locator aPart) Remove the given Locator from this link
void	removeResource(Resource aPart) Remove the given resource from this link
void	removeTitle(Title aPart) Remove the given title from the collection of title elements for this link
void	setId(XmlAttribute id)
void	setXlinkRole(XmlAttribute xlinkRole)
void	setXmlBase(XmlAttribute xmlBase)
boolean	validate(ValidationDocument msgs) Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessages collection.

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

Method Detail

getLocatorsList

java.util.List getLocatorsList()

Get the collection of locator elements off this link

Returns:

List

createArc

Arc createArc(java.lang.String xlinkFrom,
              java.lang.String xlinkTo)

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

Parameters:

xlinkFrom -

xlinkTo -

Returns:

Arc 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

createLocator

Locator createLocator(java.lang.String xlinkHref)

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

Parameters:

xlinkHref -

Returns:

Locator new child that is already added to parent when returned

createTitle

Title createTitle(java.lang.String value)

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

Parameters:

value -

Returns:

Title new child that is already added to parent when returned

getDocumentations

java.util.List getDocumentations()

Get the collection of documentation elements for this link

Returns:

List

addDocumentation

void addDocumentation(Documentation aPart)

Add the given Documentation to the collection of Documentation elements of this link.

Parameters:

aPart -

removeDocumentation

void removeDocumentation(Documentation aPart)

Remove the given Documentation from the collection of Documentation elements of this link.

Parameters:

aPart -

getTitles

java.util.List getTitles()

Get the collection of title elements for this link

Returns:

List

addTitle

void addTitle(Title aPart)

Add the given title to the collection of title elements for this link

Parameters:

aPart -

removeTitle

void removeTitle(Title aPart)

Remove the given title from the collection of title elements for this link

Parameters:

aPart -

getLocators

java.util.Map getLocators()

Get the collection of locators off this link, contained by lists of locators with the same label that are mapped by that label value.

Returns:

Map

addLocator

void addLocator(Locator aPart)

make sure the labelled locators can be found through their label multiple locators can have the same label

getLabelled

Set getLabelled(java.lang.String labelValue)

Find the labelled fragments within this link

Parameters:

labelValue -

Returns:

removeLocator

void removeLocator(Locator aPart)

Remove the given Locator from this link

Parameters:

aPart -

getResources

java.util.Map getResources()

Get the collection of resources off this link, contained by lists of resources with the same label that are mapped by that label value.

Returns:

Map

addResource

void addResource(Resource aPart)

make sure the labelled Resources can be found through their label multiple resources can have the same label

removeResource

void removeResource(Resource aPart)

Remove the given resource from this link

Parameters:

aPart -

getArcs

java.util.List getArcs()

Get the collection of arcs off this link

Returns:

List

addArc

void addArc(Arc aPart)

Add the given Arc to the collections of Arc elements off this link

Parameters:

aPart -

removeArc

void removeArc(Arc aPart)

Remove the given Arc from the collections of Arc elements off this link

Parameters:

aPart -

getId

XmlAttribute getId()

Specified by:

getId in interface IdHolder

Returns:

Returns the id.

setId

void setId(XmlAttribute id)

Parameters:

id - The id to set.

getXlinkRole

XmlAttribute getXlinkRole()

Returns:

Returns the xlinkRole.

setXlinkRole

void setXlinkRole(XmlAttribute xlinkRole)

Parameters:

xlinkRole - The xlinkRole to set.

getXmlBase

XmlAttribute getXmlBase()

Specified by:

getXmlBase in interface XmlBaseHolder

Returns:

Returns the xmlBase.

setXmlBase

void setXmlBase(XmlAttribute xmlBase)

Parameters:

xmlBase - The xmlBase to set.

validate

boolean validate(ValidationDocument msgs)

Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessages collection.

Specified by:

validate in interface XmlElement

Parameters:

msgs - The messages that indicate the problems with the instance and or its supporting taxonomy set

Returns:

true if there ar no problems with this XbrlElementImpl