com.ihr.xbrl.om.rstable

Class RSTableProcessor

java.lang.Object

com.ihr.xbrl.om.rstable.RSTableProcessor

All Implemented Interfaces:

HasDTSContainer, XBRLCompilableProcessor, XBRLPlugInProcessor

public class RSTableProcessor
extends java.lang.Object
implements XBRLCompilableProcessor

The Class RSTableProcessor. This processor provide actions on cell tables gui events. Only applies to closed tables.

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	aspectNodeFilterArcrole_URI The Constant aspectNodeFilterArcrole_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.
static java.lang.String	tableActionArcrole_URI The Constant conceptAutofillArcrole_URI.

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.
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 table action processor is added to the chain
void	clear() Clear.
net.sf.saxon.s9api.XdmValue	compileAndEvaluate(net.sf.saxon.s9api.XPathCompiler xpc, java.lang.String expression, RSTableManager formTableManager, XBRLInstance instance) Compile and evaluate.
XBRLValidationReport	compileResources() Compile resources.
void	configure(java.util.Properties properties) Configure.
static RSTableProcessor	create(DTSContainer dts) Creates the.
void	freeUnnecessary() Free unnecessary.
XBRLArcroleType	getAspectNodeFilterArcrole() Gets the aspect node filter arcrole.
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.util.Collection<RSTableAction>	getTableAction(XBRLTable table) Returns the collection of RSTableAction resources linked with the xbrl table.
XBRLArcroleType	getTableActionArcrole() Gets the table action arcrole.
static boolean	isAspectNodeAsClosed(XBRLOpenDefinitionNode xbrlOpenDefinitionNode) Checks if is aspect node as closed.
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

tableActionArcrole_URI

public static final java.lang.String tableActionArcrole_URI

The Constant conceptAutofillArcrole_URI.

See Also:

Constant Field Values

aspectNodeFilterArcrole_URI

public static final java.lang.String aspectNodeFilterArcrole_URI

The Constant aspectNodeFilterArcrole_URI.

See Also:

Constant Field Values

Method Detail

registerProcessorStatic

public static void registerProcessorStatic()

Register processor static.

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

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

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 table action processor is added to the chain

Parameters:

initialProperties - the initial properties

Returns:

initialProperties modified

clear

public void clear()

Clear.

Specified by:

clear in interface XBRLPlugInProcessor

getTableActionArcrole

public XBRLArcroleType getTableActionArcrole()

Gets the table action arcrole.

Returns:

the arcrole type definition obtained form the official schema or null

getAspectNodeFilterArcrole

public XBRLArcroleType getAspectNodeFilterArcrole()

Gets the aspect node filter arcrole.

Returns:

the arcrole type definition obtained form the official schema or null

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

create

public static RSTableProcessor create(DTSContainer dts)

Creates the.

Parameters:

dts - the dts

Returns:

the table action processor

getDescriptionStatic

public static java.lang.String getDescriptionStatic()

Gets the description static.

Returns:

the description static

getTableAction

public java.util.Collection<RSTableAction> getTableAction(XBRLTable table)

Returns the collection of RSTableAction resources linked with the xbrl table.

Parameters:

table - the xbrl table

Returns:

the collection of RSTableAction

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

isAspectNodeAsClosed

public static boolean isAspectNodeAsClosed(XBRLOpenDefinitionNode xbrlOpenDefinitionNode)

Checks if is aspect node as closed.

Parameters:

xbrlOpenDefinitionNode - the xbrl open definition node

Returns:

true, if is aspect node as closed

compileAndEvaluate

public net.sf.saxon.s9api.XdmValue compileAndEvaluate(net.sf.saxon.s9api.XPathCompiler xpc,
                                                      java.lang.String expression,
                                                      RSTableManager formTableManager,
                                                      XBRLInstance instance)
                                               throws net.sf.saxon.s9api.SaxonApiException

Compile and evaluate.

Parameters:

xpc - the xpc

expression - the expression

formTableManager - the form table manager

instance - the instance

Returns:

the xdm value

Throws:

net.sf.saxon.s9api.SaxonApiException - the saxon api exception