com.ihr.xbrl.om.instance

Class XBRLContext

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.instance.XBRLContext

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, XBRLValidation, HasEqualsCache, 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 XBRLContext
extends XMLFragment
implements java.lang.Cloneable, XBRLValidation, HasEqualsCache

This class represents the content of an XBRL Context.

An XBRL Context contains:

Content	Description
XBRLEntity	Content about the reporting entity
XBRLPeriod	Content about the reporting period, instant or duration
XBRLScenario	Content about the reporting scenario. Collection of XML nodes

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 javax.xml.namespace.QName	contextNode The QName of the XML element that is the container of context information.
static net.sf.saxon.om.StructuredQName	sqnContextNode The Constant sqnContextNode.

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
XBRLContext(DTSContainer dts, XBRLEntity entity, XBRLPeriod period, XBRLScenario scenario) Creates a new context with the supplied entity, period and scenario.
XBRLContext(XBRLInstance parent, XBRLEntity entity, XBRLPeriod period, XBRLScenario scenario) Creates a new context with the supplied entity, period and scenario and set the parent to the parent instance.
XBRLContext(XMLFragment node) Creates a new context with the supplied XMLFragment.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XBRLContext	clone() Clone.
XBRLContext	clone(DTSContainer newDTS) Clone.
boolean	equals(java.lang.Object other) Evaluates c-equality of two contexts according to the XBRL 2.1 spec The context IDs may be different and are not compared
XBRLContext	generateNode() Generate node.
XBRLEntity	getEntity() Obtains the entity associated with this context or null.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
java.lang.String	getFriendlyName() Gets the friendly name.
java.lang.String	getFriendlyName(int modifiers, LabelsProvider lp) Gets the friendly name.
java.lang.String	getFriendlyNameOnlyId() Gets the friendly name only id.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLScenario	getOrCreateScenario() Returns the scenario for this context.
XBRLPeriod	getPeriod() obtains the period of this context.
XBRLScenario	getScenario() Returns the scenario for this context.
XBRLValidationReport	getValidationReport() Gets the validation report.
boolean	hasChildNodes()
int	hashCode() Hash code.
void	invalidate() Invalidate.
boolean	invalidate(XBRLValidation.Direction dir) Invalidate.
boolean	isOnValidation() Checks if is on validation.
static XBRLContext	make(XBRLInstance instance, XBRLEntity ent, XBRLPeriod pi, XBRLScenario scenario) Make.
boolean	s_equal2(java.lang.Object other) S equal 2.
void	setEntity(XBRLEntity entity) Sets the entity for this context this method resets validation of the context.
void	setId(java.lang.String id) Sets the id.
void	setPeriod(XBRLPeriod period) Sets the period of this context This method resets validation status of this context.
void	setScenario(XBRLScenario scenario) Sets the new scenario for this context.
XBRLValidationReport	validate(XBRLPlugInProcessor proc) Validate.

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, getAttributes, 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, 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, isHashDependsOnAtribute, 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, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, 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

Field Detail

contextNode

public static final javax.xml.namespace.QName contextNode

The QName of the XML element that is the container of context information.

sqnContextNode

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

The Constant sqnContextNode.

Constructor Detail

XBRLContext

public XBRLContext(XMLFragment node)

Creates a new context with the supplied XMLFragment. and replaces current XMLFragment with the new XBRLContext

Parameters:

node - - the XMLFragment to obtain data from and replace in the container document

XBRLContext

public XBRLContext(DTSContainer dts,
                   XBRLEntity entity,
                   XBRLPeriod period,
                   XBRLScenario scenario)

Creates a new context with the supplied entity, period and scenario. The content parent will not be set so it will be null. For entity, period and scenario parameters that are not null, a clone will be added to this context, not the instance passed in. This is due to the reason the entity, period and scenario instance parent property will be set to this context and the passed in entity period and scenario will not be changed. If set parent is executed on one instance, it is removed from previous parent

Parameters:

dts - - The container DTS, MUST not be null

entity - - The entity, may be null

period - - The period, may be null

scenario - - The scenario, may be null

XBRLContext

public XBRLContext(XBRLInstance parent,
                   XBRLEntity entity,
                   XBRLPeriod period,
                   XBRLScenario scenario)

Creates a new context with the supplied entity, period and scenario and set the parent to the parent instance.

This constructor will add this context as child of the instance root nodes and will add the context to the limbo contexts. It is possible later that instance document serialization algorithm decides to remove the context from instance if it is not used.

Parameters:

parent - - The parent XBRLInstance document

entity - - The entity, may be null

period - - The period, may be null

scenario - - The scenario, may be null

Method Detail

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XMLFragment

Throws:

java.lang.Throwable - the throwable

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

clone

public XBRLContext clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL context

clone

public XBRLContext clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

newDTS - the new DTS

Returns:

the XBRL context

equals

public boolean equals(java.lang.Object other)

Evaluates c-equality of two contexts according to the XBRL 2.1 spec The context IDs may be different and are not compared

Specified by:

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

Overrides:

equals in class XMLFragment

Parameters:

other - the other

Returns:

true, if successful

s_equal2

public boolean s_equal2(java.lang.Object other)

S equal 2.

Overrides:

s_equal2 in class XMLFragment

Parameters:

other - the other

Returns:

true, if successful

hashCode

public int hashCode()

Hash code.

Specified by:

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

Overrides:

hashCode in class XMLFragment

Returns:

the int

getPeriod

public XBRLPeriod getPeriod()

obtains the period of this context.

Returns:

the period object or null if not set or it cannot be created from the supplied node

setPeriod

public void setPeriod(XBRLPeriod period)

Sets the period of this context This method resets validation status of this context.

Parameters:

period - the new period

getEntity

public XBRLEntity getEntity()

Obtains the entity associated with this context or null.

Returns:

an XBRLEntity object

setEntity

public void setEntity(XBRLEntity entity)

Sets the entity for this context this method resets validation of the context.

Parameters:

entity - the new entity

getScenario

public XBRLScenario getScenario()

Returns the scenario for this context. This method returns null if the context contains no scenario

Returns:

an XBRLScenario object

See Also:

getOrCreateScenario()

getOrCreateScenario

public XBRLScenario getOrCreateScenario()

Returns the scenario for this context. This method never returns null. It returns a newly created empty scenario if the scenario was not specified. Note the scenario is not added to the context.

Returns:

an XBRLScenario object

See Also:

setScenario(XBRLScenario)

setScenario

public void setScenario(XBRLScenario scenario)

Sets the new scenario for this context. If the scenario is empty it is considered as being null and not added or removed from context using this method resets validation flag.

Parameters:

scenario - the new scenario

generateNode

public XBRLContext generateNode()
                         throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XMLFragment

Returns:

the XBRL context

Throws:

XBRLSerializationException - the XBRL serialization exception

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,
                                        LabelsProvider lp)

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Parameters:

modifiers - the modifiers

lp - the lp

Returns:

the friendly name

getFriendlyNameOnlyId

public java.lang.String getFriendlyNameOnlyId()

Gets the friendly name only id.

Returns:

the friendly name only id

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

make

public static XBRLContext make(XBRLInstance instance,
                               XBRLEntity ent,
                               XBRLPeriod pi,
                               XBRLScenario scenario)

Make.

Parameters:

instance - the instance

ent - the ent

pi - the pi

scenario - the scenario

Returns:

the XBRL context

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