com.ihr.xbrl.adins.eba

Class EBAProcessor

java.lang.Object

com.ihr.xbrl.adins.eba.EBAProcessor

All Implemented Interfaces:

HasDTSContainer, LicensedProcessor, IValueSpaceProvider, XBRLCompilableProcessor, XBRLPlugInProcessor

public class EBAProcessor
extends java.lang.Object
implements XBRLCompilableProcessor, LicensedProcessor, IValueSpaceProvider

The Class EBAProcessor.

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EBAProcessor.FilingSerializationMode The Enum FilingSerializationMode.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EBA_VERSION The EBA_VERSION property indicates the version of the Edgar Filer Manual document to be used.
static java.lang.String	EBA_VERSION_42 The EBA_VERSION_42 property indicates the processor will use EBA rules in the version 4.2 of the EBA document.
static javax.xml.namespace.QName	filed The Constant filed.
static java.lang.String	FILING_INDICATOR_CODE The Constant FILING_INDICATOR_CODE.
static java.lang.String	FILING_INDICATOR_ITEM The Constant FILING_INDICATOR_ITEM.
static java.lang.String	FILING_INDICATORS_NS The Constant FILING_INDICATORS_NS.
static java.lang.String	FILING_INDICATORS_TUPLE The Constant FILING_INDICATORS_TUPLE.
static javax.xml.namespace.QName	filingIndicatorItem The Constant filingIndicatorItem.
static javax.xml.namespace.QName	filingIndicatorsTuple The Constant filingIndicatorsTuple.
static java.lang.String	MODEL_NS The Constant MODEL_NS.
static java.lang.String	MODEL_PFX The Constant MODEL_PFX.
static javax.xml.namespace.QName	modelDomain The Constant modelDomain.
static javax.xml.namespace.QName	modelHierarchy The Constant modelHierarchy.
static java.lang.String	PROCESSORNAME The Constant PROCESSORNAME.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XBRLValidationReport	compileResources() Compile resources.
void	configure(java.util.Properties properties) Configure.
static EBAProcessor	create(DTSContainer dts) Obtains the instance of the EBAProcessor that has been registered for this DTS.
void	freeUnnecessary() Free unnecessary.
DTSContainer	getContainer() Gets the container.
java.lang.String	getDescription() Gets the description.
static java.lang.String	getDescriptionStatic() Obtains the description of this processor regardless of the instance.
java.util.Map<java.lang.String,FilingIndicatorsInfo>	getFilingIndicatorsInfo() Gets the filing indicators info.
XBRLFactTuple	getFilingIndicatorsTuple() Gets the filing indicators tuple.
XBRLInstance	getInstance() Gets the single instance of EBAProcessor.
java.lang.String	getName() Gets the name.
java.lang.String	getStringValueFromQNameValue(javax.xml.namespace.QName concept, javax.xml.namespace.QName qNameValue) Gets the string value from Q name value.
java.util.Iterator<DecorableValue<?>>	getValueSpace(javax.xml.namespace.QName concept) Gets the value space.
boolean	isEBATaxonomy() Returns true if the DTS loaded contains the schema that defines the tuple for filing indicators
boolean	isHidden() Checks if is hidden.
boolean	isLicensed() Checks if is licensed.
boolean	isTableSelected(XBRLTable table) Checks if is table selected.
boolean	isValueSpace(javax.xml.namespace.QName concept) Checks if is value space.
static void	registerProcessorStatic() Register processor static.
XBRLInstance	setInstance(XBRLInstance instance) Sets the instance.
XBRLValidationReport	validate() Validate.
XBRLValidationReport	validate(XBRLDocument xDocument) Validate.

Methods inherited from class java.lang.Object

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

Field Detail

PROCESSORNAME

public static final java.lang.String PROCESSORNAME

The Constant PROCESSORNAME.

See Also:

Constant Field Values

EBA_VERSION

public static final java.lang.String EBA_VERSION

The EBA_VERSION property indicates the version of the Edgar Filer Manual document to be used. The possible value is EBA_VERSION_42. More values will be added in the future.

The value of the EBA_VERSION constant is "http://www.reportingstandard.com/properties/eba-version".

The default value for the property it refers to is EBA_VERSION_42 which is the lastest release.

See Also:

Constant Field Values

FILING_INDICATORS_NS

public static final java.lang.String FILING_INDICATORS_NS

The Constant FILING_INDICATORS_NS.

See Also:

Constant Field Values

FILING_INDICATORS_TUPLE

public static final java.lang.String FILING_INDICATORS_TUPLE

The Constant FILING_INDICATORS_TUPLE.

See Also:

Constant Field Values

FILING_INDICATOR_ITEM

public static final java.lang.String FILING_INDICATOR_ITEM

The Constant FILING_INDICATOR_ITEM.

See Also:

Constant Field Values

filingIndicatorsTuple

public static final javax.xml.namespace.QName filingIndicatorsTuple

The Constant filingIndicatorsTuple.

filingIndicatorItem

public static final javax.xml.namespace.QName filingIndicatorItem

The Constant filingIndicatorItem.

MODEL_NS

public static final java.lang.String MODEL_NS

The Constant MODEL_NS.

See Also:

Constant Field Values

MODEL_PFX

public static final java.lang.String MODEL_PFX

The Constant MODEL_PFX.

See Also:

Constant Field Values

modelDomain

public static final javax.xml.namespace.QName modelDomain

The Constant modelDomain.

modelHierarchy

public static final javax.xml.namespace.QName modelHierarchy

The Constant modelHierarchy.

FILING_INDICATOR_CODE

public static final java.lang.String FILING_INDICATOR_CODE

The Constant FILING_INDICATOR_CODE.

See Also:

Constant Field Values

filed

public static final javax.xml.namespace.QName filed

The Constant filed.

EBA_VERSION_42

public static final java.lang.String EBA_VERSION_42

The EBA_VERSION_42 property indicates the processor will use EBA rules in the version 4.2 of the EBA document. https://www.eba.europa.eu/documents/10180/1738017/EBA+Filing+Rules+v4.2.pdf

See Also:

Constant Field Values

Method Detail

create

public static EBAProcessor create(DTSContainer dts)
                           throws com.rs.lic.LicenseVerificationException

Obtains the instance of the EBAProcessor that has been registered for this DTS. If none has been registered a new one is created. The creator will register the instance within the DTS.

Parameters:

dts - the dts

Returns:

the EBA processor

Throws:

com.rs.lic.LicenseVerificationException - the license verification exception

registerProcessorStatic

public static void registerProcessorStatic()

Register processor static.

getDescriptionStatic

public static java.lang.String getDescriptionStatic()

Obtains the description of this processor regardless of the instance.

Returns:

the description static

getContainer

public DTSContainer getContainer()

Gets the container.

Specified by:

getContainer in interface HasDTSContainer

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

getName

public java.lang.String getName()

Gets the name.

Specified by:

getName in interface XBRLPlugInProcessor

Returns:

the name

getDescription

public java.lang.String getDescription()

Gets the description.

Specified by:

getDescription in interface XBRLPlugInProcessor

Returns:

the description

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()
           throws java.lang.Throwable

Clear.

Specified by:

clear in interface XBRLPlugInProcessor

Throws:

java.lang.Throwable - the throwable

isLicensed

public boolean isLicensed()

Checks if is licensed.

Specified by:

isLicensed in interface LicensedProcessor

Returns:

true, if is licensed

isEBATaxonomy

public boolean isEBATaxonomy()

Returns true if the DTS loaded contains the schema that defines the tuple for filing indicators

Returns:

boolean value

getFilingIndicatorsInfo

public java.util.Map<java.lang.String,FilingIndicatorsInfo> getFilingIndicatorsInfo()

Gets the filing indicators info.

Returns:

the filing indicators info

setInstance

public XBRLInstance setInstance(XBRLInstance instance)

Sets the instance.

Parameters:

instance - the instance

Returns:

the XBRL instance

getInstance

public XBRLInstance getInstance()

Gets the single instance of EBAProcessor.

Returns:

single instance of EBAProcessor

getFilingIndicatorsTuple

public XBRLFactTuple getFilingIndicatorsTuple()

Gets the filing indicators tuple.

Returns:

the filing indicators tuple

isTableSelected

public boolean isTableSelected(XBRLTable table)

Checks if is table selected.

Parameters:

table - The XBRLTable instance to check if it is included in the Filings Indicator tuple.

Returns:

boolean value, true if it is included, false otherwise

compileResources

public XBRLValidationReport compileResources()

Compile resources.

Specified by:

compileResources in interface XBRLCompilableProcessor

Returns:

the XBRL validation report

freeUnnecessary

public void freeUnnecessary()
                     throws com.rs.lic.LicenseVerificationException,
                            XBRLValidationException

Free unnecessary.

Specified by:

freeUnnecessary in interface XBRLCompilableProcessor

Throws:

com.rs.lic.LicenseVerificationException - the license verification exception

XBRLValidationException - the XBRL validation exception

isValueSpace

public boolean isValueSpace(javax.xml.namespace.QName concept)

Checks if is value space.

Specified by:

isValueSpace in interface IValueSpaceProvider

Parameters:

concept - the concept

Returns:

true, if is value space

getValueSpace

public java.util.Iterator<DecorableValue<?>> getValueSpace(javax.xml.namespace.QName concept)

Gets the value space.

Specified by:

getValueSpace in interface IValueSpaceProvider

Parameters:

concept - the concept

Returns:

the value space

getStringValueFromQNameValue

public java.lang.String getStringValueFromQNameValue(javax.xml.namespace.QName concept,
                                                     javax.xml.namespace.QName qNameValue)

Gets the string value from Q name value.

Specified by:

getStringValueFromQNameValue in interface IValueSpaceProvider

Parameters:

concept - the concept

qNameValue - the q name value

Returns:

the string value from Q name value