com.ihr.xbrl.om.instance
Class XBRLFactNonNumeric

java.lang.Object
  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:

ObtainHistoryInterface, StoreHistoryInterface, XBRLRelationshipPoint, XBRLValidation, XMLHasParent, java.lang.Cloneable, javax.xml.namespace.NamespaceContext

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

Nested Class Summary

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

nil

Fields inherited from class com.ihr.xbrl.om.XMLFragment

CONCEPT_LABEL, CONCEPT_QNAME, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, idQName, NO_POSITION, OrderComparator, PERIOD_TYPE, PERIOD_VALUE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Constructor Summary

XBRLFactNonNumeric(XBRLFactsList container, XBRLContext context, XBRLItem item)
Creates a fact for non numeric valus and adds it to the container object.

Method Summary

XBRLFactNonNumeric	clone()
XBRLFactNonNumeric	clone(DTSContainer newDTS) Clone current fact but in a new DTSContainer
org.jdom.Element	generateNode(boolean relativize, java.net.URI base) Generates the XBRLFactItem jdom node.
java.lang.String	getFriendlyName() Returns a string description that represents the element content in a form that users can understand.
java.lang.String	getFriendlyName(int modifiers, LabelsProvider lp) Returns a string description that represents the element content in a form that users can understand.
boolean	isDuplicate(XBRLFact otherFact) Check if two items are duplicates as defined in the XBRL 2.1 specification
boolean	isDuplicate(XBRLFactItem otherFact, boolean reversePEqual) For internal purposes only during the calculation of isDuplicate of tuple children elements.
boolean	uEqual(XBRLFactItem toFact) Check if two items are unit equal as defined in the XBRL 2.1 specification
boolean	vEqual(XBRLFactItem toFact) Check if two items are value equal as defined in the XBRL 2.1 specification

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

cEqual, clear, createItemInstance, createItemInstance, createItemInstance, equals, getAttributes, getContext, getDocumentURI, getElementDefinition, getStringValue, hashCode, isBlank, isDescendantOrSibling, s_equal2, setBlank, setContext, setValue, setValue

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

addEvent, addEvent, addEvent, createItemOrTupleInstance, createItemOrTupleInstance, generateLocatorToNode, getElements, getHistory, getHistoryAsString, getInstance, getParent, getTaxonomy, getValidationReport, getXPathToRoot, invalidate, invalidate, isNil, isOnValidation, pEqual, setId, setNil, setParent, validate

Methods inherited from class com.ihr.xbrl.om.XMLFragment

addAttribute, addChild, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, delAttribute, delAttribute, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAttribute, getAttributeQNameValue, getAttributes, getAttributeStringValue, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getContainerDocumentURI, getDeclaredNamespaces, getDocument, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getLang, getNamespaceURI, getNodeName, getNumberOfAttributes, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathNamespaceContext, getXPathToNode, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, isDead, isNamespaceDefined, objEquals, objHashCode, qNameToString, removeAttribute, removeChild, removeChild, removeFromRelationship, removeToRelationship, removeXMLChild, resetElements, resetHash, resolveHRef, resolveHRef, s_equal2, setAttributes, setBase, setDocument, setDocumentAndReload, setElements, setLang, setNamespaceContext, setNamespaces, setNode, setNodeName, setParent, setVariablesDefined, toString, valueEquals, xEqual

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XBRLFactNonNumeric

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

Creates a fact for non numeric valus and adds it to the container object. This method is intented 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

context - - the context for this new fact

item - - the taxonomy object for this new fact

Method Detail

clone

public XBRLFactNonNumeric clone()

Overrides:

clone in class XBRLFactItem

clone

public XBRLFactNonNumeric clone(DTSContainer newDTS)

Description copied from class: XBRLFact

Clone current fact but in a new DTSContainer

Overrides:

clone in class XBRLFactItem

Returns:

cloned XBRLFact

vEqual

public boolean vEqual(XBRLFactItem toFact)

Description copied from class: XBRLFactItem

Check if two items are value equal as defined in the XBRL 2.1 specification

Specified by:

vEqual in class XBRLFactItem

Parameters:

toFact - the other XBRLFactItem

Returns:

boolean

isDuplicate

public boolean isDuplicate(XBRLFact otherFact)

Description copied from class: XBRLFact

Check if two items are duplicates as defined in the XBRL 2.1 specification

Specified by:

isDuplicate in class XBRLFact

Parameters:

otherFact - the other XBRLFactItem

Returns:

boolean

isDuplicate

public boolean isDuplicate(XBRLFactItem otherFact,
                           boolean reversePEqual)

Description copied from class: XBRLFactItem

For internal purposes only during the calculation of isDuplicate of tuple children elements.

Specified by:

isDuplicate in class XBRLFactItem

Returns:

boolean value

generateNode

public org.jdom.Element generateNode(boolean relativize,
                                     java.net.URI base)
                              throws XBRLSerializationException

Description copied from class: XBRLFactItem

Generates the XBRLFactItem jdom node. If neccesary, generates the footnotes defined for this node.

Overrides:

generateNode in class XBRLFactItem

Parameters:

relativize - boolean indicating if URIs should be relativized to the base URI (see next argument)

base - the URI to which some attributes of this object should be relativided

Returns:

a clone of the surrounding jdom Element so it can be incorporated into multiple trees

Throws:

XBRLSerializationException

uEqual

public boolean uEqual(XBRLFactItem toFact)

Description copied from class: XBRLFactItem

Check if two items are unit equal as defined in the XBRL 2.1 specification

Specified by:

uEqual in class XBRLFactItem

Parameters:

toFact - the other XBRLFactItem

Returns:

boolean

getFriendlyName

public java.lang.String getFriendlyName()

Description copied from class: XMLFragment

Returns a string description that represents the element content in a form that users can understand. This method may be overridden by parent classes.

Remarks, this method may return very long names not suitable for user interface

Overrides:

getFriendlyName in class XBRLFact

Returns:

Non empty String. Internationalization is enabled

getFriendlyName

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

Description copied from class: XMLFragment

Returns a string description that represents the element content in a form that users can understand. This method may be override by parent classes.

This function accepts flags that are defined as constants in XMLFragment in order to modify the output.

• XMLFragment.XPOINTER includes the element position in the source file using the XPointer specification. Note, if the document is created from objects the value may not be available
• XMLFragment.XPATH includes the element position in the source file using XPATH. Note, if the document is created from objects the value may not be available
• XMLFragment.NO_POSITION does not include the element position in the source file.
• XMLFragment.CONCEPT_QNAME for XBRLItem, XBRLTuple and XMLElementDefinition.
• XMLFragment.CONCEPT_LABEL for XBRLItema and XBRLTuple.
• XMLFragment.FACT_QNAME for facts.
• XMLFragment.FACT_CONCEPT_LABEL for facts.
• XMLFragment.SHORT_TEXT for resources, returns the resource text, id or xlink:label

Overrides:

getFriendlyName in class XBRLFact

Parameters:

modifiers - integer

Returns:

a String representation of this fact.