public abstract class XLinkElement extends XMLFragment implements java.io.Serializable
In release 2.6.5 of the API the local variables has been replaced by the content of the attributes hash table in the parent XMLFragment object in order to avoid double storage of values.
XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>
Modifier and Type | Field and Description |
---|---|
static javax.xml.namespace.QName |
actuate
The QName xlink:actuate.
|
static int |
ARC
The Constant ARC.
|
static javax.xml.namespace.QName |
arcrole
The QName xlink:arcrole.
|
static int |
ETITLE
The Constant ETITLE.
|
static int |
EXTENDED
The Constant EXTENDED.
|
static javax.xml.namespace.QName |
from
The QName xlink:from.
|
static javax.xml.namespace.QName |
href
The QName xlink:href.
|
static javax.xml.namespace.QName |
label
The QName xlink:label.
|
static int |
LOCATOR
The Constant LOCATOR.
|
static int |
RESOURCE
The Constant RESOURCE.
|
static javax.xml.namespace.QName |
role
The QName xlink:role.
|
static javax.xml.namespace.QName |
show
The QName xlink:show.
|
static int |
SIMPLE
The Constant SIMPLE.
|
static javax.xml.namespace.QName |
title
The QName xlink:title.
|
static javax.xml.namespace.QName |
to
The QName xlink:to.
|
static javax.xml.namespace.QName |
type
The QName xlink:type.
|
static int |
X_ACTUATE
The Constant ACTUATE.
|
static int |
X_ARCROLE
The Constant ARCROLE.
|
static int |
X_FROM
The Constant FROM.
|
static int |
X_HREF
The Constant HREF.
|
static int |
X_LABEL
The Constant LABEL.
|
static int |
X_ROLE
The Constant ROLE.
|
static int |
X_SHOW
The Constant SHOW.
|
static int |
X_TITLE
The Constant TITLE.
|
static int |
X_TO
The Constant TO.
|
static int |
X_TYPE
The Constant TYPE.
|
static java.lang.String |
XLINKPREFIX
The Constant XLINKPREFIX.
|
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
Constructor and Description |
---|
XLinkElement(DTSContainer dts)
Creates an XLinkElement object for a DTS without assigning it to a node.
|
XLinkElement(DTSContainer dts,
javax.xml.namespace.QName nodeName)
Creates an XLinkElement object for a DTS without assigning it to a node.
|
XLinkElement(DTSContainer dts,
XMLFragment fragment)
Creates an XLinkElement object that exist in a DTS and assign it to a node returned by saxonica processor.
|
XLinkElement(XMLFragment node)
Creates an XLinkElement object that exist in a DTS and assign it to a node returned by saxonica processor.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clear.
|
boolean |
equals(java.lang.Object other)
Equals.
|
XLinkElement |
generateNode()
Generate node.
|
java.lang.String |
getActuate()
Access to the value of the xlink:actuate property on simple link elements
null is returned if the value is not set and there is no actuate attribute
on the node.
|
java.lang.String |
getArcrole()
Access to the value of the xlink:arcrole attribute on simple link elements.
|
java.util.Iterator<XBRLAttribute> |
getAttributes()
Gets the attributes.
|
net.sf.saxon.tree.linked.NodeImpl |
getFirstChild() |
java.lang.String |
getFromTxt()
Access to the value of the xlink:from attibute on simple link elements (arcs only).
|
java.net.URI |
getHRef()
Access to the value of the xlink:href attribute on simple link elements
The value is converted to a relative URI.
|
XMLDocumentURI |
getHRefDocument()
Obtains the document this simple link or locator is pointing to.
|
XMLDocumentURI |
getHRefDocumentResolved()
Obtains the document this simple link or locator is pointing to.
|
java.net.URI |
getHRefResolved()
This method obtains the resolved value of the xlink:href resolved
against the xml:base and absolutized.
|
java.lang.String |
getLabel()
Access to the value of the xlink:label attribute on simple link elements (only locator and resource elements)
According to the XLink specification, label is optional on locators and resource elements.
|
net.sf.saxon.tree.linked.NodeImpl |
getLastChild() |
int |
getNumberOfChildren() |
java.lang.String |
getRawHRef()
Access to the value of the xlink:href attribute on simple link elements
The value is not converted to an absolute URI in this function.
|
XMLFragment |
getReference()
Access to the [Reference] property.
|
java.lang.String |
getRole()
Access to the content of the xlink:role attribute on the XLinkElement
returns null if there is no xlink:role attribute on the element.
|
java.lang.String |
getShow()
Access to the value of the xlink:show attribute on simple link elements,
null is returned if the value is not set or there is no show attribute on the node .
|
static java.lang.String |
getStaticLabel()
Creates a unique string to be used in xlink:label attributes.
|
java.lang.String |
getSType()
Returns a string representation of the xlink:type attribute on simple links.
|
java.lang.String |
getTitle()
Returns the value of the xlink:title attribute on simple link elements.
|
java.lang.String |
getToTxt()
Access to the value of the xlink:to attribute on simple link elements (arcs only).
|
boolean |
hasChildNodes() |
int |
hashCode()
Hash code.
|
boolean |
isHashDependsOnAtribute(javax.xml.namespace.QName attributeName)
Checks if is hash depends on atribute.
|
static boolean |
isRequiredAttribute(int elementType,
int attributeType)
Checks whether or not an attribute code is required for an xlink element.
|
static boolean |
isValidAttribute(int elementType,
int attributeType)
Checks whether or not an attribute code is valid in an xlink element.
|
void |
setActuate(java.lang.String actuate)
Sets the value of the xlink:actuate attribute on simple link elements.
|
void |
setArcrole(java.lang.String arcrole)
Sets the value of the xlink:arcrole attribute on simple link elements.
|
void |
setFrom(java.lang.String from)
Sets the value of the xlink:from attribute on simple link elements (arcs only)
since 2.6.5 setting this attribute updates all xlink:label attributes for existing
elements in the source of the arc or the element that is the source of the relationship
|
void |
setHRef(java.lang.String href)
Sets the value of the xlink:href attribute on simple link elements.
|
void |
setLabel(java.lang.String label)
Sets the value of the xlink:label attribute on simple link elements
starting with version 2.6.5 setting the value of the label here updates also the
value of the xlink:from and xlink:to attributes on relationships.
|
void |
setRole(java.lang.String role)
Sets the value of the xlink:role attribute to a specific value.
|
void |
setShow(java.lang.String show)
Sets the value of the xlink:show attribute on simple link elements.
|
void |
setSType(java.lang.String type)
Sets the value of the xlink:type attribute on simple links.
|
void |
setTitle(java.lang.String title)
Sets the value for the xlink:title attribute.
|
void |
setTo(java.lang.String to)
Sets the value of the xlink:to attribute on simple link elements (arcs only)
since 2.6.5 setting this attribute updates all xlink:label attributes for existing
elements in the target of the arc or the element that is the target of the relationship
|
void |
validateXPointer(java.net.URI uriHref)
Resolve the XPointer to the node pointed to and returns the XMLFragment it points to or null if none can
be found.
|
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, clone, clone, 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, getElements, getFirstChildNoComment, getFragment, getFriendlyName, 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, getParentDocument, 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
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
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
public static final int LOCATOR
public static final int ARC
public static final int RESOURCE
public static final int EXTENDED
public static final int SIMPLE
public static final int ETITLE
public static final java.lang.String XLINKPREFIX
public static final int X_TYPE
public static final int X_ROLE
public static final int X_ARCROLE
public static final int X_TITLE
public static final int X_SHOW
public static final int X_ACTUATE
public static final int X_LABEL
public static final int X_FROM
public static final int X_TO
public static final int X_HREF
public static final javax.xml.namespace.QName type
public static final javax.xml.namespace.QName role
public static final javax.xml.namespace.QName arcrole
public static final javax.xml.namespace.QName title
public static final javax.xml.namespace.QName show
public static final javax.xml.namespace.QName actuate
public static final javax.xml.namespace.QName label
public static final javax.xml.namespace.QName from
public static final javax.xml.namespace.QName to
public static final javax.xml.namespace.QName href
public XLinkElement(DTSContainer dts, XMLFragment fragment)
dts
- the dtsfragment
- the nodepublic XLinkElement(XMLFragment node)
node
- the nodepublic XLinkElement(DTSContainer dts)
dts
- the dtspublic XLinkElement(DTSContainer dts, javax.xml.namespace.QName nodeName)
dts
- the dtsnodeName
- the node namepublic int hashCode()
hashCode
in interface net.sf.saxon.om.NodeInfo
hashCode
in class XMLFragment
public boolean equals(java.lang.Object other)
equals
in interface net.sf.saxon.om.NodeInfo
equals
in class XMLFragment
other
- the otherpublic java.util.Iterator<XBRLAttribute> getAttributes()
getAttributes
in class XMLFragment
XMLFragment.getAllAttributes()
public boolean isHashDependsOnAtribute(javax.xml.namespace.QName attributeName)
isHashDependsOnAtribute
in class XMLFragment
attributeName
- the attribute namepublic static boolean isValidAttribute(int elementType, int attributeType)
elementType
- the element typeattributeType
- the attribute typepublic static boolean isRequiredAttribute(int elementType, int attributeType)
elementType
- the element typeattributeType
- the attribute typepublic final java.lang.String getTitle()
XBRLRuntimeException
- the XBRL runtime exceptionpublic void setTitle(java.lang.String title) throws XBRLValidationException
title
- the new titleXBRLValidationException
- the XBRL validation exceptionpublic final java.lang.String getRole()
XBRLRuntimeException
- the XBRL runtime exceptionpublic void setRole(java.lang.String role) throws XBRLValidationException
role
- the new roleXBRLValidationException
- the XBRL validation exceptionpublic static java.lang.String getStaticLabel()
public final java.lang.String getLabel() throws XBRLRuntimeException
XBRLRuntimeException
- the XBRL runtime exceptionpublic void setLabel(java.lang.String label) throws XBRLRuntimeException
starting with version 2.6.5 setting the value of the label here updates also the value of the xlink:from and xlink:to attributes on relationships.
label
- the new labelXBRLRuntimeException
- the XBRL runtime exceptionpublic final java.lang.String getRawHRef() throws XBRLRuntimeException
XBRLRuntimeException
- the XBRL runtime exceptionpublic final java.net.URI getHRef() throws XBRLRuntimeException
XBRLRuntimeException
- the XBRL runtime exceptionpublic void setHRef(java.lang.String href) throws XBRLValidationException
href
- the new value for the xlink:href attributeXBRLValidationException
- the XBRL validation exceptionpublic final java.lang.String getArcrole() throws XBRLRuntimeException
XBRLRuntimeException
- the XBRL runtime exceptionpublic void setArcrole(java.lang.String arcrole) throws XBRLValidationException
arcrole
- the new arcroleXBRLValidationException
- the XBRL validation exceptionpublic final java.lang.String getFromTxt() throws XBRLRuntimeException
XBRLRuntimeException
- the XBRL runtime exceptionpublic void setFrom(java.lang.String from) throws XBRLValidationException
since 2.6.5 setting this attribute updates all xlink:label attributes for existing elements in the source of the arc or the element that is the source of the relationship
from
- the new fromXBRLValidationException
- the XBRL validation exceptionpublic final java.lang.String getToTxt() throws XBRLRuntimeException
XBRLRuntimeException
- the XBRL runtime exceptionpublic void setTo(java.lang.String to) throws XBRLValidationException
since 2.6.5 setting this attribute updates all xlink:label attributes for existing elements in the target of the arc or the element that is the target of the relationship
to
- the new toXBRLValidationException
- the XBRL validation exceptionpublic final java.lang.String getSType() throws XBRLRuntimeException
XBRLRuntimeException
- the XBRL runtime exceptionpublic void setSType(java.lang.String type) throws XBRLRuntimeException
type
- the new s typeXBRLRuntimeException
- the XBRL runtime exceptionpublic final java.lang.String getShow() throws XBRLRuntimeException
XBRLRuntimeException
- the XBRL runtime exceptionpublic void setShow(java.lang.String show) throws XBRLValidationException
show
- the new showXBRLValidationException
- the XBRL validation exceptionpublic final java.lang.String getActuate() throws XBRLRuntimeException
XBRLRuntimeException
- the XBRL runtime exceptionpublic void setActuate(java.lang.String actuate) throws XBRLValidationException
actuate
- the new actuateXBRLValidationException
- the XBRL validation exceptionpublic void clear() throws java.lang.Throwable
clear
in class XMLFragment
java.lang.Throwable
- the throwablepublic XLinkElement generateNode() throws XBRLSerializationException
generateNode
in class XMLFragment
XBRLSerializationException
- the XBRL serialization exceptionpublic java.net.URI getHRefResolved() throws XBRLValidationException
XBRLValidationException
- the XBRL validation exceptionpublic XMLFragment getReference() throws XBRLValidationException
XBRLValidationException
- the XBRL validation exceptionpublic XMLDocumentURI getHRefDocument() throws XBRLValidationException
This method attempts to load the referenced document if it is not already loaded into the DTSContainer
XBRLValidationException
- the XBRL validation exceptiongetHRefDocumentResolved()
public XMLDocumentURI getHRefDocumentResolved()
This method returns null if the referenced document is not already loaded into the DTSContainer
getHRefDocument()
public void validateXPointer(java.net.URI uriHref) throws XBRLValidationException
The href MUST be absolute.
uriHref
- the URI to resolveXBRLValidationException
- if the URI cannot be resolved according to the rules in the XBRL 2.1 specificationpublic final boolean hasChildNodes()
hasChildNodes
in interface net.sf.saxon.om.NodeInfo
hasChildNodes
in class net.sf.saxon.tree.linked.NodeImpl
public final int getNumberOfChildren()
public final net.sf.saxon.tree.linked.NodeImpl getFirstChild()
getFirstChild
in interface net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>
getFirstChild
in class net.sf.saxon.tree.linked.NodeImpl
public final net.sf.saxon.tree.linked.NodeImpl getLastChild()
getLastChild
in class net.sf.saxon.tree.linked.NodeImpl
Copyright 2006-2015 Reporting Standard S.L., C/ Torrecilla del Puerto 1, 28043, Madrid, Espaņa