com.ihr.xbrl.om.ixbrl

Class IXBRLProcessorBase

java.lang.Object

com.ihr.xbrl.om.ixbrl.IXBRLProcessorBase

All Implemented Interfaces:

HasDTSContainer, IIXBRLProcessor, XBRLPlugInProcessor

Direct Known Subclasses:

IXBRL1_1Processor, IXBRLProcessor

public abstract class IXBRLProcessorBase
extends java.lang.Object
implements XBRLPlugInProcessor, IIXBRLProcessor

The Class IXBRLProcessorBase.

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IXBRLProcessorBase.WrapStreamSource The Class WrapStreamSource.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROCESSORNAME The Constant PROCESSORNAME.
static javax.xml.namespace.QName	version The name of the version attribute in the html element
static java.lang.String	wrapSourceNS The Constant wrapSourceNS.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
void	configure(java.util.Properties properties) Configure.
DTSContainer	getContainer() Gets the container.
java.util.Collection<IXBRLReceiver>	getExtensionProcessors() Obtains a collection of IXBRL Extension processors or the empty collection if there are none.
net.sf.saxon.om.Item	getFormattedValue(javax.xml.namespace.QName format, java.lang.String effectiveValue) Gets the formatted value.
net.sf.saxon.type.SchemaType	getFormatType(net.sf.saxon.value.QNameValue format) Find the type definition in loaded schemas.
XBRLInstance	getInstance(java.lang.String target) Gets the single instance of IXBRLProcessorBase.
abstract java.lang.String	getIXBRLNamespace() Returns the namespace that corresponds with the specification version.
abstract java.lang.String	getIXBRLSchemaURL() Returns the official URL of the IXBRL schema for the surrounding IXBRL Processor.
abstract java.lang.String	getIXBRLVersionFixed() Returns the value of the version attribute in the html element.
java.lang.String	getName() Gets the name.
int	getSources() Obtains the number of source documents that contributed to the target instance(s).
java.lang.String[]	getTargets() Gets the targets.
XMLDocumentURI	getXBRLInstanceSource(javax.xml.transform.Source sourceTree) Extracts from the node the surrounding XBRLInstance as an XdmNode.
net.sf.saxon.om.NodeInfo	getXHTML(int source) Obtains the html node that is specified in the indicated source value.
boolean	isFormatDefined(net.sf.saxon.value.QNameValue format) Checks if is format defined.
boolean	isFormatValueValid(net.sf.saxon.value.QNameValue format, net.sf.saxon.value.AtomicValue value, java.util.List<net.sf.saxon.trans.XPathException> outErrors) Checks if is format value valid.
boolean	isFormatValueValid(net.sf.saxon.value.QNameValue format, java.lang.String value, java.util.List<net.sf.saxon.trans.XPathException> outErrors) Checks if is format value valid.
boolean	isHidden() Checks if is hidden.
static void	registerExtensionProcessor(java.lang.String processorname, java.lang.Class<? extends XBRLProcessorFactory> factoryClazz) Register extension processor.
XBRLValidationReport	validate() Validate.
XBRLValidationReport	validate(XBRLDocument xDocument) Validate.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ihr.xbrl.om.XBRLPlugInProcessor

getDescription

Methods inherited from interface com.ihr.xbrl.om.ixbrl.IIXBRLProcessor

resolveToURI

Field Detail

PROCESSORNAME

public static final java.lang.String PROCESSORNAME

The Constant PROCESSORNAME.

See Also:

Constant Field Values

wrapSourceNS

public static final java.lang.String wrapSourceNS

The Constant wrapSourceNS.

See Also:

Constant Field Values

version

public static final javax.xml.namespace.QName version

The name of the version attribute in the html element

Method Detail

getName

public java.lang.String getName()

Gets the name.

Specified by:

getName in interface XBRLPlugInProcessor

Returns:

the name

registerExtensionProcessor

public static void registerExtensionProcessor(java.lang.String processorname,
                                              java.lang.Class<? extends XBRLProcessorFactory> factoryClazz)

Register extension processor.

Parameters:

processorname - the processorname

factoryClazz - the factory clazz

getExtensionProcessors

public java.util.Collection<IXBRLReceiver> getExtensionProcessors()

Obtains a collection of IXBRL Extension processors or the empty collection if there are none.

This method is used primarily by the IXBRLKeyElementsInterceptor class to forward events to extension processors

Returns:

Collection<IXBRLReceiver>

getIXBRLNamespace

public abstract java.lang.String getIXBRLNamespace()

Returns the namespace that corresponds with the specification version.

Returns:

the IXBRL namespace

getIXBRLVersionFixed

public abstract java.lang.String getIXBRLVersionFixed()

Returns the value of the version attribute in the html element. This value is fixed by the schema and depends on the specification version

Returns:

String

getIXBRLSchemaURL

public abstract java.lang.String getIXBRLSchemaURL()

Returns the official URL of the IXBRL schema for the surrounding IXBRL Processor. This value is fixed by the schema and depends on the specification version

Returns:

String

getContainer

public DTSContainer getContainer()

Gets the container.

Specified by:

getContainer in interface HasDTSContainer

Specified by:

getContainer in interface IIXBRLProcessor

Returns:

the container

validate

public XBRLValidationReport validate()

Validate.

Specified by:

validate in interface XBRLPlugInProcessor

Returns:

the XBRL validation report

validate

public XBRLValidationReport validate(XBRLDocument xDocument)

Validate.

Specified by:

validate in interface XBRLPlugInProcessor

Parameters:

xDocument - the x document

Returns:

the XBRL validation report

configure

public void configure(java.util.Properties properties)

Configure.

Specified by:

configure in interface XBRLPlugInProcessor

Parameters:

properties - the properties

isHidden

public boolean isHidden()

Checks if is hidden.

Specified by:

isHidden in interface XBRLPlugInProcessor

Returns:

true, if is hidden

clear

public void clear()

Clear.

Specified by:

clear in interface XBRLPlugInProcessor

isFormatDefined

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

Checks if is format defined.

Specified by:

isFormatDefined in interface IIXBRLProcessor

Parameters:

format - the format

Returns:

true, if is format defined

isFormatValueValid

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

Checks if is format value valid.

Specified by:

isFormatValueValid in interface IIXBRLProcessor

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, if is format value valid

isFormatValueValid

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

Checks if is format value valid.

Parameters:

format - the format

value - the value

Returns:

true, if is format value valid

getFormatType

public net.sf.saxon.type.SchemaType getFormatType(net.sf.saxon.value.QNameValue format)

Find the type definition in loaded schemas.

Parameters:

format - the format

Returns:

the format type

getXBRLInstanceSource

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

Extracts from the node the surrounding XBRLInstance as an XdmNode.

Specified by:

getXBRLInstanceSource in interface IIXBRLProcessor

Parameters:

sourceTree - the source document tree

Returns:

XdmNode a new tree

Throws:

DTSDiscoveryException - the DTS discovery exception

XBRLValidationException - the XBRL validation exception

getFormattedValue

public net.sf.saxon.om.Item getFormattedValue(javax.xml.namespace.QName format,
                                              java.lang.String effectiveValue)
                                       throws net.sf.saxon.trans.XPathException

Gets the formatted value.

Parameters:

format - the format

effectiveValue - the effective value

Returns:

the formatted value

Throws:

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

getTargets

public java.lang.String[] getTargets()

Gets the targets.

Specified by:

getTargets in interface IIXBRLProcessor

Returns:

the targets

getSources

public int getSources()

Obtains the number of source documents that contributed to the target instance(s).

Returns:

integer, zero or more, hopefully always just one.

getInstance

public XBRLInstance getInstance(java.lang.String target)

Gets the single instance of IXBRLProcessorBase.

Specified by:

getInstance in interface IIXBRLProcessor

Parameters:

target - the target

Returns:

single instance of IXBRLProcessorBase

getXHTML

public net.sf.saxon.om.NodeInfo getXHTML(int source)

Obtains the html node that is specified in the indicated source value. The first document is at index 0.

This method can be used while processing XBRLEvent.IXBRL_END events to obtain the html document representation

Parameters:

source - index of the source document to obtain that is one of the values obtained from getSources().

Returns:

NodeInfo of the html node that corresponds with the indicated index. This method returns null in case the index is out of bounds

See Also:

getSources()