com.ihr.xbrl.om.utr

Class UTRProcessor

java.lang.Object

com.ihr.xbrl.om.utr.UTRProcessor

All Implemented Interfaces:

HasDTSContainer, XBRLPlugInProcessor

public class UTRProcessor
extends java.lang.Object
implements XBRLPlugInProcessor

The Class UTRProcessor.

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Fields

Modifier and Type	Field and Description
static java.lang.String	PROCESSORNAME The Constant PROCESSORNAME.
static java.lang.String	UTR_ERRORS_NS The Constant UTR_ERRORS_NS.
static java.lang.String	UTR_NS The Constant UTR_NS.
static java.lang.String	UTR_OFFICIAL_URL The Constant 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.
static java.lang.String	UTR_URL Alternate URL for testing UTR processor conformance.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
void	configure(java.util.Properties properties) Configure.
static UTRProcessor	create(DTSContainer dts) Creates the UTRProcessor.
DTSContainer	getContainer() Obtains the instance of the DTSContainer for which this processor was created.
java.lang.String	getDescription() Gets the description.
static java.lang.String	getDescriptionStatic() Gets the description static.
java.lang.String	getName() Gets the name.
XBRLUnit	getUnit(XBRLItem itm, javax.xml.namespace.QName defaultUnit) Returns a valid XBRLUnit for the item passed in in the first parameter.
boolean	isHidden() Checks if is hidden.
static void	registerProcessorStatic() Register processor static.
XBRLValidationReport	validate() Validate.
XBRLValidationReport	validate(XBRLDocument xDocument) Validate.
XBRLValidationReport	validateFact(XBRLFactNumeric xbrlFactNumeric) Validate fact numeric.

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

UTR_URL

public static final java.lang.String UTR_URL

Alternate URL for testing UTR processor conformance. "A processor being tested for compliance with the UTR structure specification requires some means of using that file instead of the published utr file at http://www.xbrl.org/utr/utr.xml". Due to the reason this file is required during the static initialization of the UTR processor it cannot be provided as a property. It MUST be provided via -D parameter to the JVM. The property name is "utr-url" and it is defined here as a constant

See Also:

Constant Field Values

UTR_OFFICIAL_URL

public static final java.lang.String UTR_OFFICIAL_URL

The Constant 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 in the Status enumeration

See Also:

UTRProcessor.Status, Constant Field Values

UTR_NS

public static final java.lang.String UTR_NS

The Constant UTR_NS.

See Also:

Constant Field Values

UTR_ERRORS_NS

public static final java.lang.String UTR_ERRORS_NS

The Constant UTR_ERRORS_NS.

See Also:

Constant Field Values

Method Detail

registerProcessorStatic

public static void registerProcessorStatic()

Register processor static.

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

getContainer

public DTSContainer getContainer()

Obtains the instance of the DTSContainer for which this processor was created.

Specified by:

getContainer in interface HasDTSContainer

Returns:

the container

validateFact

public XBRLValidationReport validateFact(XBRLFactNumeric xbrlFactNumeric)

Validate fact numeric.

Parameters:

xbrlFactNumeric - the xbrl fact numeric

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

create

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

Creates the UTRProcessor.

Parameters:

dts - the dts

Returns:

the XBRL plug in processor

Throws:

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

clear

public void clear()

Clear.

Specified by:

clear in interface XBRLPlugInProcessor

getDescriptionStatic

public static java.lang.String getDescriptionStatic()

Gets the description static.

Returns:

the description static

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 - the itm

defaultUnit - the default unit

Returns:

valid XBRLUnit for the item definition itm

isHidden

public boolean isHidden()

Checks if is hidden.

Specified by:

isHidden in interface XBRLPlugInProcessor

Returns:

true, if is hidden