com.ihr.xbrl.om.sax

Class IXBRLKeyElementsInterceptor

java.lang.Object

net.sf.saxon.event.Builder

com.ihr.xbrl.om.sax.XBRLSaxBuilder

com.ihr.xbrl.om.sax.IXBRLKeyElementsInterceptor

All Implemented Interfaces:

javax.xml.transform.Result, net.sf.saxon.event.Receiver

public class IXBRLKeyElementsInterceptor
extends XBRLSaxBuilder

This class will receive SAX events during the generation of the schema aware version of the document and will be used to capture NodeInfo elements for which a specific object shall be created.

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IXBRLKeyElementsInterceptor.NestedStackageIXElement The Interface NestedStackageIXElement.

Field Summary

Fields inherited from class net.sf.saxon.event.Builder

AXIOM_TREE, JDOM_TREE, JDOM2_TREE, LINKED_TREE, STANDARD_TREE, TINY_TREE, TINY_TREE_CONDENSED, UNSPECIFIED_TREE_MODEL

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Method Summary

Modifier and Type	Method and Description
void	attribute(net.sf.saxon.om.NodeName atName, net.sf.saxon.type.SimpleType atType, java.lang.CharSequence value, int locationId, int properties) Attribute.
void	characters(java.lang.CharSequence chars, int locationId, int properties) Characters.
void	endDocument() End document.
void	endElement() End element.
void	getEffectiveFootnoteValue(XMLFragment res, net.sf.saxon.tree.linked.NodeImpl baseIXFootnote) Special method used to set the value of XBRLResources that allows complexType mixing html and text.
void	getEffectiveFootnoteValueWithEscape(XMLFragment res, BaseIXElement ixElem) Returns the effective value of a node resolving ix:exclude and continuedAt attributes.
java.lang.String	getEffectiveValue(BaseIXElement ixElem) Returns the effective value of a node resolving ix:exclude and continuedAt attributes.
net.sf.saxon.value.AtomicValue	getFormattedValue(BaseIXElement fact) if the BaseIXFact contains a format attribute value this method applies the format to the effectiveValue.
net.sf.saxon.om.NodeInfo	getGeneratedElementById(java.lang.String id, XBRLExtendedLink el) Gets the generated element by id.
net.sf.saxon.om.NodeInfo	getIXElementById(java.lang.String id) Gets the IX element by id.
java.util.Set<javax.xml.namespace.QName>	getIxOtherAttrs(BaseIXElement ixElement, boolean filterSpec, boolean filterXML, java.util.Set<javax.xml.namespace.QName> except) Get ix:* Other attributes property: The set of attributes with a namespace name which has a value other than http://www.xbrl.org/2013/inlineXBRL.
net.sf.saxon.value.AtomicValue	getScaledAndSign(BaseIXElement fact) if the BaseIXFact contains a scale and or sign attribute value this method applies the transformations required in those attributes.
java.lang.String[]	getTargets() Returns the set of unique values of the target attributes so it is possible to access each instance separately.
XBRLInstance	getXBRLInstance(java.lang.String target) Gets the XBRL instance.
XBRLInstance[]	getXBRLInstances() Create an XBRLInstance with the information collected.
static boolean	isAllowContinuedAt(javax.xml.namespace.QName nodeName) Returns true when the node name is ix:continuation, ix:footnote or ix:nonNumeric and is in the 1.1 specification
void	namespace(net.sf.saxon.om.NamespaceBinding namespaceBinding, int properties) Namespace.
void	reset() Reset.
void	reset2() Called when the instance document has been generated with the information collected.
void	setGeneratedElementById(java.lang.String id, XMLFragment f) Sets the generated element by id.
void	setSystemId(java.lang.String systemId) Sets the system id.
void	startDocument(int properties) Start document.
void	startElement(net.sf.saxon.om.NodeName nameCode, net.sf.saxon.type.SchemaType typeCode, int locationId, int properties) Start element.

Methods inherited from class com.ihr.xbrl.om.sax.XBRLSaxBuilder

close, comment, getBaseURI, getBuilderMonitor, getConfiguration, getCurrentRoot, getPipelineConfiguration, getSystemId, isTiming, open, processingInstruction, setBaseURI, setLineNumbering, setPipelineConfiguration, setTiming, setUnparsedEntity, startContent, usesTypeAnnotations

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setSystemId

public void setSystemId(java.lang.String systemId)

Sets the system id.

Specified by:

setSystemId in interface javax.xml.transform.Result

Specified by:

setSystemId in interface net.sf.saxon.event.Receiver

Overrides:

setSystemId in class XBRLSaxBuilder

Parameters:

systemId - the new system id

startDocument

public void startDocument(int properties)
                   throws net.sf.saxon.trans.XPathException

Start document.

Specified by:

startDocument in interface net.sf.saxon.event.Receiver

Overrides:

startDocument in class XBRLSaxBuilder

Parameters:

properties - the properties

Throws:

net.sf.saxon.trans.XPathException - the x path exception

reset

public void reset()

Reset.

Overrides:

reset in class XBRLSaxBuilder

reset2

public void reset2()

Called when the instance document has been generated with the information collected.

endDocument

public void endDocument()
                 throws net.sf.saxon.trans.XPathException

End document.

Specified by:

endDocument in interface net.sf.saxon.event.Receiver

Overrides:

endDocument in class XBRLSaxBuilder

Throws:

net.sf.saxon.trans.XPathException - the x path exception

getIxOtherAttrs

public java.util.Set<javax.xml.namespace.QName> getIxOtherAttrs(BaseIXElement ixElement,
                                                                boolean filterSpec,
                                                                boolean filterXML,
                                                                java.util.Set<javax.xml.namespace.QName> except)

Get ix:* Other attributes property: The set of attributes with a namespace name which has a value other than http://www.xbrl.org/2013/inlineXBRL.

Parameters:

ixElement - if set to true, the result will NOT include attributes defined in the specs (1.0 or 1.1)

filterSpec - if set to true, the result will skip attributes defined in the ixbrl specification

filterXML - is set to true the attribute xml:base is skip

except - the except

Returns:

the ix other attrs

getEffectiveValue

public java.lang.String getEffectiveValue(BaseIXElement ixElem)
                                   throws net.sf.saxon.trans.XPathException

Returns the effective value of a node resolving ix:exclude and continuedAt attributes.

Parameters:

ixElem - the ix elem

Returns:

the effective value

Throws:

net.sf.saxon.trans.XPathException - the x path exception

endElement

public void endElement()
                throws net.sf.saxon.trans.XPathException

End element.

Specified by:

endElement in interface net.sf.saxon.event.Receiver

Overrides:

endElement in class XBRLSaxBuilder

Throws:

net.sf.saxon.trans.XPathException - the x path exception

startElement

public void startElement(net.sf.saxon.om.NodeName nameCode,
                         net.sf.saxon.type.SchemaType typeCode,
                         int locationId,
                         int properties)
                  throws net.sf.saxon.trans.XPathException

Start element.

Specified by:

startElement in interface net.sf.saxon.event.Receiver

Overrides:

startElement in class XBRLSaxBuilder

Parameters:

nameCode - the name code

typeCode - the type code

locationId - the location id

properties - the properties

Throws:

net.sf.saxon.trans.XPathException - the x path exception

attribute

public void attribute(net.sf.saxon.om.NodeName atName,
                      net.sf.saxon.type.SimpleType atType,
                      java.lang.CharSequence value,
                      int locationId,
                      int properties)
               throws net.sf.saxon.trans.XPathException

Attribute.

Specified by:

attribute in interface net.sf.saxon.event.Receiver

Overrides:

attribute in class XBRLSaxBuilder

Parameters:

atName - the at name

atType - the at type

value - the value

locationId - the location id

properties - the properties

Throws:

net.sf.saxon.trans.XPathException - the x path exception

characters

public void characters(java.lang.CharSequence chars,
                       int locationId,
                       int properties)
                throws net.sf.saxon.trans.XPathException

Characters.

Specified by:

characters in interface net.sf.saxon.event.Receiver

Overrides:

characters in class XBRLSaxBuilder

Parameters:

chars - the chars

locationId - the location id

properties - the properties

Throws:

net.sf.saxon.trans.XPathException - the x path exception

namespace

public void namespace(net.sf.saxon.om.NamespaceBinding namespaceBinding,
                      int properties)
               throws net.sf.saxon.trans.XPathException

Namespace.

Specified by:

namespace in interface net.sf.saxon.event.Receiver

Overrides:

namespace in class XBRLSaxBuilder

Parameters:

namespaceBinding - the namespace binding

properties - the properties

Throws:

net.sf.saxon.trans.XPathException - the x path exception

isAllowContinuedAt

public static boolean isAllowContinuedAt(javax.xml.namespace.QName nodeName)

Returns true when the node name is ix:continuation, ix:footnote or ix:nonNumeric and is in the 1.1 specification

Parameters:

nodeName - the node name

Returns:

true, if is allow continued at

getXBRLInstances

public XBRLInstance[] getXBRLInstances()
                                throws net.sf.saxon.trans.XPathException

Create an XBRLInstance with the information collected. The instance dts will be the same obtained from the ixbrlProcessor. The instance content will NOT be schema validated because the DTS has not been loaded into the DTSContainer. The returned XBRLInstance can be considered just as a raw XML file just loaded form disk.

Returns:

Generated XBRLInstance

Throws:

net.sf.saxon.trans.XPathException - the x path exception

getXBRLInstance

public XBRLInstance getXBRLInstance(java.lang.String target)
                             throws net.sf.saxon.trans.XPathException

Gets the XBRL instance.

Parameters:

target - the target

Returns:

the XBRL instance

Throws:

net.sf.saxon.trans.XPathException - the x path exception

getTargets

public java.lang.String[] getTargets()

Returns the set of unique values of the target attributes so it is possible to access each instance separately.

Returns:

String array

getFormattedValue

public net.sf.saxon.value.AtomicValue getFormattedValue(BaseIXElement fact)
                                                 throws net.sf.saxon.trans.XPathException

if the BaseIXFact contains a format attribute value this method applies the format to the effectiveValue.

This method does not apply scale nor sign to the returned value. Use getScaledAndSign(BaseIXElement) for that purpose

Parameters:

fact - the fact

Returns:

the formatted value

Throws:

net.sf.saxon.trans.XPathException - the x path exception

getScaledAndSign

public net.sf.saxon.value.AtomicValue getScaledAndSign(BaseIXElement fact)
                                                throws net.sf.saxon.trans.XPathException

if the BaseIXFact contains a scale and or sign attribute value this method applies the transformations required in those attributes.

This method first call getFormattedValue(BaseIXElement) and applies the scale and sign transformations to the returned value

Parameters:

fact - the fact

Returns:

the scaled and sign

Throws:

net.sf.saxon.trans.XPathException - the x path exception

getIXElementById

public net.sf.saxon.om.NodeInfo getIXElementById(java.lang.String id)

Gets the IX element by id.

Parameters:

id - the id

Returns:

the IX element by id

setGeneratedElementById

public void setGeneratedElementById(java.lang.String id,
                                    XMLFragment f)

Sets the generated element by id.

Parameters:

id - the id

f - the f

getGeneratedElementById

public net.sf.saxon.om.NodeInfo getGeneratedElementById(java.lang.String id,
                                                        XBRLExtendedLink el)
                                                 throws net.sf.saxon.trans.XPathException

Gets the generated element by id.

Parameters:

id - the id

el - the el

Returns:

the generated element by id

Throws:

net.sf.saxon.trans.XPathException - the x path exception

getEffectiveFootnoteValue

public void getEffectiveFootnoteValue(XMLFragment res,
                                      net.sf.saxon.tree.linked.NodeImpl baseIXFootnote)
                               throws net.sf.saxon.trans.XPathException

Special method used to set the value of XBRLResources that allows complexType mixing html and text.

Parameters:

res - the res

baseIXFootnote - the base IX footnote

Throws:

net.sf.saxon.trans.XPathException - the x path exception

getEffectiveFootnoteValueWithEscape

public void getEffectiveFootnoteValueWithEscape(XMLFragment res,
                                                BaseIXElement ixElem)
                                         throws net.sf.saxon.trans.XPathException

Returns the effective value of a node resolving ix:exclude and continuedAt attributes.

Parameters:

res - the res

ixElem - the ix elem

Throws:

net.sf.saxon.trans.XPathException - the x path exception