com.batavia.xbrl.taxonomy.xlink
Interface Locator

All Superinterfaces:

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

All Known Subinterfaces:

FootnoteLocator

public interface Locator
extends Labelled

Locators are child elements of an extended link that point to resources external to the extended link itself. All XBRL extended links MAY contain locators.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	addTitle(Title aPart) Add the given title to this locaotr
Title	createTitle(java.lang.String value) Create a child Title and add it to the XbrlElement.
java.lang.String	getAbsoluteXlinkHref()
java.util.List	getTitles() Get the collection of title elements for this locator
void	removeTitle(Title aPart) remove the given title form this locator
void	setXlinkHref(XmlAttribute xlinkHref)

Methods inherited from interface com.batavia.xbrl.taxonomy.xlink.Labelled

getParentLink, getReplacement, getXlinkLabel, setXlinkLabel

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

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

getTitles

java.util.List getTitles()

Get the collection of title elements for this locator

Returns:

List

addTitle

void addTitle(Title aPart)

Add the given title to this locaotr

Parameters:

aPart -

removeTitle

void removeTitle(Title aPart)

remove the given title form this locator

Parameters:

aPart -

setXlinkHref

void setXlinkHref(XmlAttribute xlinkHref)

Parameters:

xlinkHref - The xlinkHref to set.

getAbsoluteXlinkHref

java.lang.String getAbsoluteXlinkHref()

Returns:

Returns the xlinkHref complete with the xml:base.