com.ihr.xbrl.om

Class XBRLCoreProcessor

java.lang.Object

com.ihr.xbrl.om.XBRLCoreProcessor

All Implemented Interfaces:

HasDTSContainer, XBRLPlugInProcessor, XBRLValidationConfiguration

public class XBRLCoreProcessor
extends java.lang.Object
implements XBRLPlugInProcessor, XBRLValidationConfiguration

This class is a XBRLPlugInProcessor for doing XBRL 2.1 validation of the DTS.

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROCESSORNAME The Constant PROCESSORNAME.

Fields inherited from interface com.ihr.xbrl.om.XBRLValidationConfiguration

VALIDATE_ALL_TABLES, VALIDATE_CYCLES, VALIDATE_DOCUMENT, VALIDATE_ESSENCE_ALIAS, VALIDATE_REPORT_ITEMS_AND_TUPLES, VALIDATE_REQUIRES_ELEMENT, VALIDATE_SUMMATION_ITEM, VALIDATE_TABLE_RELATIONSHIPS

Method Summary

Modifier and Type	Method and Description
void	clear() Resets the content of the validation report.
void	configure(java.util.Properties properties) Configure.
static XBRLCoreProcessor	create(DTSContainer dts) Creates the.
DTSContainer	getContainer() Gets the container.
java.lang.String	getDescription() Gets the description.
static java.lang.String	getDescriptionStatic() Gets the description static.
java.lang.String	getName() Gets the name.
int	getWhatToValidate() Gets the what to validate.
boolean	isHidden() Checks if is hidden.
static void	registerProcessorStatic() Register processor static.
void	reset() Reset this processor status.
void	setArcrolesToCheckCycles(java.util.Collection<? extends XBRLArcroleType> xbrlArcroleTypes) Sets the arcroles to check cycles.
int	setWhatToValidate(int newValue) Adjust the work performed by this XBRLCoreProcessor.
XBRLValidationReport	validate() Validate.
XBRLValidationReport	validate(XBRLDocument doc) Validates an instance document against all arcroles defined in the XBRL 2.1 specification
XBRLValidationReport	validateCyclesOnBaseSet(DTSBase base, XBRLArcroleType arcRole, int cyclesAllowed) This is the internal method used by the API to validate cycles on a base set.

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

Method Detail

create

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

Creates the.

Parameters:

dts - the dts

Returns:

the XBRL core processor

Throws:

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

getContainer

public DTSContainer getContainer()

Gets the container.

Specified by:

getContainer in interface HasDTSContainer

Returns:

the container

clear

public void clear()

Resets the content of the validation report.

Specified by:

clear in interface XBRLPlugInProcessor

reset

public void reset()

Reset this processor status.

registerProcessorStatic

public static void registerProcessorStatic()

Register processor static.

configure

public void configure(java.util.Properties properties)

Configure.

Specified by:

configure in interface XBRLPlugInProcessor

Parameters:

properties - the properties

setWhatToValidate

public int setWhatToValidate(int newValue)

Adjust the work performed by this XBRLCoreProcessor. By default the processor will check for cycles, essence-alias, requires-element summation-item and document validation.

Use a combination of VALIDATE_ constants in order to set or unset specific validation steps.

Specified by:

setWhatToValidate in interface XBRLValidationConfiguration

Parameters:

newValue - integer, bitmap

Returns:

the int

getWhatToValidate

public int getWhatToValidate()

Gets the what to validate.

Specified by:

getWhatToValidate in interface XBRLValidationConfiguration

Returns:

the what to validate

validate

public XBRLValidationReport validate()

Validate.

Specified by:

validate in interface XBRLPlugInProcessor

Returns:

the XBRL validation report

validate

public XBRLValidationReport validate(XBRLDocument doc)

Validates an instance document against all arcroles defined in the XBRL 2.1 specification

Specified by:

validate in interface XBRLPlugInProcessor

Parameters:

doc - the doc

Returns:

the XBRL validation report

validateCyclesOnBaseSet

public XBRLValidationReport validateCyclesOnBaseSet(DTSBase base,
                                                    XBRLArcroleType arcRole,
                                                    int cyclesAllowed)

This is the internal method used by the API to validate cycles on a base set. The base set is obtained from the base using the specific arcrole. the value of the cyclesAllowed is not taken from the arcrole definition inside this method in order to allow other processors to call this method with different values than the official values in the arcroleType declaration. Note the cycles allowed value of the arcroles defined in the XBRL 2.1 specification are not declared in link:arcroleType definitions but in the specification wording.

Parameters:

base - the DTS base from which the Base Set will be obtained. The DTS container already handles a database of bases and base sets.

arcRole - the arcrole that identifies the Base Set.

cyclesAllowed - the value here is a constant integer defined in the XBRLArcroleType type.

Returns:

the XBRL validation report

getDescription

public java.lang.String getDescription()

Gets the description.

Specified by:

getDescription in interface XBRLPlugInProcessor

Returns:

the description

getDescriptionStatic

public static java.lang.String getDescriptionStatic()

Gets the description static.

Returns:

the description static

getName

public java.lang.String getName()

Gets the name.

Specified by:

getName in interface XBRLPlugInProcessor

Returns:

the name

setArcrolesToCheckCycles

public void setArcrolesToCheckCycles(java.util.Collection<? extends XBRLArcroleType> xbrlArcroleTypes)

Sets the arcroles to check cycles.

Parameters:

xbrlArcroleTypes - the new arcroles to check cycles

isHidden

public boolean isHidden()

Checks if is hidden.

Specified by:

isHidden in interface XBRLPlugInProcessor

Returns:

true, if is hidden