com.ihr.xbrl.om.exLinks
Class FootnoteLinkbase

java.lang.Object
  com.ihr.xbrl.om.XMLFragment
      com.ihr.xbrl.om.exLinks.XLinkElement
          com.ihr.xbrl.om.exLinks.XBRLExtendedLink
              com.ihr.xbrl.om.exLinks.FootnoteLinkbase

All Implemented Interfaces:

XBRLAllowsDocumentation, XBRLRelationshipPoint, XBRLDTSDocument, XMLHasParent, java.lang.Cloneable, javax.xml.namespace.NamespaceContext

public class FootnoteLinkbase
extends XBRLExtendedLink

Field Summary

static java.lang.String	fact_footnote_arcrole_URI The standard fact_footnote_arcrole_URI http://www.xbrl.org/2003/arcrole/fact-footnote
static java.lang.String	footnote_role_URI Standard footnote role URI to be used on link:footnote resources
static javax.xml.namespace.QName	lbResource This is the link:footnote QName
static javax.xml.namespace.QName	lbType This is the link:footnoteLink QName
static javax.xml.namespace.QName	standard_arc The QName link:footnoteArc

Fields inherited from class com.ihr.xbrl.om.exLinks.XBRLExtendedLink

standard_role_URI

Fields inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

actuate, ACTUATE, ARC, arcrole, ARCROLE, ETITLE, EXTENDED, from, FROM, href, HREF, label, LABEL, LOCATOR, RESOURCE, role, ROLE, show, SHOW, SIMPLE, title, TITLE, to, TO, type, TYPE

Fields inherited from class com.ihr.xbrl.om.XMLFragment

CONCEPT_LABEL, CONCEPT_QNAME, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, idQName, NO_POSITION, OrderComparator, PERIOD_TYPE, PERIOD_VALUE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Constructor Summary

FootnoteLinkbase(XBRLDocument parent, DTSBase base)
Deprecated. use FootnoteLinkbase(XBRLDocument, XBRLRoleType) instead

FootnoteLinkbase(XBRLDocument parent, XBRLRoleType role)
Creates a Footnote extended link

FootnoteLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)

Method Summary

java.lang.String	getExtendedLinkTypeName() Returns a localized constant string indicating the extended link type
javax.xml.namespace.QName	getStaticLinkbaseType() This function MUST be implemented by classes derived from this class
XBRLValidationReport	validate(XBRLCoreProcessor proc) Performs XLink valiadtion at the arcs level
void	validateNewRelationship(XBRLRelationship rel)

Methods inherited from class com.ihr.xbrl.om.exLinks.XBRLExtendedLink

addDocumentation, addRelationship, addResource, clear, clearCaches, createExtendedLink, createExtendedLink, createExtendedLink, discoverDTS, equals, generateNode, getArcroles, getArcs, getAttributes, getDocumentation, getDTSBase, getDTSKey, getElements, getFriendlyName, getLinkbaseType, getLocators, getNumberOfResources, getParent, getRelationships, getResources, getRoleType, hashCode, removeDocumentation, removeRelationship, removeResource, setDTSBase, setParent, setRole, setRoleType, wouldBeDuplicateArc

Methods inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

getActuate, getArcrole, getFromTxt, getHRef, getLabel, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo

Methods inherited from class com.ihr.xbrl.om.XMLFragment

addAttribute, addChild, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, clone, clone, delAttribute, delAttribute, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAttribute, getAttributeQNameValue, getAttributes, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getDeclaredNamespaces, getDocument, getFragment, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getId, getLang, getNamespaceURI, getNodeName, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathNamespaceContext, getXPathToNode, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, isNamespaceDefined, objEquals, objHashCode, qNameToString, removeAttribute, removeChild, removeChild, removeFromRelationship, removeToRelationship, removeXMLChild, resetElements, resetHash, resolveHRef, resolveHRef, s_equal2, s_equal2, setAttributes, setBase, setDocument, setDocumentAndReload, setElements, setId, setLang, setNamespaceContext, setNamespaces, setNode, setNodeName, setParent, setValue, setValue, setVariablesDefined, toString, valueEquals, xEqual

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ihr.xbrl.om.exLinks.XBRLAllowsDocumentation

getContainer

Methods inherited from interface com.ihr.xbrl.om.XMLHasParent

addXMLChild, getBase, removeXMLChild, setParent

Field Detail

lbType

public static final javax.xml.namespace.QName lbType

This is the link:footnoteLink QName

lbResource

public static final javax.xml.namespace.QName lbResource

This is the link:footnote QName

fact_footnote_arcrole_URI

public static final java.lang.String fact_footnote_arcrole_URI

The standard fact_footnote_arcrole_URI http://www.xbrl.org/2003/arcrole/fact-footnote

See Also:

Constant Field Values

standard_arc

public static final javax.xml.namespace.QName standard_arc

The QName link:footnoteArc

footnote_role_URI

public static final java.lang.String footnote_role_URI

Standard footnote role URI to be used on link:footnote resources

See Also:

Constant Field Values

Constructor Detail

FootnoteLinkbase

public FootnoteLinkbase(XBRLDocument parent,
                        net.sf.saxon.s9api.XdmNode node)

FootnoteLinkbase

public FootnoteLinkbase(XBRLDocument parent,
                        DTSBase base)
                 throws XBRLInconsistentDTSException

Deprecated. use FootnoteLinkbase(XBRLDocument, XBRLRoleType) instead

Parameters:

parent -

base -

Throws:

XBRLInconsistentDTSException

FootnoteLinkbase

public FootnoteLinkbase(XBRLDocument parent,
                        XBRLRoleType role)

Creates a Footnote extended link

Parameters:

parent - the XBRLInstance document where the extended link will be serialized (can be null)

role - the role type for the new FootnoteLinkase. Cannot be null.

Since:

2.6.5

Method Detail

validate

public XBRLValidationReport validate(XBRLCoreProcessor proc)

Description copied from class: XBRLExtendedLink

Performs XLink valiadtion at the arcs level

Overrides:

validate in class XBRLExtendedLink

getStaticLinkbaseType

public javax.xml.namespace.QName getStaticLinkbaseType()

Description copied from class: XBRLExtendedLink

This function MUST be implemented by classes derived from this class

Specified by:

getStaticLinkbaseType in class XBRLExtendedLink

Returns:

QName indicating the LinkbaseType like xbrli:footnoteLinkbase etc.

getExtendedLinkTypeName

public java.lang.String getExtendedLinkTypeName()

Description copied from class: XBRLExtendedLink

Returns a localized constant string indicating the extended link type

Specified by:

getExtendedLinkTypeName in class XBRLExtendedLink

Returns:

String

validateNewRelationship

public void validateNewRelationship(XBRLRelationship rel)
                             throws XBRLValidationException

Specified by:

validateNewRelationship in class XBRLExtendedLink

Throws:

XBRLValidationException