com.ihr.xbrl.om.approps

Class XBRLAppPropsProcessor

java.lang.Object

com.ihr.xbrl.om.approps.XBRLAppPropsProcessor

All Implemented Interfaces:

HasDTSContainer, XBRLCompilableProcessor, XBRLPlugInProcessor

public class XBRLAppPropsProcessor
extends java.lang.Object
implements XBRLCompilableProcessor

This processor does not validate anything. It just collects properties in a properties resource in the DTS. The properties can be used to configure different parts of the XBRL Processor or GUI tools. Property handler processors may be added to this processor

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AppPropsNS The Constant AppPropsNS.
static java.lang.String	AppPropsURL The Constant AppPropsURL.
static javax.xml.namespace.QName	key The Constant key.
static java.lang.String	PROCESSORNAME The Constant PROCESSORNAME.
static javax.xml.namespace.QName	propertyNodeName The Constant propertyNodeName.
static javax.xml.namespace.QName	resource The Constant resource.
static javax.xml.namespace.QName	value The Constant value.

Method Summary

Modifier and Type	Method and Description
void	addNode(net.sf.saxon.om.NodeInfo ni, java.lang.Object param) Adds a node to be compiled during the compileResources phase of this processor.
void	clear() Clear.
XBRLValidationReport	compileResources() Compile resources.
void	configure(java.util.Properties properties) Configure.
static XBRLAppPropsProcessor	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.
java.lang.String	getProperty(java.lang.String key) Searches for the property with the specified key in this property list.
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) Searches for the property with the specified key in this property list.
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

AppPropsNS

public static final java.lang.String AppPropsNS

The Constant AppPropsNS.

See Also:

Constant Field Values

AppPropsURL

public static final java.lang.String AppPropsURL

The Constant AppPropsURL.

See Also:

Constant Field Values

resource

public static final javax.xml.namespace.QName resource

The Constant resource.

propertyNodeName

public static final javax.xml.namespace.QName propertyNodeName

The Constant propertyNodeName.

key

public static final javax.xml.namespace.QName key

The Constant key.

value

public static final javax.xml.namespace.QName value

The Constant value.

Method Detail

getContainer

public DTSContainer getContainer()

Gets the container.

Specified by:

getContainer in interface HasDTSContainer

Returns:

the container

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

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

isHidden

public boolean isHidden()

Checks if is hidden.

Specified by:

isHidden in interface XBRLPlugInProcessor

Returns:

true, if is hidden

clear

public void clear()

Clear.

Specified by:

clear in interface XBRLPlugInProcessor

create

public static XBRLAppPropsProcessor create(DTSContainer dts)

Creates the.

Parameters:

dts - the dts

Returns:

the XBRL app props processor

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

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defaultValue)

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.

Parameters:

key - the hashtable key.

defaultValue - a default value.

Returns:

the value in this property list with the specified key value.

getProperty

public java.lang.String getProperty(java.lang.String key)

Searches for the property with the specified key in this property list. The method returns null if the property is not found.

Parameters:

key - the property key.

Returns:

the value in this processor with the specified key value.

addNode

public void addNode(net.sf.saxon.om.NodeInfo ni,
                    java.lang.Object param)

Adds a node to be compiled during the compileResources phase of this processor. This method is called during SAX parsing to register a node that requires transformation by this processor. It might be called from this processor if resources are discovered using XPath (the old style)

Parameters:

ni - the NodeInfo representing the resource to be transformed into an specific rs table resource

param - not used for this processor