com.ihr.xbrl.mapper.instance

Class MapperSection

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

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 MapperSection
extends XMLFragment

Starting with mapper version 3 (2011) there is the possibility to create mapping sections.

Mapping sections are groups of facts that belongs to a section this allows for the following features:

• It is possible to classify facts to the section they belong
• It is possible to divide the target DTS into multiple sections
• It is possible to define rules to let drivers decide if the section will be added or not to the target instance (only drivers on facts within the section will be asked to include that section)

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	mapperSectionQName The Constant mapperSectionQName.

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
MapperSection(DTSContainer dts) Instantiates a new mapper xbrlMap/instance/section node.
MapperSection(DTSContainer dts, java.lang.String id, java.util.Collection<java.lang.String> files) Instantiates a new mapper xbrlMap/instance/section node.

Method Summary

Modifier and Type	Method and Description
void	addFilesTo(XBRLInstance instance) Adds referenced files to the instance document.
boolean	equals(java.lang.Object obj) Equals.
java.util.Iterator<java.lang.String>	getFiles() Gets the files.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
MapperAnchor	getMapperAnchor() Gets the anchor node.
MapperDocumentation	getMapperDocumentation() Gets the mapper documentation node.
int	getNumberOfChildren()
java.lang.String	getRuleIdentifier() Gets the rule identifier.
boolean	hasChildNodes()
int	hashCode() Hash code.
boolean	hasRule() Returns true if this section has a rule.
void	setAnchor(java.lang.String sectionLink, javax.xml.namespace.QName sectionElement) Sets the anchor.
void	setDocumentation(java.lang.String documentation) Sets the documentation value.
void	setId(java.lang.String id) Sets the id of this section. if null, the section id is reset to the next automatically generated section id as the section id must exist.
void	setMapperAnchor(MapperAnchor anchor) Sets the anchor.
void	setRuleIdentifier(java.lang.String ruleIdentifier) Sets the rule identifier.

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

mapperSectionQName

public static final javax.xml.namespace.QName mapperSectionQName

The Constant mapperSectionQName.

Constructor Detail

MapperSection

public MapperSection(DTSContainer dts)

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

Parameters:

dts - the DTS

MapperSection

public MapperSection(DTSContainer dts,
                     java.lang.String id,
                     java.util.Collection<java.lang.String> files)
              throws MapException

Instantiates a new mapper xbrlMap/instance/section node.

Parameters:

dts - the DTS

id - the id

files - the files

Throws:

MapException - the map exception

Method Detail

hasRule

public boolean hasRule()

Returns true if this section has a rule. Returns false otherwise.

Returns:

boolean value

getRuleIdentifier

public java.lang.String getRuleIdentifier()

Gets the rule identifier.

Returns:

the ruleIdentifier

setRuleIdentifier

public void setRuleIdentifier(java.lang.String ruleIdentifier)

Sets the rule identifier.

Parameters:

ruleIdentifier - the ruleIdentifier to set

addFilesTo

public void addFilesTo(XBRLInstance instance)
                throws MapException

Adds referenced files to the instance document.

Parameters:

instance - the instance

Throws:

MapException - the map exception

setId

public void setId(java.lang.String id)
           throws XBRLInconsistentDTSException

Sets the id of this section. if null, the section id is reset to the next automatically generated section id as the section id must exist.

Overrides:

setId in class XMLFragment

Parameters:

id - the id to set

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent DTS exception

getMapperDocumentation

public MapperDocumentation getMapperDocumentation()

Gets the mapper documentation node. Must be public, it is used from C#

Returns:

the documentation

setDocumentation

public void setDocumentation(java.lang.String documentation)

Sets the documentation value.

Parameters:

documentation - the new documentation

setAnchor

public void setAnchor(java.lang.String sectionLink,
                      javax.xml.namespace.QName sectionElement)

Sets the anchor.

Parameters:

sectionLink - the section link

sectionElement - the section element

setMapperAnchor

public void setMapperAnchor(MapperAnchor anchor)

Sets the anchor. Must be public, it is used from C#

Parameters:

anchor - the new mapper anchor

getMapperAnchor

public MapperAnchor getMapperAnchor()

Gets the anchor node. Must be public, it is used from C#

Returns:

the anchor

getFiles

public java.util.Iterator<java.lang.String> getFiles()

Gets the files. Must be public, it is used from C#

Returns:

the vURL

hashCode

public int hashCode()

Description copied from class: XMLFragment

Hash code.

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 net.sf.saxon.om.NodeInfo

Overrides:

equals in class XMLFragment

Parameters:

obj - the other

Returns:

true, if successful

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