com.ihr.xbrl.mapper.instance

Class MapperFacts

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.mapper.instance.MapperFacts

All Implemented Interfaces:

HasDTSContainer, HasMapperFacts, 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 MapperFacts
extends XMLFragment
implements HasMapperFacts

This class represents a xbrlMap/instance/facts node in the mapper.

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>

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	mapperFactsQName The Constant mapperFactsQName.

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
MapperFacts(DTSContainer dts, MapperBase mapperBase) Instantiates a new mapper xbrlMap/instance/facts node.

Method Summary

Modifier and Type	Method and Description
void	addChildToIndex(MapperFact e) Called during the SAX parse process to add child to factsContent
void	addFact(MapperFact newMapperFact) Adds a MapperFact node.
void	addFactAt(MapperFact newMapperFact, int pos) Adds a MapperFact node at the given pos.
void	clear() Frees-up used memory This method should not be invoqued on live objects in the DTS.
void	delFact(MapperFact mapperFact) Deletes a MapperFact node.
java.util.Iterator<MapperFact>	getChildrenFacts() Access to an iterator over the children facts of this object.
int	getChildrenFactsCount() Returns the number of facts.
MapperFact	getFactFromMapIdentifier(java.lang.String mapIdentifier) Gets the fact from map identifier.
java.util.List<MapperFact>	getFactsList() Access to all mapperFacts.
java.util.Map<java.lang.String,MapperFact>	getFactsMap() Gets the facts map.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
java.util.Set<java.lang.String>	getMapIdentifiersSet() Gets the map identifiers set.
HasMapperFacts	getMapperParent() Access to the parent element of a Fact.
int	getNumberOfChildren()
boolean	hasChildNodes()
int	hashCode() Hash code.
MapperFact	processAddNodeFact(ClsDataForNewNode c, java.util.Map<java.lang.String,java.lang.String> contextMap, java.util.Map<java.lang.String,java.lang.String> unitMap) Process add node fact.
void	recursiveReadFacts(net.sf.saxon.s9api.XdmValue lstFacts, java.util.List<MapperFact> facts, HasMapperFacts mapperParent, java.util.List<ClsDataForNewNode> vDuplicateIdentifierNodes, java.util.Map<java.lang.String,java.lang.String> contextMap, java.util.Map<java.lang.String,java.lang.String> unitMap) Recursive read facts.
void	registerFact(MapperFact mapperFact) Registers a new fact has been added to the container.
void	unregisterFact(MapperFact mapperFact) Same as HasMapperFacts.registerFact(MapperFact) but in this case for removing the information stored.

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, clone, clone, commitBatch, copy, createComment, delAttribute, delAttribute, delete, equals, equalXdmValues, findFirstNodeOfClass, findPosition, firePropertyChangeEvent, generateId, generateLocatorToNode, generateNode, 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, 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, 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

equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ihr.xbrl.mapper.HasMapperFacts

equals

Field Detail

mapperFactsQName

public static final javax.xml.namespace.QName mapperFactsQName

The Constant mapperFactsQName.

Constructor Detail

MapperFacts

public MapperFacts(DTSContainer dts,
                   MapperBase mapperBase)

Instantiates a new mapper xbrlMap/instance/facts node. Internally constructor for XMLFragmentMapFactory class.

Parameters:

dts - the DTS

mapperBase - the mapper base

Method Detail

clear

public void clear()
           throws java.lang.Throwable

Description copied from class: XMLFragment

Frees-up used memory

This method should not be invoqued on live objects in the DTS. It is automatically invoqued by the API when an object is no longer used and referenced by other objects. It is save not to call it directly.

Overrides:

clear in class XMLFragment

Throws:

java.lang.Throwable - the throwable

hashCode

public int hashCode()

Description copied from class: XMLFragment

Hash code.

Specified by:

hashCode in interface HasMapperFacts

Specified by:

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

Overrides:

hashCode in class XMLFragment

Returns:

the int

addFact

public void addFact(MapperFact newMapperFact)
             throws MapConfigurationFileException

Adds a MapperFact node.

Specified by:

addFact in interface HasMapperFacts

Parameters:

newMapperFact - the new mapper fact

Throws:

MapConfigurationFileException - the map configuration file exception

addFactAt

public void addFactAt(MapperFact newMapperFact,
                      int pos)
               throws MapConfigurationFileException

Adds a MapperFact node at the given pos.

Specified by:

addFactAt in interface HasMapperFacts

Parameters:

newMapperFact - the new mapper fact

pos - the pos

Throws:

MapConfigurationFileException - the map configuration file exception

delFact

public void delFact(MapperFact mapperFact)

Deletes a MapperFact node.

Specified by:

delFact in interface HasMapperFacts

Parameters:

mapperFact - the mapper fact

getChildrenFacts

public java.util.Iterator<MapperFact> getChildrenFacts()

Description copied from interface: HasMapperFacts

Access to an iterator over the children facts of this object.

Specified by:

getChildrenFacts in interface HasMapperFacts

Returns:

Iterator over children facts

getChildrenFactsCount

public int getChildrenFactsCount()

Description copied from interface: HasMapperFacts

Returns the number of facts.

Specified by:

getChildrenFactsCount in interface HasMapperFacts

Returns:

the children facts count

getMapperParent

public HasMapperFacts getMapperParent()

Description copied from interface: HasMapperFacts

Access to the parent element of a Fact. This is null only when the current HasMapperFacts is a template document

Specified by:

getMapperParent in interface HasMapperFacts

Returns:

MapperFact that represents a tupleFact or templateDocument. Null when current HasMapperFacts object is the template.

registerFact

public void registerFact(MapperFact mapperFact)
                  throws MapConfigurationFileException

Description copied from interface: HasMapperFacts

Registers a new fact has been added to the container. This method updates the Hashtables in the instance template and passes UP to its parent the registration of facts for tuples. This method is called internally by the API and should not be called manually

Specified by:

registerFact in interface HasMapperFacts

Parameters:

mapperFact - the fact

Throws:

MapConfigurationFileException - the map configuration file exception

unregisterFact

public void unregisterFact(MapperFact mapperFact)

Description copied from interface: HasMapperFacts

Same as HasMapperFacts.registerFact(MapperFact) but in this case for removing the information stored.

Specified by:

unregisterFact in interface HasMapperFacts

Parameters:

mapperFact - the fact

getFactsList

public java.util.List<MapperFact> getFactsList()

Access to all mapperFacts.

Returns:

the facts list

getMapIdentifiersSet

public java.util.Set<java.lang.String> getMapIdentifiersSet()

Gets the map identifiers set.

Returns:

the map identifiers set

getFactsMap

public java.util.Map<java.lang.String,MapperFact> getFactsMap()

Gets the facts map.

Returns:

the facts map

getFactFromMapIdentifier

public MapperFact getFactFromMapIdentifier(java.lang.String mapIdentifier)

Gets the fact from map identifier.

Parameters:

mapIdentifier - the map identifier

Returns:

the fact from map identifier

recursiveReadFacts

public void recursiveReadFacts(net.sf.saxon.s9api.XdmValue lstFacts,
                               java.util.List<MapperFact> facts,
                               HasMapperFacts mapperParent,
                               java.util.List<ClsDataForNewNode> vDuplicateIdentifierNodes,
                               java.util.Map<java.lang.String,java.lang.String> contextMap,
                               java.util.Map<java.lang.String,java.lang.String> unitMap)
                        throws MapConfigurationFileException

Recursive read facts.

Parameters:

lstFacts - the lst facts

facts - the facts

mapperParent - the parent

vDuplicateIdentifierNodes - the v duplicate identifier nodes

contextMap - map old context ids with new context ids

Throws:

MapConfigurationFileException - the map configuration file exception

processAddNodeFact

public MapperFact processAddNodeFact(ClsDataForNewNode c,
                                     java.util.Map<java.lang.String,java.lang.String> contextMap,
                                     java.util.Map<java.lang.String,java.lang.String> unitMap)
                              throws MapConfigurationFileException

Process add node fact.

Parameters:

c - the c

contextMap - the context map

Returns:

the fact

Throws:

MapConfigurationFileException - the map configuration file exception

addChildToIndex

public void addChildToIndex(MapperFact e)

Description copied from interface: HasMapperFacts

Called during the SAX parse process to add child to factsContent

Specified by:

addChildToIndex in interface HasMapperFacts

Parameters:

e -

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