com.ihr.xbrl.om.customcodes

Class CustomCodesProcessor

java.lang.Object

com.ihr.xbrl.om.customcodes.CustomCodesProcessor

All Implemented Interfaces:

HasDTSContainer, XBRLCompilableProcessor, XBRLPlugInProcessor

public class CustomCodesProcessor
extends java.lang.Object
implements XBRLCompilableProcessor

The Class CustomCodesProcessor.

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	assertionCodeArcrole_URI The Constant roleHintsArcrole_URI.
static java.lang.String	namespace The Constant namespace.
static java.lang.String	prefix The Constant prefix.
static java.lang.String	PROCESSORNAME The Constant PROCESSORNAME.
static java.lang.String	schemaURL The Constant schemaURL.

Method Summary

Modifier and Type	Method and Description
static java.util.Properties	addProcessor(java.util.Properties initialProperties) This method receives a Properties instance that already contains a DTSContainer.PROCESSORS_SEQUENCE property and modifies it so the CustomCodes processor is added to the chain
void	clear() Clear.
XBRLValidationReport	compileResources() Compile resources.
void	configure(java.util.Properties properties) Configure.
static CustomCodesProcessor	create(DTSContainer dts) Creates the.
void	freeUnnecessary() Free unnecessary.
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.
boolean	isHidden() Checks if is hidden.
static void	registerProcessorStatic() Register processor static.
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

schemaURL

public static final java.lang.String schemaURL

The Constant schemaURL.

See Also:

Constant Field Values

namespace

public static final java.lang.String namespace

The Constant namespace.

See Also:

Constant Field Values

prefix

public static final java.lang.String prefix

The Constant prefix.

See Also:

Constant Field Values

assertionCodeArcrole_URI

public static final java.lang.String assertionCodeArcrole_URI

The Constant roleHintsArcrole_URI.

See Also:

Constant Field Values

Method Detail

registerProcessorStatic

public static void registerProcessorStatic()

Register processor static.

create

public static CustomCodesProcessor create(DTSContainer dts)

Creates the.

Parameters:

dts - the dts

Returns:

the XBRL plug in processor

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

getDescriptionStatic

public static java.lang.String getDescriptionStatic()

Gets the description static.

Returns:

the description static

configure

public void configure(java.util.Properties properties)

Configure.

Specified by:

configure in interface XBRLPlugInProcessor

Parameters:

properties - the properties

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

isHidden

public boolean isHidden()

Checks if is hidden.

Specified by:

isHidden in interface XBRLPlugInProcessor

Returns:

true, if is hidden

addProcessor

public static java.util.Properties addProcessor(java.util.Properties initialProperties)

This method receives a Properties instance that already contains a DTSContainer.PROCESSORS_SEQUENCE property and modifies it so the CustomCodes processor is added to the chain

Parameters:

initialProperties - the initial properties

Returns:

initialProperties modified

clear

public void clear()
           throws java.lang.Throwable

Clear.

Specified by:

clear in interface XBRLPlugInProcessor

Throws:

java.lang.Throwable - the throwable