com.ihr.xbrl.om.exLinks
Class GenericLinkbase

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.GenericLinkbase

All Implemented Interfaces:

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

public class GenericLinkbase
extends XBRLExtendedLink

Nested Class Summary

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation

XBRLValidation.Direction

Field Summary

static java.lang.String	element_label_arcrole_URI
static java.lang.String	element_reference_arcrole_URI
static java.lang.String	generic_documentation_label_role_URI
static javax.xml.namespace.QName	generic_label_resource
static java.lang.String	generic_label_role_URI
static javax.xml.namespace.QName	generic_reference_resource
static java.lang.String	generic_terse_label_role_URI
static java.lang.String	generic_verbose_label_role_URI
static javax.xml.namespace.QName	lbType This is just for the "standard" Generic Linkbase container.
static javax.xml.namespace.QName	standard_arc

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

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

GenericLinkbase(XBRLDocument parent, XBRLRoleType role)
Creates a new GenericLinkbase extended link container

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

Method Summary

java.lang.String	getExtendedLinkTypeName() Returns a localized constant string indicating the extended link type
java.lang.String	getGenLinkRole()
javax.xml.namespace.QName	getStaticLinkbaseType() This function MUST be implemented by classes derived from this class
boolean	isStandardExtendedLink() Returns true if the extended link belongs to the XBRL 2.1 specification.
void	setGenLinkRole(java.lang.String genLinkRole)

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

addDocumentation, addRelationship, addResource, clear, clearCaches, createExtendedLink, createExtendedLink, createExtendedLink, discoverDTS, equals, generateNode, getArcroles, getArcroleType, getArcs, getAttributes, getDocumentation, getDTSBase, getDTSKey, getElements, getFriendlyName, getLinkbaseType, getLocators, getNumberOfResources, getParent, getRelationships, getResources, getRoleType, getValidationReport, hashCode, invalidate, invalidate, isOnValidation, removeDocumentation, removeRelationship, removeResource, setDTSBase, setParent, setRole, setRoleType, validate, 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, getAttributeStringValue, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getContainerDocumentURI, getDeclaredNamespaces, getDocument, getFragment, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getLang, getNamespaceURI, getNodeName, getNumberOfAttributes, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathNamespaceContext, getXPathToNode, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, isDead, 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 just for the "standard" Generic Linkbase container. Custom linkbases uses this object but do not require lbType to be the container element

standard_arc

public static final javax.xml.namespace.QName standard_arc

generic_label_role_URI

public static final java.lang.String generic_label_role_URI

See Also:

Constant Field Values

generic_verbose_label_role_URI

public static final java.lang.String generic_verbose_label_role_URI

See Also:

Constant Field Values

generic_terse_label_role_URI

public static final java.lang.String generic_terse_label_role_URI

See Also:

Constant Field Values

generic_documentation_label_role_URI

public static final java.lang.String generic_documentation_label_role_URI

See Also:

Constant Field Values

element_label_arcrole_URI

public static final java.lang.String element_label_arcrole_URI

See Also:

Constant Field Values

element_reference_arcrole_URI

public static final java.lang.String element_reference_arcrole_URI

See Also:

Constant Field Values

generic_label_resource

public static final javax.xml.namespace.QName generic_label_resource

generic_reference_resource

public static final javax.xml.namespace.QName generic_reference_resource

Constructor Detail

GenericLinkbase

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

GenericLinkbase

public GenericLinkbase(XBRLDocument parent,
                       DTSBase base)
                throws XBRLInconsistentDTSException

Deprecated. use GenericLinkbase(XBRLDocument, XBRLRoleType) instead

Parameters:

parent - XBRLDocument

base - DTSBase

Throws:

XBRLInconsistentDTSException

GenericLinkbase

public GenericLinkbase(XBRLDocument parent,
                       XBRLRoleType role)

Creates a new GenericLinkbase extended link container

Parameters:

parent -

role -

Since:

2.6.5

Method Detail

getGenLinkRole

public java.lang.String getGenLinkRole()

Returns:

String

setGenLinkRole

public void setGenLinkRole(java.lang.String genLinkRole)

Parameters:

genLinkRole - String

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

isStandardExtendedLink

public boolean isStandardExtendedLink()

Description copied from class: XBRLExtendedLink

Returns true if the extended link belongs to the XBRL 2.1 specification. This means it is a PresentationLinkbase, CalculationLinkbase, DefinitionLinkbase, LabelLinkbase, FootnoteLinkbase or ReferenceLinkbase

Specified by:

isStandardExtendedLink in class XBRLExtendedLink

Returns:

a boolean value that is true for XBRL 2.1 extended links only