com.ihr.xbrl.om.ixbrl

Interface IXBRLReceiver

All Known Subinterfaces:

QualityCheckIx<T>

All Known Implementing Classes:

ESEF_2_2_3, ESEF_2_3_1_c, ESEF_2_4_1, ESEF_2_4_2, ESEF_2_5_1_a, ESEF_2_5_1_b, ESEF_2_5_2, ESEF_2_5_3, ESEF_2_5_4, ESEF_2_6_1, ESEF_3_5_1, ESEF_RTS_Art_6_a, ESEF_RTS_IV_p4_1, ESEF_RTS_IV_p4_2, ESEF_RTS_IV_p7, ESEF_RTS_IV_p8, ESEFIxRule, ESEFProcessor

public interface IXBRLReceiver

This interface must be implemented by xbrl processors that wants to add specific validations when processing IXBRL reports.

When an instance of XBRLPlugInProcessor also implements the IXBRLReceiver interface it is added to the IXBRLProcessorBase (for 1.0 and 1.1) and receives some notifications from the Saxon Receiver interface and Saxon Builder class. This allows the processor to see the surrounding xhtml nodes while they are parsed and scan for error conditions that are processor specific.

When validation is finished it is possible to obtain collected errors and inconsistencies in an XBRLValidationReport

Author:

Ignacio

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) Grabbed from Saxon Receiver interface.
void	characters(java.lang.CharSequence chars, int locationId, int properties) Grabbed from Saxon Receiver interface.
void	endDocument() Grabbed from Saxon Receiver interface.
void	endElement() Grabbed from Saxon Receiver interface.
void	namespace(net.sf.saxon.om.NamespaceBinding namespaceBinding, int properties) Grabbed from Saxon Receiver interface.
void	reset() Grabbed from Saxon Receiver interface.
void	setSystemId(java.lang.String systemId) Grabbed from Saxon Receiver interface.
void	startDocument(int properties) Grabbed from Saxon Receiver interface.
void	startElement(net.sf.saxon.om.NodeName nameCode, net.sf.saxon.type.SchemaType typeCode, int locationId, int properties) Grabbed from Saxon Receiver interface.

Method Detail

attribute

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

Grabbed from Saxon Receiver interface.

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

See Also:

Receiver#attribute(NodeName, SimpleType, CharSequence, int, int)}

characters

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

Grabbed from Saxon Receiver interface.

Parameters:

chars - the chars

locationId - the location id

properties - the properties

Throws:

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

See Also:

Receiver#characters(CharSequence, int, int)}

endDocument

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

Grabbed from Saxon Receiver interface.

Throws:

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

See Also:

Receiver#endDocument()}

endElement

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

Grabbed from Saxon Receiver interface.

Throws:

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

See Also:

Receiver#endElement()}

namespace

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

Grabbed from Saxon Receiver interface.

Parameters:

namespaceBinding - the namespace binding

properties - the properties

Throws:

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

See Also:

Receiver#namespace(NamespaceBinding, int)}

reset

void reset()

Grabbed from Saxon Receiver interface.

See Also:

Builder#reset()}

setSystemId

void setSystemId(java.lang.String systemId)

Grabbed from Saxon Receiver interface.

Parameters:

systemId - the new system id

See Also:

Receiver#setSystemId(String)}

startDocument

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

Grabbed from Saxon Receiver interface.

Parameters:

properties - the properties

Throws:

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

See Also:

Receiver.startDocument(int)}

startElement

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

Grabbed from Saxon Receiver interface.

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

See Also:

Receiver.startElement(NodeName, SchemaType, int, int)