com.ihr.xbrl.om.exLinks

Class PresentationLinkbase

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.exLinks.XLinkElement

com.ihr.xbrl.om.exLinks.XBRLExtendedLink

com.ihr.xbrl.om.exLinks.PresentationLinkbase

All Implemented Interfaces:

HasDTSContainer, XBRLAllowsDocumentation, XBRLRelationshipPoint, HasChangeHashSupport, XBRLDTSDocument, XBRLValidation, java.io.Serializable, java.lang.Cloneable, javax.xml.namespace.NamespaceContext, javax.xml.transform.Source, javax.xml.transform.SourceLocator, net.sf.saxon.evpull.PullEvent, net.sf.saxon.om.FingerprintedNode, net.sf.saxon.om.Item, net.sf.saxon.om.MutableNodeInfo, net.sf.saxon.om.NamespaceResolver, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>, net.sf.saxon.tree.wrapper.SiblingCountingNode

public class PresentationLinkbase
extends XBRLExtendedLink
implements java.io.Serializable

The Class PresentationLinkbase.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ihr.xbrl.om.XMLFragment

XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>

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

XBRLValidation.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	lbType link:presentationLink.
static java.lang.String	parent_child_arcrole_URI http://www.xbrl.org/2003/arcrole/parent-child
static javax.xml.namespace.QName	preferredLabel This is the attribute name preferredLabel that may exist on presentation arcs.
static net.sf.saxon.om.StructuredQName	sqnLbType The Constant sqnLbType.
static javax.xml.namespace.QName	standard_arc link:presentationArc.
static java.lang.String	standard_role_ref http://www.xbrl.org/2003/role/presentationLinkbaseRef

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

standard_role_URI

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

actuate, ARC, arcrole, ETITLE, EXTENDED, from, href, label, LOCATOR, RESOURCE, role, show, SIMPLE, title, to, type, X_ACTUATE, X_ARCROLE, X_FROM, X_HREF, X_LABEL, X_ROLE, X_SHOW, X_TITLE, X_TO, X_TYPE, XLINKPREFIX

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

ADD_NAMESPACE_INHERIT, baseQName, CONCEPT_LABEL, CONCEPT_QNAME, EASY_TO_READ, ELEMENT_LABEL, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, FACT_VALUE, HIDE_COMMON_ACCURACY, idQName, langQName, nil, NO_POSITION, OrderComparator, OrderComparator2, OrderComparatorReverse, PERIOD_BOP, PERIOD_TYPE, PERIOD_VALUE, RELATIONSHIP_TYPE, RESOURCE_TYPE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl

NODE_LETTER

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
PresentationLinkbase(XBRLDocument parent, DTSBase base) Deprecated. use PresentationLinkbase(XBRLDocument, XBRLRoleType) instead
PresentationLinkbase(XBRLDocument parent, XBRLRoleType role) Creates a new PresentationLinkbase extended link container.
PresentationLinkbase(XMLFragment node) Instantiates a new presentation linkbase.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
PresentationLinkbase	clone() Clone.
PresentationLinkbase	clone(DTSContainer newDTS) Clone.
java.lang.String	getExtendedLinkTypeName() Gets the extended link type name.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
static XBRLRoleType	getPreferredLabel(XBRLRelationship rel) If the relationship rel contains an attribute preferredLabel this method returns the XBRLRoleType indicated.
java.lang.Class<? extends XBRLResource>	getResourceClass(net.sf.saxon.om.NodeInfo ni) Gets the resource class.
java.util.Collection<java.lang.String>	getStandardDefinedRolesOnResources() Gets the standard defined roles on resources.
java.util.Collection<javax.xml.namespace.QName>	getStandardResourceNodeNames() Gets the standard resource node names.
javax.xml.namespace.QName	getStaticLinkbaseType() Gets the static linkbase type.
boolean	hasChildNodes()
boolean	isStandardExtendedLink() Checks if is standard extended link.

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

addDocumentation, addRelationship, addResource, checkCountOfRelationships, checkValidArcroleOnLink, clearCaches, createExtendedLink, createExtendedLink, createExtendedLink, discoverDTS, equals, generateNode, getArcroles, getArcroleType, getArcs, getArcsByArcrole, getAttributes, getDocumentation, getDTSBase, getDTSKey, getElements, getFriendlyName, getLinkbaseType, getLocators, getNumberOfResources, getParentDocument, getRelationships, getResource, getResources, getRoleType, getValidationReport, hashCode, invalidate, invalidate, isHashDependsOnAtribute, isOnValidation, removeDocumentation, removeRelationship, removeResource, resetHash, setArcrolesMapCount, setDTSBase, setLocatorsByLabel, setRelationshipsByArcrole, setResources, setResourcesCache, setRole, setRoleType, setRoleTypeCode, validate, wouldBeDuplicateArc

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

getActuate, getArcrole, getFromTxt, getHRef, getHRefDocument, getHRefDocumentResolved, getHRefResolved, getLabel, getRawHRef, getReference, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo, validateXPointer

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

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addChild, addChildArray, addChildAt, addChildNode, addChildNodeArray, addChildNodeAt, addChildNodeInBatch, addComment, addFromRelationship, addNamespace, addNamespace, addPropertyChangeListener, addToRelationship, changeBase, checkBase, childExists, commitBatch, copy, createComment, delAttribute, delAttribute, delete, equalXdmValues, findFirstNodeOfClass, findPosition, firePropertyChangeEvent, generateId, generateLocatorToNode, generatePrefix, getAllAttributes, getAttribute, getAttributeAtomicValue, getAttributeBooleanValue, getAttributeGroundedValue, getAttributeQNameValue, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getContainerDocumentURI, getDocument, getElement, getElement, getFirstChildNoComment, getFragment, getFriendlyName, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentXBRL, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isNamespaceDefined, isNil, moveNamespacesUp, objEquals, objHashCode, reindex, removeChild, removeChildNode, removeFromRelationship, removeNamespace, removePropertyChangeListener, removeToRelationship, replace, replaceChild, replaceStringValue, resetElements, resolveHRef, s_equal2_xp2, s_equal2_xp2, s_equal2, s_equal2, s_equal2, s_equal2, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setId, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setRawParentXBRL, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, valueEquals, xEqual

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl

addAttribute, addNamespace, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, isId, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, setLocation, setNameCode, setNamespaceList, setSystemId, setTypeAnnotation

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

atomize, compareOrder, comparePosition, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getSuccessorElement, getURI, head, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterate, iterateAxis, iterateAxis, newBuilder, replace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getContainer

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

getContainer

Field Detail

parent_child_arcrole_URI

public static final java.lang.String parent_child_arcrole_URI

http://www.xbrl.org/2003/arcrole/parent-child

See Also:

Constant Field Values

lbType

public static final javax.xml.namespace.QName lbType

link:presentationLink.

sqnLbType

public static final net.sf.saxon.om.StructuredQName sqnLbType

The Constant sqnLbType.

standard_arc

public static final javax.xml.namespace.QName standard_arc

link:presentationArc.

standard_role_ref

public static final java.lang.String standard_role_ref

http://www.xbrl.org/2003/role/presentationLinkbaseRef

See Also:

Constant Field Values

preferredLabel

public static final javax.xml.namespace.QName preferredLabel

This is the attribute name preferredLabel that may exist on presentation arcs.

Constructor Detail

PresentationLinkbase

public PresentationLinkbase(XMLFragment node)

Instantiates a new presentation linkbase.

Parameters:

node - the node

PresentationLinkbase

public PresentationLinkbase(XBRLDocument parent,
                            DTSBase base)
                     throws XBRLInconsistentDTSException

Deprecated. use PresentationLinkbase(XBRLDocument, XBRLRoleType) instead

Instantiates a new presentation linkbase.

Parameters:

parent - XBRLDocument

base - DTSBase

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent dts exception

PresentationLinkbase

public PresentationLinkbase(XBRLDocument parent,
                            XBRLRoleType role)

Creates a new PresentationLinkbase extended link container.

Parameters:

parent - the parent

role - the role

Since:

2.6.5

Method Detail

getPreferredLabel

public static XBRLRoleType getPreferredLabel(XBRLRelationship rel)

If the relationship rel contains an attribute preferredLabel this method returns the XBRLRoleType indicated. Otherwise, the standard role is returned.

Parameters:

rel - the rel

Returns:

the role that shall be used to obtain a label for the relationship target element

getStaticLinkbaseType

public javax.xml.namespace.QName getStaticLinkbaseType()

Gets the static linkbase type.

Specified by:

getStaticLinkbaseType in class XBRLExtendedLink

Returns:

the static linkbase type

getExtendedLinkTypeName

public java.lang.String getExtendedLinkTypeName()

Gets the extended link type name.

Specified by:

getExtendedLinkTypeName in class XBRLExtendedLink

Returns:

the extended link type name

getResourceClass

public java.lang.Class<? extends XBRLResource> getResourceClass(net.sf.saxon.om.NodeInfo ni)

Gets the resource class.

Specified by:

getResourceClass in class XBRLExtendedLink

Parameters:

ni - the ni

Returns:

the resource class

isStandardExtendedLink

public boolean isStandardExtendedLink()

Checks if is standard extended link.

Specified by:

isStandardExtendedLink in class XBRLExtendedLink

Returns:

true, if is standard extended link

getStandardResourceNodeNames

public java.util.Collection<javax.xml.namespace.QName> getStandardResourceNodeNames()

Gets the standard resource node names.

Specified by:

getStandardResourceNodeNames in class XBRLExtendedLink

Returns:

the standard resource node names

getStandardDefinedRolesOnResources

public java.util.Collection<java.lang.String> getStandardDefinedRolesOnResources()

Gets the standard defined roles on resources.

Specified by:

getStandardDefinedRolesOnResources in class XBRLExtendedLink

Returns:

the standard defined roles on resources

clear

public void clear()
           throws java.lang.Throwable

Clear.

Specified by:

clear in interface XBRLDTSDocument

Overrides:

clear in class XBRLExtendedLink

Throws:

java.lang.Throwable - the throwable

clone

public PresentationLinkbase clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the presentation linkbase

clone

public PresentationLinkbase clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

newDTS - the new DTS

Returns:

the presentation linkbase

hasChildNodes

public final boolean hasChildNodes()

Specified by:

hasChildNodes in interface net.sf.saxon.om.NodeInfo

Overrides:

hasChildNodes in class net.sf.saxon.tree.linked.NodeImpl

getNumberOfChildren

public final int getNumberOfChildren()

getFirstChild

public final net.sf.saxon.tree.linked.NodeImpl getFirstChild()

Specified by:

getFirstChild in interface net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>

Overrides:

getFirstChild in class net.sf.saxon.tree.linked.NodeImpl

getLastChild

public final net.sf.saxon.tree.linked.NodeImpl getLastChild()

Overrides:

getLastChild in class net.sf.saxon.tree.linked.NodeImpl