com.batavia.xbrl.taxonomy.xlink
Interface Labelled

All Superinterfaces:

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

All Known Subinterfaces:

DeclaredResource, Footnote, FootnoteLocator, Label, Locator, Reference, Resource

public interface Labelled
extends Xlink

Interface for labelled elements that reside in extended links.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

ExtendedLink	getParentLink() get the link this labelled element is contained by
java.lang.String	getReplacement() Get a replacement string for this labelled element for use in a PTVx file
XmlAttribute	getXlinkLabel()
void	setXlinkLabel(XmlAttribute xlinkLabel)

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, 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

getParentLink

ExtendedLink getParentLink()

get the link this labelled element is contained by

Returns:

ExtendedLink

getXlinkLabel

XmlAttribute getXlinkLabel()

Returns:

Returns the xlinkLabel.

setXlinkLabel

void setXlinkLabel(XmlAttribute xlinkLabel)

Parameters:

xlinkLabel - The xlinkLabel to set.

getReplacement

java.lang.String getReplacement()

Get a replacement string for this labelled element for use in a PTVx file

Returns:

String