| Package | Description |
|---|---|
| com.ihr.xbrl.dataloader |
Provides the classes necessary to load data from an instance document to any possible data target.
|
| com.ihr.xbrl.dataloader.target |
Provides implementations of different drivers for data loading
Loader drivers responds to loading events and store the information in the target format.
|
| com.ihr.xbrl.dts |
Provides the classes necessary to investigate the content of a DTS.
|
| com.ihr.xbrl.filters |
Provides the classes necessary to identify a fact in an instance document by all
the properties the element could be uniquely identified.
|
| com.ihr.xbrl.formula |
Provides the classes to implement a plug in processor for XBRL information and execute XQuery formulas defined in XBRL Linkbases
The content of this package is the processor and the required classes to compile and execute
formulas written in the XQuery language from the W3C.
|
| com.ihr.xbrl.gui.interfaces |
Provides the interfaces for the common operations that require user interface and are implemented
in applications.
|
| com.ihr.xbrl.mapper |
Provides the classes necessary access to content in whatever format and create an XBRL Instance document
This package contains the MapEngine and Mappers that uses a configuration file with an Instance
template.
|
| com.ihr.xbrl.mapper.source |
Provides implementations of drivers to obtain data from multiple sources in order to create an XBRL Instance
Some of the drivers collects data from a web form or from an excel file.
|
| com.ihr.xbrl.mapper.source.worksheet |
This package contains the root class for the mapper XBRL drivers that obtains information from
spreadsheets, Excel and Google sheets are currently implemented.
|
| com.ihr.xbrl.om |
Provides the classes necessary to start processing XBRL information.
|
| com.ihr.xbrl.om.assertions | |
| com.ihr.xbrl.om.errors |
Provides the classes necessary to produce and process XBRL related errors
There are two error categories.
|
| com.ihr.xbrl.om.formula |
Provides the classes necessary to implement a plug in XBRL processor for validation of
docuents and taxonomies according to the XBRL formula specification 1.0
At this stage the package is just created.
|
| com.ihr.xbrl.om.formula.aspects | |
| com.ihr.xbrl.om.formula.filters | |
| com.ihr.xbrl.om.formula.util | |
| com.ihr.xbrl.om.instance |
Provides the classes necessary to process, read and write the content of XBRL Instance documents.
|
| com.ihr.xbrl.om.table |
This package contains an object model to work with tables as defined in the XBRL Table specification
The current implementation is based on table linkbase PWD
http://www.xbrl.org/Specification/table-linkbase/PWD-2013-05-17/table-linkbase-PWD-2013-05-17.html
The XBRLTableProcessor class
|
| com.ihr.xbrl.pojo |
Provides the classes necessary to access to the content of a DTS using POJO technology.
|
| com.ihr.xbrl.store | |
| com.ihr.xbrl.transform.target |
Provides the classes necessary to serialize the generated XML document in the output format.
|
| com.ihr.xbrl.versioning |
Provides the classes necessary to create or access to the content of a versioning
report.
|
| com.ihr.xbrl.web |
Provides the classes necessary to initialize servlers that will transform data into XBRL
This package contains a sample Config class for servlets that generates XBRL from web forms
or other sources using the mapper engine
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.Object[] |
Loader.load(XBRLInstance instance)
Process the content of an instance document.
|
java.lang.Object[] |
LoaderEngine.load(XBRLInstance instance,
DTSContainer dts)
Executes the mapping defined in the configuration file.
|
void |
LoaderEngine.migrateConfigFile(XBRLInstance versioningReport,
java.net.URI outputReportUri,
java.net.URI newConfigFileUri)
Migrates a configuration file from using a DTS to using a new DTS with information from
an XBRL versioning report.
|
void |
Loader.migrateConfigFile(XBRLInstance versioningReport,
java.net.URI outputReportUri,
java.net.URI newConfigFileUri)
Migrate config file.
|
void |
XBRLLoaderInterface.startOfDocument(XBRLInstance instance)
Called by the transformation processor to indicate the start of a new document.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SQLDriver.startOfDocument(XBRLInstance instance) |
void |
NullDriver.startOfDocument(XBRLInstance instance) |
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance |
InstanceExplorerInterface.getInstance()
Access to the XBRLInstance in the instance explorer.
|
XBRLInstance |
InstanceExplorer.getInstance() |
XBRLInstance |
DimensionalInstanceExplorer.getInstance() |
| Modifier and Type | Method and Description |
|---|---|
void |
InstanceBuilder.buildConcepts(XBRLInstance instance)
Creates facts in the instance according to concepts
in the DTS
The instance MUST have at least one unit, one instant context and one duration context.
|
void |
InstanceExplorerInterface.setInstance(XBRLInstance instance)
Sets the instance.
|
void |
InstanceExplorer.setInstance(XBRLInstance instance) |
void |
DimensionalInstanceExplorer.setInstance(XBRLInstance instance)
Sets the instance.
|
| Modifier and Type | Method and Description |
|---|---|
static XBRLFilterInterface |
CompanyFilter.newCompanyFilter(XBRLEntity entity,
XBRLInstance instance,
org.hibernate.Session session)
New company filter.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance[] |
FlFormulaProcessor.formulaInstanceCreation(XBRLInstance source)
Formula instance creation.
|
XBRLInstance |
FlFormulaProcessor.getInstance()
Gets the single instance of FlFormulaProcessor.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance[] |
FlFormulaProcessor.formulaInstanceCreation(XBRLInstance source)
Formula instance creation.
|
java.lang.String[] |
FlFormulaProcessor.formulaValidationStr(XBRLInstance source)
Formula validation str.
|
void |
FlFormulaProcessor.setInstance(XBRLInstance instance)
Sets the instance.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLValidationReport |
HasErrorsHandler.validateDTS(XBRLInstance instance)
Executes validation of the instance document that is being edited and
generates a new XBRLValidation report.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance |
Mapper.generateInstance(java.lang.Object[] inputs)
Generates a new instance document obtaining data from data sources and using the
information in the configuration file.
|
XBRLInstance |
Mapper.generateInstance(java.lang.Object[] inputs,
DTSLoadingBarInterface bar)
Generates a new instance document obtaining data from data sources and using the
information in the configuration file.
|
XBRLInstance |
MapEngine.map(java.lang.Object[] inputs)
Executes the mapping defined in the configuration file.
|
XBRLInstance |
MapEngine.map(java.lang.Object[] inputs,
DTSLoadingBarInterface bar)
Executes the mapping defined in the configuration file.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Section.addFilesTo(XBRLInstance instance)
Adds referenced files to the instance document.
|
static MapperFileSaveInterface |
Mapper.createConfigFile(XBRLInstance instance,
java.net.URI config,
java.net.URI configConfUri,
java.lang.String scheme,
java.lang.String company,
java.util.ArrayList<Mapper.PeriodMapping> mappingPeriods,
XBRLDataSource dataSource)
This function generates a sample configuration file for a given DTS.
|
void |
Mapper.migrateConfigFile(XBRLInstance versioningReport,
java.net.URI outputReportUri,
java.net.URI newConfigFileUri)
Migrates a mapping configuration file to a new release of a DTS
Produces a XHTML file in the given URI with information about the
migration process.
|
void |
MapEngine.migrateConfigFile(XBRLInstance versioningReport,
java.net.URI outputReportUri,
java.net.URI newConfigFileUri)
Migrates a configuration file from using a DTS to using a new DTS with information from
an XBRL versioning report.
|
| Modifier and Type | Method and Description |
|---|---|
void |
XBRLFileDataSource.endOfDocument(XBRLInstance instance) |
void |
XBRLDataSource.endOfDocument(XBRLInstance instance)
Called by the MapEngine when a new instance is finished
Can be used to close connections to data sources.
|
void |
WebFormDataSource.endOfDocument(XBRLInstance instance) |
void |
VoidDataSource.endOfDocument(XBRLInstance instance) |
void |
SQLDataSource.endOfDocument(XBRLInstance instance) |
void |
JNDIDataSource.endOfDocument(XBRLInstance instance) |
void |
CSVDataSource.endOfDocument(XBRLInstance instance) |
void |
ExcelDataSource.startOfDocument(XBRLInstance instance,
java.lang.Object[] inputs,
DTSLoadingBarInterface bar) |
void |
XBRLFileDataSource.startOfDocument(XBRLInstance instance,
java.lang.Object[] inputs,
DTSLoadingBarInterface bar) |
void |
XBRLDataSource.startOfDocument(XBRLInstance instance,
java.lang.Object[] inputs,
DTSLoadingBarInterface bar)
Called by the MapEngine when a new instance that requires this data source is
going to be created.
|
void |
WebFormDataSource.startOfDocument(XBRLInstance instance,
java.lang.Object[] inputs,
DTSLoadingBarInterface bar) |
void |
VoidDataSource.startOfDocument(XBRLInstance instance,
java.lang.Object[] inputs,
DTSLoadingBarInterface bar) |
void |
SQLDataSource.startOfDocument(XBRLInstance instance,
java.lang.Object[] inputs,
DTSLoadingBarInterface bar) |
void |
JNDIDataSource.startOfDocument(XBRLInstance instance,
java.lang.Object[] inputs,
DTSLoadingBarInterface bar) |
void |
CSVDataSource.startOfDocument(XBRLInstance instance,
java.lang.Object[] inputs,
DTSLoadingBarInterface bar) |
| Modifier and Type | Method and Description |
|---|---|
void |
AbstractWorksheetDataSource.endOfDocument(XBRLInstance instance) |
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance |
XBRLValidationReport.getFormulaProcessorGeneratedInstance()
If the DTS contains formula linkbases this method returns the output
instance generated using formulas.
|
XBRLInstance |
DTSContainer.getInstanceByURI(java.net.URI u)
Returns an XBRLInstance that has been loaded into the
document cache using the document URI.
|
XBRLInstance |
DTSContainer.isInstanceOfThisDTS(MultiDTSValidationFile item,
int mode)
Check whether or not the document in the xmlSource is an instance document according to
this DTS.
|
XBRLInstance |
DTSContainer.isInstanceOfThisDTS(javax.xml.transform.Source xmlSource,
int mode)
Check whether or not the document in the xmlSource is an instance document according to
this DTS.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
DTSContainer.isInstanceOfThisDTS(XBRLInstance instance,
int mode)
Check whether or not the instance document received as a parameter can be used in this
DTSContainer.
|
void |
MultiDTSValidationHandler.processReport(XBRLInstance instance,
XBRLValidationReport report)
This function is called by the validation service.
|
void |
XBRLValidationReport.setFormulaInstance(XBRLInstance instance)
Used by the processor internally to set the generated instance.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLAssertionResult[] |
XBRLConsistencyAssertion.evaluateAssertion(XBRLInstance doc) |
XBRLAssertionResult[] |
XBRLAssertion.evaluateAssertion(XBRLInstance doc) |
XBRLAssertionResult[] |
EvaluableAssertion.evaluateAssertion(XBRLInstance doc)
Required for evaluating the assertion.
|
XBRLAssertionResult[] |
XBRLValueAssertion.evaluateAssertionType(XBRLInstance instance) |
XBRLAssertionResult[] |
XBRLExistenceAssertion.evaluateAssertionType(XBRLInstance instance) |
XBRLAssertionResult[] |
XBRLConsistencyAssertion.evaluateAssertionType(XBRLInstance instance) |
XBRLAssertionResult[] |
AssertionEvaluationLocal.evaluateAssertionType(XBRLInstance instance)
Evaluate assertion type.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance |
XBRLAssertionResult.getAfterFormulaInstance()
Access to the XBRL Report that was created after the evaluation of the variable set
Returns null if the DTS Property FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS is false.
|
XBRLInstance |
XBRLAssertionResult.getInputInstance()
Acess to the XBRL Input instance document on this assertion.
|
| Constructor and Description |
|---|
XBRLAssertionResult(XBRLFormulaResource assertion,
boolean result,
int cycle,
XBRLInstance inputInstance,
XBRLInstance afterFormulaInstance)
This method can be used to create an XBRLAssertionResult while looking if the
XBRLAssertion contains a specific user defined message.
|
XBRLValidationExceptionTargetIsNotContext(XBRLInstance file,
java.lang.String id,
XMLFragment fragment)
Instantiates a new XBRL validation exception target is not context.
|
XBRLValidationExceptionTargetIsNotFact(XBRLInstance instance,
java.lang.String id,
XMLFragment fragment)
Instantiates a new XBRL validation exception target is not fact.
|
XBRLValidationExceptionTargetIsNotUnit(XBRLInstance file,
java.lang.String id,
XMLFragment fragment)
Instantiates a new XBRL validation exception target is not unit.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance |
XBRLFormula.evaluateFormula(XBRLInstance doc,
XBRLInstance instance)
Evaluates a formula and returns an instance document containing the formula output.
|
XBRLInstance |
XBRLFormulaProcessor.getUnderEvaluationInstance()
Gets the under evaluation instance.
|
| Modifier and Type | Method and Description |
|---|---|
void |
XBRLFormulaProcessor.addInScopeInstance(XBRLInstance doc)
Adds the in scope instance.
|
XBRLValidationReport |
XBRLFormulaProcessor.evaluate(XBRLResource resource,
XBRLInstance instance)
Evaluates one resource and returns an XBRLValidationReport instance.
|
XBRLInstance |
XBRLFormula.evaluateFormula(XBRLInstance doc,
XBRLInstance instance)
Evaluates a formula and returns an instance document containing the formula output.
|
void |
XBRLFormulaProcessor.evaluateFormulaSet(java.util.Collection<XBRLFormula> formulas,
XBRLValidationReport valReport,
XBRLInstance doc,
ExecutionTargetType targetType)
Evaluates a collection of formulas and put the result inside the validation report passed in
as parameter valReport.
|
void |
XBRLFormulaProcessor.removeInScopeInstance(XBRLInstance doc)
Removes the in scope instance.
|
void |
XBRLFormulaProcessor.setUnderEvaluationInstance(XBRLInstance valInstance)
Sets or clear the instance document that is in the scope of formula functions.
|
XBRLValidationReport |
XBRLFormulaProcessor.validate(XBRLInstance doc)
This method validates an instance document (doc) against the content of the formula
linkbase.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLFactsList |
LocationAspectInterface.getLocation(XBRLInstance instance,
XPathHelper xph)
Returns the location for a new item or tuple .
|
XBRLFactsList |
DefaultAspectRule.getLocation(XBRLInstance instance,
XPathHelper xph) |
| Modifier and Type | Method and Description |
|---|---|
XBRLUnit |
XBRLFormulaUnitFilter.getUnit(XBRLInstance doc)
Gets the unit.
|
| Modifier and Type | Method and Description |
|---|---|
void |
AssertionExecutor.setParams(EvaluableAssertion a,
XBRLInstance doc,
XBRLValidationReport valReport)
Sets the params.
|
| Constructor and Description |
|---|
FactHasExplicitDimensionValueCache(XBRLInstance report)
Creates an instance of the helper class to boost the resolution of dimensions and dimension members
reported for every fact in the instance document
|
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance |
XBRLInstance.clone() |
XBRLInstance |
XBRLInstance.getInstance() |
XBRLInstance |
XBRLFactsListImpl.getInstance() |
XBRLInstance |
XBRLFactsList.getInstance()
Access to the instance document on the top of this facts container hierarchy.
|
XBRLInstance |
XBRLFactsContainer.getInstance()
Gets the single instance of XBRLFactsContainer.
|
XBRLInstance |
XBRLFact.getInstance()
The instance document where this fact exists.
|
XBRLInstance |
XBRLUnit.getParent() |
XBRLInstance |
XBRLContext.getParent() |
| Modifier and Type | Method and Description |
|---|---|
void |
XBRLInstance.copyHistory(XBRLInstance fromInstance)
This method copy all history details from instance in the fromInstance parameter
to facts in this instance document.
|
void |
XBRLInstance.merge(XBRLInstance otherInstance)
Add to this instance document all the facts and contexts from the instance
document in the parameter.
|
| Constructor and Description |
|---|
XBRLContext(XBRLInstance parent,
XBRLEntity entity,
XBRLPeriod period,
XBRLScenario scenario)
Creates a new context with the supplied entity, period and scenario and set the parent to the parent instance.
|
XBRLContext(XBRLInstance parent,
net.sf.saxon.s9api.XdmNode root)
Creates a new context with the supplied XdmNode.
|
XBRLUnit(XBRLInstance parent,
net.sf.saxon.s9api.XdmNode root)
Instantiates a new XBRL unit.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance |
XBRLTableProcessor.getUnderEvaluationInstance()
Gets the under evaluation instance.
|
| Modifier and Type | Method and Description |
|---|---|
void |
XBRLTableProcessor.setUnderEvaluationInstance(XBRLInstance valInstance)
Sets or clear the instance document that is in the scope of formula functions.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance |
XBRLRSGenerator.generate(XBRLInstance instanceIn)
Generate.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance |
XBRLPojoGenerator.generate(XBRLInstance instance)
Generate.
|
XBRLInstance |
XBRLPojoGenerator.generate(XBRLInstance instance,
boolean bForUpdate)
Generates a new pojo instance document based on the content of the instance document submitted as a parameter.
|
XBRLInstance |
XBRLPojoGenerator.generate(XBRLInstance instance,
boolean bForUpdate,
java.lang.String pathConversionRule)
Generates a new pojo instance document based on the content of the instance document submitted as a parameter.
|
XBRLInstance |
XBRLDBAccessor.queryDocument(XBRLInstance instance)
Query the database for the existence of an XBRLInstance document.
|
| Modifier and Type | Method and Description |
|---|---|
XBRLInstance |
StorageEvent.getRegularInstance()
Gets the regular instance.
|
| Constructor and Description |
|---|
LoadPojoInThread(java.lang.String instanceUriOnDatabase,
XBRLInstance instanceDocument,
DTSContainer dts,
DbUtil dbUtil,
org.hibernate.Session session,
org.apache.log4j.Appender logHandler,
org.apache.log4j.Level level,
DTSLoadingBarInterface bar,
boolean bForUpdate,
PojoExtension<?,?>[] pojoExtensions)
Instantiates a new load pojo in thread.
|
LoadPojoInThread(XBRLInstance instanceDocument,
DTSContainer dts,
DbUtil dbUtil,
org.hibernate.Session session,
org.apache.log4j.Appender logHandler,
org.apache.log4j.Level level,
DTSLoadingBarInterface bar,
boolean bForUpdate,
PojoExtension<?,?>[] pojoExtensions)
Instantiates a new load pojo in thread.
|
StorageEvent(StoreXBRLThread thread,
int status,
XBRLInstance pojoInstance,
XBRLInstance regularInstance,
DTSContainer pojoContainer,
DTSContainer regularContainer,
java.lang.String message)
Creates an StorageEvent object to be sent to parent applications.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ExcelReportFactHandler.startOfDocument(XBRLInstance instance) |
void |
XBRLReportHandlerInterface.startOfDocument(XBRLInstance instance)
Called by the transformation processor to indicate the start of a new document.
|
void |
XBRLReportHandler.startOfDocument(XBRLInstance instance) |
void |
XBRLFactHandlerInterface.startOfDocument(XBRLInstance instance)
Called by the processor to announce a new instance document is about to be processed.
|
void |
HTMLReportHandler.startOfDocument(XBRLInstance instance) |
void |
HTMLFactHandler.startOfDocument(XBRLInstance instance) |
| Modifier and Type | Method and Description |
|---|---|
static void |
ReportWriter.documentAction(Path dp,
XBRLFactsList cf,
XBRLTaxonomy verTx,
org.jdom.Namespace verNS,
GenericLinkbase glb,
XBRLInstance report,
boolean relativize,
java.net.URI u)
recursive function.
|
void |
VlVersioningProcessor.loadVersioningReport(XBRLInstance versioningReport)
Second edition of this method.
|
| Constructor and Description |
|---|
VlVersioningProcessor(java.lang.String versioningDTSUri,
java.lang.String versioningConfSuiteSchema,
XBRLInstance vlDTS)
Creates an instance of the versioning processor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ValidationHandler.processReport(XBRLInstance instance,
XBRLValidationReport report,
javax.servlet.http.HttpServletResponse response)
This function is called by the validation service.
|
void |
DefaultValidationHandler.processReport(XBRLInstance instance,
XBRLValidationReport report,
javax.servlet.http.HttpServletResponse response) |