com.batavia.xbrl.taxonomy.xlink
Interface Xlink

All Superinterfaces:

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

All Known Subinterfaces:

Arc, ArcroleRef, CalculationArc, CalculationLink, DeclaredArc, DeclaredLink, DeclaredResource, DefinitionArc, DefinitionLink, Documentation, ExtendedLink, Footnote, FootnoteArc, FootnoteLink, FootnoteLocator, Label, LabelArc, Labelled, LabelLink, LinkbaseExtendedLink, LinkbaseRef, LinkbaseRef, Locator, PresentationArc, PresentationLink, Reference, ReferenceArc, ReferenceLink, RelationLink, Resource, RoleRef, SchemaRef, SimpleLink, Title, UnknownXlink

public interface Xlink
extends TaxonomyElement

Links between XML fragments occur in many forms in XBRL.

There are links between XBRL instances and their supporting DTS. There are links between XBRL instance facts and the footnotes that describe relationships between those facts. There are links between concept syntax definitions and their semantics, defined in linkbases. The semantics themselves are expressed in the networks of links that constitute the linkbases. XBRL expresses all of these links using the syntax defined in the XLink specification [XLINK]. XBRL uses both the simple links and the extended links defined in the [XLINK] specification.

The [XLINK] specification establishes the syntax and semantics for a set of attributes in the [XLINK] namespace, http://www.w3.org/1999/xlink. These attributes can then be used on elements defined in another namespace to document various kinds of links between XML fragments. Many of these attributes are used extensively in XBRL. Others have no semantics that are relevant to the links defined by XBRL. These attributes are permitted by the XML Schema syntax constraints but they are not documented or given any specific semantics in this specification. Examples include the xlink:show and the xlink:actuate attributes.

This section documents the generic forms of the simple links and the extended links used in XBRL. Specific elements that use the simple link or extended link syntax are documented in detail in the relevant sections of this specification dealing with the syntax of XBRL instances or the syntax of XBRL taxonomies.

The syntax of the generic [XLINK] structures used by XBRL is constrained by two XML Schemas: the xlink-2003-12-31.xsd (normative) that defines the syntax for the [XLINK] attributes; and the xl-2003-12-31.xsd (normative) that defines the content models for the various kinds of link-related elements defined by this specification.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

LinkbaseContainer	getLinkbaseContainer() get the linkbasecontainer this xlink element is contained by
XmlAttribute	getXlinkType() Get the xlink:type attribute
void	setXlinkType(XmlAttribute xlinkType) Set the xlink:type attribute

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

getXlinkType

XmlAttribute getXlinkType()

Get the xlink:type attribute

Returns:

XmlAttribute

setXlinkType

void setXlinkType(XmlAttribute xlinkType)

Set the xlink:type attribute

Parameters:

XmlAttribute -

getLinkbaseContainer

LinkbaseContainer getLinkbaseContainer()

get the linkbasecontainer this xlink element is contained by

Returns:

LinkbaseContainer