com.ihr.xbrl.mapper.instance

Class MapperFact

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

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 MapperFact
extends XMLFragment
implements HasMapperFacts

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

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapperFact.Type The Enum Type.

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 int	ALL The Constant ALL.
static javax.xml.namespace.QName	groupDocNode
static javax.xml.namespace.QName	itemDocNode
static int	PREV The Constant PREV.
static int	SINGLE The Constant SINGLE.
static javax.xml.namespace.QName	tupleDocNode

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
MapperFact(MapperBase mapperBase) Instantiates a new mapper xbrlMap/instance/facts/fact node.
MapperFact(MapperBase mapperBase, MapperFact.Type type) Instantiates a new mapper xbrlMap/instance/facts/fact node.
MapperFact(MapperBase mapperBase, MapperFact.Type type, HasMapperFacts parent, XBRLDataSource source, MapperContext context, java.lang.String mapIdentifier, javax.xml.namespace.QName concept, XBRLUnit unit, int multi) Instantiates a new fact.

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 newFact) Adds a new Fact to the end of the Facts container.
void	addFactArray(MapperFact[] newFacts) Adds a set of new facts to the end of this group fact.
void	addFactAt(MapperFact newFact, int pos) Adds a new Fact at the position indicated by pos.
void	delFact(MapperFact fact) Removes a fact from the container.
boolean	equals(java.lang.Object obj) Equals.
java.util.Iterator<MapperFact>	getChildrenFacts() Access to an iterator over the children facts of this object.
int	getChildrenFactsCount() Returns the number of facts.
javax.xml.namespace.QName	getConcept() The concept definition in the taxonomy that corresponds to this fact in the template.
XMLElementDefinition	getConceptElement() Gets the concept definition QName.
MapperContext	getContext() Gets the MapperContext node.
java.lang.String	getContextRef() Gets the contextRef property.
java.util.Collection<XBRLFact>	getFacts(XBRLFactsList cf, int index, XBRLValidationReport mapReport) Gets the facts.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
java.lang.String	getMapIdentifier() Gets the mapIdentifier property.
HasMapperFacts	getMapperParent() Access to the parent element of a Fact.
int	getMulti() Gets the multi property.
int	getNumberOfChildren()
int	getNumberOfValues() Gets the number of source values.
MapperSection	getSection() Gets the MapperSection node.
java.lang.String	getSectionRef() Gets the sectionRef property.
XBRLDataSource	getSource() Gets the XBRLDataSource.
java.lang.String	getSourceRef() Gets the sourceRef property.
net.sf.saxon.s9api.XdmValue	getSubFacts() Gets child facts.
MapperFact.Type	getType() Gets the type property.
XBRLUnit	getUnit() Gets the unit.
java.lang.String	getUnitRef() Gets the unitRef property.
ListMapperFacts	getVFacts() Gets the v facts.
boolean	hasChildNodes()
int	hashCode() Hash code.
void	registerFact(MapperFact fact) Registers a new fact has been added to the container.
void	setConcept(javax.xml.namespace.QName concept) Sets the concept.
void	setConcept(XMLElementDefinition concept) Sets the concept definition in the taxonomy.
void	setContext(MapperContext newMapperContext) Replaces context by a new context.
void	setMapIdentifier(java.lang.String mapIdentifier) Sets the mapIdentifier property.
void	setMapperParent(HasMapperFacts mapperParent) Sets the mapper parent node.
void	setMapperParent(MapperBase mapperBase) Sets the mapper parent node.
void	setMulti(int multi) Sets the multi property.
void	setSection(MapperSection mapperSection) Replaces the MapperSection node by a new one.
void	setSource(XBRLDataSource source) Sets the XBRLDataSource.
void	setUnit(XBRLUnit unit) Replaces unit by a new unit.
void	unregisterFact(MapperFact fact) 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, clear, clone, clone, commitBatch, copy, createComment, delAttribute, delAttribute, delete, 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

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final int ALL

The Constant ALL.

See Also:

Constant Field Values

SINGLE

public static final int SINGLE

The Constant SINGLE.

See Also:

Constant Field Values

PREV

public static final int PREV

The Constant PREV.

See Also:

Constant Field Values

itemDocNode

public static final javax.xml.namespace.QName itemDocNode

tupleDocNode

public static final javax.xml.namespace.QName tupleDocNode

groupDocNode

public static final javax.xml.namespace.QName groupDocNode

Constructor Detail

MapperFact

public MapperFact(MapperBase mapperBase)

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

Parameters:

mapperBase - the MapperBase

MapperFact

public MapperFact(MapperBase mapperBase,
                  MapperFact.Type type)

Instantiates a new mapper xbrlMap/instance/facts/fact node.

Parameters:

mapperBase - the MapperBase

type - the MapperFact.Type type

MapperFact

public MapperFact(MapperBase mapperBase,
                  MapperFact.Type type,
                  HasMapperFacts parent,
                  XBRLDataSource source,
                  MapperContext context,
                  java.lang.String mapIdentifier,
                  javax.xml.namespace.QName concept,
                  XBRLUnit unit,
                  int multi)

Instantiates a new fact. This constructor is required by the C# code

Parameters:

mapperBase - the mapper base

type - the type

parent - the parent

source - the source

context - the context

mapIdentifier - the map identifier

concept - the concept

unit - the unit

multi - the multi

Method Detail

getMapIdentifier

public java.lang.String getMapIdentifier()

Gets the mapIdentifier property.

Returns:

mapIdentifier

setMapIdentifier

public void setMapIdentifier(java.lang.String mapIdentifier)

Sets the mapIdentifier property.

Parameters:

mapIdentifier - the new map identifier

getContext

public MapperContext getContext()

Gets the MapperContext node.

Returns:

the MapperContext

getContextRef

public java.lang.String getContextRef()

Gets the contextRef property.

Returns:

contextRef

setContext

public void setContext(MapperContext newMapperContext)

Replaces context by a new context. The new context must be c-equal to current context to avoid further problems in the generation of the hashCode

Parameters:

newMapperContext - the new context

getUnit

public XBRLUnit getUnit()

Gets the unit.

Returns:

the unit. If this is not a numeric unit or it is a tuple null is returned

getUnitRef

public java.lang.String getUnitRef()

Gets the unitRef property.

Returns:

unitRef

setUnit

public void setUnit(XBRLUnit unit)

Replaces unit by a new unit.

Parameters:

unit - the new unit

getSection

public MapperSection getSection()

Gets the MapperSection node.

Returns:

the section

getSectionRef

public java.lang.String getSectionRef()

Gets the sectionRef property.

Returns:

sectionRef

setSection

public void setSection(MapperSection mapperSection)

Replaces the MapperSection node by a new one.

Parameters:

mapperSection - MapperSection

getSourceRef

public java.lang.String getSourceRef()

Gets the sourceRef property.

Returns:

sourceRef

getSource

public XBRLDataSource getSource()

Gets the XBRLDataSource.

Returns:

XBRLDataSource

setSource

public void setSource(XBRLDataSource source)
               throws MapConfigurationFileException

Sets the XBRLDataSource.

Parameters:

source - the new source

Throws:

MapConfigurationFileException - the map configuration file exception

getMulti

public int getMulti()

Gets the multi property.

Returns:

multi int

getNumberOfValues

public int getNumberOfValues()

Gets the number of source values.

Returns:

int

setMulti

public void setMulti(int multi)

Sets the multi property.

Parameters:

multi - the new multi

getConcept

public javax.xml.namespace.QName getConcept()

The concept definition in the taxonomy that corresponds to this fact in the template.

Returns:

the concept this is either an XBRLItem or XBRLTuple

setConcept

public void setConcept(XMLElementDefinition concept)

Sets the concept definition in the taxonomy.

Parameters:

concept - XMLElementDefinition

getConceptElement

public XMLElementDefinition getConceptElement()

Gets the concept definition QName.

Returns:

QName concept definition

setConcept

public void setConcept(javax.xml.namespace.QName concept)

Sets the concept.

Parameters:

concept - the new concept

getType

public MapperFact.Type getType()

Gets the type property.

Returns:

MapperFact.Type type

getSubFacts

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

Gets child facts.

Returns:

XdmValue

getFacts

public java.util.Collection<XBRLFact> getFacts(XBRLFactsList cf,
                                               int index,
                                               XBRLValidationReport mapReport)
                                        throws MapException

Gets the facts.

Parameters:

cf - the cf

index - the index

mapReport - the optional mapper report

Returns:

a XBRLFact Collection

Throws:

MapException - the map exception

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

equals

public boolean equals(java.lang.Object obj)

Description copied from class: XMLFragment

Equals.

Specified by:

equals in interface HasMapperFacts

Specified by:

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

Overrides:

equals in class XMLFragment

Parameters:

obj - the other

Returns:

true, if successful

getVFacts

public ListMapperFacts getVFacts()

Gets the v facts.

Returns:

the vFacts

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.

setMapperParent

public void setMapperParent(HasMapperFacts mapperParent)

Sets the mapper parent node.

Parameters:

mapperParent - the new mapper parent

setMapperParent

public void setMapperParent(MapperBase mapperBase)

Sets the mapper parent node.

Parameters:

mapperBase - the new mapper parent

addFact

public void addFact(MapperFact newFact)
             throws MapConfigurationFileException

Description copied from interface: HasMapperFacts

Adds a new Fact to the end of the Facts container.

This method does not updates the taxonomy URLs.

Specified by:

addFact in interface HasMapperFacts

Parameters:

newFact - the new fact to be added

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

addFactArray

public void addFactArray(MapperFact[] newFacts)
                  throws MapConfigurationFileException

Adds a set of new facts to the end of this group fact. Use carefully. The caller must be sure that all facts in the array are new facts. Use addFact(MapperFact) for each fact alternatively.

Parameters:

newFacts - the array of facts

Throws:

MapConfigurationFileException - the map configuration file exception

addFactAt

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

Description copied from interface: HasMapperFacts

Adds a new Fact at the position indicated by pos.

Specified by:

addFactAt in interface HasMapperFacts

Parameters:

newFact - Fact to be added

pos - integer. Zero based

Throws:

MapConfigurationFileException - the map configuration file exception

delFact

public void delFact(MapperFact fact)

Description copied from interface: HasMapperFacts

Removes a fact from the container.

Specified by:

delFact in interface HasMapperFacts

Parameters:

fact - Fact to remove

registerFact

public void registerFact(MapperFact fact)
                  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:

fact - the fact

Throws:

MapConfigurationFileException - the map configuration file exception

unregisterFact

public void unregisterFact(MapperFact fact)

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:

fact - the fact

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