com.ihr.xbrl.om.ixbrl

Interface IIXBRLProcessor

All Known Implementing Classes:

IXBRL1_1Processor, IXBRLProcessor, IXBRLProcessorBase

public interface IIXBRLProcessor

There are actually two implementations of the IXBRL processor: IXBRL 1.0 and IXBRL 1.1

the iXBRL 1.0 processor is implemented in the IXBRLProcessor class

the iXBRL 1.1 processor is implemented in the IXBRL1_1Processor class

This interface covers the methods in common used by APIs that are processor version agnostic such as the transformation functions in the registry or the validation functions

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
DTSContainer	getContainer() Allows to obtain a reference of the current DTSContainer form the IXBRL processor.
XBRLInstance	getInstance(java.lang.String target) Returns the XBRLInstance generated for the particular target.
java.lang.String[]	getTargets() Returns an array of unique values collected from the different values of the target attribute on the IXBRL Document Set in document order.
XMLDocumentURI	getXBRLInstanceSource(javax.xml.transform.Source sourceTree) Transforms a sourceTree into an XBRLInstance document applying the transformation rules defined in the IXBRL specification.
boolean	isFormatDefined(net.sf.saxon.value.QNameValue format) Returns true if the value of the format attribute corresponds with a transformation function in the registry.
boolean	isFormatValueValid(net.sf.saxon.value.QNameValue format, net.sf.saxon.value.AtomicValue value, java.util.List<net.sf.saxon.trans.XPathException> outErrors) This is the callback method from the rs_ixv:validateFormattedValue that, in turn validates an incoming value against the type definition in the registry schema.
java.net.URI	resolveToURI(java.lang.String targetNamespace) Resolve to URI.

Method Detail

getContainer

DTSContainer getContainer()

Allows to obtain a reference of the current DTSContainer form the IXBRL processor.

Returns:

DTSContainer processor used to create the IXBRL processor

isFormatDefined

boolean isFormatDefined(net.sf.saxon.value.QNameValue format)

Returns true if the value of the format attribute corresponds with a transformation function in the registry. The same method checks on all existing registry versions

Parameters:

format - the QNameValue of the format attribute

Returns:

true if there is a registered transformation for that QName

isFormatValueValid

boolean isFormatValueValid(net.sf.saxon.value.QNameValue format,
                           net.sf.saxon.value.AtomicValue value,
                           java.util.List<net.sf.saxon.trans.XPathException> outErrors)

This is the callback method from the rs_ixv:validateFormattedValue that, in turn validates an incoming value against the type definition in the registry schema.

Parameters:

format - the format

value - the value

outErrors - optional, can be null, pass in an instance of a List of XPathExceptions (with no exceptions at all), in case of validation errors (false will be returned), the internal XPathException will be added to the list.

Returns:

true indicates the value matches the pattern and is a valid value, false otherwise

getXBRLInstanceSource

XMLDocumentURI getXBRLInstanceSource(javax.xml.transform.Source sourceTree)
                              throws DTSDiscoveryException,
                                     XBRLValidationException

Transforms a sourceTree into an XBRLInstance document applying the transformation rules defined in the IXBRL specification.

Parameters:

sourceTree - the source tree

Returns:

the XBRL instance source

Throws:

DTSDiscoveryException - the DTS discovery exception

XBRLValidationException - the XBRL validation exception

resolveToURI

java.net.URI resolveToURI(java.lang.String targetNamespace)

Resolve to URI.

Parameters:

targetNamespace - the target namespace

Returns:

the uri

getTargets

java.lang.String[] getTargets()

Returns an array of unique values collected from the different values of the target attribute on the IXBRL Document Set in document order.

Note there is always a default target that is documented as the empty string

Returns:

String array

getInstance

XBRLInstance getInstance(java.lang.String target)

Returns the XBRLInstance generated for the particular target.

Parameters:

target - the target

Returns:

XBRLInstance