com.ihr.xbrl.om.exLinks

Class XBRLResource

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

com.ihr.xbrl.om.exLinks.XBRLResource

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, XBRLValidation, XBRLValueKey, 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

Direct Known Subclasses:

AutoFill, CustomCode, FlMessage, RenderHints, RSTableEvaluableResource, StaticRole, XBRLFormulaResource, XBRLLabelResource, XBRLTableResource

public class XBRLResource
extends XBRLPointerOfARelationship
implements XBRLValueKey, XBRLValidation

This is the base type for XBRL resources. This object represents the content of an XBRL Resource as indicated in the XBRL Infoset documentation. Every other XBRL resource is derived from this XBRLResource and may overwrite methods in this class or any other class in the hierarchy tree. Label resources, for example, are implemented as XBRLLabelResource objects with additional properties, validation constraints etc.

Author:

Ignacio

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 org.apache.log4j.Logger	log The log.
static XBRLResource	nullResource The Constant nullResource.

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, 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
XBRLResource(DTSContainer dts) Instantiates a new XBRL resource.
XBRLResource(XBRLExtendedLink parent, javax.xml.namespace.QName type, boolean bAddToParent) Creates a XBRLResource programatically Set bAddToParent to false if the resource is not fully initialized in this case this function never throws a XBRLDuplicateResource exception Starting with release 2.6.5 this constructor requires the element declaration of the type parameter to be loaded in the set of schemas available in the DTSContainer of the parent.
XBRLResource(XBRLExtendedLink parent, XMLFragment node) constructor of an XBRLResource object.

Method Summary

Modifier and Type	Method and Description
void	addChild(XMLFragment f) Sets the resource value to a complex type value and adds a fragment to it.
void	clear() Removes all referneces to this resource in the DTS.
XBRLResource	clone() Clone.
XBRLResource	clone(DTSContainer newDTS) Clone.
boolean	equals(java.lang.Object other) Equals.
XBRLResource	generateNode() Generate node.
java.util.Iterator<XBRLAttribute>	getAttributes() Access to the [Attributes] property.
int	getCode() Gets the code.
DTSBase	getDTSBase() Gets the DTS base.
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.
java.lang.String	getFriendlyName(int modifiers, LabelsProvider lp) Gets the friendly name.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLExtendedLink	getParentXBRL() Access to the [Parent] property.
static java.lang.String	getResourceIdentifier(XBRLResource resource) Returns a text identifying the resource from the linkbase syntax. this is either the value of the id attribute or the value of the xlink:label on the resource
XBRLRoleType	getRoleType() Access to the [Role Type] property The resource is validated against the content of the roleType information Return null if no roleType exist on resource.
XBRLXSDTypeDefinition	getType() Gets the type.
XBRLValidationReport	getValidationReport() Gets the validation report.
net.sf.saxon.value.AnyURIValue	getValueKey() Gets the value key.
boolean	hasChildNodes()
int	hashCode() Hash code.
void	invalidate() Invalidate.
boolean	invalidate(XBRLValidation.Direction dir) Invalidate.
boolean	isComplexType() Checks if is complex type.
boolean	isHashDependsOnAtribute(javax.xml.namespace.QName attributeName) Checks if is hash depends on atribute.
boolean	isOnValidation() Checks if is on validation.
boolean	isSimpleType() Checks if is simple type.
void	setCode(int resourceNumber) Set the resource code.
void	setComplexType() Programatically sets if the resource type is simple or complex.
void	setDTSBase(DTSBase base) Sets the DTS base.
void	setId(java.lang.String id) Sets the id.
boolean	setRawParentXBRL(XMLFragment parent) Sets the parent of this resource to the Extended link that is used in the parameter.
void	setRole(java.lang.String role) Sets the role.
void	setRoleType(XBRLRoleType role) Sets the role type.
void	setSimpleType() Programatically sets if the resource type is simple or complex.
void	setValue(net.sf.saxon.s9api.XdmValue v) Sets the resource value to a specific simple type value.
XBRLValidationReport	validate(XBRLPlugInProcessor proc) Validate.

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, 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, 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, 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

Field Detail

log

public static org.apache.log4j.Logger log

The log.

nullResource

public static final XBRLResource nullResource

The Constant nullResource.

Constructor Detail

XBRLResource

public XBRLResource(XBRLExtendedLink parent,
                    XMLFragment node)

constructor of an XBRLResource object. This class creates an instance of a XBRL resource and registers it in the container.

Parameters:

parent - the parent

node - the node

XBRLResource

public XBRLResource(DTSContainer dts)

Instantiates a new XBRL resource.

Parameters:

dts - the dts

XBRLResource

public XBRLResource(XBRLExtendedLink parent,
                    javax.xml.namespace.QName type,
                    boolean bAddToParent)

Creates a XBRLResource programatically Set bAddToParent to false if the resource is not fully initialized in this case this function never throws a XBRLDuplicateResource exception Starting with release 2.6.5 this constructor requires the element declaration of the type parameter to be loaded in the set of schemas available in the DTSContainer of the parent.

Parameters:

parent - XBRLExtendedLink the extended link

type - QName the type of this new resource

bAddToParent - if this is true the resource will be added to the extended link and to the DTS Container.

Method Detail

hashCode

public int hashCode()

Hash code.

Specified by:

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

Overrides:

hashCode in class XLinkElement

Returns:

the int

isHashDependsOnAtribute

public boolean isHashDependsOnAtribute(javax.xml.namespace.QName attributeName)

Checks if is hash depends on atribute.

Overrides:

isHashDependsOnAtribute in class XLinkElement

Parameters:

attributeName - the attribute name

Returns:

true, if is hash depends on atribute

equals

public boolean equals(java.lang.Object other)

Equals.

Specified by:

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

Overrides:

equals in class XLinkElement

Parameters:

other - the other

Returns:

true, if successful

getParentXBRL

public XBRLExtendedLink getParentXBRL()

Access to the [Parent] property.

Overrides:

getParentXBRL in class XMLFragment

Returns:

XBRLExtendedLink

setRawParentXBRL

public boolean setRawParentXBRL(XMLFragment parent)

Sets the parent of this resource to the Extended link that is used in the parameter.

If the resource had a previous parent this method detach the resource from previous parent and attach it to the new parent.

This method calls XBRLExtendedLink.addResource(XBRLResource) on the new parent (if not null) and XBRLExtendedLink.removeResource(XBRLResource) on the old parent (if any)

Overrides:

setRawParentXBRL in class XMLFragment

Parameters:

parent - XBRLExtendedLink

Returns:

true, if successful

getResourceIdentifier

public static java.lang.String getResourceIdentifier(XBRLResource resource)

Returns a text identifying the resource from the linkbase syntax. this is either the value of the id attribute or the value of the xlink:label on the resource

Parameters:

resource - the resource

Returns:

the resource identification

getRoleType

public XBRLRoleType getRoleType()

Access to the [Role Type] property The resource is validated against the content of the roleType information Return null if no roleType exist on resource.

Returns:

XBRLRoleType

setRoleType

public void setRoleType(XBRLRoleType role)

Sets the role type.

Parameters:

role - the new role type

setRole

public void setRole(java.lang.String role)

Sets the role.

Overrides:

setRole in class XLinkElement

Parameters:

role - the new role

getDTSBase

public DTSBase getDTSBase()

Gets the DTS base.

Returns:

the DTS base

setDTSBase

public void setDTSBase(DTSBase base)

Sets the DTS base.

Parameters:

base - DTSBase

getAttributes

public java.util.Iterator<XBRLAttribute> getAttributes()

Access to the [Attributes] property.

Overrides:

getAttributes in class XLinkElement

Returns:

Iterator<XBRLAttribute>

See Also:

XMLFragment.getAllAttributes()

getType

public XBRLXSDTypeDefinition getType()

Gets the type.

Returns:

the type

isComplexType

public boolean isComplexType()

Checks if is complex type.

Returns:

boolean

setComplexType

public void setComplexType()

Programatically sets if the resource type is simple or complex.

setSimpleType

public void setSimpleType()

Programatically sets if the resource type is simple or complex.

setValue

public void setValue(net.sf.saxon.s9api.XdmValue v)

Sets the resource value to a specific simple type value.

Overrides:

setValue in class XMLFragment

Parameters:

v - the new value

setId

public void setId(java.lang.String id)
           throws XBRLInconsistentDTSException

Sets the id.

Overrides:

setId in class XMLFragment

Parameters:

id - the new id

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent DTS exception

addChild

public void addChild(XMLFragment f)

Sets the resource value to a complex type value and adds a fragment to it.

Overrides:

addChild in class XMLFragment

Parameters:

f - the f

isSimpleType

public boolean isSimpleType()

Checks if is simple type.

Returns:

boolean

generateNode

public XBRLResource generateNode()
                          throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XLinkElement

Returns:

the XBRL resource

Throws:

XBRLSerializationException - the XBRL serialization exception

getValueKey

public net.sf.saxon.value.AnyURIValue getValueKey()

Gets the value key.

Specified by:

getValueKey in interface XBRLValueKey

Returns:

the value key

clear

public void clear()
           throws java.lang.Throwable

Removes all referneces to this resource in the DTS.

Overrides:

clear in class XLinkElement

Throws:

java.lang.Throwable - the throwable

clone

public XBRLResource clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL resource

clone

public XBRLResource clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

newDTS - the new DTS

Returns:

the XBRL resource

getFriendlyName

public java.lang.String getFriendlyName()

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Returns:

the friendly name

getFriendlyName

public java.lang.String getFriendlyName(int modifiers)

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Parameters:

modifiers - the modifiers

Returns:

the friendly name

getFriendlyName

public java.lang.String getFriendlyName(int modifiers,
                                        LabelsProvider lp)

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Parameters:

modifiers - the modifiers

lp - the lp

Returns:

the friendly name

getValidationReport

public XBRLValidationReport getValidationReport()

Gets the validation report.

Specified by:

getValidationReport in interface XBRLValidation

Returns:

the validation report

validate

public XBRLValidationReport validate(XBRLPlugInProcessor proc)

Validate.

Specified by:

validate in interface XBRLValidation

Parameters:

proc - the proc

Returns:

the XBRL validation report

invalidate

public void invalidate()

Invalidate.

Specified by:

invalidate in interface XBRLValidation

invalidate

public boolean invalidate(XBRLValidation.Direction dir)

Invalidate.

Specified by:

invalidate in interface XBRLValidation

Parameters:

dir - the dir

Returns:

true, if successful

isOnValidation

public boolean isOnValidation()

Checks if is on validation.

Specified by:

isOnValidation in interface XBRLValidation

Returns:

true, if is on validation

setCode

public void setCode(int resourceNumber)

Set the resource code. Resource codes uniquely identify the resource. This method is called by the DTSContainer.addResource(XBRLResource) method when a resource is added

Parameters:

resourceNumber - the new code

getCode

public int getCode()

Gets the code.

Returns:

the code

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