public class XBRLRelationship extends XLinkElement implements XBRLGlueInterface, java.io.Serializable, XBRLValidation
XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>
XBRLValidation.Direction
Modifier and Type | Field and Description |
---|---|
static javax.xml.namespace.QName |
orderQName
The Constant orderQName.
|
static javax.xml.namespace.QName |
priorityQName
The Constant priorityQName.
|
static javax.xml.namespace.QName |
useQName
The Constant useQName.
|
actuate, ARC, arcrole, ETITLE, EXTENDED, href, label, LOCATOR, RESOURCE, role, show, SIMPLE, title, type, X_ACTUATE, X_ARCROLE, X_FROM, X_HREF, X_LABEL, X_ROLE, X_SHOW, X_TITLE, X_TO, X_TYPE, 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 |
---|
XBRLRelationship(XBRLExtendedLink parent,
DTSContainer dts,
XBRLArcroleType arcroleType,
XMLFragment from,
XMLFragment to,
XMLFragment document,
XBRLAttribute[] attributes)
Creates a new relationship object from a XMLFragment in a file
parent linkbaseType - QName returned by the baseArc.getLinkbaseType()
|
XBRLRelationship(XBRLExtendedLink parent,
javax.xml.namespace.QName type,
XMLFragment from,
XMLFragment to,
XBRLArcroleType arcroleType,
XBRLAttribute[] attributes,
boolean bValidate)
Creates a new relationship object programmatically.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clear.
|
XBRLRelationship |
clone()
Clone.
|
XBRLRelationship |
clone(DTSContainer newDTS)
Clone.
|
boolean |
equals(java.lang.Object obj)
Equals.
|
XBRLRelationship |
generateNode()
Generate node.
|
XBRLArcroleType |
getArcroleType()
Access to the [Arcrole] property.
|
java.lang.Integer |
getArcroleTypeCode()
Access to the [Arcrole] property.
|
java.util.Iterator<XBRLAttribute> |
getAttributes()
Access to the [Attributes] property.
|
XBRLRelationshipsChainLink |
getChain()
Gets the chain.
|
DTSBase |
getDTSBase()
Returns the base property of this relationship.
|
net.sf.saxon.tree.linked.NodeImpl |
getFirstChild() |
java.lang.String |
getFriendlyName()
Gets the friendly name.
|
java.lang.String |
getFriendlyName(int modifiers)
Gets the friendly name.
|
XMLFragment |
getFrom()
Access to the [From] property of a relationship.
|
net.sf.saxon.tree.linked.NodeImpl |
getLastChild() |
java.util.Iterator<XBRLRelationship> |
getNext()
Access to the [Following] property of the chain of relationships.
|
int |
getNumberOfChildren() |
java.util.Iterator<XMLFragment> |
getObjectsFrom()
Gets the objects from.
|
java.util.Iterator<XMLFragment> |
getObjectsTo()
Gets the objects to.
|
java.lang.Double |
getOrder()
Gets the value of the order attribute on the relationship or the
default value when the order attribute is not explicitly indicated.
|
XBRLExtendedLink |
getParentXBRL()
Access to the [Parent] property.
|
java.util.Iterator<XBRLRelationship> |
getPrevious()
Access to the [Preceding] property of the chain of relationships.
|
int |
getPriority()
Access to the [Priority] property.
|
XMLFragment |
getSource()
The relationship [source] is the same as the relationship [From] property.
|
XMLFragment |
getTarget()
The relationship [target] is the same as the relationship [To] property.
|
XMLFragment |
getTo()
Access to the [To] property of a relationship.
|
javax.xml.namespace.QName |
getType()
Access to the [Type] property
The [Type] property of a relationship is the node name of the surrounding arc
link:presentationArc, link:labelArc, link:calculationArc are some examples of
values for the [Type] property .
|
int |
getUse()
Access to the [Use] property.
|
static java.lang.String |
getUse(int useCode)
Gets the use.
|
static int |
getUse(java.lang.String code)
Used to convert from string value of use to the integer value.
|
XBRLValidationReport |
getValidationReport()
Gets the validation report.
|
boolean |
hasChildNodes() |
int |
hashCode()
Hash code.
|
void |
invalidate()
Invalidate.
|
boolean |
invalidate(XBRLValidation.Direction dir)
Invalidate.
|
boolean |
isHashDependsOnAtribute(javax.xml.namespace.QName attributeName)
Checks if is hash depends on atribute.
|
boolean |
isOnValidation()
Checks if is on validation.
|
static XBRLRelationship |
make(XBRLExtendedLink parent,
javax.xml.namespace.QName type,
XMLFragment from,
XMLFragment to,
XBRLArcroleType arcroleType,
XBRLAttribute[] attributes,
boolean bValidate)
Make.
|
void |
setArcrole(java.lang.String arcrole)
Sets the arcrole.
|
void |
setArcroleType(XBRLArcroleType arcrole)
Sets the value of the [Arcrole] property of this relationship.
|
void |
setChain(XBRLRelationshipsChainLink chain)
Sets the chain.
|
void |
setDTSBase(DTSBase base)
Sets the base property of this relationship.
|
void |
setFrom(XMLFragment newFrom)
sets the [From] property of this relationship
|
void |
setId(java.lang.String id)
Sets the id.
|
java.lang.Double |
setOrder(java.lang.Double newValue)
Set the value of the order attribute.
|
boolean |
setParent(XBRLExtendedLink parent)
Sets the parent of this relationship to a new extended link.
|
java.lang.Integer |
setPriority(java.lang.Integer newValue)
Sets the value of the [Priority] property or resets it if null is used as the new value.
|
void |
setTo(XMLFragment newTo)
Sets the [To] property of this relationship.
|
void |
setType(javax.xml.namespace.QName type)
Sets the [Type] property of this relationship.
|
java.lang.Integer |
setUse(java.lang.Integer newValue)
Sets the value of the [Use] property to
XBRLArc.OPTIONAL or XBRLArc.PROHIBITED or reset the value if null is used
|
XBRLValidationReport |
validate(XBRLPlugInProcessor proc)
Validate.
|
getActuate, getArcrole, getFromTxt, getHRef, getHRefDocument, getHRefDocumentResolved, getHRefResolved, getLabel, getRawHRef, getReference, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setFrom, setHRef, setLabel, setRole, setShow, setSType, setTitle, setTo, validateXPointer
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, getElements, getFirstChildNoComment, getFragment, 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, 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, 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 javax.xml.namespace.QName useQName
public static final javax.xml.namespace.QName orderQName
public static final javax.xml.namespace.QName priorityQName
public XBRLRelationship(XBRLExtendedLink parent, DTSContainer dts, XBRLArcroleType arcroleType, XMLFragment from, XMLFragment to, XMLFragment document, XBRLAttribute[] attributes) throws XBRLValidationException
parent
- XBRLExtendedLink of the base arcdts
- DTSContainerarcroleType
- XBRLArcroleType objectfrom
- XMLFragment in the from extreme of this relationshipto
- XMLFragment in the to extreme of this relationshipdocument
- NodeInfo surounding nodeattributes
- XBRLAttribute[] Array of attributes to add to the attributes in the XMLFragment. null is a valid valueXBRLValidationException
- the XBRL validation exceptionpublic XBRLRelationship(XBRLExtendedLink parent, javax.xml.namespace.QName type, XMLFragment from, XMLFragment to, XBRLArcroleType arcroleType, XBRLAttribute[] attributes, boolean bValidate) throws XBRLValidationException
parent
- XBRLExtendedLink of the base arctype
- QName relationship node of the arcfrom
- XMLFragment in the from extreme of this relationshipto
- XMLFragment in the to extreme of this relationshiparcroleType
- XBRLArcroleType objectattributes
- XBRLAttribute[] Array of attributes. Attributes will be "cloned" before linked to this relationship. May be nullbValidate
- if this is false then the new relationship will not be validated against the XBRL 2.1 specificationXBRLValidationException
- the XBRL validation exceptionpublic static XBRLRelationship make(XBRLExtendedLink parent, javax.xml.namespace.QName type, XMLFragment from, XMLFragment to, XBRLArcroleType arcroleType, XBRLAttribute[] attributes, boolean bValidate) throws XBRLValidationException
parent
- the parenttype
- the typefrom
- the fromto
- the toarcroleType
- the arcrole typeattributes
- the attributesbValidate
- the b validateXBRLValidationException
- the XBRL validation exceptionpublic XBRLRelationship clone()
clone
in class XMLFragment
public XBRLRelationship clone(DTSContainer newDTS)
clone
in class XMLFragment
newDTS
- the new DTSpublic int hashCode()
hashCode
in interface net.sf.saxon.om.NodeInfo
hashCode
in class XLinkElement
public boolean equals(java.lang.Object obj)
equals
in interface net.sf.saxon.om.NodeInfo
equals
in class XLinkElement
obj
- the objpublic void clear() throws java.lang.Throwable
clear
in class XLinkElement
java.lang.Throwable
- the throwablepublic void setId(java.lang.String id) throws XBRLInconsistentDTSException
setId
in class XMLFragment
id
- the new idXBRLInconsistentDTSException
- the XBRL inconsistent DTS exceptionpublic XMLFragment getFrom()
public XMLFragment getSource()
getFrom()
public XMLFragment getTo()
public XMLFragment getTarget()
getTo()
public XBRLExtendedLink getParentXBRL()
getParentXBRL
in class XMLFragment
public boolean setParent(XBRLExtendedLink parent) throws XBRLInconsistentDTSException
parent
- the new parentXBRLInconsistentDTSException
- the XBRL inconsistent dts exceptionpublic javax.xml.namespace.QName getType()
public void setType(javax.xml.namespace.QName type)
type
- the new typepublic java.lang.Integer getArcroleTypeCode()
public XBRLArcroleType getArcroleType()
public void setArcroleType(XBRLArcroleType arcrole)
arcrole
- the new arcrole typepublic void setArcrole(java.lang.String arcrole)
setArcrole
in class XLinkElement
arcrole
- the new arcrolepublic java.util.Iterator<XBRLRelationship> getNext()
public java.util.Iterator<XBRLRelationship> getPrevious()
public void setFrom(XMLFragment newFrom) throws XBRLInconsistentDTSException
newFrom
- XMLFragmentXBRLInconsistentDTSException
- the XBRL inconsistent dts exceptionpublic void setTo(XMLFragment newTo) throws XBRLInconsistentDTSException
newTo
- XMLFragmentXBRLInconsistentDTSException
- the XBRL inconsistent dts exceptionpublic int getUse()
getUse
in interface XBRLGlueInterface
public static int getUse(java.lang.String code)
code
- string value to convert to integer valuepublic static java.lang.String getUse(int useCode)
useCode
- the use codepublic java.lang.Integer setUse(java.lang.Integer newValue)
newValue
- the new valuepublic int getPriority()
getPriority
in interface XBRLGlueInterface
public java.lang.Integer setPriority(java.lang.Integer newValue)
newValue
- as an Integerpublic java.util.Iterator<XBRLAttribute> getAttributes()
getAttributes
in interface XBRLGlueInterface
getAttributes
in class XLinkElement
XMLFragment.getAllAttributes()
public boolean isHashDependsOnAtribute(javax.xml.namespace.QName attributeName)
isHashDependsOnAtribute
in class XLinkElement
attributeName
- the attribute namepublic DTSBase getDTSBase()
public void setDTSBase(DTSBase base)
base
- the new DTS basepublic java.lang.Double getOrder()
The default value is 1.0
public java.lang.Double setOrder(java.lang.Double newValue)
newValue
- the new valuepublic void setChain(XBRLRelationshipsChainLink chain)
chain
- the new chainpublic XBRLRelationshipsChainLink getChain() throws XBRLValidationException
XBRLValidationException
- the XBRL validation exceptionpublic XBRLRelationship generateNode() throws XBRLSerializationException
generateNode
in class XLinkElement
XBRLSerializationException
- the XBRL serialization exceptionpublic java.lang.String getFriendlyName()
getFriendlyName
in class XMLFragment
public java.lang.String getFriendlyName(int modifiers)
getFriendlyName
in class XMLFragment
modifiers
- the modifierspublic XBRLValidationReport getValidationReport()
getValidationReport
in interface XBRLValidation
public XBRLValidationReport validate(XBRLPlugInProcessor proc)
validate
in interface XBRLValidation
proc
- the procpublic void invalidate()
invalidate
in interface XBRLValidation
public boolean invalidate(XBRLValidation.Direction dir)
invalidate
in interface XBRLValidation
dir
- the dirpublic boolean isOnValidation()
isOnValidation
in interface XBRLValidation
public java.util.Iterator<XMLFragment> getObjectsFrom() throws XBRLValidationException
getObjectsFrom
in interface XBRLGlueInterface
XBRLValidationException
- the XBRL validation exceptionpublic java.util.Iterator<XMLFragment> getObjectsTo() throws XBRLValidationException
getObjectsTo
in interface XBRLGlueInterface
XBRLValidationException
- the XBRL validation exceptionpublic 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