com.batavia.xbrl.taxonomy.xlink
Interface Arc

All Superinterfaces:

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

All Known Subinterfaces:

CalculationArc, DeclaredArc, DefinitionArc, FootnoteArc, LabelArc, PresentationArc, ReferenceArc

public interface Arc
extends Xlink

All XBRL extended links MAY contain arcs.

Arcs document relationships between resources identified by locators in extended links or occurring as resources in extended links.

Arcs join the elements referenced in their [XLINK] attributes: xlink:from and xlink:to. These two attributes contain the xlink:label attribute values of either locators or resources within the same extended link as the arc itself. The relationship documented by an arc is a relationship running from the resource or locator identified by the xlink:from attribute to the resource or locator identified by the xlink:to attribute.

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 the collection of title elements of this arc
XmlAttribute	getOrder()
ExtendedLink	getParentLink()
FullyQualifiedName	getParentLinkName() Get the name off the link this arc is contained by
XmlAttribute	getParentXlinkRole() Get the xlink:role attribute from the link this arc is contained by
XmlAttribute	getPriority()
int	getPriorityInt() Get the value of the priority attribute as an int
java.util.List	getTitles() Get the collection of title elements of this arc
XmlAttribute	getUse()
XmlAttribute	getXlinkArcrole()
XmlAttribute	getXlinkFrom()
XmlAttribute	getXlinkTo()
boolean	isDuplicate(Arc other) same xlink:from and xlink:to is duplicate
boolean	isProhibiting() Determine if this arc is prohibiting based on the prohibited attribute value.
void	removeTitle(Title aPart) Remove the given title from the collection of title elements of this arc
void	setOrder(XmlAttribute order)
void	setPriority(XmlAttribute priority)
void	setUse(XmlAttribute use)
void	setXlinkArcrole(XmlAttribute xlinkArcrole)
void	setXlinkFrom(XmlAttribute xlinkFrom)
void	setXlinkTo(XmlAttribute xlinkTo)
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

getParentLinkName

FullyQualifiedName getParentLinkName()

Get the name off the link this arc is contained by

Returns:

FullyQualifiedName

getParentXlinkRole

XmlAttribute getParentXlinkRole()

Get the xlink:role attribute from the link this arc is contained by

Returns:

XmlAttribute

getTitles

java.util.List getTitles()

Get the collection of title elements of this arc

Returns:

List

addTitle

void addTitle(Title aPart)

Add the given title to the collection of title elements of this arc

Parameters:

aPart -

removeTitle

void removeTitle(Title aPart)

Remove the given title from the collection of title elements of this arc

Parameters:

aPart -

getOrder

XmlAttribute getOrder()

Returns:

Returns the order.

setOrder

void setOrder(XmlAttribute order)

Parameters:

order - The order to set.

getPriority

XmlAttribute getPriority()

Returns:

Returns the priority.

getPriorityInt

int getPriorityInt()

Get the value of the priority attribute as an int

Returns:

int

isProhibiting

boolean isProhibiting()

Determine if this arc is prohibiting based on the prohibited attribute value.

Returns:

boolean

setPriority

void setPriority(XmlAttribute priority)

Parameters:

priority - The priority to set.

getUse

XmlAttribute getUse()

Returns:

Returns the use.

setUse

void setUse(XmlAttribute use)

Parameters:

use - The use to set.

getXlinkArcrole

XmlAttribute getXlinkArcrole()

Returns:

Returns the xlinkArcrole.

setXlinkArcrole

void setXlinkArcrole(XmlAttribute xlinkArcrole)

Parameters:

xlinkArcrole - The xlinkArcrole to set.

getXlinkFrom

XmlAttribute getXlinkFrom()

Returns:

Returns the xlinkFrom.

setXlinkFrom

void setXlinkFrom(XmlAttribute xlinkFrom)

Parameters:

xlinkFrom - The xlinkFrom to set.

getXlinkTo

XmlAttribute getXlinkTo()

Returns:

Returns the xlinkTo.

setXlinkTo

void setXlinkTo(XmlAttribute xlinkTo)

Parameters:

xlinkTo - The xlinkTo to set.

getParentLink

ExtendedLink getParentLink()

Returns:

Returns the parentLink.

isDuplicate

boolean isDuplicate(Arc other)

same xlink:from and xlink:to is duplicate

Parameters:

other -

Returns:

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