com.ihr.xbrl.om.instance

Class XBRLEntity

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

All Implemented Interfaces:

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

The Class XBRLEntity.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XBRLEntity.EntityComparator The Class EntityComparator.

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	entity The Constant entityNode.
static XBRLEntity.EntityComparator	EntityComparatorInstance The Entity comparator instance.
static net.sf.saxon.om.StructuredQName	sqnEntity The Constant sqnEntity.

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
XBRLEntity(DTSContainer dts, java.lang.String scheme, java.lang.String identifier, XBRLSegment segment) Creates a new Entity to be added to a context later.
XBRLEntity(XMLFragment node) Instantiates a new XBRL entity.

Method Summary

Modifier and Type	Method and Description
XBRLEntity	clone() Clone.
XBRLEntity	clone(DTSContainer newDTS) Clone.
boolean	equals(java.lang.Object other) Equals.
XBRLEntity	generateNode() Generate node.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
java.lang.String	getIdentifier() Access to the identifier string on this entity.
XBRLIdentifier	getIdentifierNode() In principle this is used only within the formula processor.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLIdentifier	getOrCreateIdentifierNode() Gets the or create identifier node.
XBRLSegment	getOrCreateSegment() Access to the segment object of this entity or a new empty segment that will not be linked to the parent element.
java.lang.String	getScheme() Access to the value of the Scheme on this entity.
XBRLSegment	getSegment() Access to the segment object of this entity.
net.sf.saxon.s9api.XdmValue	getValue() Gets the value.
boolean	hasChildNodes()
int	hashCode() Hash code.
static XBRLEntity	make(DTSContainer dts) Make.
boolean	s_equal2(java.lang.Object other) S equal 2.
void	setIdentifier(java.lang.String identifier) Sets the identifier.
void	setScheme(java.lang.String scheme) Sets the scheme.
void	setSegment(XBRLSegment segment) Sets the segment.

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

Field Detail

entity

public static final javax.xml.namespace.QName entity

The Constant entityNode.

sqnEntity

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

The Constant sqnEntity.

EntityComparatorInstance

public static XBRLEntity.EntityComparator EntityComparatorInstance

The Entity comparator instance.

Constructor Detail

XBRLEntity

public XBRLEntity(XMLFragment node)

Instantiates a new XBRL entity.

Parameters:

node - the node to replace

XBRLEntity

public XBRLEntity(DTSContainer dts,
                  java.lang.String scheme,
                  java.lang.String identifier,
                  XBRLSegment segment)

Creates a new Entity to be added to a context later. null parameters are permitted except for the parent parameter.

Parameters:

dts - - DTSContainer the DTS object

scheme - - String the scheme URI string, may be null

identifier - - String the company name token, may be null

segment - - XBRLSegment the content of the segment, may be null

Method Detail

make

public static XBRLEntity make(DTSContainer dts)

Make.

Parameters:

dts - the dts

Returns:

the XBRL entity

clone

public XBRLEntity clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL entity

clone

public XBRLEntity clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

newDTS - the new DTS

Returns:

the XBRL entity

setScheme

public void setScheme(java.lang.String scheme)

Sets the scheme.

Parameters:

scheme - the new scheme

setIdentifier

public void setIdentifier(java.lang.String identifier)

Sets the identifier.

Parameters:

identifier - the new identifier

setSegment

public void setSegment(XBRLSegment segment)

Sets the segment.

Parameters:

segment - the new segment

getScheme

public java.lang.String getScheme()

Access to the value of the Scheme on this entity.

Returns:

String

getIdentifier

public java.lang.String getIdentifier()

Access to the identifier string on this entity.

Note this method returns the identifier after removing leading and trailing spaces and never returns null. If the surrounding identifier node contains no string value or contains null, this method will return the empty string instead.

If you want to obtain the real value of the identifier node and deal with null and leading and trailing spaces then obtain a reference to the identifier node via call to getOrCreateIdentifierNode() and continue from there.

Returns:

String

getOrCreateIdentifierNode

public XBRLIdentifier getOrCreateIdentifierNode()

Gets the or create identifier node.

Returns:

existing XBRLIdentifer node or new node if it does not exists

See Also:

getIdentifierNode()

getIdentifierNode

public XBRLIdentifier getIdentifierNode()

In principle this is used only within the formula processor. This method returns the identifier node inside the entity. This class handles the values of the identifier node as text and the identifier node is internally created or read when it is needed.

Returns:

XdmItem

See Also:

getIdentifier()

getSegment

public XBRLSegment getSegment()

Access to the segment object of this entity. This method returns null if no segment is defined

Returns:

a XBRLSegment object

See Also:

getOrCreateSegment()

getOrCreateSegment

public XBRLSegment getOrCreateSegment()

Access to the segment object of this entity or a new empty segment that will not be linked to the parent element.

Returns:

a XBRLSegment object

See Also:

setSegment(XBRLSegment)

equals

public boolean equals(java.lang.Object other)

Equals.

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

generateNode

public XBRLEntity generateNode()
                        throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XMLFragment

Returns:

the XBRL entity

Throws:

XBRLSerializationException - the XBRL serialization exception

getValue

public net.sf.saxon.s9api.XdmValue getValue()

Gets the value.

Overrides:

getValue in class XMLFragment

Returns:

the value

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