com.ihr.xbrl.om.utr
Class UTRProcessor

java.lang.Object
  com.ihr.xbrl.om.utr.UTRProcessor

All Implemented Interfaces:

XBRLPlugInProcessor

public class UTRProcessor
extends java.lang.Object
implements XBRLPlugInProcessor

Author:

Ignacio

Nested Class Summary

static class

UTRProcessor.Status CR - Candidate Recommendation REC - RECOMMENDATION NIE - Not in effect (for whatever reason other than RR such as being withdrawn, superseded, found to be invalid etc.)

Field Summary

static java.lang.String	PROCESSORNAME
static java.lang.String	UTR_NS
static java.lang.String	UTR_OFFICIAL_URL
static java.lang.String	UTR_STATUS_TO_CONSIDER The UTR_STATUS_TO_CONSIDER property defines what unit definitions form the registry will be considered for validation of units assigned to facts in an instance document.

Method Summary

void	clear() clears all stored information on this processor so validation start from scratch
void	configure(java.util.Properties properties) Configures the processor according with the properties passed in in the properties parameter
static XBRLPlugInProcessor	create(DTSContainer dts)
java.lang.String	getDescription() Returns the processor description so it can be written in validation reports
static java.lang.String	getDescriptionStatic()
java.lang.String	getName() Returns the processor name so it can be written in validation reports
XBRLUnit	getUnit(XBRLItem itm, javax.xml.namespace.QName defaultUnit) Returns a valid XBRLUnit for the item passed in in the first parameter.
XBRLValidationReport	validate() Validates the content of the DTS according to the rules indicated in this plug-in processor.
XBRLValidationReport	validate(XBRLDocument xDocument) Validates the document according to the rules indicated in this plug-in processor.
XBRLValidationReport	validateFact(XBRLFactNumeric xbrlFactNumeric)

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

See Also:

Constant Field Values

UTR_OFFICIAL_URL

public static final java.lang.String UTR_OFFICIAL_URL

See Also:

Constant Field Values

UTR_STATUS_TO_CONSIDER

public static final java.lang.String UTR_STATUS_TO_CONSIDER

The UTR_STATUS_TO_CONSIDER property defines what unit definitions form the registry will be considered for validation of units assigned to facts in an instance document. For example, if you are interested only in considering units with status of REC and CR you can assign to this property the value "REC,CR". All other unit definitions in the UTR registry will be ignored.

This property key is defined as a constant string "http://www.reportingstandard.com/UTRProcessor/status-to-consider"

The default value for this property is "REC,CR".

The complete list of possible values is here #Status

See Also:

Constant Field Values

UTR_NS

public static final java.lang.String UTR_NS

See Also:

Constant Field Values

Method Detail

validate

public XBRLValidationReport validate()

Description copied from interface: XBRLPlugInProcessor

Validates the content of the DTS according to the rules indicated in this plug-in processor.

This is the method that is called by the DTSContainer on each XBRLPlugInProcessor when the validation() method is called on the DTSContainer instance.

Specified by:

validate in interface XBRLPlugInProcessor

Returns:

an XBRLValidationReport object XBRLValidationReport

validate

public XBRLValidationReport validate(XBRLDocument xDocument)

Description copied from interface: XBRLPlugInProcessor

Validates the document according to the rules indicated in this plug-in processor.

Specified by:

validate in interface XBRLPlugInProcessor

Returns:

an XBRLValidationReport object XBRLValidationReport

validateFact

public XBRLValidationReport validateFact(XBRLFactNumeric xbrlFactNumeric)

Parameters:

xbrlFactNumeric -

Returns:

getName

public java.lang.String getName()

Description copied from interface: XBRLPlugInProcessor

Returns the processor name so it can be written in validation reports

Specified by:

getName in interface XBRLPlugInProcessor

getDescription

public java.lang.String getDescription()

Description copied from interface: XBRLPlugInProcessor

Returns the processor description so it can be written in validation reports

Specified by:

getDescription in interface XBRLPlugInProcessor

configure

public void configure(java.util.Properties properties)

Description copied from interface: XBRLPlugInProcessor

Configures the processor according with the properties passed in in the properties parameter

Specified by:

configure in interface XBRLPlugInProcessor

create

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

Parameters:

theDTS -

Returns:

Throws:

com.rs.lic.LicenseVerificationException

clear

public void clear()

clears all stored information on this processor so validation start from scratch

getDescriptionStatic

public static java.lang.String getDescriptionStatic()

Returns:

getUnit

public XBRLUnit getUnit(XBRLItem itm,
                        javax.xml.namespace.QName defaultUnit)

Returns a valid XBRLUnit for the item passed in in the first parameter. During the computation of a valid unit, a "monetary unit" is replaced by the value passed in as the value for the defaultUnit parameter.

The unit will be new and created in the same DTSContainer as the item in the itm parameter.

Returns null if no unit is found or cannot be created.

Parameters:

itm -

defaultUnit -

Returns:

valid XBRLUnit for the item definition itm