com.ihr.xbrl.om.instance

Class XBRLFactNonNumeric

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

com.ihr.xbrl.om.instance.XBRLFactItem

com.ihr.xbrl.om.instance.XBRLFactNonNumeric

All Implemented Interfaces:

HasDTSContainer, ObtainHistoryInterface, StoreHistoryInterface, XBRLRelationshipPoint, HasChangeHashSupport, XBRLValidation, 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 XBRLFactNonNumeric
extends XBRLFactItem

This object represents a non numeric fact value in an instance document. Non numeric facts can be created from an application or from an instance document. Nil non numeric facts can be created by instantiating an object of this class and callling setNil(true) later.

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 inherited from class com.ihr.xbrl.om.instance.XBRLFactItem

contextRef

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
XBRLFactNonNumeric(DTSContainer dts) Instantiates a new XBRL fact non numeric.
XBRLFactNonNumeric(XBRLFactsList container, XBRLContext context, XBRLItem item, boolean addToParentNow) Creates a fact for non numeric values and adds it to the container object.
XBRLFactNonNumeric(XBRLFactsList container, XBRLContext context, XBRLItem item, java.lang.String value, boolean addToParentNow) Creates a fact for non numeric values and adds it to the container object.

Method Summary

Modifier and Type	Method and Description
XBRLFactNonNumeric	clone() Clone.
XBRLFactNonNumeric	clone(DTSContainer newDTS) Clone.
XBRLFactNonNumeric	generateNode() Generate node.
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.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
boolean	hasChildNodes()
int	hashCode() Hash code.
boolean	isBase64() Evaluate if the content of this non numeric fact is a binary file using base64 data type.
boolean	isDuplicate(XBRLFact otherFact) Checks if is duplicate.
boolean	isDuplicate(XBRLFactItem otherFact, boolean reversePEqual) Checks if is duplicate.
boolean	isEncodedHTML() Evaluate if the content of this non numeric fact is an HTML string or plain text.
boolean	isEnumerable() Evaluate if the content of this non numeric fact is an enumerated list according with the extensible enumerations specification.
boolean	isQName() Evaluate if the content of this non numeric fact is a QName data type.
static XBRLFactNonNumeric	make(XBRLFactsList container, XBRLContext context, XBRLItem item, boolean addToParentNow) Make.
static XBRLFactNonNumeric	make(XBRLFactsList container, XBRLContext context, XBRLItem item, java.lang.String value, boolean addToParentNow) Make.
boolean	uEqual(XBRLFactItem toFact) U equal.
boolean	vEqual(XBRLFactItem toFact) V equal.

Methods inherited from class com.ihr.xbrl.om.instance.XBRLFactItem

cEqual, createFractionItemInstance, createItemInstance, createItemInstance, createNonNumericItemInstance, createNumericItemInstance, equals, getAttributes, getContext, getDocumentURI, getElementDefinition, getStringValue, isDescendantOrSibling, isHashDependsOnAtribute, s_equal2, setContext

Methods inherited from class com.ihr.xbrl.om.instance.XBRLFact

addEvent, clear, createFractionItemInstance, createItemOrTupleInstance, createNonNumericItemInstance, createNumericItemInstance, createTupleInstance, delete, getCode, getElements, getHistory, getHistoryAsHTMLString, getHistoryAsString, getInstance, getParentXBRL, getParentXBRLFactsList, getTaxonomy, getValidationReport, getValue, getXPathToRoot, invalidate, invalidate, isBlank, isOnValidation, pEqual, setBlank, setCode, setId, setInstance, setNil, setParent, setValue, setValue, setValue, setValue, setValue, setValue, setValue, 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, 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, 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, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getXPath, getXPathFromXPointer, getXPathNamespaceContext, 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, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNodeName, setRawParentXBRL, 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

Constructor Detail

XBRLFactNonNumeric

public XBRLFactNonNumeric(DTSContainer dts)

Instantiates a new XBRL fact non numeric. This method is used when the SAX parser reads XML nodes from the instance document file

Parameters:

dts - the dts

XBRLFactNonNumeric

public XBRLFactNonNumeric(XBRLFactsList container,
                          XBRLContext context,
                          XBRLItem item,
                          boolean addToParentNow)

Creates a fact for non numeric values and adds it to the container object. This method is to be used to create non numeric facts from an application. nodeInfo is not a requirement.

the fact value will not be set and the status will be blank

Parameters:

container - - The XBRLFactsContainer this object will be added to, can be null if the fact will be added to the container later

context - - the context for this new fact

item - - the taxonomy object for this new fact

addToParentNow - if this is true, the new fact will be added to the instance. If this is false, call container.add(...) later

XBRLFactNonNumeric

public XBRLFactNonNumeric(XBRLFactsList container,
                          XBRLContext context,
                          XBRLItem item,
                          java.lang.String value,
                          boolean addToParentNow)

Creates a fact for non numeric values and adds it to the container object. This method is intended to be used to create non numeric facts from an application. nodeInfo is not a requirement.

Parameters:

container - - The XBRLFactsContainer this object will be added to, can be null if the fact will be added to the container later

context - - the context for this new fact

item - - the taxonomy object for this new fact

value - the value

addToParentNow - if this is true, the new fact will be added to the instance. If this is false, call container.add(...) later

Method Detail

make

public static XBRLFactNonNumeric make(XBRLFactsList container,
                                      XBRLContext context,
                                      XBRLItem item,
                                      boolean addToParentNow)

Make.

Parameters:

container - the container

context - the context

item - the item

addToParentNow - if this is true, the new fact will be added to the instance. If this is false, call container.add(...) later

Returns:

the XBRL fact non numeric

make

public static XBRLFactNonNumeric make(XBRLFactsList container,
                                      XBRLContext context,
                                      XBRLItem item,
                                      java.lang.String value,
                                      boolean addToParentNow)

Make.

Parameters:

container - the container

context - the context

item - the item

value - the value

addToParentNow - if this is true, the new fact will be added to the instance. If this is false, call container.add(...) later

Returns:

the XBRL fact non numeric

clone

public XBRLFactNonNumeric clone()

Clone.

Overrides:

clone in class XBRLFactItem

Returns:

the XBRL fact non numeric

clone

public XBRLFactNonNumeric clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XBRLFactItem

Parameters:

newDTS - the new DTS

Returns:

the XBRL fact non numeric

vEqual

public boolean vEqual(XBRLFactItem toFact)

V equal.

Specified by:

vEqual in class XBRLFactItem

Parameters:

toFact - the to fact

Returns:

true, if successful

isDuplicate

public boolean isDuplicate(XBRLFact otherFact)

Checks if is duplicate.

Specified by:

isDuplicate in class XBRLFact

Parameters:

otherFact - the other fact

Returns:

true, if is duplicate

isDuplicate

public boolean isDuplicate(XBRLFactItem otherFact,
                           boolean reversePEqual)

Checks if is duplicate.

Specified by:

isDuplicate in class XBRLFactItem

Parameters:

otherFact - the other fact

reversePEqual - the reverse P equal

Returns:

true, if is duplicate

isEncodedHTML

public boolean isEncodedHTML()

Evaluate if the content of this non numeric fact is an HTML string or plain text.

In previous versions this functionality was is the EFM processor. Not it is here for convenience.

Returns:

true if the content is HTML or seems to be HTML

Since:

2.8.3

isBase64

public boolean isBase64()

Evaluate if the content of this non numeric fact is a binary file using base64 data type.

Returns:

true if this non numeric fact is derived from xbrli:base64BinaryItemType

isQName

public boolean isQName()

Evaluate if the content of this non numeric fact is a QName data type.

Returns:

true if this non numeric fact is derived from xbrli:QNameItemType

isEnumerable

public boolean isEnumerable()

Evaluate if the content of this non numeric fact is an enumerated list according with the extensible enumerations specification.

Returns:

true if the fact is an enumerated list

generateNode

public XBRLFactNonNumeric generateNode()
                                throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XBRLFactItem

Returns:

the XBRL fact non numeric

Throws:

XBRLSerializationException - the XBRL serialization exception

uEqual

public boolean uEqual(XBRLFactItem toFact)

U equal.

Specified by:

uEqual in class XBRLFactItem

Parameters:

toFact - the to fact

Returns:

true, if successful

hashCode

public int hashCode()

Hash code.

Specified by:

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

Overrides:

hashCode in class XBRLFactItem

Returns:

the int

getFriendlyName

public java.lang.String getFriendlyName()

Gets the friendly name.

Overrides:

getFriendlyName in class XBRLFact

Returns:

the friendly name

getFriendlyName

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

Gets the friendly name.

Overrides:

getFriendlyName in class XBRLFact

Parameters:

modifiers - the modifiers

lp - the lp

Returns:

the friendly name

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