com.ihr.xbrl.mapper
Class Section

java.lang.Object
  com.ihr.xbrl.mapper.Section

public class Section
extends java.lang.Object

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

Constructor Summary

Section(java.lang.String id, java.util.Collection<java.lang.String> files)

Section(java.lang.String id, java.lang.String file)

Section(java.lang.String id, java.lang.String[] files)

Section(net.sf.saxon.s9api.XdmNode node)

Method Summary

void	addFact(Fact d)
void	addFilesTo(XBRLInstance instance) Adds referenced files to the instance document.
boolean	equals(java.lang.Object obj)
org.jdom.Element	generateNode(boolean relativize, java.net.URI base)
Anchor	getAnchor()
java.lang.String	getDocumentation()
java.util.Iterator<java.lang.String>	getFiles()
java.lang.String	getId() Returns the section identifier
java.lang.String	getRuleIdentifier()
int	hashCode()
boolean	hasRule() Returns true if this section has a rule.
void	setAnchor(Anchor anchor) Sets this section anchor
void	setAnchor(java.lang.String sectionLink, javax.xml.namespace.QName sectionElement)
void	setDocumentation(java.lang.String documentation)
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	setRuleIdentifier(java.lang.String ruleIdentifier)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Section

public Section(net.sf.saxon.s9api.XdmNode node)
        throws MapConfigurationFileException

Parameters:

next -

Throws:

MapConfigurationFileException

Section

public Section(java.lang.String id,
               java.lang.String file)

Section

public Section(java.lang.String id,
               java.lang.String[] files)

Section

public Section(java.lang.String id,
               java.util.Collection<java.lang.String> files)

Method Detail

getId

public java.lang.String getId()

Returns the section identifier

Returns:

addFact

public void addFact(Fact d)

Parameters:

d -

generateNode

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

Throws:

XBRLSerializationException

hasRule

public boolean hasRule()

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

Returns:

boolean value

getRuleIdentifier

public java.lang.String getRuleIdentifier()

Returns:

the ruleIdentifier

setRuleIdentifier

public void setRuleIdentifier(java.lang.String ruleIdentifier)

Parameters:

ruleIdentifier - the ruleIdentifier to set

addFilesTo

public void addFilesTo(XBRLInstance instance)
                throws MapException

Adds referenced files to the instance document.

Parameters:

instance -

Throws:

MapConfigurationFileException

MapException

setId

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

Parameters:

id - the id to set

getDocumentation

public java.lang.String getDocumentation()

Returns:

the documentation

setDocumentation

public void setDocumentation(java.lang.String documentation)

Parameters:

documentation -

setAnchor

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

Parameters:

sectionLink -

sectionElement -

setAnchor

public void setAnchor(Anchor anchor)

Sets this section anchor

Parameters:

anchor -

getAnchor

public Anchor getAnchor()

Returns:

the anchor

getFiles

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

Returns:

the vURL

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object