Package com.altova.raptorxml

Interface XBRL

public interface XBRL

  • Method Details

    • isValid

      boolean isValid(XBRL.ENUMValidationType type) throws RaptorXMLException
      Validates the input XBRL data.
      Returns:
      true on success, false on failure. In case of an error, use function getLastErrorMessage() to get additional information.
      Throws:
      RaptorXMLException

    • isValid

      boolean isValid() throws RaptorXMLException
      Throws:
      RaptorXMLException

    • evaluateFormula

      boolean evaluateFormula() throws RaptorXMLException
      Evaluates XBRL formulas in an instance file.
      Returns:
      true on success, false on failure. In case of an error, use function getLastErrorMessage() to get additional information.
      Throws:
      RaptorXMLException

    • generateTables

      boolean generateTables() throws RaptorXMLException
      Evaluates XBRL Tables in an instance file.
      Returns:
      true on success, false on failure. In case of an error, use function getLastErrorMessage() to get additional information.
      Throws:
      RaptorXMLException

    • setInputFileName

      void setInputFileName(String filePath)
      Set the input file name. Please note that you have to use absolute URLs.
      Parameters:
      filePath - an absolute URL giving the base location of the file.

    • setInputFileCollection

      void setInputFileCollection(Collection<String> fileCollection)
      Set a collection of files as input data. Please note that you have to use absolute URLs.
      Parameters:
      fileCollection - Collection of strings containing absolute URLs

    • setInputFromText

      void setInputFromText(String inputText)
      Set the text value for the input data
      Parameters:
      inputText - a string containing XBRL data

    • setInputTextCollection

      void setInputTextCollection(Collection<String> stringCollection)
      Set a collection of strings as input
      Parameters:
      stringCollection - collection of strings containing input documents

    • setDimensionExtensionEnabled

      void setDimensionExtensionEnabled(boolean bEnable)
      Enable dimension extensions for validation

    • setExtensibleEnumerationsEnabled

      void setExtensibleEnumerationsEnabled(boolean enable)
      Enables the XBRL Extensible Enumerations 1.0 extension. [default: true]

    • setUTREnabled

      void setUTREnabled(boolean enable)
      Enables the XBRL Unit Registry 1.0 extension. [default: false]

    • setPreloadSchemasEnabled

      void setPreloadSchemasEnabled(boolean enable)
      Preloads XBRL 2.1 specification schemas. [default: true]

    • addExternalDTS

      void addExternalDTS(String path)
      Preloads the given DTS entry point and uses it for validation of instance files (call the method multiple times to specify more than one entry point). Entry points in instance files will be ignored.

    • clearExternalDTS

      void clearExternalDTS()
      Clears the list of paths used for preloading DTS entry points.

    • addTaxonomyPackage

      void addTaxonomyPackage(String path)
      Specifies the path to an additional taxonomy package (all the method multiple times to specify more than one taxonomy package).

    • clearTaxonomyPackage

      void clearTaxonomyPackage()
      Clears the additional taxonomy package path list.

    • setTaxonomyPackagesConfigFile

      void setTaxonomyPackagesConfigFile(String path)
      Specifies the path to the TaxonomyPackagesConfig.json file (used by Altova XMLSpy, MapForce and StyleVision).

    • setValidateDTSOnly

      void setValidateDTSOnly(boolean enable)
      Validates only the DTS referenced from the given XBRL instance. Any other instance specific validation will be skipped. [default: false]

    • setInconsistenciesLimit

      void setInconsistenciesLimit(int value)
      Specifies the XBRL inconsistencies limit in the range 1-65535. Processing continues if this limit is reached, but further XBRL inconsistencies are not reported. [default: 100]

    • setInconsistenciesAsErrors

      void setInconsistenciesAsErrors(boolean enable)
      Treat XBRL inconsistencies as errors [default: false]

    • setFormulaExtensionEnabled

      void setFormulaExtensionEnabled(boolean bEnable)
      Enable formula extensions for validation

    • setFormulaOutput

      void setFormulaOutput(String outputFile)
      Set the location for the output of the formula evaluation
      Parameters:
      outputFile - Full path of the output file

    • setFormulaAssertionsOutput

      void setFormulaAssertionsOutput(String outputFile)
      Set the location for the formula assertion output
      Parameters:
      outputFile - Full path of the output file

    • setFormulaAssertionsAsXML

      void setFormulaAssertionsAsXML(boolean bEnable)
      Enable the XML formatting of the assertion file
      Parameters:
      bEnable - true for XML output, false for JSON output

    • addFormulaParameter

      void addFormulaParameter(String type, String name, String value, String namespace)
      Add a parameter used in the formula evaluation
      Parameters:
      type - Parameter data type
      name - Parameter name
      value - Parameter value (given as string)
      namespace - Parameter namespace

    • addFormulaParameter

      void addFormulaParameter(String type, String name, String value)
      Add a parameter used in the formula evaluation
      Parameters:
      type - Parameter data type
      name - Parameter name
      value - Parameter value (given as string)

    • addFormulaArrayParameter

      void addFormulaArrayParameter(String type, String name, Object[] values)
      Add an array-parameter used in the formula evaluation
      Parameters:
      type - Default type (to be used for the non-pair values inside arValue; default is "xs:string"
      name - Name
      values - Array of values and datatype-value pairs

    • addFormulaParameterNamespace

      void addFormulaParameterNamespace(String prefix, String URI)
      Define a namespace used in the QNames of the parameter names, types or values
      Parameters:
      prefix - The namespace prefix, as used in the values passed to
      invalid reference 
      #addFormulaArrayParameter()
      URI - The namespace URI

    • clearFormulaParameterList

      void clearFormulaParameterList()
      Clear the list of parameters.

    • getLastErrorMessage

      String getLastErrorMessage()
      Get the last error message from the engine.
      Returns:
      last error message

    • readFormulaOutput

      String readFormulaOutput()
      Read the output data of the last formula execution
      Returns:
      output of formula execution (if any)

    • readFormulaAssertions

      String readFormulaAssertions()
      Read the assertions from the last execution
      Returns:
      assertions from last run (if any)

    • setFormulaPreloadSchemas

      void setFormulaPreloadSchemas(boolean bPreload)
      Enable the schema preloading

    • setXincludeSupport

      void setXincludeSupport(boolean support)
      Enable/disable xinclude support

    • setSchemalocationHints

      void setSchemalocationHints(XMLValidator.ENUMLoadSchemalocation opt)
      Configure the usage of the xsi:schemaLocation hints

    • setSchemaImports

      void setSchemaImports(XMLValidator.ENUMSchemaImports opt)
      Configure the usage of the xsi:schemaLocation hints

    • seSchemaImports

      @Deprecated void seSchemaImports(XMLValidator.ENUMSchemaImports opt)
      Deprecated.
      use setSchemaImports(com.altova.raptorxml.XMLValidator.ENUMSchemaImports) instead.
      Configure the usage of the xsi:schemaLocation hints

    • setSchemaMapping

      void setSchemaMapping(XMLValidator.ENUMSchemaMapping opt)
      Configure the usage of the xsi:schemaLocation hints

    • setPythonScriptFile

      void setPythonScriptFile(String file)
      Python script to be executed after a successful validation.
      Parameters:
      file - path of the script file.

    • addPythonScriptFile

      void addPythonScriptFile(String file)
      Add another Python script to be executed after a successful validation.
      Parameters:
      file - path of the script file.

    • clearPythonScriptFiles

      void clearPythonScriptFiles()
      Clear the list of Python scripts to be executed after a successful validation.

    • setPreloadSchemas

      void setPreloadSchemas(boolean preload)
      Enable/disable schema preloading.

    • setTreatXBRLInconsistenciesAsErrors

      void setTreatXBRLInconsistenciesAsErrors(boolean treat)
      Report XBRL instances as invalid in case of data inconsistencies http://xbrl.org/Specification/XBRL-2.1/REC-2003-12-31/XBRL-2.1-REC-2003-12-31+corrected-errata-2013-02-20.html#_3.4

    • setParallelAssessment

      void setParallelAssessment(boolean support)
      Enable/disable parallel schema validity assessment.

    • setTableExtensionEnabled

      void setTableExtensionEnabled(boolean bEnable)
      Enable/Disable the XBRL Table 1.0 extension

    • setTablePreloadSchemas

      void setTablePreloadSchemas(boolean bEnable)
      Enable/Disable preloading of XBRL Table 1.0 specification schemas

    • setTableOutput

      void setTableOutput(String outputFile)
      Set the location for the output of the table evaluation
      Parameters:
      outputFile - Full path of the output file

    • setTableOutputFormat

      void setTableOutputFormat(XBRL.ENUMTableOutputFormat format)
      Sets the format of the table output file
      Parameters:
      format - XML or HTML

    • setTableEliminateEmptyRows

      void setTableEliminateEmptyRows(boolean bEnable)
      Enable elimination of empty table rows/columns (applies to html output only).

    • setGenericLabelLinkrole

      void setGenericLabelLinkrole(String labelLinkrole)
      Specifies the preferred extended link role to use when rendering generic labels.

    • setConceptLabelLinkrole

      void setConceptLabelLinkrole(String labelLinkrole)
      Specifies the preferred extended link role to use when rendering concept labels.

    • setGenericLabelRole

      void setGenericLabelRole(String labelRole)
      Specifies the preferred label role to use when rendering generic labels. [default: http://www.xbrl.org/2008/role/label]

    • setConceptLabelRole

      void setConceptLabelRole(String labelRole)
      Specifies the preferred label role to use when rendering concept labels. [default: http://www.xbrl.org/2003/role/label]

    • setLabelLang

      void setLabelLang(String labelLang)
      Specifies the preferred label language to use when rendering labels. [default: en]

    • addFormulaForProcessing

      void addFormulaForProcessing(String formula)
      Limits formula execution to the given formula only (call multiple times to specify more than one)
      Parameters:
      bstrFormula - Name of the formula; use \"##none\" for nothing and \"##all\" for processing all

    • addAssertionForProcessing

      void addAssertionForProcessing(String assertion)
      Limits formula execution to the given assertion only (call multiple times to specify more than one)
      Parameters:
      bstrAssertion - Name of the assertion; use \"##none\" for nothing and \"##all\" for processing all

    • addAssertionSetForProcessing

      void addAssertionSetForProcessing(String assertionSet)
      Limits formula execution to the given assertion set only (call multiple times to specify more than one)
      Parameters:
      bstrAssertionSet - Name of the assertion set; use \"##none\" for nothing and \"##all\" for processing all

    • addTableForProcessing

      void addTableForProcessing(String table)
      Limits table generation to the given table only (call multiple times to specify more than one)
      Parameters:
      bstrTable - Name of the table; use \"##none\" for nothing and \"##all\" for processing all

    • setTableLinkbaseNamespace

      void setTableLinkbaseNamespace(String namespace)
      Enables loading of table linkbases written with a previous draft specification. Table linkbase validation, resolution and layout is still performed according to the Table Linkbase 1.0 Recommendation 18 March 2014.
      Parameters:
      namespace - Namespace; use ##detect to enable auto-detection.

    • setEvaluateReferencedParametersOnly

      void setEvaluateReferencedParametersOnly(boolean bEnable)
      If false, forces evaluation of all parameters even if they are not referenced by any formulas/assertions/tables. [default: true]

    • setIXBRLTreatAsDocumentSet

      void setIXBRLTreatAsDocumentSet(boolean enable)
      Treat all inputs as a single Inline XBRL Document Set. [default: false]

    • setIXBRLVersion

      void setIXBRLVersion(XBRL.ENUMIXBRLVersion version)
      Specifies the Inline XBRL (iXBRL) version to use. [default: detect]

    • addIXBRLTransformationRegistryLimit

      void addIXBRLTransformationRegistryLimit(String URL)
      Limit the available Inline XBRL Transformation Registries to the specified version

    • clearIXBRLTransformationRegistryLimit

      void clearIXBRLTransformationRegistryLimit()
      Removes the limiting of the available Inline XBRL Transformation Registries to specific versions (similar to #all option on the CLI)

    • setIXBRLUriTransformationStrategy

      void setIXBRLUriTransformationStrategy(XBRL.ENUMIXBRLUriStrategy strategy)
      Specifies how Inline XBRL URIs should be transformed in generated Target Documents. [default: keep-relative]

    • enableIXBRLValidateTarget

      void enableIXBRLValidateTarget(boolean enable)
      Enables XBRL validation of generated Target Document XBRL output. [default: true]

    • setIXBRLOutput

      void setIXBRLOutput(String outputFile)
      If specified, the generated Target Document XBRL output will be written to this path.

    • addXuleFile

      void addXuleFile(String filePath)
      Executes the rules in the specified XULE file. If a directory or zip archive is specified, all *.xule files in that directory or zip archive will be executed. (add option multiple times to specify more than one XULE file)
      Parameters:
      filePath - an absolute URL giving the base location of the file.

    • clearXuleFileList

      void clearXuleFileList()
      Clears the list of XULE files.

    • addProcessXuleRule

      void addProcessXuleRule(String ruleName)
      Limits XULE execution to the given rule only (add option multiple times to specify more than one rule)

    • clearProcessXuleRuleList

      void clearProcessXuleRuleList()
      Clears the list of process XULE rules.

    • enableXuleInstanceNamespaceBindings

      void enableXuleInstanceNamespaceBindings(boolean enable)
      Makes namespace bindings from the XBRL root element available in the XULE processor. [default: false]

    • setXuleOutput

      void setXuleOutput(String outputFile)
      Serializes XULE output to outputFile.

    • enableXuleReportRuleEvaluations

      void enableXuleReportRuleEvaluations(boolean enable)
      Report XULE rule evaluations as errors, warnings or infos depending on the assigned rule severity. [default: true]

    • setXuleStackSize

      void setXuleStackSize(int value)
      Specifies the XULE processor stack size. [default: 1000]

    • setTreatInvalidUseOfStandardRoleAsWarning

      void setTreatInvalidUseOfStandardRoleAsWarning(boolean value)
      \ Specifies whether the invalid use of standard roles should be reported only as a warning. Default value is false.\
      Parameters:
      bTreat - New value\

    • setTreatCustomRoleErrorsAsWarnings

      void setTreatCustomRoleErrorsAsWarnings(boolean value)
      \ Report non-critical XBRL errors related to custom role/arcrole types (for example, missing roleRefs) as warnings. Default value is false.\
      Parameters:
      bTreat - New value\

    • useExistingCSVMetadata

      void useExistingCSVMetadata(boolean value)
      Specifies whether to use the existing CSV metadata file. The default value is false.

    • addTaxonomyToIgnore

      void addTaxonomyToIgnore(String value)
      Specifies a taxonomy that should not be referenced by a schema reference in the generated xBRL-XML report.

    • clearTaxonomiesToIgnoreList

      void clearTaxonomiesToIgnoreList()
      Clear taxonomies that should not be referenced by a schema reference in the generated xBRL-XML report.

    • addCSVTable

      void addCSVTable(String value)
      Specifies an optional CSV table that should be generated in xBRL-CSV output. If nothing is specified, then all tables will be written.

    • clearCSVTableList

      void clearCSVTableList()
      All CSV tables will be written.

    • setXMLOutputFileName

      void setXMLOutputFileName(String value)
      Writes the XBRL data in OIM xBRL-XML format to file. The File value must be a path to a .xml file.

    • setJSONOutputFileName

      void setJSONOutputFileName(String value)
      Writes the XBRL data in OIM xBRL-JSON format to file. The File value must be a path to a .xml file.

    • setCSVOutputFileName

      void setCSVOutputFileName(String value)
      Writes the XBRL data in OIM xBRL-CSV format to file. The File value must be a path to a .xml file.

    • setOIMXBRLNamespace

      void setOIMXBRLNamespace(String value)
      Namespace to use instead of the default namespace https://xbrl.org/2021.

    • setOIMValidate

      void setOIMValidate(boolean value)
      Specifies whether to perform an XBRL validation of the data model. The default value is false.