DTSContainer

java.lang.Object
- com.ihr.xbrl.om.DTSContainer

All Implemented Interfaces:: Stopable, java.io.Serializable

public final class DTSContainer
extends java.lang.Object
implements Stopable, java.io.Serializable

The DTSContainer is the root class that ties all pieces in a DTS together

One instance of a DTSContainer is required on the creator of almost every object in this API.

You can obtain the DTSContainer on every object derived from XMLFragment

Correspondence table between objects in the XBRL Infoset and this API

Class	Infoset Object
`DTSContainer`	2.2.1 DTS Information Item
`XBRLDocument`	2.2.2 XBRL Document Information Item
`XBRLTaxonomy`	2.2.3 XBRL Taxonomy Information Item
`XBRLImport`	2.2.4 XBRL Imported XBRL Taxonomy Information Item
`XBRLRoleType`	2.2.5 XBRL Role Type Information Item
`XBRLArcroleType`	2.2.6 XBRL Arcrole Type Information Item
`XBRLUsedOn`	2.2.7 XBRL Used On Information Item
`XMLElementDefinition`	2.2.8 XBRL Concept Information Item
`XBRLItem`	2.2.9 XBRL Item Information Item
`XBRLTuple`	2.2.10 XBRL Tuple Information Item
`XBRLLinkbase`	2.2.11 XBRL Linkbase Information Item
`XBRLExtendedLink`	2.2.12 XBRL Extended Link Information Item
`XBRLDocumentation`	2.2.13 XBRL Documentation Information Item
`XBRLRelationship`	2.2.14 XBRL Relationship Information Item
`XBRLResource`	2.2.15 XBRL Resource Information Item

The DTSContainer implements the Stopable interface in order to allow the GUI to request the cancellation of the operation of opening a DTS.

Extending the available processors:

The available set of XBRL processors is extensible. Processors are discovered using factories. A factory is a class that creates the processor when the processor is needed for a specific task such as validation of a DTS.

All factories must implement the XBRLProcessorFactory interface.

Processor factories are loaded during the static initialization of the DTSContainer class. It is possible creating additional factories to be registered during the static initialization according to the following rules:

In a resource available in the classpath called RSXBRLMANIFEST/xbrlprocessors.properties a line with a property named "processor-factories" whose value is a comma separated list of processor factory classes, and
The -Dxbrl.processors system property may contain a comma separated list of processor factory classes, and
Applications may call the registerProcessor(String, XBRLPlugInProcessor) method on this class

It is not possible to override standard processor names (Core XBRL 2.1, Dimensions and Formula)

Extending the available functions in the formula processor:

Custom function factories are loaded during the static initialization of the DTSContainer class. It is possible creating additional factories to be registered during the static initialization according to the following rules:

In a resource available in the classpath called RSXBRLMANIFEST/customlibraries.properties a line with a property named "library-factories" whose value is a comma separated list of library factory classes, and
The -Dxbrl.libraries system property may contain a comma separated list of library factory classes, and
Applications may call the XBRLFormulaProcessor.addCustomFunctionLibrary(XBRLRSCustomFunctionLibrary)

Author:: Ignacio
See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DTSContainer.ProcessorAndSchemaCompiler` Helper class to encapsulate the saxonica Processor of this DTSContainer and a saxonica SchemaCompiler together.
`static class`	`DTSContainer.Status` The Enum Status.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADQUIRE_EXTENDED_LOCK` Constant to be used as flag for `specialValidation(SpecialValidationProcess, int, Object[])` the calling process will adquire the lock for the extended links so it can create temporary extended links that will be deleted before exiting validation.
`static int`	`ADQUIRE_ROLETYPES_BY_EXT_LINK_LOCK` Constant to be used as flag for `specialValidation(SpecialValidationProcess, int, Object[])` The calling process will adquire the lock for the roles by extended link.
`static java.lang.String`	`ALWAYS_ADD_ref_2006_02_27_xsd_SCHEMA_TO_DTS` ALWAYS_ADD_ref_2006_02_27_xsd_SCHEMA_TO_DTS is defined as "http://www.reportingstandard.com/properties/always_add_ref_2006_02_27_schema_to_DTS" Possible value is a string that can be converted into a boolean "true" or "false" Default value is "false" Some taxonomies does not incorporate the URL of the reference schema http://www.xbrl.org/2006/ref-2006-02-27.xsd to the DTS but use its namespace in the reference linkbase instead.
`static java.lang.String`	`AUTHENTICATOR_DELEGATE_INSTANCE` The AUTHENTICATOR_DELEGATE_INSTANCE property is the instance of an object implementing java.net.Authenticator that will be registered as the default authenticator.
`static java.lang.String`	`CONSIDER_COMPARISON_WITH_NUMBER_WITH_PRECISION_ZERO_AS_INCONSISTENCY` CONSIDER_COMPARISON_WITH_NUMBER_WITH_PRECISION_ZERO_AS_INCONSISTENCY is defined as "http://www.reportingstandard.com/properties/compare-with-number-p-zero-is-inconsistency" Possible value is a String that can be converted into a boolean "true" or "false" Default value is "false" According to the XBRL 2.1 specification in the simple equation A = B + C, if A is zero with precision 0 the comparison must return true regardless the value of B + C.
`static java.lang.String`	`CONSIDER_DUPLICATES_AS_INCONSISTENCIES` CONSIDER_DUPLICATES_AS_INCONSISTENCIES is defined as "http://www.reportingstandard.com/properties/duplicate-is-inconsistency" Possible value is a String that can be converted into a boolean "true" or "false" Default value is "false" According to the XBRL 2.1 specification duplicates must be ignored for calculation checking.
`static java.lang.String`	`DEFAULT_DIMENSIONS_APPLICANCY` The DEFAULT_DIMENSIONS_APPLICANCY property indicates how the Formula Functions (this does not affects Dimensions Validation) returns the value of a Fact item when the Fact item is NOT reported for a dimension that contains a default value.
`static java.lang.String`	`DEFAULTS_ALWAYS_APPLY` Possible value for the DEFAULT_DIMENSIONS_APPLICANCY property.
`static java.lang.String`	`DEFAULTS_NOT_APPLY` Possible value for the DEFAULT_DIMENSIONS_APPLICANCY property.
`static java.lang.String`	`DTS_CHECK_TOP_LEVEL_SCHEMAS` Work in progress of the new XBRL 2.1 specification version
`static java.lang.String`	`DTS_DISCOVERY_ALLOWSPACESONURIS` Spaces are not allowed in the value space of an URI, but some software vendors such as Fujitsu XWand failed to implement this rule and this means there are URIs with spaces in some taxonomies (at the SEC there are some... and taxonomies in Asian countries might also contain space too).
`static java.lang.String`	`DTS_DISCOVERY_ON_DIFFERENT_FILE_NAMES` The DTS_DISCOVERY_ON_DIFFERENT_FILE_NAMES property specifies how the processor reacts when a reference to a file differs from the real file name on the file system but the file subsystem resolves to the same file name.
`static java.lang.String`	`DTS_DISCOVERY_PRELOAD_OFFICIAL_SCHEMAS` The DTS_DISCOVERY_PRELOAD_OFFICIAL_SCHEMAS property is used internally by the processor to decide if, after creating a new DTSContainer instance, the official schemas from XBRL International will be loaded in the XML processor.
`static java.lang.String`	`DTS_DISCOVERY_RAISE_WARNING_IF_TWO_FILES_HAVE_SAME_NAMESPACE` The DTS_DISCOVERY_RAISE_WARNING_IF_TWO_FILES_HAVE_SAME_NAMESPACE property is used to signal a warning when two files in the DTS use the same namespace with different systemID.
`static java.lang.String`	`DTS_DISCOVERY_REPLACE_OFFICIAL_SCHEMAS_SCHEMALOCATION` The DTS_DISCOVERY_REPLACE_OFFICIAL_SCHEMAS_SCHEMALOCATION property is used to force the processor to load standard schemas from the official location even if the schemaLocation points to a different path.
`static java.lang.String`	`DTS_DISCOVERY_TRUST_NAMESPACES_ONLY` The DTS_DISCOVERY_TRUST_NAMESPACES_ONLY property is used internally by the processor to decide about the strategy to load or reject a new schema will be loaded into the processor based on the new schema target namespace or in both, the target namespace and the schema location.
`static java.lang.String`	`DTS_DISCOVERY_TRUST_NAMESPACES_ONLY_FOR_OFFICIAL_FILES` The DTS_DISCOVERY_TRUST_NAMESPACES_ONLY_FOR_OFFICIAL_FILES property is used internally by the processor similar to the DTS_DISCOVERY_TRUST_NAMESPACES_ONLY but differs from DTS_DISCOVERY_TRUST_NAMESPACES_ONLY in the scope of schemas that will be trusted using the namespace only for files defined in XBRL specifications.
`static java.lang.String`	`DTS_ERROR_MESSAGE_MAX_CHARS` The DTS_ERROR_MESSAGE_MAX_CHARS can be set to set a limit to the error messages produced by the validation.
`static java.lang.String`	`DTS_PROXY_HEADER` The DTS_PROXY_HEADER property is the head of the following three properties: DTS_PROXY_HEADER/address/{n} indicates the proxy address DTS_PROXY_HEADER/port/{n} indicates the proxy port number (no defaults are recognized) DTS_PROXY_HEADER/type/{n} indicates the proxy type "HTTP" or "SOCKS" are recognized types.
`static java.lang.String`	`DTS_RESOLVER` The DTS_RESOLVER property is used in order to add additional DTS URI resolvers to the default ones after the DTS configuration process has been finished.
`static java.lang.String`	`DTS_SHOW_EXACTITUDE_DETAILS` The DTS_SHOW_EXACTITUDE_DETAILS property controls how the values for the calculation inconsistencies are converted to strings.
`static java.lang.String`	`DTS_STORE_CACHE_ENABLE` The DTS_STORE_CACHE_ENABLE property is used to enable or disable the use of a dynamic cache.
`static java.lang.String`	`DTS_STORE_CACHE_PATH` if this property is set, during the DTS discovery process, when a file comes from the Internet, a copy of the file will be written to a directory down on this folder.
`static java.lang.String`	`DTS_THIN` The DTS_THIN property liberates internal resources that can be obtained back from the original XML nodes and reduces the DTS memory footprint.
`static java.lang.String`	`DTS_USER_LANGUAGES` The DTS_USER_LANGUAGES can be set to a comma separated list of language codes in ISO-639-1 that might be used for label selection for concepts and resources.
`static java.lang.String`	`ERROR_PROPERTY_VALUE` This is set to the constant value "error".
`static java.lang.String`	`EXPERIMENTAL_USE_CACHED_STRINGS` If this property value is "true", reading XML documents will store all text pieces into a buffer and that buffer will be used when other strings contains sub-strings that can be obtained form the cache.
`static java.lang.String`	`FAIL_FAST` This is the default and recommended value for the FAIL_STRATEGY property
`static java.lang.String`	`FAIL_SLOW` This is the alternate value for the FAIL_STRATEGY property
`static java.lang.String`	`FAIL_STRATEGY` The FAIL_STRATEGY property allows for the processor to modify when the errors will be reported.
`static int`	`FAST` FAST is a constant for the `mode` parameter in the `isInstanceOfThisDTS(Source, int)` function.
`static java.lang.String`	`FORMULA_PROCESSOR_DEFAULT_MESSAGE_ROLE` The FORMULA_PROCESSOR_DEFAULT_MESSAGE_ROLE property indicates the default role URI string that will be used for the resolution of the winning message when no role (null) is indicated or when no message is found for the selected role (second opportunity).
`static java.lang.String`	`FORMULA_PROCESSOR_ENABLE_ASSERTION_MESSAGE_EXTENSIONS` The FORMULA_PROCESSOR_ENABLE_ASSERTION_MESSAGE_EXTENSIONS property indicates if the processor will calculate and return custom messages during the evaluation of assertions.
`static java.lang.String`	`FORMULA_PROCESSOR_EXCLUSION_FILE` The FORMULA_PROCESSOR_EXLUSION_FILE property can be set to a file name (using URI notation) that may contain formula or assertion identifiers that the processor will skip evaluation.
`static java.lang.String`	`FORMULA_PROCESSOR_FILTER_ORDER_CLASS` The FORMULA_PROCESSOR_FILTER_ORDER_CLASS property indicates the name of a class that must implement the XBRLFilterOrderTool interface.
`static java.lang.String`	`FORMULA_PROCESSOR_GENERAL_VARIABLE_SCHEMA_AWARE` The FORMULA_PROCESSOR_GENERAL_VARIABLE_SCHEMA_AWARE property contains a value 'true' or 'false' that defines the behavior of the XPath expression evaluation for General Variables.
`static java.lang.String`	`FORMULA_PROCESSOR_IGNORE_ASSERTION_NOT_SATISFIED` The FORMULA_PROCESSOR_IGNORE_ASSERTION_NOT_SATISFIED property indicates if the evaluation of assertions with "assertion not satisfied" result will generate a message that will be added to the validation report or if the message will not be generated at all.
`static java.lang.String`	`FORMULA_PROCESSOR_IGNORE_ASSERTION_SATISFIED` The FORMULA_PROCESSOR_IGNORE_ASSERTION_SATISFIED property indicates if the evaluation of assertions with "assertion satisfied" result will generate a message that will be added to the validation report or if the message will not be generated at all.
`static java.lang.String`	`FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE` The FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE establish the behavior of the interrupt call on the DTSContainer instance that is validating formulas.
`static java.lang.String`	`FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE_CURRENT` This is one of the possible values of the FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE property.
`static java.lang.String`	`FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE_PROCESSOR` This is one of the possible values of the FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE property.
`static java.lang.String`	`FORMULA_PROCESSOR_LEVEL_OF_EXCEPTIONS_INSIDE_FILTER_XPATH_EXPRESSIONS` The FORMULA_PROCESSOR_LEVEL_OF_EXCEPTIONS_INSIDE_FILTER_XPATH_EXPRESSIONS property indicates how the formula processor will react when a the evaluation of a formula filter raises an XPath exception.
`static java.lang.String`	`FORMULA_PROCESSOR_PARAMETER_RESOLVER` The FORMULA_PROCESSOR_PARAMETER_RESOLVER property is used in order to add additional Variable Parameter resolvers to the formula processor.
`static java.lang.String`	`FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS` The FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS property is used to configure the formula processor in order to allow XBRLAssertionResult instances to keep a reference of the original input instance after the execution of the formulas in the variable set that defined the input of the consistency assertion.
`static java.lang.String`	`FORMULA_PROCESSOR_RETAIN_ASSERTION_RESOURCES` The FORMULA_PROCESSOR_RETAIN_ASSERTION_RESOURCES property allows applications to access the internal resources that were used during the evaluation of an assertion.
`static java.lang.String`	`FORMULA_PROCESSOR_RETAIN_INPUT_INTANCE_ON_ASSERTION_RESULTS` The FORMULA_PROCESSOR_RETAIN_INPUT_INTANCE_ON_ASSERTION_RESULTS property is used to configure the formula processor in order to allow XBRLAssertionResult instances to keep a reference of the original input instance.
`static java.lang.String`	`FORMULA_PROCESSOR_RETAIN_USED_FACTS` The FORMULA_PROCESSOR_RETAIN_USED_FACTS property sets the processor to record all facts from fact variables that binds to a particular formula during assertion evaluation.
`static java.lang.String`	`FORMULA_PROCESSOR_SCHEMA_VALIDATE_EXTERNAL_DOCS` All documents in the DTS must be schema valid.
`static java.lang.String`	`FORMULA_PROCESSOR_USE_GLOBAL_PARAMETERS` The original version of the variables specification (The already approved recommendation) considers that parameters must have arcs connecting the parameter with the variable set using it.
`static java.lang.String`	`FORMULA_PROCESSOR_USE_STRICT_SPECIFICATION_XPATH` The FORMULA_PROCESSOR_USE_STRICT_SPECIFICATION_XPATH property sets the processor to use the XPath expressions defined for filters in the formula specification as they are written in the specifications document.
`static int`	`FULL` FULL is a constant for the `mode` parameter in the `isInstanceOfThisDTS(Source, int)` function.
`static java.lang.String`	`FUNCTIONS_CREATE_PHANTOM_RELATIONSHIPS_WHEN_NEEDED_TO_MAKE_FILTER_MEMBER_NETWORK_SELECTION_TO_WORK_UNDER_CERTAIN_PROJECTS` The xfi:filter-member-network-selection function may have two operation modes: mode 1, the filter only considers existing relationships in linkbases.
`static java.lang.String`	`FUNCTIONS_USE_TARGETROLE_IN_XFI_FILTER_MEMBER_NETWORK_SELECTION` The xfi:filter-member-network-selection function does not specify if the `targetrole` attribute value shall be used when exploring dimensions or not, in fact: The conformance suite is unclear and does not contains any test case around this characteristic.
`static int`	`GENERATION_MODE_NODEINFO` ORIGINAL serialization method means that the serialization of this object will be made using the document that was first read from source file.
`static int`	`GENERATION_MODE_OBJECTS` GENERATION_MODE_OBJECTS serialization method means that the serialization of this object will be made using the object model and objects in the infoset.
`static java.lang.String`	`GENERIC_LABEL_VERSION` GENERIC_LABEL_VERSION is defined as "http://www.reportingstandard.com/properties/generic-linkbase/label-version" Possible values of this property are USE_GENERIC_LABEL_AS_OF_22_JUNE_2009 or USE_GENERIC_LABEL_AS_OF_CURRENT_EXPERIMENTAL.
`static java.lang.String`	`GENERIC_LINKBASE_REQUIRE_ROLEREF_ARCROLEREF` GENERIC_LINKBASE_REQUIRE_ROLEREF_ARCROLEREF is defined as "http://www.reportingstandard.com/properties/generic-linkbase/require-roleRef-arcroleRef" Possible value is a String that can be converted into a boolean "true" or "false" Default value is "true" if the PROCESSORS_SEQUENCE property contains the formula processor and "false" otherwise.
`static java.lang.String`	`GENERIC_REFERENCE_VERSION` GENERIC_REFERENCE_VERSION is defined as "http://www.reportingstandard.com/properties/generic-linkbase/reference-version" Possible values of this property are USE_GENERIC_REFERENCE_AS_OF_22_JUNE_2009 or USE_GENERIC_REFERENCE_AS_OF_CURRENT_EXPERIMENTAL.
`static java.lang.String`	`IGNORE_PROPERTY_VALUE` This is set to the constant value "ignore".
`static java.lang.String`	`IXBRL_DEDUPLICATE_FACTS_AFTER_LOAD` The IXBRL_DEDUPLICATE_FACTS_AFTER_LOAD property sets the processor to deduplicate facts after loading an instance document.
`static java.lang.String`	`IXBRL_DOCTYPE_VALIDATION` The IXBRL_DOCTYPE_VALIDATION property sets the processor to raise an error, a warning or ignore the existence of <!
`static java.lang.String`	`IXBRL_V10` This is one possible value for the IXBRL_VERSION property key.
`static java.lang.String`	`IXBRL_V11` This is one possible value for the IXBRL_VERSION property key.
`static java.lang.String`	`IXBRL_VERSION` The IXBRL_VERSION property sets the version of the IXBRL processor to use along with this DTSContainer.
`org.apache.log4j.Logger`	`log` All log information goes through this logger.
`static java.lang.String`	`LOG_LEVEL` The log level that will be set to the standard logger at com.ihr.xbrl The value must be a valid string representation of the level as indicated in the log4j logging package.
`static java.lang.String`	`LOGGER_NAME` LOGGER_NAME is defined as com.ihr.xbrl and is final
`static java.lang.String`	`PARALLEL_PROCESSING` The PARALLEL_PROCESSING property enables all processors to execute validation in parallel.
`static java.lang.String`	`PARALLEL_PROCESSORS` The PARALLEL_PROCESSORS property indicates the maximum number of parallel threads that the platform will reserve for validation.
`static java.lang.String`	`PROCESSORS_SEQUENCE` The PROCESSORS_SEQUENCE property contains a comma separated list of processors responsible of performing DTS validation The default value for the PROCESSORS_SEQUENCE property is XBRLCoreProcessor.PROCESSORNAME which is "XBRL21Core" Note: In order to perform XBRL 2.1 validation and XBRL Dimensions 1.0 validation, the value of this property must be set to XBRLCoreProcessor.PROCESSORNAME,XDTProcessor.PROCESSORNAME this is: "XBRL21Core,XBRLDimensions" Processors extensibility: Creating your own processors for project specific validation rules Processor factories are loaded during the static initialization of the DTSContainer class.
`static java.lang.String`	`SEQUAL_MODE` The SEQUAL_MODE property indicates if the s-equal function follow the rules of the XBRL 2.1 specification or if it should follow the interpretation made by the authors of the XBRL formula specification.
`static java.lang.String`	`SERIALIZATION_OUTPUT_DEFAULT_ATTRIBUTE_VALUES` The SERIALIZATION_OUTPUT_DEFAULT_ATTRIBUTE_VALUES indicates if during the serialization phase (conversion from internal object model representation to the XBRL syntax) the default values for attributes will be explicitly serialized or will be hidden.
`static java.lang.String`	`SERIALIZATION_OUTPUT_INDENT` The SERIALIZATION_OUTPUT_INDENT property can be set to either "yes" or "no".
`static java.lang.String`	`SERIALIZATION_OUTPUT_INDENT_DEFAULT` The Constant SERIALIZATION_OUTPUT_INDENT_DEFAULT.
`static java.lang.String`	`SERIALIZATION_OUTPUT_OMIT_XML_DECLARATION` The SERIALIZATION_OUTPUT_OMIT_XML_DECLARATION cat be set to either "yes" or "no".
`static java.lang.String`	`SERIALIZATION_OUTPUT_OMIT_XML_DECLARATION_DEFAULT` The Constant SERIALIZATION_OUTPUT_OMIT_XML_DECLARATION_DEFAULT.
`static java.lang.String`	`SERIALIZATION_OUTPUT_XML_ENCODING` The SERIALIZATION_OUTPUT_XML_ENCODING property can be set to the encoding for XML files produced by the API.
`static java.lang.String`	`SERIALIZATION_OUTPUT_XML_ENCODING_DEFAULT` The Constant SERIALIZATION_OUTPUT_XML_ENCODING_DEFAULT.
`static java.lang.String`	`USE_CACHE_PROPERTY` USE_CACHE_PROPERTY is defined as "http://www.reportingstandard.com/properties/use-cache" Possible values are String that can be converted to a boolean "true" or "false" Default value is "true" Cache is read form the catalog file XBRLCatalog.xml There may be catalog files at the folder where the tool is initiated, or in the user's home directory or both.
`static java.lang.String`	`USE_GENERIC_LABEL_AS_OF_22_JUNE_2009` USE_GENERIC_LABEL_AS_OF_22_JUNE_2009 is defined as GENERIC_LABEL_22_JUN_2009.
`static java.lang.String`	`USE_GENERIC_LABEL_CURRENT_EXPERIMENTAL` USE_GENERIC_LABEL_AS_OF_CURRENT_EXPERIMENTAL is defined as GENERIC_LABEL_CURRENT_EXPERIMENTAL.
`static java.lang.String`	`USE_GENERIC_REFERENCE_AS_OF_22_JUNE_2009` USE_GENERIC_REFERENCE_AS_OF_22_JUNE_2009 is defined as GENERIC_REFERENCE_22_JUN_2009.
`static java.lang.String`	`USE_GENERIC_REFERENCE_CURRENT_EXPERIMENTAL` USE_GENERIC_REFERENCE_AS_OF_CURRENT_EXPERIMENTAL is defined as GENERIC_REFERENCE_CURRENT_EXPERIMENTAL.
`static java.lang.String`	`USE_SEQUAL_AS_FORMULA_COMPLIANT` USE_SEQUAL_AS_FORMULA_COMPLIANT is defined as FORMULA_COMPLIANT.
`static java.lang.String`	`USE_SEQUAL_AS_XBRL_COMPLIANT` USE_SEQUAL_AS_XBRL_COMPLIANT is defined as XBRL_COMPLIANT.
`static java.lang.String`	`USE_XDT_1_0_AS_OF_18_SEP_2006` USE_XDT_1_0_AS_OF_18_SEP_2006 is defined as XDT_18_SEP_2006.
`static java.lang.String`	`USE_XDT_1_0_AS_OF_25_JAN_2012` USE_XDT_1_0_AS_OF_25_JAN_2012 is defined as XDT_25_JAN_2012.
`static java.lang.String`	`USE_XDT_1_0_AS_OF_7_SEP_2009` USE_XDT_1_0_AS_OF_7_SEP_2009 is defined as XDT_7_SEP_2009.
`static java.lang.String`	`USE_XEQUAL_AS_FORMULA_COMPLIANT` USE_XEQUAL_AS_FORMULA_COMPLIANT is defined as FORMULA_COMPLIANT.
`static java.lang.String`	`USE_XEQUAL_AS_XBRL_COMPLIANT` USE_XEQUAL_AS_XBRL_COMPLIANT is defined as XBRL_COMPLIANT.
`static java.lang.String`	`UTR_REPORT_AS_INCONSISTENCY` If this property controls how the UTR processor notifies the facts that does not satisfy the UTR rules.
`static java.lang.String`	`WARNING_PROPERTY_VALUE` This is set to the constant value "warning".
`static java.lang.String`	`XBRL_BASE` The XBRL_BASE property indicates the directory that will be used as base for resolution of files that during the DTS Discovery process.
`static java.lang.String`	`XBRL_VERSION` The XBRL_VERSION property indicates the version of the XBRL specification to be used when multiple editions of the XBRL 2.1 specification causes different behavior of the XBRL processor.
`static java.lang.String`	`XBRL_VERSION_2_JUL_2008` Default value for the XBRL Processor in production.
`static java.lang.String`	`XBRL_VERSION_20_FEB_2013` This configures the processor to use the specification version released on February 20 of 2013.
`static java.lang.String`	`XBRL_VERSION_25_JAN_2012` This configures the processor to use the specification version released on January 25 of 2012.
`static java.lang.String`	`XBRL_VERSION_EXPERIMENTAL_BUG_368` Experimental value of the XBRL Processor according to the BUG 368.
`static java.lang.String`	`XDT_VERSION` The XDT_VERSION property indicates the version of the Dimensions Specification to be used.
`static java.lang.String`	`XEQUAL_MODE` The XEQUAL_MODE property indicates if the x-equal function follow the rules of the XBRL 2.1 specification or if it should follow the interpretation made by the authors of the XBRL formula specification.
`static java.lang.String`	`XML_REMOVE_NAMESPACE_DECLARATIONS` The XML_REMOVE_NAMESPACE_DECLARATIONS property indicates if the toString method in the XMLFragment generates a string with namespace declarations or without namespace declarations.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`addArcroleType(XBRLArcroleType arcrole)` Register a new arcroleType declaration.
`void`	`addChangeIdListener(net.sf.saxon.om.DocumentInfo physicalRoot, java.beans.PropertyChangeListener changeIdListener)` Adds the change id listener.
`boolean`	`addChild(java.lang.Integer documentCode, java.lang.Integer childToAdd)` Stores a child document to another document
`void`	`addDocumentToDTS(XBRLDTSDocument d)` Adds a document to the DTS container objects.
`void`	`addError(java.lang.Exception e)` Adds the error.
`void`	`addInconsistencey(XBRLInconsistency e)` Deprecated. Since version 3.2.0 the addInconsistency(XBRLInconsistency) method shall be used instead
`void`	`addInconsistency(XBRLInconsistency e)` Adds the inconsistency.
`void`	`addNodeToBatch(XMLFragment parent, XMLFragment newNode)` Adds the node to batch.
`boolean`	`addParent(java.lang.Integer documentCode, java.lang.Integer parentToAdd)` Stores a parent document to another document
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Add a PropertyChangeListener to the listener list.
`void`	`addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)` Add a PropertyChangeListener for a specific property.
`int`	`addResource(XBRLResource resource)` The XBRLResouce initializer calls this method to store a new resource in the DTSContainer cache.
`java.lang.Integer`	`addRoleType(XBRLRoleType role)` Register a new roleType declaration.
`void`	`addRoleTypeForExtendedLink(javax.xml.namespace.QName linkbaseType, java.lang.Integer role)` Adds or increases the count of role types for a linkbase type.
`void`	`addRoleTypeForExtendedLink(javax.xml.namespace.QName linkbaseType, XBRLRoleType role)` Adds or increases the count of role types for a linkbase type.
`void`	`addSourceToCacheByNamespace(java.lang.String targetNamespace, javax.xml.transform.Source s1)` Adds the source to cache by namespace.
`void`	`addValidationException(XBRLValidationException e)` Adds the validation exception.
`<T> T`	`banEvents(java.util.concurrent.Callable<T> exec, java.lang.String... events)` This method will ban events to be fired.
`boolean`	`cacheContains(java.lang.Integer documentURI)` Interrogates objects in the cache of documents indexed by documentURI returns true if the documentURI is on the cache The document URI is normalized and absolutized before the index search operation fragments are removed because the cache contains documents.
`XMLDocumentURI`	`cacheGet(java.lang.Integer documentURI)` Obtains a document from the cache indexed by document URI The URI is absolutized and normalized before comparison.
`XMLDocumentURI`	`cacheGet(java.net.URI documentURI)` Obtains a document from the cache using the document URI.
`void`	`cachePut(XMLDocumentURI documentURI)` Stores a document in the cache indexed by document URI The URI is absolutized and normalized before stored being stored.
`void`	`cacheRemove(java.lang.Integer documentURI)` Removes a document form the cache.
`XBRLResource`	`cacheResource(XBRLExtendedLink parent, net.sf.saxon.om.NodeInfo ni, java.lang.Class<? extends XBRLResource> name)` Obtains a resource from the cache or creates a new resource corresponding to the node supplied as a parameter and stores it in the cache for further reference.
`java.util.Iterator<XBRLTaxonomy>`	`cacheSchemaByNamespace(java.lang.String namespace)` Obtains a series of XBRLTaxonomy objects from the cache based on the namespace declared in the XBRLTaxonomy schema Results are not in any specific ordered Returns the empty sequence if the namespace is not found in the DTS.
`int`	`cacheSize()` Returns the number of files in the cache.
`void`	`clear()` Similarly to the clear method in collections, this method frees up memory and resources used in this object.
`void`	`clearEqualsCaches()` Clear equals caches.
`void`	`collectTopLevelSchemaUsage(java.net.URI sourceDocumentURI, java.lang.String namespace, java.net.URI targetDocumentURI, boolean bMode)` Collect top level schema usage.
`void`	`commitBatch(XMLFragment parent)` Commit batch.
`static void`	`configureJavaProxy(java.util.Properties props)` Configures java virtual machine proxy according with the properties received.
`void`	`delArcroleType(XBRLArcroleType arcrole)` Unregister a loaded arcroleType declaration.
`void`	`delayEvents(java.lang.Runnable runnable, java.lang.String... events)` This method will store locally all events of the type indicated in the array string so they will not be fired but just catch by the API.
`void`	`delConcept(javax.xml.namespace.QName concept)` Removes a concept form the DTS and removes also all relationships this concept participates on.
`void`	`delDocumentFromDTS(XBRLDTSDocument d)` Del document from dts.
`boolean`	`delResource(XBRLResource resource, java.lang.Integer elCode)` Eliminates a resource form the DTS cache.
`void`	`delRoleType(XBRLRoleType role)` Unregister a registered roleType.
`void`	`delRoleTypeForExtendedLink(javax.xml.namespace.QName linkbaseType, java.lang.Integer role)` Removes or decreases the count of role types for a linkbase type.
`void`	`delRoleTypeForExtendedLink(javax.xml.namespace.QName linkbaseType, XBRLRoleType role)` Removes or decreases the count of role types for a linkbase type.
`void`	`doCallInstallDTSURIResolver(HasCreateDTSUriResolver instanceClass)` Executes a call to the method createAndRegisterDTSUriResolver on the class passed in as a parameter.
`void`	`doCallInstallFormulaParameterResolver(HasCreateFormulaParameterResolver instanceClass)` Do call install formula parameter resolver.
`boolean`	`equals(java.lang.Object obj)` Equals.
`void`	`fireChangeIdEvent(XMLFragment xmlFragment, java.lang.String oldId, java.lang.String id)` Fire change id event.
`void`	`firePropertyChangeEvent(java.lang.Object source, java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)` Convenient method to fire a property change event.
`void`	`firePropertyChangeEvent(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)` Convenient method to fire a property change event.
`java.lang.Integer`	`getArcroleCode(java.lang.String arcroleURI)` Gets the arc role `code` (an Integer) from the `arcroleURI` (an String) If there is no code already defined for the given `arcroleURI` a new code is created.
`XBRLArcroleType`	`getArcroleType(java.lang.Integer arcroleType)` Let's store all arcroletypes and assign an index to them.
`java.util.List<XBRLArcroleType>`	`getArcroleType(java.lang.String uri)` Access to the arcroleType object from the URI regardless where it is defined or if there are multiple valid definitions of the same arcrole URI.
`java.util.Iterator<XBRLArcroleType>`	`getArcroleTypes()` Access to an iterator over defined XBRL Arcrole Types defined on all taxonomies in the loaded DTS.
`AtomicComparerHelper`	`getAtomicComparator()` Gets the atomic comparator.
`XMLAttributesInDTS`	`getAttributesDatabase()` Gets the attributes database.
`DTSBase`	`getBase(javax.xml.namespace.QName linkbaseType, java.lang.Integer role)` Obtains a base for the specified linkbaseType and role type.
`DTSBase`	`getBase(javax.xml.namespace.QName linkbaseType, XBRLRoleType role)` Obtains a base for the specified linkbaseType and role type.
`java.util.Iterator<java.lang.Integer>`	`getBaseRoleCodes(javax.xml.namespace.QName extendedLinkQName)` Same as `getBaseRoleTypes(QName)` but returns an iterator over integers that are unique codes for the role types which might be faster to process on some occassions.
`java.util.Iterator<XBRLRoleType>`	`getBaseRoles(javax.xml.namespace.QName linkbaseType)` Iterator over all roles used on xlink:role attributes on extended links Iterator elements can be casted to XBRLRoleType objects.
`java.util.Iterator<XBRLRoleType>`	`getBaseRoleTypes(javax.xml.namespace.QName extendedLinkQName)` Return an iterator over all XBRLRoleType elements where DTSBase exists.
`java.util.Iterator<javax.xml.namespace.QName>`	`getBaseTypes()` Returns an iterator over the QNames of all DTSBases in the DTS this is all types of containers of relationships.
`java.net.URI`	`getBaseURI()` Access to the base URI for the XBRL processor.
`XMLDocumentURI`	`getCacheElement(int index)` Returns the nth element in the cache.
`java.util.Set<java.lang.Integer>`	`getChildren(java.lang.Integer documentCode)` Returns a set of document children.
`int`	`getChildrenCount(java.lang.Integer documentCode)` Returns the number of children of a document.
`XBRLDTSDocument`	`getCodeDocument(java.lang.Integer code)` Access to a document by the document key.
`java.net.URI`	`getCodeURI(java.lang.Integer code)` Returns the URI stored for the code passed as parameter the special value -1 returns the empty URI.
`static net.sf.saxon.s9api.Processor`	`getCompatibleProcessor(net.sf.saxon.s9api.Processor compatWith, boolean schemaAware)` Gets the compatible processor.
`XMLElementDefinition`	`getConcept(javax.xml.namespace.QName concept)` Returns a concept declaration in the DTS regardless it is a tuple, item or pure element returns null if the concept is not defined in the DTS or if the value of the QName for the concept parameter is null.
`java.util.Iterator<XMLElementDefinition>`	`getConcepts()` Iterator over all XBRL Concept declarations (Items and Tuples) in the DTS (crosses all taxonomies).
`net.sf.saxon.s9api.Processor`	`getConfiguration()` Obtains the Saxonica Processor object used by all elements in this DTS.
`java.util.Collection<XBRLLibraryFactory>`	`getCustomFunctionFactories()` Access to the collection of all registered Library Factories.
`javax.xml.transform.URIResolver`	`getDTSURIResolver()` Access to the URIResolver of this DTSContainer.
`<T extends HasEqualsCache> EqualsCache<T>`	`getEqualsCache(java.lang.Class<T> clazz)` Gets the equals cache.
`java.lang.String[]`	`getErrors()` Gets the errors.
`java.util.Iterator<java.lang.Integer>`	`getExtendedLinkCodes()` Returns an iterator over all extended link codes in the DTS.
`java.lang.Iterable<XBRLExtendedLink>`	`getExtendedLinks()` Gets the extended links.
`FactsListClassifier`	`getFactsListClassifier(XBRLFactsList instance, int aspectsToCover)` Obtains an instance for the FactsListClassifier and stores it on an internal cache for further fast reference.
`net.sf.saxon.s9api.Processor`	`getFastConfiguration()` Method to access to the Processor corresponding to this DTSContainer and the status of this DTSContainer.
`java.lang.String[]`	`getInformationAboutEntryPoint()` Generates information about the entry point used to load the DTS.
`XBRLInstance`	`getInstanceByURI(java.lang.Integer u)` Returns an XBRLInstance that has been loaded into the document cache using the document URI.
`java.util.Iterator<java.net.URI>`	`getInstanceURIs()` Returns an iterator over URIs of loaded instances in the document cache.
`java.util.Iterator<XBRLItem>`	`getItemDeclarations()` Iterator over all Item concepts declarations in the DTS (crosses all taxonomies).
`java.util.Map<java.lang.String,java.lang.String>`	`getIXBRLPackagePublishersByLang()` This method returns the map of publishers in the taxonomy package to be used later in the ESEF 3.1.5 validation rule.
`KeyElementsInterceptorHelper`	`getKeyElementsInterceptorHelper()` Gets the key elements interceptor helper.
`java.util.Iterator<java.lang.String>`	`getLanguages()` Returns an iterator over all languages used in labels in the DTS.
`java.lang.String`	`getLastResolvedSystemId()` Returns the systemId of the last file resolved by the Resolver during the DTSDiscovery process or null if the DTSDiscoveryProcess is not on-going.
`XBRLLinkbase`	`getLinkbaseByCode(java.lang.Integer code)` Returns the XBRLLinkbase corresponding with the code or null if the code does not corresponds with a linkbase.
`XBRLLinkbase`	`getLinkbaseByURI(java.lang.Integer u)` Returns the XBRLLinkbase corresponding to the Document URI or null if the URI cannot be found or does not corresponds to a linkbase.
`XBRLLinkbase`	`getLinkbaseByURI(java.net.URI u)` Returns the XBRLLinkbase corresponding to the Document URI or null if the URI cannot be found or does not corresponds to a linkbase.
`java.util.Iterator<java.lang.Integer>`	`getLinkbaseCodes()` Returns an iterator over all linkbase codes in the DTS.
`java.util.Iterator<XBRLLinkbase>`	`getLinkbases()` Returns an iterator over all linkbase documents in the DTS.
`java.util.Iterator<java.net.URI>`	`getLinkbaseURIs()` Returns an iterator over all linkbase documents in the DTS.
`XBRLlrrAndRelationshipConstraints`	`getLRRAndRelationshipsConstraintsChecker()` Obtains an instance of the XBRLlrrAndRelationshipConstraints class that is unique for the entire DTSContainer live cycle.
`java.lang.String`	`getName()` Returns back the DTS name, this is useful for GUIs only.
`static DTSContainer.ProcessorAndSchemaCompiler`	`getNewConfiguration(boolean schemaAware, DTSContainer dts, java.util.Properties props)` Creates a new Configuration object.
`java.lang.Integer`	`getNewURICode(java.net.URI uri)` Stores a new URI to the cache and returns the assigned code.
`int`	`getNextDocumentKeyCode()` Provides a new document code but does not store the document into the DTSContainer yet.
`java.util.Set<java.net.URI>`	`getNoNormalURIs()` Obtains URIs that has been normalized during the DTS loading process.
`int`	`getNumberOfInstanceURIs()` Returns the number of XBRL Instances in the DTS.
`int`	`getNumberOfItemDeclarations()` Gets the number of item declarations.
`int`	`getNumberOfLinkbaseURIs()` Returns the number of linkbase URIs in the DTS.
`int`	`getNumberOfProcessorsInSequence()` Returns the number of processors added to the PROCESSORS_SEQUENCE property.
`int`	`getNumberOfTaxonomyURIs()` Returns the number of taxonomy URIs in the DTS.
`int`	`getNumberOfTupleDeclarations()` Gets the number of tuple declarations.
`<T extends XBRLPlugInProcessor> T`	`getOrCreateProcessor(java.lang.String processorName)` This method tries to obtain the instance of the processor already registered if it is not there, this method checks if the processor indicated in the processorName parameter is in the PROCESSORS_SEQUENCE, if it is there a new processor instance is created.
`java.util.Set<java.lang.Integer>`	`getParents(java.lang.Integer documentCode)` Returns a set of document parents.
`int`	`getParentsCount(java.lang.Integer documentCode)` Returns the number of parents of a document.
`<T extends XBRLPlugInProcessor> T`	`getProcessor(java.lang.String processorname)` Returns an already registered plug-in processor based on the processor name.
`static java.lang.Class<? extends XBRLProcessorFactory>`	`getProcessorFactory(java.lang.String processorName)` Accesss to the processor factory class for the processor name.
`java.util.Iterator<XBRLPlugInProcessor>`	`getProcessors()` Access to all registered plug-in processors.
`java.util.Properties`	`getProperties()` Access to the properties of this DTSContainer.
`java.beans.PropertyChangeListener[]`	`getPropertyChangeListeners()` Returns an array of all the listeners that were added to the PropertyChangeSupport object with addPropertyChangeListener().
`java.beans.PropertyChangeListener[]`	`getPropertyChangeListeners(java.lang.String propertyName)` Returns an array of all the listeners which have been associated with the named property.
`DTSLoadingBarInterface`	`getRegisteredBar()` If this DTSContainer has a registered object that implements the DTSLoadingBarInterface interface this function returns it.
`static java.lang.String[]`	`getRegisteredProcessorNames()` Access to all registered processor names.
`XBRLRelationship`	`getRelationship(java.lang.String extendedLink, javax.xml.namespace.QName relationshipType, java.lang.String arcrole, java.util.List<XBRLAttribute> attributes, XMLFragment source, XMLFragment target)` Returns the relationship that matches the search criteria.
`java.util.Iterator<XBRLRelationship>`	`getRelationships(DTSBase base)` Return all relationships in a DTSBase.
`java.lang.String`	`getRelativeURI(java.lang.String documentURIAsString)` Obtains a relative URI from the documentURI using the URI passed in in the `load(URI)` call as the base URI When the `load(URI[])` method was used with an array of URIs the common part of those URIs is used as the base URI.
`java.net.URI`	`getRelativeURI(java.net.URI documentURI)` Obtains a relative URI from the documentURI using the URI passed in in the `load(URI)` call as the base URI When the `load(URI[])` method was used with an array of URIs the common part of those URIs is used as the base URI.
`java.util.Iterator<javax.xml.transform.Source>`	`getResolvedSourcesByNamespace(java.lang.String targetNamespace)` Gets the resolved sources by namespace.
`XBRLResource`	`getResource(java.lang.Integer code)` Gets the resource.
`XMLFragment`	`getResource(java.lang.String resourceRole, javax.xml.namespace.QName resourceType, java.lang.String content, java.util.List<XBRLAttribute> attributes, net.sf.saxon.om.AbstractItem value, java.util.List<java.lang.String> xpathChildren)` Search for a resource in the DTS with the given id.
`XBRLResource`	`getResource(java.net.URI xpointerIdentifier)` Resolves an XBRLResource from its XPointer identifier.
`java.util.Iterator<XBRLResource>`	`getResources()` Make sure the DTS has beed validated or the list of resources may not be complete.
`java.lang.Integer`	`getRoleCode(java.lang.String roleURI)` Gets the role `code` (an Integer) from the `roleURI` (an String) If there is no code already defined for the given `roleURI` a new code is created.
`XBRLRoleType`	`getRoleType(java.lang.Integer roleType)` Obtains the `XBRLRoleType` associated to the given `roleType` code (an Integer) If no role type was registered for the given code null is returned.
`java.util.List<XBRLRoleType>`	`getRoleType(java.lang.String uri)` Access to the roleType object from the URI regardless where it is defined or if there are multiple valid definitions of the same role URI.
`java.util.Iterator<XBRLRoleType>`	`getRoleTypes()` Access to an iterator over defined XBRL Role Types defined on all taxonomies in the loaded DTS.
`java.net.URI`	`getRootURI()` Returns the DTS root URI or the starting point of the DTS Discovery.
`java.net.URI[]`	`getRootURIs()` Returns an array of URIs that contains the DTS Discovery starting points.
`com.saxonica.ee.schema.SchemaCompiler`	`getSchemaCompiler()` Returns the current schema compiler for this configuration object.
`int`	`getSerializationMethod()` Obtains the value of the serialization method.
`<T extends XBRLResource> T`	`getSimilarResource(T res, XBRLExtendedLink el)` This method returns an XBRLResource that already exists in the Extended Link indicated at `el` and is s_equals2 of `res` resource or null if no resource is found.
`XBRLArcroleType`	`getStaticArcroleTypeByURI(java.lang.String arcrole)` Gets the static arcrole type by uri.
`static DTSContainer`	`getStaticContainer()` The static container exist only for static objects like standard roleTypes and standard arcroleTypes that are not used on any specific DTS.
`XBRLRoleType`	`getStaticRoleTypeByURI(java.lang.String role)` Gets the static role type by uri.
`DTSContainer.Status`	`getStatus()` Access to the processor status.
`StringCache`	`getStringCache()` Gets the string cache.
`java.util.Iterator<XBRLTaxonomy>`	`getTaxonomies()` Returns an iterator over all taxonomy documents in the DTS.
`XBRLTaxonomy`	`getTaxonomyByCode(java.lang.Integer code)` Returns the XBRLTaxonomy corresponding with the code or null if the code does not corresponds with a taxonomy.
`java.util.Iterator<XBRLTaxonomy>`	`getTaxonomyByNamespace(java.lang.String namespace)` Returns an iterator over all taxonomy schemas that matches the corresponding namespace and are loaded into the DTS or has been loaded to validate elements even it is not loaded in the DTS.
`java.util.Iterator<XBRLTaxonomy>`	`getTaxonomyByNamespaceInDts(java.lang.String namespace)` Returns an iterator over all taxonomy schemas that matches the corresponding namespace and are loaded into the DTS.
`java.util.Iterator<XBRLTaxonomy>`	`getTaxonomyByPrefix(java.lang.String conceptPrefix)` Returns an iterator over all taxonomy schemas whose target namespace matches the prefix.
`XBRLTaxonomy`	`getTaxonomyByURI(java.lang.Integer u)` Returns the XBRLTaxonomy corresponding to the Document URI or null if the URI cannot be found or does not corresponds to a taxonomy.
`XBRLTaxonomy`	`getTaxonomyByURI(java.net.URI u)` Returns the XBRLTaxonomy corresponding to the Document URI or null if the URI cannot be found or does not corresponds to a taxonomy.
`java.util.Iterator<java.lang.Integer>`	`getTaxonomyCodes()` Returns an iterator over all taxonomy codes in the DTS.
`java.util.Iterator<java.net.URI>`	`getTaxonomyURIs()` Returns an iterator over all taxonomy documents in the DTS.
`static java.net.URI`	`getTempURL()` Returns a URL pointin to a temporary folder in the local drive.
`java.util.Iterator<XBRLTuple>`	`getTupleDeclarations()` Iterator over all Tuple concept declarations in the DTS (crosses all taxonomies).
`XBRLXSDTypeDefinition`	`getTypeDefinition(javax.xml.namespace.QName type)` Find the type definition for the specific QName This function does not find new types defined in taxonomy schemas that has not been read from XML files.
`XBRLInstance`	`getUnderEvaluationInstance()` Gets the instance document that is under evaluation.
`java.lang.Integer`	`getURICode(java.net.URI uri)` Returns a URI code for a URI that is already stored if the URI was not stored this method returns null and the uri is not stored.
`XBRLValidationReport`	`getValidationReport()` Access to the internal validation report.
`java.util.Properties`	`getVariablesForProcessors()` Access to the variables that has been set to be available for processors.
`int`	`getWhatToValidate()` Gets the what to validate.
`XBRLExtendedLink`	`getXBRLExtendedLink(java.lang.Integer code)` Obtains an extended link from the extended link code.
`int`	`hashCode()` Hash code.
`void`	`informPossibleNamespaceGhist(java.lang.String uri)` Detected during SAX parsing.
`void`	`installDTSURIResolver(javax.xml.transform.URIResolver resolver)` Sets a new resolver to this DTSContainer object.
`void`	`installFormulaParameterResolver(XBRLFormulaParametersResolver parameterResolver)` Sets a new resolver to this XBRLFormulaParametersResolver object.
`boolean`	`isArcroleTypeUsed(java.lang.String arcroleType)` Helper method to ask the DTS if a certain arc role type is used.
`boolean`	`isAssertionSeverityLoadedInDTS()` Returns true if the assertionSeverity schema has been loaded into the DTS.
`boolean`	`isBaseDefined(javax.xml.namespace.QName linkbaseType, java.lang.Integer role)` Returns true if there is a DTSbase defined in the DTS for the given role and of the specified linkbaseType.
`boolean`	`isBaseDefined(javax.xml.namespace.QName linkbaseType, XBRLRoleType role)` Returns true if there is a DTSbase defined in the DTS for the given role and of the specified linkbaseType.
`boolean`	`isBUG368Mode()` Returns true if the user has set the property XBRL_VERSION to the value XBRL_VERSION_EXPERIMENTAL_BUG_368.
`boolean`	`isDocumentInDTS(java.lang.Integer key)` Returns true if the document is in the DTS.
`boolean`	`isDocumentInDTS(java.net.URI documentURI)` Returns true if a document pointed to by the documentURI parameter is in the DTS.
`boolean`	`isDocumentInDTSAndProcess(XBRLDTSDocument d)` If the document is alreay part of the DTS this method returns true.
`boolean`	`isDocumentKeyInDTS(java.lang.Integer docCode)` Returns true of the document key is part of the DTS.
`boolean`	`isExtendedLink(java.lang.Integer docCode)` Returns true if the value of `docCode` corresponds with an extended link in the DTS.
`boolean`	`isFailFast()` Helper method to quickly check if this DTSContainer is set to `FAIL_FAST` under the `FAIL_STRATEGY` property
`boolean`	`isGeneralVariableSchemaAware()` This method returns the value of the property FORMULA_PROCESSOR_GENERAL_VARIABLE_SCHEMA_AWARE See `FORMULA_PROCESSOR_GENERAL_VARIABLE_SCHEMA_AWARE` for more information.
`XBRLInstance`	`isInstanceOfThisDTS(MultiDTSValidationFile item, int mode)` Check whether or not the document in the xmlSource is an instance document according to this DTS.
`XBRLInstance`	`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.
`XBRLInstance`	`isInstanceOfThisDTS(XBRLInstance instance, int mode)` Check whether or not the instance document received as a parameter can be used in this DTSContainer.
`boolean`	`isIXBRLDocumentSet()` Checks if is IXBRL document set.
`boolean`	`isLinkbase(java.lang.Integer docCode)` Returns true if the value of `docCode` corresponds with a linkbase in the DTS.
`boolean`	`isLocalResourceInIXBRLDocumentSet(java.nio.file.Path src)` Checks if is local resource in IXBRL document set.
`boolean`	`isProcessorInProcessorsSequence(java.lang.String processorName)` Returns true if the processor indicated in the `processorName` parameter is in referenced in the PROCESSORS_SEQUENCE property.
`boolean`	`isProperty(java.lang.String property)` Helper method to check the value of a DTSContainer property and return a boolean value representing the boolean value property.
`boolean`	`isRoleTypeUsed(java.lang.String roleType)` Helper method to ask the DTS if a certain role type is used.
`boolean`	`isShowExactitudeDetails()` Returns true if the DTSContainer.DTS_SHOW_EXACTITUDE_DETAILS property is set to true
`static boolean`	`isStandardArcrole(java.lang.String arcrole)` Detects if an arcrole is defined in the XBRL 2.1 specification or not Note, this method does not registers the arcrole uri within the loaded DTSContainer
`static boolean`	`isStandardExtendedLink(javax.xml.namespace.QName extendedLinkNodeName)` Detects if an extended link is defined in the XBRL 2.1 specification
`static boolean`	`isStandardRole(java.lang.String role)` Detects if a role is defined in the XBRL 2.1 specification or not Note, this method does not registers the role uri within the loaded DTSContainer
`boolean`	`isTaxonomy(java.lang.Integer docCode)` Returns true if the value of `docCode` corresponds with a taxonomy in the DTS.
`boolean`	`isTaxonomyLoadedByNamespace(java.lang.String namespace)` Fast implementation of a mechanism to check if a taxonomy schema has been loaded using the schema namespace.
`boolean`	`isThin()` Helper method to know if this DTS has the DTS_THIN property set to true or false.
`boolean`	`isVersion20122501()` Checks if is version20122501.
`boolean`	`isVersion20132002()` Checks if is version20132002.
`XBRLDocument`	`load(javax.xml.transform.Source source)` Load a DTS.
`XBRLDocument[]`	`load(javax.xml.transform.Source[] ss)` Load a DTS from a set of urls.
`XBRLDocument`	`load(java.net.URI url)` Loads a DTS from the indicated `url`.
`XBRLDocument[]`	`load(java.net.URI[] url)` Loads a DTS from the `url` array.
`void`	`loadExtraSchemas()` Called internally by the API when extra schemas must be loaded in the configuration object and schema compiler.
`void`	`loadIntoConfiguration()` Switch the configuration object to strict schema validation, then loads all documents in this DTS (thus in the cache) into the configuration object.
`void`	`loadIntoConfiguration(XBRLTaxonomy taxonomy)` Load a new schema into the schema compiler.
`XMLFragment`	`makeXMLFragment(net.sf.saxon.om.NodeInfo parent, net.sf.saxon.om.NodeName nameCode, net.sf.saxon.type.SchemaType elementType, boolean isNilled, net.sf.saxon.tree.util.AttributeCollectionImpl attlist, net.sf.saxon.event.PipelineConfiguration pipe, int locationId)` This method is called during SAX parsing of an XML document and must return an instance of a class that will contain the NodeImpl.
`static DTSContainer`	`mergeDTSs(DTSContainer[] dtss)` Merges several DTSs into a single DTS.
`static DTSContainer`	`newCompatibleContainer(DTSContainer otherContainer, java.util.Properties props)` Creates a new DTSContainer that is compatible with the Processor suppied as a parameter.
`static DTSContainer`	`newCompatibleContainer(net.sf.saxon.s9api.Processor proc, java.util.Properties props)` Creates a new DTSContainer that is compatible with the Processor suppied as a parameter.
`static DTSContainer`	`newEmptyContainer()` Method used to create a new empty DTSContainer.
`static DTSContainer`	`newEmptyContainer(java.util.Properties props)` Method used to create a new empty DTSContainer.
`void`	`readInfoset()` Method used to populate the object model in all objects defined within this DTS.
`void`	`recompile()` Recompile schemas loaded into the schemaconfiguration.
`void`	`registerBar(DTSLoadingBarInterface bar)` Register bar.
`void`	`registerProcessor(java.lang.String processorname, XBRLPlugInProcessor processor)` Called by the processor to self register.
`static boolean`	`registerProcessorFactory(java.lang.String name, java.lang.Class<? extends XBRLProcessorFactory> clazz)` Register a new processor factory for the indicated processor name.
`java.util.Set<java.lang.Integer>`	`removeAllChildren(java.lang.Integer documentCode)` removes all children documents of documentCode.
`void`	`removeAllParent(java.lang.Integer documentCode)` removes all parent documents of documentCode.
`void`	`removeChangeIdListener(net.sf.saxon.om.DocumentInfo physicalRoot)` Removes the change id listener.
`boolean`	`removeChild(java.lang.Integer documentCode, java.lang.Integer childToRemove)` Removes a child document to another document.
`void`	`removeCodeDocument(java.lang.Integer code)` Removes a document from the document cache.
`boolean`	`removeParent(java.lang.Integer documentCode, java.lang.Integer parentToRemove)` Removes a parent document to another document.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Remove a PropertyChangeListener from the listener list.
`void`	`removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)` Remove a PropertyChangeListener for a specific property.
`void`	`removeSourceFromCacheByNamespace(java.lang.String targetNamespace)` Removes the source from cache by namespace.
`void`	`replaceDocument(java.lang.Integer code, XBRLDTSDocument newdocument)` Replaces a document already stored in the DTS by a new document version using the code passed in as parameter.
`void`	`replaceURICode(java.lang.Integer uriCode, java.net.URI newURI)` This method replaces an existing URI by a new URI but maintains the same uriCode.
`javax.xml.transform.Source`	`resolve(java.net.URI resolvedURI)` Resolve a URI against the base URI but considering first if this file is already part of the system registered files or if the file is in XML catalogs.
`XMLFragment`	`resolveXPointer(java.net.URI uriHref, XMLDocumentURI doc)` resolve the XPointer to the node pointed to and returns the XMLFragment it points to or null if none can be found.
`void`	`save()` Save all files in the DTS.
`boolean`	`sEqualMode()` The default value of the SEQUAL_MODE is XBRL_COMPLIANT but the conformance suite of the formula processor requires it to be set to FORMULA_COMPLIANT.
`XBRLDTSDocument`	`setDocumentCode(XBRLDTSDocument document)` Store (or replace) a document in the document cache.
`void`	`setName(java.lang.String name)` Sets the name of this DTS to the specified name.
`void`	`setProperties(java.util.Properties newProps)` Internal method using during class constructors to set the properties of this DTSContainer.
`void`	`setProperty(java.lang.String name, java.lang.String value)` Sets a DTSConfiguration property.
`void`	`setRootURI(java.net.URI newURI)` Sets the root uri.
`void`	`setSerializationMethod(int method)` Sets the serialization method to OBJECTS or ORIGINAL.
`XBRLInstance`	`setUnderEvaluationInstance(XBRLInstance valInstance)` Sets or clear the instance document that is under validation.
`void`	`setVariablesForProcessors(java.util.Properties variables)` Variables is a new machanism to pass information from an external application to a custom processor.
`void`	`setWhatToValidate(int newValue)` Sets the what to validate.
`boolean`	`shouldStop()` This function will be called by classes that knows what to do if the loading proces of a DTS has been cancelled by the user.
`static void`	`shutdown()` The shutdown method has been created to allow a web applications to gracefully stop all DTSContainer threads.
`java.lang.Object[]`	`specialValidation(SpecialValidationProcess process, int flags, java.lang.Object[] arguments)` Performs a special validation process that requires adquisition of internal locks that are only available inside the DTSContainer.
`void`	`stop()` Stop.
`XBRLValidationReport`	`validate()` Executes all registered validators indicated in the PROCESSORS_SEQUENCE property of this DTS and returns the XBRLValidationReport instance with the validation result.
`XBRLValidationReport`	`validate(XBRLDocument doc)` Validates a new document against this already loaded DTS.
`boolean`	`xEqualMode()` The default value of the XEQUAL_MODE is XBRL_COMPLIANT but the conformance suite of the formula processor requires it to be set to FORMULA_COMPLIANT.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USE_CACHE_PROPERTY
```
public static final java.lang.String USE_CACHE_PROPERTY
```
    USE_CACHE_PROPERTY is defined as "http://www.reportingstandard.com/properties/use-cache" Possible values are String that can be converted to a boolean "true" or "false" Default value is "true" Cache is read form the catalog file XBRLCatalog.xml There may be catalog files at the folder where the tool is initiated, or in the user's home directory or both.
    
    See Also:
    
    Constant Field Values
  - CONSIDER_DUPLICATES_AS_INCONSISTENCIES
```
public static final java.lang.String CONSIDER_DUPLICATES_AS_INCONSISTENCIES
```
    CONSIDER_DUPLICATES_AS_INCONSISTENCIES is defined as "http://www.reportingstandard.com/properties/duplicate-is-inconsistency" Possible value is a String that can be converted into a boolean "true" or "false" Default value is "false"
    According to the XBRL 2.1 specification duplicates must be ignored for calculation checking. Very often this is a problem in real projects that wanted to detect if the incoming instance is trying to avoid calculation checks by submitting duplicates in the instance. Setting this value to "true" generates an "inconsistency" warning in case a calculation rule has been skipped due to the existence of a duplicate fact in the instance document.
    
    Since:
    
    2.6.3
    
    See Also:
    
    Constant Field Values
  - CONSIDER_COMPARISON_WITH_NUMBER_WITH_PRECISION_ZERO_AS_INCONSISTENCY
```
public static final java.lang.String CONSIDER_COMPARISON_WITH_NUMBER_WITH_PRECISION_ZERO_AS_INCONSISTENCY
```
    CONSIDER_COMPARISON_WITH_NUMBER_WITH_PRECISION_ZERO_AS_INCONSISTENCY is defined as "http://www.reportingstandard.com/properties/compare-with-number-p-zero-is-inconsistency" Possible value is a String that can be converted into a boolean "true" or "false"
    Default value is "false"
    According to the XBRL 2.1 specification in the simple equation A = B + C, if A is zero with precision 0 the comparison must return true regardless the value of B + C.
    If this property has the value "true" a warning will be raised if this condition happens.
    
    Since:
    
    2.6.5
    
    See Also:
    
    Constant Field Values
  - GENERIC_LINKBASE_REQUIRE_ROLEREF_ARCROLEREF
```
public static final java.lang.String GENERIC_LINKBASE_REQUIRE_ROLEREF_ARCROLEREF
```
    GENERIC_LINKBASE_REQUIRE_ROLEREF_ARCROLEREF is defined as "http://www.reportingstandard.com/properties/generic-linkbase/require-roleRef-arcroleRef" Possible value is a String that can be converted into a boolean "true" or "false"
    Default value is "true" if the PROCESSORS_SEQUENCE property contains the formula processor and "false" otherwise.
    All defined extended links in the XBRL 2.1 specification (presentationLink, calculationLink, definitionLink, labelLink and referenceLink) requires the existence of a roleRef element pointing to the role definition for roles not defined in the XBRL 2.1 specification and arcroleRef element pointing to the arcrole definition for arcroles not defined in the XBRL 2.1 specification. For consistency reasons, the Generic Links 1.0 specification (Recommendation 22 June 2009) requires the same constraints on roles and arcroles used in generic links. Just sticking to the wording of the XBRL 2.1 specification, roleRef and arcroleRef elements would not be required on generic links.
    The GENERIC_LINKBASE_REQUIRE_ROLEREF_ARCROLEREF allows the processor to raise an error (DTSDiscoveryException) if roles or arcroles defined in generic links does not contain a roleRef arcroleRef element (as required in the Generic Links 1.0); in this case, the property value should be "true" or not raise an error as defined in the XBRL 2.1 specification without the constraints defined in the Generic Links 1.0; in this case, the property value should be "false".
    
    See Also:
    
    Constant Field Values
  - GENERIC_LABEL_VERSION
```
public static final java.lang.String GENERIC_LABEL_VERSION
```
    GENERIC_LABEL_VERSION is defined as "http://www.reportingstandard.com/properties/generic-linkbase/label-version" Possible values of this property are USE_GENERIC_LABEL_AS_OF_22_JUNE_2009 or USE_GENERIC_LABEL_AS_OF_CURRENT_EXPERIMENTAL.
    The schema for the Generic labels 1.0 specification defined on June 22 2009 contains an arcrole definition for the arcrole type http://xbrl.org/arcrole/2008/element-label. That arcrole type contains an attribute called cyclesAllowed whose value was "none".
    The (currently not dated) version of the errata corrections for the Generic labels 1.0 specification changes the value of the cyclesAllowed attribute from "none" to "undirected". For this reason the property adjust the processor for using the original or the newest version of that schema.
    The default value for this property is USE_GENERIC_LABEL_AS_OF_22_JUNE_2009. Note this value will be changed at a later time.
    
    See Also:
    
    Constant Field Values
  - GENERIC_REFERENCE_VERSION
```
public static final java.lang.String GENERIC_REFERENCE_VERSION
```
    GENERIC_REFERENCE_VERSION is defined as "http://www.reportingstandard.com/properties/generic-linkbase/reference-version" Possible values of this property are USE_GENERIC_REFERENCE_AS_OF_22_JUNE_2009 or USE_GENERIC_REFERENCE_AS_OF_CURRENT_EXPERIMENTAL.
    The schema for the Generic references 1.0 specification defined on June 22 2009 contains an arcrole definition for the arcrole type http://xbrl.org/arcrole/2008/element-reference. That arcrole type contains an attribute called cyclesAllowed whose value was "none".
    The (currently not dated) version of the errata corrections for the Generic references 1.0 specification changes the value of the cyclesAllowed attribute from "none" to "undirected". For this reason the property adjust the processor for using the original or the newest version of that schema.
    The default value for this property is USE_GENERIC_REFERENCE_AS_OF_22_JUNE_2009. Note this value will be changed at a later time.
    
    See Also:
    
    Constant Field Values
  - USE_GENERIC_LABEL_AS_OF_22_JUNE_2009
```
public static final java.lang.String USE_GENERIC_LABEL_AS_OF_22_JUNE_2009
```
    USE_GENERIC_LABEL_AS_OF_22_JUNE_2009 is defined as GENERIC_LABEL_22_JUN_2009.
    This is one of the possible values of the GENERIC_LABEL_VERSION property of the DTSContainer.
    
    See Also:
    
    Constant Field Values
  - USE_GENERIC_LABEL_CURRENT_EXPERIMENTAL
```
public static final java.lang.String USE_GENERIC_LABEL_CURRENT_EXPERIMENTAL
```
    USE_GENERIC_LABEL_AS_OF_CURRENT_EXPERIMENTAL is defined as GENERIC_LABEL_CURRENT_EXPERIMENTAL.
    This is one of the possible values of the GENERIC_LABEL_VERSION property of the DTSContainer.
    Note: the specification wording still has not been approved. The new specification version changes the cyclesAllowed attribute on the arcrole definition for element-label relationships from none to undirected
    
    See Also:
    
    Constant Field Values
  - USE_GENERIC_REFERENCE_AS_OF_22_JUNE_2009
```
public static final java.lang.String USE_GENERIC_REFERENCE_AS_OF_22_JUNE_2009
```
    USE_GENERIC_REFERENCE_AS_OF_22_JUNE_2009 is defined as GENERIC_REFERENCE_22_JUN_2009.
    This is one of the possible values of the GENERIC_REFERENCE_VERSION property of the DTSContainer.
    
    See Also:
    
    Constant Field Values
  - USE_GENERIC_REFERENCE_CURRENT_EXPERIMENTAL
```
public static final java.lang.String USE_GENERIC_REFERENCE_CURRENT_EXPERIMENTAL
```
    USE_GENERIC_REFERENCE_AS_OF_CURRENT_EXPERIMENTAL is defined as GENERIC_REFERENCE_CURRENT_EXPERIMENTAL.
    This is one of the possible values of the GENERIC_REFERENCE_VERSION property of the DTSContainer.
    Note: the specification wording still has not been approved. The new specification version changes the cyclesAllowed attribute on the arcrole definition for element-reference relationships from none to undirected
    
    See Also:
    
    Constant Field Values
  - ALWAYS_ADD_ref_2006_02_27_xsd_SCHEMA_TO_DTS
```
public static final java.lang.String ALWAYS_ADD_ref_2006_02_27_xsd_SCHEMA_TO_DTS
```
    ALWAYS_ADD_ref_2006_02_27_xsd_SCHEMA_TO_DTS is defined as "http://www.reportingstandard.com/properties/always_add_ref_2006_02_27_schema_to_DTS" Possible value is a string that can be converted into a boolean "true" or "false" Default value is "false" Some taxonomies does not incorporate the URL of the reference schema http://www.xbrl.org/2006/ref-2006-02-27.xsd to the DTS but use its namespace in the reference linkbase instead. This is poor design in XML terms because the same namespace could potentially be driven to a different URL. But there is no way to open a DTS if it contains this error so we have had to add this property in order to deal with this. Taxonomies that constains this problem are: Central Bank of India created by IRIS and Fujitsu.
    
    See Also:
    
    Constant Field Values
  - USE_XDT_1_0_AS_OF_18_SEP_2006
```
public static final java.lang.String USE_XDT_1_0_AS_OF_18_SEP_2006
```
    USE_XDT_1_0_AS_OF_18_SEP_2006 is defined as XDT_18_SEP_2006.
    This is one of the possible values of the XDT_VERSION property of the DTSContainer.
    
    See Also:
    
    Constant Field Values
  - USE_XDT_1_0_AS_OF_7_SEP_2009
```
public static final java.lang.String USE_XDT_1_0_AS_OF_7_SEP_2009
```
    USE_XDT_1_0_AS_OF_7_SEP_2009 is defined as XDT_7_SEP_2009.
    This is one of the possible values of the XDT_VERSION property of the DTSContainer.
    
    See Also:
    
    Constant Field Values
  - USE_XDT_1_0_AS_OF_25_JAN_2012
```
public static final java.lang.String USE_XDT_1_0_AS_OF_25_JAN_2012
```
    USE_XDT_1_0_AS_OF_25_JAN_2012 is defined as XDT_25_JAN_2012.
    This is one of the possible values of the XDT_VERSION property of the DTSContainer.
    Note: there are no functional differences between XDT specification version September 7th 2009 and January 1st 2012. Both values are equivalent.
    
    See Also:
    
    Constant Field Values
  - USE_XEQUAL_AS_XBRL_COMPLIANT
```
public static final java.lang.String USE_XEQUAL_AS_XBRL_COMPLIANT
```
    USE_XEQUAL_AS_XBRL_COMPLIANT is defined as XBRL_COMPLIANT.
    This is one of the possible value of the XEQUAL_MODE property.
    
    See Also:
    
    Constant Field Values
  - USE_XEQUAL_AS_FORMULA_COMPLIANT
```
public static final java.lang.String USE_XEQUAL_AS_FORMULA_COMPLIANT
```
    USE_XEQUAL_AS_FORMULA_COMPLIANT is defined as FORMULA_COMPLIANT.
    This is one of the possible value of the XEQUAL_MODE property.
    
    See Also:
    
    Constant Field Values
  - XEQUAL_MODE
```
public static final java.lang.String XEQUAL_MODE
```
    The XEQUAL_MODE property indicates if the x-equal function follow the rules of the XBRL 2.1 specification or if it should follow the interpretation made by the authors of the XBRL formula specification.
    The value of the XEQUAL_MODE constant is "http://www.reportingstandard.com/properties/x-equal"
    The default value for the property is USE_XEQUAL_AS_XBRL_COMPLIANT which is safer in all conditions except when passing the XBRL functions comformance suite.
    
    See Also:
    
    Constant Field Values
  - USE_SEQUAL_AS_XBRL_COMPLIANT
```
public static final java.lang.String USE_SEQUAL_AS_XBRL_COMPLIANT
```
    USE_SEQUAL_AS_XBRL_COMPLIANT is defined as XBRL_COMPLIANT.
    This is one of the possible value of the SEQUAL_MODE property.
    
    See Also:
    
    Constant Field Values
  - USE_SEQUAL_AS_FORMULA_COMPLIANT
```
public static final java.lang.String USE_SEQUAL_AS_FORMULA_COMPLIANT
```
    USE_SEQUAL_AS_FORMULA_COMPLIANT is defined as FORMULA_COMPLIANT.
    This is one of the possible value of the SEQUAL_MODE property.
    
    See Also:
    
    Constant Field Values
  - SEQUAL_MODE
```
public static final java.lang.String SEQUAL_MODE
```
    The SEQUAL_MODE property indicates if the s-equal function follow the rules of the XBRL 2.1 specification or if it should follow the interpretation made by the authors of the XBRL formula specification.
    The value of the SEQUAL_MODE constant is "http://www.reportingstandard.com/properties/s-equal"
    The default value for the property is USE_SEQUAL_AS_XBRL_COMPLIANT which is safer in all conditions except when passing the XBRL functions comformance suite.
    
    See Also:
    
    Constant Field Values
  - XDT_VERSION
```
public static final java.lang.String XDT_VERSION
```
    The XDT_VERSION property indicates the version of the Dimensions Specification to be used. The possible values are USE_XDT_1_0_AS_OF_18_SEP_2006 or USE_XDT_1_0_AS_OF_7_SEP_2009; both are defined as constants to the DTSContainer object for convenience.
    The value of the XDT_VERSION constant is "http://www.reportingstandard.com/properties/xdt-version".
    The default value for the property it refers to is USE_XDT_1_0_AS_OF_7_SEP_2009 which is the lastest release with errata corrections of the XDT specification.
    
    See Also:
    
    Constant Field Values
  - XBRL_VERSION
```
public static final java.lang.String XBRL_VERSION
```
    The XBRL_VERSION property indicates the version of the XBRL specification to be used when multiple editions of the XBRL 2.1 specification causes different behavior of the XBRL processor.
    As of 02/07/2008 Reporting Standard has found no differences in the XBRL processor implementation with previous XBRL 2.1 implementations. The default value of this property is XBRL_VERSION_2_JUL_2008 XBRL_VERSION_2_JUL_2008
    As of 26/07/2010 the XBRL 2.1 specification working group is working (for longer than a year) in changing how summation-item works and the recognition of zero with precision zero. There is a new value for experimental purposes that is XBRL_VERSION_EXPERIMENTAL_BUG_368.
    On 25/01/2012 the XBRL consortium has approve a new edition of the XBRL 2.1 specification consolidating all changes made to the specification in the last years. This is in fact a new specification version regardless the specification name says it is an errata correction. Calculations and inconsistencies and errors regarding calculations are different than in previous specification versions. Conformance suite test cases are not consistent between this version of the specification and previous versions. XBRL_VERSION_25_JAN_2012 XBRL_VERSION_20_FEB_2013
    
    See Also:
    
    Constant Field Values
  - XBRL_VERSION_2_JUL_2008
```
public static final java.lang.String XBRL_VERSION_2_JUL_2008
```
    Default value for the XBRL Processor in production.
    
    See Also:
    
    XBRL_VERSION, Constant Field Values
  - XBRL_VERSION_EXPERIMENTAL_BUG_368
```
public static final java.lang.String XBRL_VERSION_EXPERIMENTAL_BUG_368
```
    Experimental value of the XBRL Processor according to the BUG 368. This definition will be changed later if the working group finally approves the changes and the new specification has a date.
    The previous value was "XBRL_EXPERIMENTAL_BUG_368". On 2011/07/12 the value has been changed to "XBRL_PER_7_MAR_2011";
    This value is now deprecated and shall be replaced by the new value "XBRL_25_JAN_2012". Please note there are differences between PER_7_MAR_2011 and specification version of 25 JAN 2012 because rounding is on this specification version is IEEE roundTiesToEven.
    
    See Also:
    
    XBRL_VERSION, Constant Field Values
  - XBRL_VERSION_25_JAN_2012
```
public static final java.lang.String XBRL_VERSION_25_JAN_2012
```
    This configures the processor to use the specification version released on January 25 of 2012. There are substantial changes in the specification so this may impact validation of the calculations.
    
    See Also:
    
    XBRL_VERSION, Constant Field Values
  - XBRL_VERSION_20_FEB_2013
```
public static final java.lang.String XBRL_VERSION_20_FEB_2013
```
    This configures the processor to use the specification version released on February 20 of 2013. There are changes in the DTS Discovery rules and additional constraints in the use of the standard role URI
    
    See Also:
    
    XBRL_VERSION, Constant Field Values
  - XBRL_BASE
```
public static final java.lang.String XBRL_BASE
```
    The XBRL_BASE property indicates the directory that will be used as base for resolution of files that during the DTS Discovery process.
    The data type of this property is a URI. Users MUST take care the provided String can be converted into a URI
    The default value depends on the existence of a value for the environment variable XBRLCATALOGPATH.
    if that variable is set. the default value will be ${XBRLCATALOGPATH}/Other/
    if that variable is not set, the default value is the directory where the processor is running. "user.dir"/
    Note that the xbrl-base is a directory so the method reading this property value ensures the value ends with a slash character "/" in order to allow proper resolution of local files.
    
    See Also:
    
    Constant Field Values
  - DTS_DISCOVERY_ON_DIFFERENT_FILE_NAMES
```
public static final java.lang.String DTS_DISCOVERY_ON_DIFFERENT_FILE_NAMES
```
    The DTS_DISCOVERY_ON_DIFFERENT_FILE_NAMES property specifies how the processor reacts when a reference to a file differs from the real file name on the file system but the file subsystem resolves to the same file name. This is, for example, the case of Windows file systems that does not distinguish between upper case file names and lower case file names. The value of this property can be set as "warning" (this is the default), "error" or "ignore".
    If set to "warning", the processor will add an inconsistency to the validation phase. The inconsistency will indicate that the DTS will be valid on certain systems like "Windows" because windows does not distinguish between uppercase file names and lowercase file names, but it will not be valid on "Unix" because unix considers upper case file names different from lower case file names.
    If set to "error", the processor will consider this as an error even if the processor is running on a windows system and the file name can be resolved to a local file. This is our recommended value when running on a server validating incoming files on a regulator system
    If set to "ignore", the processor will ignore and this "problem" is detected, the processor will ignore it.
    
    See Also:
    
    Constant Field Values
  - DTS_DISCOVERY_TRUST_NAMESPACES_ONLY
```
public static final java.lang.String DTS_DISCOVERY_TRUST_NAMESPACES_ONLY
```
    The DTS_DISCOVERY_TRUST_NAMESPACES_ONLY property is used internally by the processor to decide about the strategy to load or reject a new schema will be loaded into the processor based on the new schema target namespace or in both, the target namespace and the schema location.
    If an schema already loaded into the XML processor has both, the same target namespace and the same schema location, it is safe to ignore the second reference to the same schema (XML schema processors do this normally) but, when the same schema is loaded from a different location this might be due to three possibilities: (1) the second schema is doing an include of the first schema using the same target namespace (which is correct) or (2) the second schema is the same as the first schema but in a different location (which would be an error due to duplicate definitions of everything but is a common mistake in the conformance suites) or, the second schema is different from the first schema and contains duplicate definitions among with new definitions which is an error.
    The default value for the DTS_DISCOVERY_TRUST_NAMESPACES_ONLY is false so namespaces and locations will be used.
    
    See Also:
    
    Constant Field Values
  - DTS_DISCOVERY_TRUST_NAMESPACES_ONLY_FOR_OFFICIAL_FILES
```
public static final java.lang.String DTS_DISCOVERY_TRUST_NAMESPACES_ONLY_FOR_OFFICIAL_FILES
```
    The DTS_DISCOVERY_TRUST_NAMESPACES_ONLY_FOR_OFFICIAL_FILES property is used internally by the processor similar to the DTS_DISCOVERY_TRUST_NAMESPACES_ONLY but differs from DTS_DISCOVERY_TRUST_NAMESPACES_ONLY in the scope of schemas that will be trusted using the namespace only for files defined in XBRL specifications. This property is set to true when running XBRL conformance suites because the XBRL conformance suite does not refer to the official schemas in the official location.
    Refer to the documentation about DTS_DISCOVERY_TRUST_NAMESPACES_ONLY for more information
    The default value for the DTS_DISCOVERY_TRUST_NAMESPACES_ONLY_FOR_OFFICIAL_FILES is false so namespaces and locations will be used.
    
    See Also:
    
    Constant Field Values
  - DTS_DISCOVERY_RAISE_WARNING_IF_TWO_FILES_HAVE_SAME_NAMESPACE
```
public static final java.lang.String DTS_DISCOVERY_RAISE_WARNING_IF_TWO_FILES_HAVE_SAME_NAMESPACE
```
    The DTS_DISCOVERY_RAISE_WARNING_IF_TWO_FILES_HAVE_SAME_NAMESPACE property is used to signal a warning when two files in the DTS use the same namespace with different systemID. This MIGHT not be a problem if one schema include another schema or if the two files have exactly the same content at different locations but it is worth noting this to the taxonomy developers to let them know when this happens.
    The default value for the DTS_DISCOVERY_RAISE_WARNING_IF_TWO_FILES_HAVE_SAME_NAMESPACE property is false. No warning will be raised.
    
    See Also:
    
    Constant Field Values
  - DTS_DISCOVERY_PRELOAD_OFFICIAL_SCHEMAS
```
public static final java.lang.String DTS_DISCOVERY_PRELOAD_OFFICIAL_SCHEMAS
```
    The DTS_DISCOVERY_PRELOAD_OFFICIAL_SCHEMAS property is used internally by the processor to decide if, after creating a new DTSContainer instance, the official schemas from XBRL International will be loaded in the XML processor.
    If the official schemas are not loaded when the DTSContainer is created, they will be discovered during the DTS discovery process and loaded from the cache or from the Internet depending on how other properties are set.
    The default value of this property is true. This means that default schemas will be loaded from internal resources when a DTSContainer is created.
    The only reason for setting this property to false would be to use other locations of the official schemas rather than the official locations of the schemas, like, for example, the formula conformance suite when it is downloaded from the SVN repository.
    
    See Also:
    
    Constant Field Values
  - DTS_DISCOVERY_REPLACE_OFFICIAL_SCHEMAS_SCHEMALOCATION
```
public static final java.lang.String DTS_DISCOVERY_REPLACE_OFFICIAL_SCHEMAS_SCHEMALOCATION
```
    The DTS_DISCOVERY_REPLACE_OFFICIAL_SCHEMAS_SCHEMALOCATION property is used to force the processor to load standard schemas from the official location even if the schemaLocation points to a different path.
    If has been found during the implementation of the FRTA validation that some schemas refer to the xbrl-instance-2003-12-31.xsd schema using a relative location of the same schema file where it imported. No standard Schema processor will be able to process that schema but the XBRL processor can handle this by recognizind the namespace corresponds with an official namespace from the XBRL 2.1 specification and load that schema from internal resources.
    The default value of this property is false. This means a DTSDiscovery exception will be raised if this condition is found but for passing the FRTA conformance suite it is required to set this property to true.
    
    See Also:
    
    Constant Field Values
  - DTS_DISCOVERY_ALLOWSPACESONURIS
```
public static final java.lang.String DTS_DISCOVERY_ALLOWSPACESONURIS
```
    Spaces are not allowed in the value space of an URI, but some software vendors such as Fujitsu XWand failed to implement this rule and this means there are URIs with spaces in some taxonomies (at the SEC there are some... and taxonomies in Asian countries might also contain space too). This property allows for spaces on URIs to be accepted even if they are not valid according with RFCs and Schema validation. The default value of this property is "false" and setting this property to "true" is strongly discouraged.
    
    See Also:
    
    Constant Field Values
  - DTS_STORE_CACHE_PATH
```
public static final java.lang.String DTS_STORE_CACHE_PATH
```
    if this property is set, during the DTS discovery process, when a file comes from the Internet, a copy of the file will be written to a directory down on this folder. The purpose of this folder is double: (1) to be used for generating new ZIP files for the taxonomy catalog. (2) to speed-up dts loading the second time the same entry point is open. This will be implemented in a new URIResolver
    
    See Also:
    
    Constant Field Values
  - DTS_STORE_CACHE_ENABLE
```
public static final java.lang.String DTS_STORE_CACHE_ENABLE
```
    The DTS_STORE_CACHE_ENABLE property is used to enable or disable the use of a dynamic cache. The dynamic cache stores locally copies of files obtained from the Internet and uses them during the next DTS Discovery process using the same files. The default value is "false" so this is not used in headless environments. GUI tools might pass true to this property.
    
    See Also:
    
    Constant Field Values
  - DTS_RESOLVER
```
public static final java.lang.String DTS_RESOLVER
```
    The DTS_RESOLVER property is used in order to add additional DTS URI resolvers to the default ones after the DTS configuration process has been finished. The DTS_RESOLVER property value must be an instance of a class implementing the HasCreateDTSUriResolver interface. The DTSContainer will call the createAndRegisterDTSUriResolver method in order to let the class create and register the new URI resolver.
    In case multiple DTS_RESOLVER shall be added in a chain by the calling application, the calling application may use an instance of the class MultiDTSUriResolverFactory which implements the functionality of creating all of them and registering to the DTSContainer in the proper order. Refer to the documentation of the MultiDTSUriResolverFactory for more information.
    
    See Also:
    
    MultiDTSUriResolverFactory, HasCreateDTSUriResolver, Constant Field Values
  - DTS_THIN
```
public static final java.lang.String DTS_THIN
```
    The DTS_THIN property liberates internal resources that can be obtained back from the original XML nodes and reduces the DTS memory footprint. The cost of setting this property value to 'true' is that loading the DTS and validation may take longer because the same object is created multiple times.
    The default value of this property is 'true'. It is safe to set it to either 'true' or 'false' in terms of the final result. The only tradeoff is the amount of memory and time required to perform complete loading and validation.
    since version 2.8.5 the default value is now 'true'
    
    See Also:
    
    Constant Field Values
  - DTS_SHOW_EXACTITUDE_DETAILS
```
public static final java.lang.String DTS_SHOW_EXACTITUDE_DETAILS
```
    The DTS_SHOW_EXACTITUDE_DETAILS property controls how the values for the calculation inconsistencies are converted to strings. If the value is true, the text representation includes details about the precision or the decimals. If the value is false, just the number is shown.
    The default value is 'true'
    
    See Also:
    
    Constant Field Values
  - DTS_CHECK_TOP_LEVEL_SCHEMAS
```
public static final java.lang.String DTS_CHECK_TOP_LEVEL_SCHEMAS
```
    Work in progress of the new XBRL 2.1 specification version
    
    See Also:
    
    Constant Field Values
  - DTS_USER_LANGUAGES
```
public static final java.lang.String DTS_USER_LANGUAGES
```
    The DTS_USER_LANGUAGES can be set to a comma separated list of language codes in ISO-639-1 that might be used for label selection for concepts and resources.
    The algorithm to select a proper language during the evaluation of a language for a concept or resource is indicated here LangsProviderInstance.getLangsCombined(DTSContainer).
    This variable has the empty string as default value
    
    See Also:
    
    Constant Field Values
  - DTS_ERROR_MESSAGE_MAX_CHARS
```
public static final java.lang.String DTS_ERROR_MESSAGE_MAX_CHARS
```
    The DTS_ERROR_MESSAGE_MAX_CHARS can be set to set a limit to the error messages produced by the validation.
    The default value is 1500 characters
    
    See Also:
    
    Constant Field Values
  - LOG_LEVEL
```
public static final java.lang.String LOG_LEVEL
```
    The log level that will be set to the standard logger at com.ihr.xbrl
    The value must be a valid string representation of the level as indicated in the log4j logging package. This is typically ALL, TRACE, DEBUG, WARN, ERROR or OFF.
    Use ALL for the processor to generate all debug messages sent to appenders registered for loggers at com.ihr.xbrl !!WARNING!! this may slow down performance.
    Default value is Level.ERROR
    
    See Also:
    
    Constant Field Values
  - DTS_PROXY_HEADER
```
public static final java.lang.String DTS_PROXY_HEADER
```
    The DTS_PROXY_HEADER property is the head of the following three properties:
    - DTS_PROXY_HEADER/address/{n} indicates the proxy address
    - DTS_PROXY_HEADER/port/{n} indicates the proxy port number (no defaults are recognized)
    - DTS_PROXY_HEADER/type/{n} indicates the proxy type "HTTP" or "SOCKS" are recognized types.
    - DTS_PROXY_HEADER/noProxyFor semicolon separated list of hosts for which direct connections will be made (no proxy)
    Where {n} is a sequential number starting with 0.
    Use this properties in order to set a collection of proxies that will be used in turn for opening external files.
    Note the taxonomy cache is independent from the proxies. The taxonomy cache always takes preference over any proxy configurations. Taxonomy cache sources are local files or the XBRL Database.
    See Also:
    
    Constant Field Values
  - AUTHENTICATOR_DELEGATE_INSTANCE
```
public static final java.lang.String AUTHENTICATOR_DELEGATE_INSTANCE
```
    The AUTHENTICATOR_DELEGATE_INSTANCE property is the instance of an object implementing java.net.Authenticator that will be registered as the default authenticator. Authentication may be required by web servers or by proxy servers.
    
    See Also:
    
    Constant Field Values
  - PROCESSORS_SEQUENCE
```
public static final java.lang.String PROCESSORS_SEQUENCE
```
    The PROCESSORS_SEQUENCE property contains a comma separated list of processors responsible of performing DTS validation
    The default value for the PROCESSORS_SEQUENCE property is XBRLCoreProcessor.PROCESSORNAME which is "XBRL21Core"
    Note: In order to perform XBRL 2.1 validation and XBRL Dimensions 1.0 validation, the value of this property must be set to XBRLCoreProcessor.PROCESSORNAME,XDTProcessor.PROCESSORNAME this is: "XBRL21Core,XBRLDimensions"
    Processors extensibility: Creating your own processors for project specific validation rules
    Processor factories are loaded during the static initialization of the DTSContainer class. It is possible users create additional factories to be registered during the static initialization according to the following rules:
    - The -Dxbrl.processors system property may contain a comma separated list of processor factory classes
    - Applications may call the registerProcessor(String, XBRLPlugInProcessor) method on this class
    It is not possible to override standard processor names (Core XBRL 2.1, Dimensions and Formula)
    In case of any error during the initialization of custom XBRL processors a RuntimeException is produced encapsulating an XBRLInitializationException. The XBRL Processor may be in an unusable status in this case. Regular processors for XBRL 2.1, Dimensions and Formula processing are safe and does not raise XBRLInitialization exceptions.
    See Also:
    
    Constant Field Values
  - WARNING_PROPERTY_VALUE
```
public static final java.lang.String WARNING_PROPERTY_VALUE
```
    This is set to the constant value "warning".
    
    See Also:
    
    Constant Field Values
  - ERROR_PROPERTY_VALUE
```
public static final java.lang.String ERROR_PROPERTY_VALUE
```
    This is set to the constant value "error".
    
    See Also:
    
    Constant Field Values
  - IGNORE_PROPERTY_VALUE
```
public static final java.lang.String IGNORE_PROPERTY_VALUE
```
    This is set to the constant value "ignore".
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_GENERAL_VARIABLE_SCHEMA_AWARE
```
public static final java.lang.String FORMULA_PROCESSOR_GENERAL_VARIABLE_SCHEMA_AWARE
```
    The FORMULA_PROCESSOR_GENERAL_VARIABLE_SCHEMA_AWARE property contains a value 'true' or 'false' that defines the behavior of the XPath expression evaluation for General Variables.
    Default value is 'true'
    If the value is 'true' then the XPath expression will be schema aware. Nodes returned by the evaluation of the XPath expression will be typed according with the data types defined in the schemas.
    If the value is 'false' then the XPath expression will NOT be schema aware. Nodes returned by the evaluation of the XPath expression will NOT be typed (they will be Untyped nodes) and data conversion will be necessary in the XPath expressions using them.
    Before 09/01/2011, The formula tests suite contained one test case that requires to load an external XML file using the doc() XPath function. That target XML file was NOT valid against the referenced schema. After 09/01/2011 the tests suite was changed in order make the XML file schema aware.
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_PARAMETER_RESOLVER
```
public static final java.lang.String FORMULA_PROCESSOR_PARAMETER_RESOLVER
```
    The FORMULA_PROCESSOR_PARAMETER_RESOLVER property is used in order to add additional Variable Parameter resolvers to the formula processor.
    The FORMULA_PROCESSOR_PARAMETER_RESOLVER property value must be an instance of a class implementing the HasCreateFormulaParameterResolver interface. The DTSContainer will call the createAndRegisterDTSUriResolver method in order to let the class create and register the new URI resolver.
    In case multiple FORMULA_PROCESSOR_PARAMETER_RESOLVER shall be added in a chain by the calling application, the calling application may use an instance of the class MultiFormulaParameterResolverFactory which implements the functionality of creating all of them and registering to the DTSContainer in the proper order. Refer to the documentation of the MultiFormulaParameterResolverFactory for more information.
    
    See Also:
    
    MultiFormulaParameterResolverFactory, Constant Field Values
  - FORMULA_PROCESSOR_RETAIN_INPUT_INTANCE_ON_ASSERTION_RESULTS
```
public static final java.lang.String FORMULA_PROCESSOR_RETAIN_INPUT_INTANCE_ON_ASSERTION_RESULTS
```
    The FORMULA_PROCESSOR_RETAIN_INPUT_INTANCE_ON_ASSERTION_RESULTS property is used to configure the formula processor in order to allow XBRLAssertionResult instances to keep a reference of the original input instance. Note this information may by useful on private validation modules at a later time or for debugging purposes.
    The default value of this property is "false" so a call to the function returning this value on the XBRLAssertionResult object will return null.
    Put this property to true if you want to use this information in the API.
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS
```
public static final java.lang.String FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS
```
    The FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS property is used to configure the formula processor in order to allow XBRLAssertionResult instances to keep a reference of the original input instance after the execution of the formulas in the variable set that defined the input of the consistency assertion. Note this information may by useful on private validation modules at a later time or for debugging purposes.
    The default value of this property is "false" so a call to the function returning this value on the XBRLAssertionResult object will return null.
    Put this property to true if you want to use this information in the API.
    
    See Also:
    
    Constant Field Values
  - PARALLEL_PROCESSING
```
public static final java.lang.String PARALLEL_PROCESSING
```
    The PARALLEL_PROCESSING property enables all processors to execute validation in parallel. The idea is to reduce execution time to perform validation by executing, as much as possible, things in parallel.
    The PARALLEL_PROCESSING_EXPERIMENTAL property value must be a boolean. The default is 'true' since version 3.2
    
    See Also:
    
    Constant Field Values
  - PARALLEL_PROCESSORS
```
public static final java.lang.String PARALLEL_PROCESSORS
```
    The PARALLEL_PROCESSORS property indicates the maximum number of parallel threads that the platform will reserve for validation. Note, the real number used will the the minimum between 3 numbers. (1) The Java Virtual Machine number of processors available minus 1, (2) The value of this property (3) the Maximum number of processors specified in the MAXPROXESSORS property in the license file. The default value of this property is Integer.MAX_VALUE This property is useful if, for any reason, you want to explicitly limit the number of processors that will be used for validation purposes
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_ENABLE_ASSERTION_MESSAGE_EXTENSIONS
```
public static final java.lang.String FORMULA_PROCESSOR_ENABLE_ASSERTION_MESSAGE_EXTENSIONS
```
    The FORMULA_PROCESSOR_ENABLE_ASSERTION_MESSAGE_EXTENSIONS property indicates if the processor will calculate and return custom messages during the evaluation of assertions. The property value must be a string representing a boolean value. A value of 'true' means the formula processor will try to evaluate the right message in the right language during the evaluation of an assertion. The value of 'false' means the formula processor will ignore the existence of those resources.
    The FORMULA_PROCESSOR_ENABLE_ASSERTION_MESSAGE_EXTENSIONS property value must be a boolean. The default is 'true'
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_DEFAULT_MESSAGE_ROLE
```
public static final java.lang.String FORMULA_PROCESSOR_DEFAULT_MESSAGE_ROLE
```
    The FORMULA_PROCESSOR_DEFAULT_MESSAGE_ROLE property indicates the default role URI string that will be used for the resolution of the winning message when no role (null) is indicated or when no message is found for the selected role (second opportunity).
    The FORMULA_PROCESSOR_DEFAULT_MESSAGE_ROLE property value must be a string. The default value is 'http://www.xbrl.org/2010/role/message' that is defined in the Generic messages 1.0 specification.
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_LEVEL_OF_EXCEPTIONS_INSIDE_FILTER_XPATH_EXPRESSIONS
```
public static final java.lang.String FORMULA_PROCESSOR_LEVEL_OF_EXCEPTIONS_INSIDE_FILTER_XPATH_EXPRESSIONS
```
    The FORMULA_PROCESSOR_LEVEL_OF_EXCEPTIONS_INSIDE_FILTER_XPATH_EXPRESSIONS property indicates how the formula processor will react when a the evaluation of a formula filter raises an XPath exception. According with the Formula Specification this exception MUST be raised up to the formula processor and, for this reason, the default value is "error". But other formula processors have different implementations and they just ignore XPath exceptions produced.
    In order to create high quality taxonomies we encourage taxonomy developers to set this property to "error" and create test cases in order to test the taxonomy and execution of formulas in all possible circumstances. Adding filters to the variables when needed in order to prevent the XPath expression to raise an exception when the exception is not desired.
    Possible values of this property are: "error" (the default and recommented value) and "warning". Note that "ignore" is not a valid property value.
    Setting this property value to "error" is key in order to guarantee high interoperability of the formulas defined in XBRL taxonomies as Reporting Standard XBRL formula processor has implemented all the formula specification and other software vendors are not able to raise or recognize (maybe they even skip execution) of assertions defined in formula linkbases.
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_USE_STRICT_SPECIFICATION_XPATH
```
public static final java.lang.String FORMULA_PROCESSOR_USE_STRICT_SPECIFICATION_XPATH
```
    The FORMULA_PROCESSOR_USE_STRICT_SPECIFICATION_XPATH property sets the processor to use the XPath expressions defined for filters in the formula specification as they are written in the specifications document. This mode passes all test cases in the formula conformance suite and shall be considered as the right model to use for high quality taxonomy development. Surprisingly this mode cannot be used to validate EBA instances because it generates XPath errors. The EBA instances use of face specific functions designed for Fact Items with tuple arguments without the proper filter to process only tuples. While it is not indicated in the formula conformance suite that filters shall accept invalid arguments and not raise an exception during evaluation this is the common practice of some regulators and other formula processors does not raise errors when they should be raised. This is the reason we have set this property in our processor. When this property is set to "true", the processor will raise an exception if a tuple is used in an XPath expression that is indicated to process only items. If this property is set to "false" a filter will be automatically introduced (which is not part of the formula specification) and the execution will not raise an exception. For HIGH QUALITY taxonomy development, the value of this property shall be set to "true". In order to validate instances created with low quality taxonomies, set this property to "false". The default value of this property is "false".
    
    See Also:
    
    Constant Field Values
  - IXBRL_DEDUPLICATE_FACTS_AFTER_LOAD
```
public static final java.lang.String IXBRL_DEDUPLICATE_FACTS_AFTER_LOAD
```
    The IXBRL_DEDUPLICATE_FACTS_AFTER_LOAD property sets the processor to deduplicate facts after loading an instance document.
    The deduplication process might remove facts reported in the instance so the default value is false.
    
    See Also:
    
    Constant Field Values
  - IXBRL_DOCTYPE_VALIDATION
```
public static final java.lang.String IXBRL_DOCTYPE_VALIDATION
```
    The IXBRL_DOCTYPE_VALIDATION property sets the processor to raise an error, a warning or ignore the existence of <!DOCTYPE html> in an IXBRL document.
    The property value can be set to any of the standard defined constants ERROR_PROPERTY_VALUE, WARNING_PROPERTY_VALUE or IGNORE_PROPERTY_VALUE. The default value is WARNING_PROPERTY_VALUE because section 3.5.1 of Inline XBRL Part 0: Primer 1.1 discourages its use.
    If the ESEFProcessor is added to the validation chain, the property value is changed to ERROR_PROPERTY_VALUE automatically
    
    See Also:
    
    Section 3.5.1 of Inline XBRL Part 0: Primer 1.1, Constant Field Values
  - IXBRL_VERSION
```
public static final java.lang.String IXBRL_VERSION
```
    The IXBRL_VERSION property sets the version of the IXBRL processor to use along with this DTSContainer.
    The property value can be set to any of the standard defined constants IXBRL_V10 or IXBRL_V11. The default value is IXBRL_V11
    
    See Also:
    
    Constant Field Values
  - IXBRL_V10
```
public static final java.lang.String IXBRL_V10
```
    This is one possible value for the IXBRL_VERSION property key. In this case the processor to be used is the iXBRL 1.0 (Obsolete)
    
    See Also:
    
    IXBRL_VERSION, Constant Field Values
  - IXBRL_V11
```
public static final java.lang.String IXBRL_V11
```
    This is one possible value for the IXBRL_VERSION property key. In this case the processor to be used is the iXBRL 1.1 (Current)
    
    See Also:
    
    IXBRL_VERSION, Constant Field Values
  - FUNCTIONS_USE_TARGETROLE_IN_XFI_FILTER_MEMBER_NETWORK_SELECTION
```
public static final java.lang.String FUNCTIONS_USE_TARGETROLE_IN_XFI_FILTER_MEMBER_NETWORK_SELECTION
```
    The xfi:filter-member-network-selection function does not specify if the targetrole attribute value shall be used when exploring dimensions or not, in fact:
    1. The conformance suite is unclear and does not contains any test case around this characteristic.
    2. some taxonomies worldwide are using one interpretation, and some taxonomies the other
    So, at this time we have created a configurable switch to let the user decide depending on the taxonomy used
    The value of this property can be set to "true" or "false". For historical reasons, the default value is "true" but it might be changed in the future. Note the XBRL 2.1 FUNCTIONS and FORMULA conformance suites contains no tests cases indicating which value shall be used the conformance lacks tests cases to choose for one single implementation across all software vendors and RS provides multiple implementations of this function. We apologies for the inconvenience
    See Also:
    
    FUNCTIONS_CREATE_PHANTOM_RELATIONSHIPS_WHEN_NEEDED_TO_MAKE_FILTER_MEMBER_NETWORK_SELECTION_TO_WORK_UNDER_CERTAIN_PROJECTS, Constant Field Values
  - FUNCTIONS_CREATE_PHANTOM_RELATIONSHIPS_WHEN_NEEDED_TO_MAKE_FILTER_MEMBER_NETWORK_SELECTION_TO_WORK_UNDER_CERTAIN_PROJECTS
```
public static final java.lang.String FUNCTIONS_CREATE_PHANTOM_RELATIONSHIPS_WHEN_NEEDED_TO_MAKE_FILTER_MEMBER_NETWORK_SELECTION_TO_WORK_UNDER_CERTAIN_PROJECTS
```
    The xfi:filter-member-network-selection function may have two operation modes:
    1. mode 1, the filter only considers existing relationships in linkbases. This is the default mode and is selected by indicating "false" as the value of this property.
    2. mode 2, the filter invents relationships that does not exists in the linkbases. Choose this implementation if you see inconsistencies that makes no sense when validating instances to try to match the desired result. In order to activate mode 2 you need to indicate "true" as the property of this function value.
    Note the XBRL 2.1 FUNCTIONS and FORMULA conformance suites contains no tests cases indicating which value shall be used the conformance lacks tests cases to choose for one single implementation across all software vendors and RS provides multiple implementations of this function. We apologies for the inconvenience
    At this time, the default value is "true"
    See Also:
    
    FUNCTIONS_USE_TARGETROLE_IN_XFI_FILTER_MEMBER_NETWORK_SELECTION, Constant Field Values
  - FORMULA_PROCESSOR_RETAIN_USED_FACTS
```
public static final java.lang.String FORMULA_PROCESSOR_RETAIN_USED_FACTS
```
    The FORMULA_PROCESSOR_RETAIN_USED_FACTS property sets the processor to record all facts from fact variables that binds to a particular formula during assertion evaluation. This information might be useful for debug purposes of an assertion execution but may not be relevant in production environments because it consumes extra memory.
    The default value of this property is 'false' so, no facts are recorded. If the value is set to 'true' then facts are recorded and are accessible through methods in the XBRLAssertionResult class.
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_IGNORE_ASSERTION_SATISFIED
```
public static final java.lang.String FORMULA_PROCESSOR_IGNORE_ASSERTION_SATISFIED
```
    The FORMULA_PROCESSOR_IGNORE_ASSERTION_SATISFIED property indicates if the evaluation of assertions with "assertion satisfied" result will generate a message that will be added to the validation report or if the message will not be generated at all.
    The property exists to allow for a more user friendly validation report in which only non compliant assertions are reported and save memory for not storing information that will not be used
    The default value is "false", this means all messages are generated
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_IGNORE_ASSERTION_NOT_SATISFIED
```
public static final java.lang.String FORMULA_PROCESSOR_IGNORE_ASSERTION_NOT_SATISFIED
```
    The FORMULA_PROCESSOR_IGNORE_ASSERTION_NOT_SATISFIED property indicates if the evaluation of assertions with "assertion not satisfied" result will generate a message that will be added to the validation report or if the message will not be generated at all.
    The property exists to allow for a more user friendly validation report in which only compliant assertions are reported and save memory for not storing information that will not be used
    The default value is "false", this means all messages are generated
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_RETAIN_ASSERTION_RESOURCES
```
public static final java.lang.String FORMULA_PROCESSOR_RETAIN_ASSERTION_RESOURCES
```
    The FORMULA_PROCESSOR_RETAIN_ASSERTION_RESOURCES property allows applications to access the internal resources that were used during the evaluation of an assertion. That information shall be used by applications to access variables evaluated and facts used during evaluation time.
    Note this property may consume a lot of memory if used for all assertions in a taxonomy and the taxonomy contains a big number of assertions. For this reason it is strongly recommended this property is used in combination with either FORMULA_PROCESSOR_IGNORE_ASSERTION_SATISFIED or FORMULA_PROCESSOR_IGNORE_NOT_ASSERTION_SATISFIED set to 'true' so only assertions that are important for the consumer application generates detailed log messages.
    When this property value is set to 'true' the method getEvaluatedResources() in the XBRLAssertionResult class returns the instance of the XBRLFormulaResource that serves as base for assertion evaluation. If this property value is set to 'false' the method getEvaluatedResources() returns null.
    The default value is "false", this means, no detailed information will be collected, which is adequate for general validation purposes.
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_FILTER_ORDER_CLASS
```
public static final java.lang.String FORMULA_PROCESSOR_FILTER_ORDER_CLASS
```
    The FORMULA_PROCESSOR_FILTER_ORDER_CLASS property indicates the name of a class that must implement the XBRLFilterOrderTool interface. That class will be used to obtain the order in which the filters bind to a variable evaluation will be added to the final XPath 2 expression.
    The default value of this property is an instance of the XBRLFilterOrderTool interface that passes all test cases in the formula conformance suite.
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_USE_GLOBAL_PARAMETERS
```
public static final java.lang.String FORMULA_PROCESSOR_USE_GLOBAL_PARAMETERS
```
    The original version of the variables specification (The already approved recommendation) considers that parameters must have arcs connecting the parameter with the variable set using it. This is written in the paragraph that says:
    The @name attribute on a parameter declaration contains the QName of the parameter being declared. This is the QName used by the variable processor to uniquely identify the parameter when setting its value. It is not the QName by which the parameter is referenced when it is used. That QName is specified by relationship of the parameter to the resource that makes use of it.
    http://www.xbrl.org/Specification/variables/REC-2009-06-22/variables-REC-2009-06-22.html#sec-parameters
    
    The proposed edit recommendation (still not a recommendation) published on 2011-10-19 contains a different wording and effectively makes parameters global, but there is no additional documentation about this change in the document. The new wording says:
    The @name attribute on a parameter declaration contains the QName of the parameter being declared. This QName MAY be used within any XPath expression as a global QName to access the parameter. Additionally the parameter MAY be referenced by a QName specified on relationship of the parameter to a resource that makes use of it.
    http://www.xbrl.org/Specification/variables/PER-2011-10-19/variables-PER-2011-10-19.html#sec-parameters
    
    This property allows the Formula Processor to consider parameters as global resources as indicated in the new PER of 2011. If the value is "true" the new interpretation is considered. If the value is "false" the old (recommended) interpretation is used. The default value is "false".
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_SCHEMA_VALIDATE_EXTERNAL_DOCS
```
public static final java.lang.String FORMULA_PROCESSOR_SCHEMA_VALIDATE_EXTERNAL_DOCS
```
    All documents in the DTS must be schema valid. But there may be cases in which an XPath expression that exists in a custom made formula linkbase uses the fn:doc() function to load external files. The recommended behavior is that external XML files were also schema valid but it has been noticed this is not the case in real projects. If this property value is set to 'false' externally loaded documents will not be schema validated. If this property is set to 'true' externally referenced documents will be validated against already loaded schemas and referenced schemas within the document. The default value is 'true'
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE
```
public static final java.lang.String FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE
```
    The FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE establish the behavior of the interrupt call on the DTSContainer instance that is validating formulas. Two possibilities are available: When the value is set to FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE_PROCESSOR the entire processor stops execution. This is the default option. But if this property is set to the FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE_CURRENT value, then just the current formula or assertion under validation is interrupted and validation continues with the next formula or assertion. Note this option will work as expected only when the validation is in single thread mode. If the validation is running under multiple thread mode only one running thread will be interrupted randomly.
    This property has been added in order to allow debugging and optimizations of formulas in a DTS. The idea is to configure the processor in single thread validation mode and measure how long each formula or assertion takes, then, if an assertion is taking too long it could be interrupted and continue with next assertion. We are using the personal validation tool for that purpose and we set this property manually in the launch properties file for the personal validation tool.
    The processor fires a Events.PROCESSOR_INTERRUPTED event when the DTSContainer process has finally executed the interruption. A GUI can add a property change listener on the DTSContainer instance to be informed for this status and enable again the interrupt button if it is disabled
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE_PROCESSOR
```
public static final java.lang.String FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE_PROCESSOR
```
    This is one of the possible values of the FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE property.
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE_CURRENT
```
public static final java.lang.String FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE_CURRENT
```
    This is one of the possible values of the FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE property.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DIMENSIONS_APPLICANCY
```
public static final java.lang.String DEFAULT_DIMENSIONS_APPLICANCY
```
    The DEFAULT_DIMENSIONS_APPLICANCY property indicates how the Formula Functions (this does not affects Dimensions Validation) returns the value of a Fact item when the Fact item is NOT reported for a dimension that contains a default value.
    Background: The desired and natural interpretation of this property should be "Defaults-NOT-apply". Defaults should apply only when the dimension exist on hypercubes linked with the primary item and after that test there should be a question about what the dimension value is. The authors of the formula specification and the base specification working group, surprisingly, has implemented the opposite. According to their interpretation of the Dimensions Specification, default values are always returned for a fact regardless the fact does not contains that dimension declared on any hypercube.
    Due to the reason the interpretation made by the formula WG and base WG is not understandable by business users, this processor allows our users to decide if they want to operate in the "natural mode" of not allowing defaults to appear when they are not desired or in the "anti natural mode" where defaults are always returned.
    The possible values for this parameter are:
    - "Defaults-NOT-apply" which is the natural value users can set in order to see default values when they are desired.
    - "Defaults-ALWAYS-apply" which is undesired, but it is the value that the Formula and Base spec authors has agreed on. (Unfortunately this is the default value in order to pass the International Tests Suites)
    See Also:
    
    Constant Field Values
  - DEFAULTS_NOT_APPLY
```
public static final java.lang.String DEFAULTS_NOT_APPLY
```
    Possible value for the DEFAULT_DIMENSIONS_APPLICANCY property.
    
    See Also:
    
    Constant Field Values
  - DEFAULTS_ALWAYS_APPLY
```
public static final java.lang.String DEFAULTS_ALWAYS_APPLY
```
    Possible value for the DEFAULT_DIMENSIONS_APPLICANCY property.
    
    See Also:
    
    Constant Field Values
  - FORMULA_PROCESSOR_EXCLUSION_FILE
```
public static final java.lang.String FORMULA_PROCESSOR_EXCLUSION_FILE
```
    The FORMULA_PROCESSOR_EXLUSION_FILE property can be set to a file name (using URI notation) that may contain formula or assertion identifiers that the processor will skip evaluation. The file format is one entry per line, blank lines are skipped and lines starting with hash sign '#' are skipped too.
    The default value of this property is not set (or null) and means that all formulas and assertions will be evaluated.
    The file can be absolute or relative. If it is relative the absolute base path to resolve the relative URI is the value of the system property "user.dir"
    
    See Also:
    
    Constant Field Values
  - SERIALIZATION_OUTPUT_DEFAULT_ATTRIBUTE_VALUES
```
public static final java.lang.String SERIALIZATION_OUTPUT_DEFAULT_ATTRIBUTE_VALUES
```
    The SERIALIZATION_OUTPUT_DEFAULT_ATTRIBUTE_VALUES indicates if during the serialization phase (conversion from internal object model representation to the XBRL syntax) the default values for attributes will be explicitly serialized or will be hidden.
    It is a good practice in XML to hide attributes when they have the default values assigned in the XML Schemas. This reduces the file size and maintains the same expressiveness after XML Schema validation, but the US-SEC requires the order attribute to be explicitly serialized on all relationships even if it is meaningless.
    The value can be either "true" or "false". The default value for this property is "false".
    
    See Also:
    
    Constant Field Values
  - SERIALIZATION_OUTPUT_XML_ENCODING
```
public static final java.lang.String SERIALIZATION_OUTPUT_XML_ENCODING
```
    The SERIALIZATION_OUTPUT_XML_ENCODING property can be set to the encoding for XML files produced by the API. The default encoding is "UTF-8"
    Some "modern" projects, still use encodings defined in the old 60s... such as ASCII... If you have to deal with this projects you have to provide the value "ASCII" to this property in order to make sure the output is encoded as ASCII
    
    See Also:
    
    Constant Field Values
  - SERIALIZATION_OUTPUT_XML_ENCODING_DEFAULT
```
public static final java.lang.String SERIALIZATION_OUTPUT_XML_ENCODING_DEFAULT
```
    The Constant SERIALIZATION_OUTPUT_XML_ENCODING_DEFAULT.
    
    See Also:
    
    Constant Field Values
  - SERIALIZATION_OUTPUT_INDENT
```
public static final java.lang.String SERIALIZATION_OUTPUT_INDENT
```
    The SERIALIZATION_OUTPUT_INDENT property can be set to either "yes" or "no".
    The default value is "yes". so the XML is indented and you can see the nesting of XML nodes in a text editor. Change it to "no" if that is not required and you can save some space on disk.
    
    See Also:
    
    Constant Field Values
  - SERIALIZATION_OUTPUT_INDENT_DEFAULT
```
public static final java.lang.String SERIALIZATION_OUTPUT_INDENT_DEFAULT
```
    The Constant SERIALIZATION_OUTPUT_INDENT_DEFAULT.
    
    See Also:
    
    Constant Field Values
  - SERIALIZATION_OUTPUT_OMIT_XML_DECLARATION
```
public static final java.lang.String SERIALIZATION_OUTPUT_OMIT_XML_DECLARATION
```
    The SERIALIZATION_OUTPUT_OMIT_XML_DECLARATION cat be set to either "yes" or "no".
    The default value is "no" so the XML declaration will always be included by default.
    
    See Also:
    
    Constant Field Values
  - SERIALIZATION_OUTPUT_OMIT_XML_DECLARATION_DEFAULT
```
public static final java.lang.String SERIALIZATION_OUTPUT_OMIT_XML_DECLARATION_DEFAULT
```
    The Constant SERIALIZATION_OUTPUT_OMIT_XML_DECLARATION_DEFAULT.
    
    See Also:
    
    Constant Field Values
  - XML_REMOVE_NAMESPACE_DECLARATIONS
```
public static final java.lang.String XML_REMOVE_NAMESPACE_DECLARATIONS
```
    The XML_REMOVE_NAMESPACE_DECLARATIONS property indicates if the toString method in the XMLFragment generates a string with namespace declarations or without namespace declarations. The prefixes will always remain at the elements and attributes but the namespaces can be stripped off.
    The default value of this property is "true" so namespaces will be stripped.
    This property affects GUI tools that outputs text versions of the XML extracted from files or generated internally.
    
    See Also:
    
    Constant Field Values
  - EXPERIMENTAL_USE_CACHED_STRINGS
```
public static final java.lang.String EXPERIMENTAL_USE_CACHED_STRINGS
```
    If this property value is "true", reading XML documents will store all text pieces into a buffer and that buffer will be used when other strings contains sub-strings that can be obtained form the cache. The idea is to store the less number of strings as possible at the cost of spending more time while creating the strings. The default value is "false".
    
    See Also:
    
    Constant Field Values
  - UTR_REPORT_AS_INCONSISTENCY
```
public static final java.lang.String UTR_REPORT_AS_INCONSISTENCY
```
    If this property controls how the UTR processor notifies the facts that does not satisfy the UTR rules. If the value is "true" the notification will be an inconsistency, if the value is "false" the notification will be a validation exception. The message is the same in all cases.
    The default value of this property is "true" so invalid facts will be reported as inconsistencies
    
    See Also:
    
    Constant Field Values
  - FAST
```
public static final int FAST
```
    FAST is a constant for the mode parameter in the isInstanceOfThisDTS(Source, int) function. It indicates that the comparison of the DTS will use only the files explicitly referenced in this file and not the files inside files referenced in this file (no recurse discovery of DTS files). This is faster but DTSs that contains the same files using different starting points will not be found.
    
    See Also:
    
    Constant Field Values
  - FULL
```
public static final int FULL
```
    FULL is a constant for the mode parameter in the isInstanceOfThisDTS(Source, int) function. It indicates that the comparison of the DTS will use all files in the DTS of both documents. This is slowest than FAST comparison but will detect all DTS that are the same DTS regardless the starting points of discovery are the same on both DTSs under comparison.
    
    See Also:
    
    Constant Field Values
  - FAIL_STRATEGY
```
public static final java.lang.String FAIL_STRATEGY
```
    The FAIL_STRATEGY property allows for the processor to modify when the errors will be reported. This also impacts the number of errors detected. There are two possible values for this parameter, either "fail-fast" or "fail-slow". When the value is set to "fail-fast" an error detected might stop processing immediately and the error reported to the calling application in the form of an Exception. When the value is set to "fail-slow", the error might be stored in the internal validation report (can be obtained via getValidationReport()) and the process continue. The default (and recommended) value is "fail-fast" Note: The motivation of this feature is the capacity to load iXBRL reports that contains format errors. We didn't want to stop the processor with an XPathException indicating this condition too early. But, if you set "fail-slow" there might appear additional errors in the validation report that are related with missing facts because some facts will not be properly loaded. YOU ARE WARNED
    
    Since:
    
    3.7.2
    
    See Also:
    
    https://www.martinfowler.com/ieeeSoftware/failFast.pdf, Constant Field Values
  - FAIL_FAST
```
public static final java.lang.String FAIL_FAST
```
    This is the default and recommended value for the FAIL_STRATEGY property
    
    See Also:
    
    FAIL_STRATEGY, Constant Field Values
  - FAIL_SLOW
```
public static final java.lang.String FAIL_SLOW
```
    This is the alternate value for the FAIL_STRATEGY property
    
    See Also:
    
    FAIL_STRATEGY, Constant Field Values
  - LOGGER_NAME
```
public static final java.lang.String LOGGER_NAME
```
    LOGGER_NAME is defined as com.ihr.xbrl and is final
    
    See Also:
    
    Constant Field Values
  - log
```
public transient org.apache.log4j.Logger log
```
    All log information goes through this logger.
  - GENERATION_MODE_NODEINFO
```
public static final int GENERATION_MODE_NODEINFO
```
    ORIGINAL serialization method means that the serialization of this object will be made using the document that was first read from source file. This consumes more memory but is safer in terms of storing into the database the same objects that were sent to the processor. This is a global setting for all linkbases, schemas and instance documents.
    
    See Also:
    
    Constant Field Values
  - GENERATION_MODE_OBJECTS
```
public static final int GENERATION_MODE_OBJECTS
```
    GENERATION_MODE_OBJECTS serialization method means that the serialization of this object will be made using the object model and objects in the infoset.
    
    See Also:
    
    Constant Field Values
  - ADQUIRE_EXTENDED_LOCK
```
public static final int ADQUIRE_EXTENDED_LOCK
```
    Constant to be used as flag for specialValidation(SpecialValidationProcess, int, Object[])
    the calling process will adquire the lock for the extended links so it can create temporary extended links that will be deleted before exiting validation.
    
    See Also:
    
    Constant Field Values
  - ADQUIRE_ROLETYPES_BY_EXT_LINK_LOCK
```
public static final int ADQUIRE_ROLETYPES_BY_EXT_LINK_LOCK
```
    Constant to be used as flag for specialValidation(SpecialValidationProcess, int, Object[])
    The calling process will adquire the lock for the roles by extended link.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - shutdown
```
public static void shutdown()
```
    The shutdown method has been created to allow a web applications to gracefully stop all DTSContainer threads.
  - setProperty
```
public void setProperty(java.lang.String name,
                        java.lang.String value)
```
    Sets a DTSConfiguration property. This method does not change the configuration of the currently created DTSContainer it just sets or change the value of one of the properties. If another DTSContainer is created from this properties then, the new DTSContainer will be configured according witht he properties set here
    
    Parameters:
    
    name - property name
    
    value - property value as string
  - setVariablesForProcessors
```
public void setVariablesForProcessors(java.util.Properties variables)
```
    Variables is a new machanism to pass information from an external application to a custom processor. Before the validation starts, the DTSContainer can be set to a some properties and the properties are available from the validators. A custom validator can read the variables and act in consequence.
    
    Parameters:
    
    variables - Properties instance
    
    Since:
    
    2.7.5
  - getVariablesForProcessors
```
public java.util.Properties getVariablesForProcessors()
```
    Access to the variables that has been set to be available for processors. This method returns null if no variables has been set. Call setVariablesForProcessors(Properties) in order to set the properties instance
    
    Returns:
    
    Properties or null
    
    Since:
    
    2.7.5
  - setProperties
```
public void setProperties(java.util.Properties newProps)
```
    Internal method using during class constructors to set the properties of this DTSContainer.
    
    Parameters:
    
    newProps - Properties
  - getProperties
```
public java.util.Properties getProperties()
```
    Access to the properties of this DTSContainer.
    Properties are set during the creation of the DTSContainer to their default or indicated values.
    Warning, changes in the values of some properties in a DTS already created may or may not be a safe operation.
    
    Returns:
    
    Properties object
  - hashCode
```
public int hashCode()
```
    Hash code.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the int
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Equals.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the obj
    
    Returns:
    
    true, if successful
  - registerBar
```
public void registerBar(DTSLoadingBarInterface bar)
```
    Register bar.
    
    Specified by:
    
    registerBar in interface Stopable
    
    Parameters:
    
    bar - the bar
  - getRegisteredBar
```
public DTSLoadingBarInterface getRegisteredBar()
```
    If this DTSContainer has a registered object that implements the DTSLoadingBarInterface interface this function returns it. Otherwise it returns null.
    This function is used internally by the API in order to send messages to the GUI during the process of dts discovery and loading a DTS into the object model.
    
    Returns:
    
    DTSLoadingBarInterface
    
    Since:
    
    2.6.8
  - getDTSURIResolver
```
public javax.xml.transform.URIResolver getDTSURIResolver()
```
    Access to the URIResolver of this DTSContainer. The URIResolver can be changed if there is a need to obtain documents from different sources like a database, cache etc. Some URIResolvers like the DatabaseURIResolver operates in cascade mode and requires to know the current URIResolver in order to set it as the next resolver in the cascade.
    
    Returns:
    
    URIResolver
  - installDTSURIResolver
```
public void installDTSURIResolver(javax.xml.transform.URIResolver resolver)
```
    Sets a new resolver to this DTSContainer object. The URIResolver will be used to locate files in the DTS.
    
    Parameters:
    
    resolver - the resolver
    
    Since:
    
    2.6.11
  - installFormulaParameterResolver
```
public void installFormulaParameterResolver(XBRLFormulaParametersResolver parameterResolver)
```
    Sets a new resolver to this XBRLFormulaParametersResolver object. The XBRLFormulaParametersResolver will be used to obtain formula parameters during formula evaluation.
    
    Parameters:
    
    parameterResolver - the parameter resolver
    
    Since:
    
    2.7.1
  - doCallInstallDTSURIResolver
```
public void doCallInstallDTSURIResolver(HasCreateDTSUriResolver instanceClass)
```
    Executes a call to the method createAndRegisterDTSUriResolver on the class passed in as a parameter.
    
    Parameters:
    
    instanceClass - instance of a class implementing the interface HasCreateDTSUriResolver
    
    Since:
    
    2.6.11
  - doCallInstallFormulaParameterResolver
```
public void doCallInstallFormulaParameterResolver(HasCreateFormulaParameterResolver instanceClass)
```
    Do call install formula parameter resolver.
    
    Parameters:
    
    instanceClass - the instance class
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of this DTS to the specified name. DTS Names are useful for GUIs only
    
    Parameters:
    
    name - the new name
  - getName
```
public java.lang.String getName()
```
    Returns back the DTS name, this is useful for GUIs only. If the dts name is not set, this function provides a new name for this DTS that is the constant string "DTS" followed by a number that will be incremented on each use.
    
    Returns:
    
    String, never returns null
  - clear
```
public void clear()
           throws java.lang.Throwable
```
    Similarly to the clear method in collections, this method frees up memory and resources used in this object. Do not call this method unless you are absolutely sure the DTS is no longer needed anymore. This includes objects created and using this DTS as a reference.
    
    Throws:
    
    java.lang.Throwable - the throwable
  - newEmptyContainer
```
public static DTSContainer newEmptyContainer()
                                      throws com.rs.lic.LicenseVerificationException
```
    Method used to create a new empty DTSContainer.
    After object instantiation you may be interested in using any of the load methods in order to load the DTS into the container.
    The default DTSContainer created using this method takes the default value for all DTS properties.
    The USE_CACHE_PROPERTY value is true
    
    Returns:
    
    DTSContainer
    
    Throws:
    
    com.rs.lic.LicenseVerificationException - the license verification exception
    
    Since:
    
    1.0
  - newEmptyContainer
```
public static DTSContainer newEmptyContainer(java.util.Properties props)
                                      throws com.rs.lic.LicenseVerificationException
```
    Method used to create a new empty DTSContainer. Use the load method to load the DTS into the container
    
    Parameters:
    
    props - Properties to configure the processor. null for using default values for all properties. The processor creates a local copy of the properties indicated here so during cleanUp phase of this DTS the properties used on this call will not be reset, but the properties effectively used in the report will.
    
    Returns:
    
    DTSContainer
    
    Throws:
    
    com.rs.lic.LicenseVerificationException - the license verification exception
  - newCompatibleContainer
```
public static DTSContainer newCompatibleContainer(net.sf.saxon.s9api.Processor proc,
                                                  java.util.Properties props)
                                           throws com.rs.lic.LicenseVerificationException
```
    Creates a new DTSContainer that is compatible with the Processor suppied as a parameter. This is useful when there will be XPath Expressions executed in the application that requires also access to XBRL nodes.
    
    Parameters:
    
    proc - Processor (saxonica s9api)
    
    props - Properties. May be null.
    
    Returns:
    
    DTSContainer
    
    Throws:
    
    com.rs.lic.LicenseVerificationException - the license verification exception
  - newCompatibleContainer
```
public static DTSContainer newCompatibleContainer(DTSContainer otherContainer,
                                                  java.util.Properties props)
                                           throws com.rs.lic.LicenseVerificationException
```
    Creates a new DTSContainer that is compatible with the Processor suppied as a parameter. This is useful when there will be XPath Expressions executed in the application that requires also access to XBRL nodes.
    
    Parameters:
    
    otherContainer - DTSContainer the container the new container must be compatible with
    
    props - Properties. May be null.
    
    Returns:
    
    DTSContainer
    
    Throws:
    
    com.rs.lic.LicenseVerificationException - the license verification exception
  - getCompatibleProcessor
```
public static net.sf.saxon.s9api.Processor getCompatibleProcessor(net.sf.saxon.s9api.Processor compatWith,
                                                                  boolean schemaAware)
```
    Gets the compatible processor.
    
    Parameters:
    
    compatWith - the other Processor the new processor must be cmpatible with
    
    schemaAware - the schema aware
    
    Returns:
    
    the compatible processor
  - mergeDTSs
```
public static DTSContainer mergeDTSs(DTSContainer[] dtss)
                              throws com.rs.lic.LicenseVerificationException
```
    Merges several DTSs into a single DTS.
    
    Parameters:
    
    dtss - DTSContainer[] array of DTSs to merge into a single DTS
    
    Returns:
    
    DTSContainer
    
    Throws:
    
    com.rs.lic.LicenseVerificationException - Only thrown when the license is limited to a set of files and there is a file in the DTS that is out of the valid list of files under the license
  - getStaticContainer
```
public static DTSContainer getStaticContainer()
```
    The static container exist only for static objects like standard roleTypes and standard arcroleTypes that are not used on any specific DTS. When a static role type is used in a DTS a copy of the static role type is returned instead and the dts of that role type is changed from the static dts container to the calling container.
    
    Returns:
    
    DTSContainer
  - addDocumentToDTS
```
public void addDocumentToDTS(XBRLDTSDocument d)
```
    Adds a document to the DTS container objects. Depending on the document type this is added to different object containers.
    
    Parameters:
    
    d - XMLDocumentURI
  - specialValidation
```
public java.lang.Object[] specialValidation(SpecialValidationProcess process,
                                            int flags,
                                            java.lang.Object[] arguments)
                                     throws XBRLValidationException
```
    Performs a special validation process that requires adquisition of internal locks that are only available inside the DTSContainer. Using this method prevents multiple threads to access (and modify) DTSContainer collections that are also accessed from Iterators.
    Not using this method may cause ConcurrentModificationException if one thread is using an iterator over a collection and the other thread modifies the collection.
    
    Parameters:
    
    process - this is the process implementation instance
    
    flags - OR bitmap indicating the locks to adquire see ADQUIRE_EXTENDED_LOCK and ADQUIRE_ROLETYPES_BY_EXT_LINK_LOCK
    
    arguments - the arguments
    
    Returns:
    
    whatever is returned from the SpecialValidationProcess.processImpl method
    
    Throws:
    
    XBRLValidationException - to allow the SpecialValidationProcess to raise any validation exception
    
    See Also:
    
    SpecialValidationProcess
  - delDocumentFromDTS
```
public void delDocumentFromDTS(XBRLDTSDocument d)
```
    Del document from dts.
    
    Parameters:
    
    d - the d
  - save
```
public void save()
          throws XBRLSerializationException
```
    Save all files in the DTS. Files loaded from the web or official locations cached to local files will not be saved and will be silently ignored. Only files with a file: URI scheme will be saved. Instance documents are not part of the DTS so they are not saved calling this method.
    
    Throws:
    
    XBRLSerializationException - the XBRL serialization exception
    
    Since:
    
    2.6.4
  - isDocumentInDTSAndProcess
```
public boolean isDocumentInDTSAndProcess(XBRLDTSDocument d)
```
    If the document is alreay part of the DTS this method returns true. If the document is not part of the DTS this method adds it to the DTS by calling the addDocumentToDTS(XBRLDTSDocument) method and returns false.
    This method is syncronized to allow multiple threads to request adding a document to the DTS.
    This method is used by teh API to execute dts discovery on a XBRL Document
    
    Parameters:
    
    d - XMLDocumentURI
    
    Returns:
    
    boolean
  - isDocumentInDTS
```
public boolean isDocumentInDTS(java.net.URI documentURI)
```
    Returns true if a document pointed to by the documentURI parameter is in the DTS.
    
    Parameters:
    
    documentURI - the document URI
    
    Returns:
    
    boolean
  - isDocumentInDTS
```
public boolean isDocumentInDTS(java.lang.Integer key)
```
    Returns true if the document is in the DTS.
    Note, the parameter is a URI key obtained by calling getURICode(URI)
    Keys that are part of the DTS are Taxonomies, Linkbases. This API assigns keys to Extended links inside linkbases for optimization purposes so it is valid asking if an ExtendedLink key is part of the DTS.
    
    Parameters:
    
    key - the Document Key to search for. This is the the Integer returned by the XBRLDTSDocument.getDTSKey() method.
    
    Returns:
    
    boolean
    
    See Also:
    
    isDocumentKeyInDTS(Integer)
  - isDocumentKeyInDTS
```
public boolean isDocumentKeyInDTS(java.lang.Integer docCode)
```
    Returns true of the document key is part of the DTS.
    
    Parameters:
    
    docCode - the doc code
    
    Returns:
    
    true if the document is already included in the DTS
    
    See Also:
    
    isDocumentInDTS(Integer)
  - getBaseTypes
```
public java.util.Iterator<javax.xml.namespace.QName> getBaseTypes()
```
    Returns an iterator over the QNames of all DTSBases in the DTS this is all types of containers of relationships.
    
    Returns:
    
    Iterator<QName> iterator over base types
  - getBaseRoles
```
public java.util.Iterator<XBRLRoleType> getBaseRoles(javax.xml.namespace.QName linkbaseType)
```
    Iterator over all roles used on xlink:role attributes on extended links Iterator elements can be casted to XBRLRoleType objects.
    
    Parameters:
    
    linkbaseType - QName of the extended link type
    
    Returns:
    
    Iterator<XBRLRoleType> an Iterator over all XBRLRoleType objects used in the DTS
  - addRoleTypeForExtendedLink
```
public void addRoleTypeForExtendedLink(javax.xml.namespace.QName linkbaseType,
                                       XBRLRoleType role)
```
    Adds or increases the count of role types for a linkbase type. Used internally by the API. Do not use or use at your own risk.
    
    Parameters:
    
    linkbaseType - the linkbase type
    
    role - the role
  - addRoleTypeForExtendedLink
```
public void addRoleTypeForExtendedLink(javax.xml.namespace.QName linkbaseType,
                                       java.lang.Integer role)
```
    Adds or increases the count of role types for a linkbase type. Used internally by the API. Do not use or use at your own risk.
    
    Parameters:
    
    linkbaseType - the linkbase type
    
    role - the role
  - delRoleTypeForExtendedLink
```
public void delRoleTypeForExtendedLink(javax.xml.namespace.QName linkbaseType,
                                       XBRLRoleType role)
```
    Removes or decreases the count of role types for a linkbase type. Used internally by the API. Do not use or use at your own risk.
    
    Parameters:
    
    linkbaseType - the linkbase type
    
    role - the role
  - delRoleTypeForExtendedLink
```
public void delRoleTypeForExtendedLink(javax.xml.namespace.QName linkbaseType,
                                       java.lang.Integer role)
```
    Removes or decreases the count of role types for a linkbase type. Used internally by the API. Do not use or use at your own risk.
    
    Parameters:
    
    linkbaseType - the linkbase type
    
    role - the role
  - isRoleTypeUsed
```
public boolean isRoleTypeUsed(java.lang.String roleType)
```
    Helper method to ask the DTS if a certain role type is used.
    Note the role type is passed in as string to avoid having to create an instance of XBRLRoleType type. If this method returns true, getRoleType(roleType) will return at least one XBRLRoleType instance.
    This method is guaranteed to keep the DTSContainer variables untouched
    
    Parameters:
    
    roleType - the role type to check.
    
    Returns:
    
    true if the roleType is defined in the DTS or the specifications and it is used by elements allowed to use it
  - isArcroleTypeUsed
```
public boolean isArcroleTypeUsed(java.lang.String arcroleType)
```
    Helper method to ask the DTS if a certain arc role type is used.
    Note the arc role type is passed in as string to avoid having to create an instance of XBRLArcroleType type. If this method returns true, getArcroleType(arcroleType) will return at least one XBRLArcroleType instance.
    This method is guaranteed to keep the DTSContainer variables untouched
    
    Parameters:
    
    arcroleType - the arc role type to check.
    
    Returns:
    
    true if the arcroleType is defined in the DTS or the specifications and it is used by elements allowed to use it
  - isBaseDefined
```
public boolean isBaseDefined(javax.xml.namespace.QName linkbaseType,
                             java.lang.Integer role)
```
    Returns true if there is a DTSbase defined in the DTS for the given role and of the specified linkbaseType.
    
    Parameters:
    
    linkbaseType - QName
    
    role - XBRLRoleType
    
    Returns:
    
    boolean
  - isBaseDefined
```
public boolean isBaseDefined(javax.xml.namespace.QName linkbaseType,
                             XBRLRoleType role)
```
    Returns true if there is a DTSbase defined in the DTS for the given role and of the specified linkbaseType.
    
    Parameters:
    
    linkbaseType - QName
    
    role - XBRLRoleType
    
    Returns:
    
    boolean
  - getBase
```
public DTSBase getBase(javax.xml.namespace.QName linkbaseType,
                       XBRLRoleType role)
```
    Obtains a base for the specified linkbaseType and role type.
    bases are stored in a cache of returned bases to accelerate applications
    if a DTSBase is not found a new empty DTSBase is created. if no DTS has been loaded or the DTS loading process was interrupted then null is returned.
    if a loop of this type:
```
 Iterator<XBRLRoleType> iterR = dts.getBaseRoles(DefinitionLinkbase.lbType);
  while (iterR.hasNext()) {
   XBRLRoleType rt = iterR.next();
   // add it only if there are "all" relationships in there
   DTSBase base = dts.getBase(DefinitionLinkbase.lbType, rt);
   ...
  }
 }
 
```
    the call to getBase may modify the surrounding iterator and produce an exception in the next cycle. The solution is to call isBaseDefined(QName, XBRLRoleType) before calling getBase(QName, XBRLRoleType)
    a base is an object that contains a set of extended links of the same linkbaseType and role. Multiple relationships with different arcroles are inside the same base object.
    Parameters:
    
    linkbaseType - QName
    
    role - XBRLRoleType
    
    Returns:
    
    DTSBase object
  - getBase
```
public DTSBase getBase(javax.xml.namespace.QName linkbaseType,
                       java.lang.Integer role)
```
    Obtains a base for the specified linkbaseType and role type.
    bases are stored in a cache of returned bases to accelerate applications
    if a DTSBase is not found a new empty DTSBase is created. if no DTS has been loaded or the DTS loading process was interrupted then null is returned.
    if a loop of this type:
```
 Iterator<XBRLRoleType> iterR = dts.getBaseRoles(DefinitionLinkbase.lbType);
  while (iterR.hasNext()) {
   XBRLRoleType rt = iterR.next();
   // add it only if there are "all" relationships in there
   DTSBase base = dts.getBase(DefinitionLinkbase.lbType, rt);
   ...
  }
 }
 
```
    the call to getBase may modify the surrounding iterator and produce an exception in the next cycle. The solution is to call isBaseDefined(QName, XBRLRoleType) before calling getBase(QName, XBRLRoleType)
    a base is an object that contains a set of extended links of the same linkbaseType and role. Multiple relationships with different arcroles are inside the same base object.
    Parameters:
    
    linkbaseType - QName
    
    role - XBRLRoleType
    
    Returns:
    
    DTSBase object
  - getBaseRoleTypes
```
public java.util.Iterator<XBRLRoleType> getBaseRoleTypes(javax.xml.namespace.QName extendedLinkQName)
```
    Return an iterator over all XBRLRoleType elements where DTSBase exists. If there are none an empty iterator is returned
    
    Parameters:
    
    extendedLinkQName - QName
    
    Returns:
    
    Iterator<XBRLRoleType>
  - getBaseRoleCodes
```
public java.util.Iterator<java.lang.Integer> getBaseRoleCodes(javax.xml.namespace.QName extendedLinkQName)
```
    Same as getBaseRoleTypes(QName) but returns an iterator over integers that are unique codes for the role types which might be faster to process on some occassions.
    
    Parameters:
    
    extendedLinkQName - QName
    
    Returns:
    
    Iterator<Integer>
  - getConfiguration
```
public net.sf.saxon.s9api.Processor getConfiguration()
```
    Obtains the Saxonica Processor object used by all elements in this DTS.
    
    Returns:
    
    Processor
  - recompile
```
public void recompile()
               throws DTSDiscoveryException
```
    Recompile schemas loaded into the schemaconfiguration. This method would be only called by DTS editors that requires the schemas in the DTS to be loaded again
    
    Throws:
    
    DTSDiscoveryException - the DTS discovery exception
  - collectTopLevelSchemaUsage
```
public void collectTopLevelSchemaUsage(java.net.URI sourceDocumentURI,
                                       java.lang.String namespace,
                                       java.net.URI targetDocumentURI,
                                       boolean bMode)
```
    Collect top level schema usage.
    
    Parameters:
    
    sourceDocumentURI - the source document URI
    
    namespace - the namespace
    
    targetDocumentURI - the target document URI
    
    bMode - the b mode
  - getFastConfiguration
```
public net.sf.saxon.s9api.Processor getFastConfiguration()
```
    Method to access to the Processor corresponding to this DTSContainer and the status of this DTSContainer.
    If schemas has been already compiled this method returns the shared Processor. If the status of this DTSContainer is still reading external files then a new Processor non schema aware will be created.
    
    Returns:
    
    Processor
  - getNewConfiguration
```
public static DTSContainer.ProcessorAndSchemaCompiler getNewConfiguration(boolean schemaAware,
                                                                          DTSContainer dts,
                                                                          java.util.Properties props)
```
    Creates a new Configuration object. If the new configuration object is SchemaAware then the core schemas for XBRL are loaded.
    
    Parameters:
    
    schemaAware - boolean (true if the new configuration object MUST be schema aware)
    
    dts - a DTSContainer object suitable to provide schemas from the cache or null if not available at this time
    
    props - Properties to the DTSConfiguration object
    
    Returns:
    
    ProcessorAndSchemaCompiler
  - configureJavaProxy
```
public static void configureJavaProxy(java.util.Properties props)
```
    Configures java virtual machine proxy according with the properties received. This method is called automatically when a new DTSContainer is created. On version 2.8.5 this method has been exposed to allow the GUIs to initialize the jvm proxies before any DTSContainer is created. In any case, properties must be set prior to call this method.
    
    Parameters:
    
    props - the properties to obtain information from
    
    See Also:
    
    for information about the standard properties., for information about the proxy authenticator instance
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Add a PropertyChangeListener to the listener list. The listener is registered for all properties. The same listener object may be added more than once, and will be called as many times as it is added. If listener is null, no exception is thrown and no action is taken.
    
    Parameters:
    
    listener - The PropertyChangeListener to be added
    
    Since:
    
    2.8.6
    
    See Also:
    
    addPropertyChangeListener(String, PropertyChangeListener)
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties. If listener was added more than once to the same event source, it will be notified one less time after being removed. If listener is null, or was never added, no exception is thrown and no action is taken.
    
    Parameters:
    
    listener - The PropertyChangeListener to be removed
  - getPropertyChangeListeners
```
public java.beans.PropertyChangeListener[] getPropertyChangeListeners()
```
    Returns an array of all the listeners that were added to the PropertyChangeSupport object with addPropertyChangeListener().
    If some listeners have been added with a named property, then the returned array will be a mixture of PropertyChangeListeners and PropertyChangeListenerProxys. If the calling method is interested in distinguishing the listeners then it must test each element to see if it's a PropertyChangeListenerProxy, perform the cast, and examine the parameter.
```
 PropertyChangeListener[] listeners = bean.getPropertyChangeListeners();
 for (int i = 0; i < listeners.length; i++) {
   if (listeners[i] instanceof PropertyChangeListenerProxy) {
         PropertyChangeListenerProxy proxy =
                                        (PropertyChangeListenerProxy)listeners[i];
         if (proxy.getPropertyName().equals("foo")) {
           // proxy is a PropertyChangeListener which was associated
           // with the property named "foo"
         }
   }
 }
 
```
    Returns:
    
    all of the PropertyChangeListeners added or an empty array if no listeners have been added
    
    Since:
    
    1.4
    
    See Also:
    
    PropertyChangeListenerProxy
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
```
    Add a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property. The same listener object may be added more than once. For each property, the listener will be invoked the number of times it was added for that property. If propertyName or listener is null, no exception is thrown and no action is taken.
    
    Parameters:
    
    propertyName - The name of the property to listen on. see XBRLEvent
    
    listener - The PropertyChangeListener to be added
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
```
    Remove a PropertyChangeListener for a specific property. If listener was added more than once to the same event source for the specified property, it will be notified one less time after being removed. If propertyName is null, no exception is thrown and no action is taken. If listener is null, or was never added for the specified property, no exception is thrown and no action is taken.
    
    Parameters:
    
    propertyName - The name of the property that was listened on.
    
    listener - The PropertyChangeListener to be removed
  - getPropertyChangeListeners
```
public java.beans.PropertyChangeListener[] getPropertyChangeListeners(java.lang.String propertyName)
```
    Returns an array of all the listeners which have been associated with the named property.
    
    Parameters:
    
    propertyName - The name of the property being listened to
    
    Returns:
    
    all of the PropertyChangeListeners associated with the named property. If no such listeners have been added, or if propertyName is null, an empty array is returned.
    
    Since:
    
    1.4
  - firePropertyChangeEvent
```
public void firePropertyChangeEvent(java.lang.String propertyName,
                                    java.lang.Object oldValue,
                                    java.lang.Object newValue)
```
    Convenient method to fire a property change event.
    
    Parameters:
    
    propertyName - the event name to fire
    
    oldValue - the old property value
    
    newValue - the new property value
  - firePropertyChangeEvent
```
public void firePropertyChangeEvent(java.lang.Object source,
                                    java.lang.String propertyName,
                                    java.lang.Object oldValue,
                                    java.lang.Object newValue)
```
    Convenient method to fire a property change event.
    
    Parameters:
    
    source - the object the property changed
    
    propertyName - the event name to fire
    
    oldValue - the old property value
    
    newValue - the new property value
  - getNextDocumentKeyCode
```
public int getNextDocumentKeyCode()
```
    Provides a new document code but does not store the document into the DTSContainer yet.
    
    Returns:
    
    the new document code
    
    Since:
    
    2.8.7
  - setDocumentCode
```
public XBRLDTSDocument setDocumentCode(XBRLDTSDocument document)
```
    Store (or replace) a document in the document cache. The document must have a key obtained by a call to getNextDocumentCode() in a previous step
    
    Parameters:
    
    document - the document
    
    Returns:
    
    the previously stored document for the same key value (normally null)
    
    Since:
    
    2.8.7
  - getCodeDocument
```
public XBRLDTSDocument getCodeDocument(java.lang.Integer code)
```
    Access to a document by the document key. The document key is the number assigned to a document by calling XBRLDTSDocument.getDTSKey()
    
    Parameters:
    
    code - the document key
    
    Returns:
    
    the indexed document that is an inscance of XBRLDTSDocument interface
    
    Since:
    
    2.8.7
  - replaceDocument
```
public void replaceDocument(java.lang.Integer code,
                            XBRLDTSDocument newdocument)
```
    Replaces a document already stored in the DTS by a new document version using the code passed in as parameter.
    
    Parameters:
    
    code - the code
    
    newdocument - the newdocument
  - removeCodeDocument
```
public void removeCodeDocument(java.lang.Integer code)
```
    Removes a document from the document cache.
    
    Parameters:
    
    code - the document key code to remove
  - addParent
```
public boolean addParent(java.lang.Integer documentCode,
                         java.lang.Integer parentToAdd)
```
    Stores a parent document to another document
    
    Parameters:
    
    documentCode - this is the document key code of the document a parent will be added
    
    parentToAdd - this is the document key code of the parent document to add
    
    Returns:
    
    true if the parent is new and has been added or false if the parent already existed
    
    Since:
    
    2.8.7
  - removeParent
```
public boolean removeParent(java.lang.Integer documentCode,
                            java.lang.Integer parentToRemove)
```
    Removes a parent document to another document. This method does nothing if the parentToRemove is not in the paretns list of the documentCode
    
    Parameters:
    
    documentCode - the document key a parent will be removed
    
    parentToRemove - the parent document key to remove
    
    Returns:
    
    true if succesfully removed or false if the parentToRemove was not in the parents list
    
    Since:
    
    2.8.7
  - getParentsCount
```
public int getParentsCount(java.lang.Integer documentCode)
```
    Returns the number of parents of a document.
    
    Parameters:
    
    documentCode - the document code the parents will be returned
    
    Returns:
    
    the number of parents of document indicated by documentCode
    
    Since:
    
    2.8.7
  - getChildrenCount
```
public int getChildrenCount(java.lang.Integer documentCode)
```
    Returns the number of children of a document.
    
    Parameters:
    
    documentCode - the document code the children will be returned
    
    Returns:
    
    the number of children of document indicated by documentCode
    
    Since:
    
    2.8.7
  - addChild
```
public boolean addChild(java.lang.Integer documentCode,
                        java.lang.Integer childToAdd)
```
    Stores a child document to another document
    
    Parameters:
    
    documentCode - this is the document key code of the document a child will be added
    
    childToAdd - this is the document key code of the child document to add
    
    Returns:
    
    true if the child is new and has been added or false if the child already existed
    
    Since:
    
    2.8.7
  - removeChild
```
public boolean removeChild(java.lang.Integer documentCode,
                           java.lang.Integer childToRemove)
```
    Removes a child document to another document. This method does nothing if the childToRemove is not in the children list of the documentCode
    
    Parameters:
    
    documentCode - the document a child will be removed
    
    childToRemove - the child document to remove
    
    Returns:
    
    true if succesfully removed or false if the childToRemove was not in the children list
    
    Since:
    
    2.8.7
  - getParents
```
public java.util.Set<java.lang.Integer> getParents(java.lang.Integer documentCode)
```
    Returns a set of document parents.
    
    Parameters:
    
    documentCode - the document the parents will be returned
    
    Returns:
    
    set of integers
    
    Since:
    
    2.8.7
  - getChildren
```
public java.util.Set<java.lang.Integer> getChildren(java.lang.Integer documentCode)
```
    Returns a set of document children.
    
    Parameters:
    
    documentCode - the document the children will be returned
    
    Returns:
    
    set of integers
    
    Since:
    
    2.8.7
  - removeAllChildren
```
public java.util.Set<java.lang.Integer> removeAllChildren(java.lang.Integer documentCode)
```
    removes all children documents of documentCode. This method is called when the clear() method is called in the document
    
    Parameters:
    
    documentCode - the document code all children will be removed
    
    Returns:
    
    set of integers that where children of document code (might be null)
    
    Since:
    
    2.8.7
  - removeAllParent
```
public void removeAllParent(java.lang.Integer documentCode)
```
    removes all parent documents of documentCode. This method is called when the clear() method is called in the document
    
    Parameters:
    
    documentCode - the document code all parents will be removed
    
    Since:
    
    2.8.7
  - getNewURICode
```
public java.lang.Integer getNewURICode(java.net.URI uri)
```
    Stores a new URI to the cache and returns the assigned code. If the URI is already stored, the existing code is returned. URI stored does not contains URI fragment part
    
    Parameters:
    
    uri - the uri
    
    Returns:
    
    the new URI code
  - getNoNormalURIs
```
public java.util.Set<java.net.URI> getNoNormalURIs()
```
    Obtains URIs that has been normalized during the DTS loading process.
    This method allows to raise a warning later and tell the user about rare URIs in the files
    
    Returns:
    
    Set of URIs
    
    Since:
    
    3.1.0
  - getURICode
```
public java.lang.Integer getURICode(java.net.URI uri)
```
    Returns a URI code for a URI that is already stored if the URI was not stored this method returns null and the uri is not stored.
    URI codes are used, for example, to store loaded documents into the documents cache
    
    Parameters:
    
    uri - the uri
    
    Returns:
    
    the URI code
    
    See Also:
    
    getNewURICode(URI)
  - getCodeURI
```
public java.net.URI getCodeURI(java.lang.Integer code)
```
    Returns the URI stored for the code passed as parameter the special value -1 returns the empty URI.
    
    Parameters:
    
    code - the code
    
    Returns:
    
    stored URI or null if not set and code is not -1
  - replaceURICode
```
public void replaceURICode(java.lang.Integer uriCode,
                           java.net.URI newURI)
```
    This method replaces an existing URI by a new URI but maintains the same uriCode.
    
    Parameters:
    
    uriCode - the uri code
    
    newURI - the new URI
  - removeChangeIdListener
```
public void removeChangeIdListener(net.sf.saxon.om.DocumentInfo physicalRoot)
```
    Removes the change id listener.
    
    Parameters:
    
    physicalRoot - the physical root
  - addChangeIdListener
```
public void addChangeIdListener(net.sf.saxon.om.DocumentInfo physicalRoot,
                                java.beans.PropertyChangeListener changeIdListener)
```
    Adds the change id listener.
    
    Parameters:
    
    physicalRoot - the physical root
    
    changeIdListener - the change id listener
  - fireChangeIdEvent
```
public void fireChangeIdEvent(XMLFragment xmlFragment,
                              java.lang.String oldId,
                              java.lang.String id)
```
    Fire change id event.
    
    Parameters:
    
    xmlFragment - the xml fragment
    
    oldId - the old id
    
    id - the id
  - cacheContains
```
public boolean cacheContains(java.lang.Integer documentURI)
```
    Interrogates objects in the cache of documents indexed by documentURI returns true if the documentURI is on the cache
    The document URI is normalized and absolutized before the index search operation
    fragments are removed because the cache contains documents.
    
    Parameters:
    
    documentURI - the document uri
    
    Returns:
    
    boolean true if the document refrenced by the documentURI is already in the cache
  - cacheSchemaByNamespace
```
public java.util.Iterator<XBRLTaxonomy> cacheSchemaByNamespace(java.lang.String namespace)
```
    Obtains a series of XBRLTaxonomy objects from the cache based on the namespace declared in the XBRLTaxonomy schema
    Results are not in any specific ordered
    Returns the empty sequence if the namespace is not found in the DTS.
    
    Parameters:
    
    namespace - String
    
    Returns:
    
    Iterator<XBRLTaxonomy> the XBRLTaxonomy object that defines the specified namespace
  - cacheGet
```
public XMLDocumentURI cacheGet(java.net.URI documentURI)
```
    Obtains a document from the cache using the document URI.
    This method obtains the URI code from the DTSContainer and then uses that number to search into the cache.
    
    Parameters:
    
    documentURI - the document URI
    
    Returns:
    
    the XML document URI
  - cacheGet
```
public XMLDocumentURI cacheGet(java.lang.Integer documentURI)
```
    Obtains a document from the cache indexed by document URI The URI is absolutized and normalized before comparison.
    
    Parameters:
    
    documentURI - the document uri
    
    Returns:
    
    The XMLDocumentURI stored in the cache or null if the document is not in the cache
  - cacheSize
```
public int cacheSize()
```
    Returns the number of files in the cache.
    
    Returns:
    
    the int
  - getCacheElement
```
public XMLDocumentURI getCacheElement(int index)
```
    Returns the nth element in the cache.
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the cache element
  - cachePut
```
public void cachePut(XMLDocumentURI documentURI)
              throws DTSDiscoveryException
```
    Stores a document in the cache indexed by document URI The URI is absolutized and normalized before stored being stored.
    
    Parameters:
    
    documentURI - the document uri
    
    Throws:
    
    DTSDiscoveryException - the DTS discovery exception
  - cacheRemove
```
public void cacheRemove(java.lang.Integer documentURI)
```
    Removes a document form the cache. The document is identified by its URI
    
    Parameters:
    
    documentURI - the document uri
  - getResource
```
public XBRLResource getResource(java.lang.Integer code)
```
    Gets the resource.
    
    Parameters:
    
    code - the code
    
    Returns:
    
    the resource
  - cacheResource
```
public XBRLResource cacheResource(XBRLExtendedLink parent,
                                  net.sf.saxon.om.NodeInfo ni,
                                  java.lang.Class<? extends XBRLResource> name)
```
    Obtains a resource from the cache or creates a new resource corresponding to the node supplied as a parameter and stores it in the cache for further reference.
    resources are indexed by the NodeInfo element
    
    Parameters:
    
    parent - - Extended link where the XBRLResource resides. Can be null if the XBRLResource is in the cache.
    
    ni - - NodeInfo, cannot be null
    
    name - - class of the resource to be created if no resource exist in the cache
    
    Returns:
    
    The XBRLResource object from the cache or just created
  - addResource
```
public int addResource(XBRLResource resource)
                throws XBRLDuplicateException
```
    The XBRLResouce initializer calls this method to store a new resource in the DTSContainer cache. This method is for internal use. If the resource comes from a clone of another resource this method might raise XBRLDuplicateException. To avoid this situation, call XBRLResource.setCode(int) with -1 before calling addResource(XBRLResource).
    
    Parameters:
    
    resource - the resource
    
    Returns:
    
    the code assigned to the resource
    
    Throws:
    
    XBRLDuplicateException - the XBRL duplicate exception
  - getSimilarResource
```
public <T extends XBRLResource> T getSimilarResource(T res,
                                                     XBRLExtendedLink el)
```
    This method returns an XBRLResource that already exists in the Extended Link indicated at el and is s_equals2 of res resource or null if no resource is found.
    This method might take long time and should be avoided because all existing resources in the same extended link are examined against res resource until one is found. In order to save memory, there is no a hashMap of resources to compare against. So use with care.
    if res is already on extended link el it will be skipped for comparison.
    
    Type Parameters:
    
    T - the type of the resource to be returned is of the same type of the res resource
    
    Parameters:
    
    res - the resource to search for.
    
    el - the extended link to search for similar resources
    
    Returns:
    
    other resource or null if no resource is s_equals2 to resource res
    
    Since:
    
    3.1
  - getLanguages
```
public java.util.Iterator<java.lang.String> getLanguages()
```
    Returns an iterator over all languages used in labels in the DTS. The order of the languages returned here might not be according with the user preferred languages.
    The user preferred languages list can be obtained from the LangsProviderInstance.
    
    Returns:
    
    Iterator<String>
  - delResource
```
public boolean delResource(XBRLResource resource,
                           java.lang.Integer elCode)
```
    Eliminates a resource form the DTS cache.
    
    Parameters:
    
    resource - the resource
    
    elCode - the code of the extended link where the resource is stored
    
    Returns:
    
    true if the resource has been removed from cache in the DTSContainer
  - isProcessorInProcessorsSequence
```
public boolean isProcessorInProcessorsSequence(java.lang.String processorName)
```
    Returns true if the processor indicated in the processorName parameter is in referenced in the PROCESSORS_SEQUENCE property.
    
    Parameters:
    
    processorName - the processor to check
    
    Returns:
    
    boolean value
    
    Since:
    
    3.5
    
    See Also:
    
    PROCESSORS_SEQUENCE
  - load
```
public XBRLDocument load(java.net.URI url)
                  throws DTSDiscoveryException,
                         com.rs.lic.LicenseVerificationException
```
    Loads a DTS from the indicated url. The DTS Discovery rules starts from the url(s) parameter. If the url is relative, the absolute url is resolved using the base url (uri) obtained form the getBaseURI() method. The processor base uri can be parameterized if that is needed by setting a value to the XBRL_BASE property.
    All files in the DTS are validated against schemas in the DTS and explicitly referenced in the xsi:schemaLocation attributes. Note that those the schemas may not be part of the DTS.
    The load process does not include XBRL 2.1 validation. It includes: just the following steps:
    - DTS discovery
    - Schema validation
    - Infoset process
    At the end of the process, applications can read the process status using the getStatus() method.
    Parameters:
    
    url - an array of Taxonomy schemas, linkbases or instance documents
    
    Returns:
    
    an XBRLDocument object
    
    Throws:
    
    DTSDiscoveryException - if XBRL validation errors occurs during the DTS discovery process
    
    com.rs.lic.LicenseVerificationException - Only thrown when the license is limited to a set of files and there is a file in the DTS for which there is no license
  - load
```
public XBRLDocument[] load(java.net.URI[] url)
                    throws DTSDiscoveryException,
                           com.rs.lic.LicenseVerificationException
```
    Loads a DTS from the url array. The DTS Discovery rules starts at every one of the url(s) in the array. If the url is relative, the absolute url is resolved using the base url (uri) obtained form the getBaseURI() method. The processor base uri can be parameterized if that is needed by setting a value to the XBRL_BASE property.
    All files in the DTS are validated against schemas in the DTS and explicitly referenced in the xsi:schemaLocation attributes. Note that those the schemas may not be part of the DTS.
    The load process does not include XBRL 2.1 validation. It includes: just the following steps:
    - DTS discovery
    - Schema validation
    - Infoset process
    Parameters:
    
    url - an array of Taxonomy schemas, linkbases or instance documents
    
    Returns:
    
    an XBRLDocument object
    
    Throws:
    
    DTSDiscoveryException - if XBRL validation errors occurs during the DTS discovery process
    
    com.rs.lic.LicenseVerificationException - Only thrown when the license is limited to a set of files and there is a file in the DTS for which there is no license
  - load
```
public XBRLDocument load(javax.xml.transform.Source source)
                  throws DTSDiscoveryException,
                         com.rs.lic.LicenseVerificationException
```
    Load a DTS. The DTS Discovery rules start at the URL indicated in the SystemID of the source object received as a parameter. If the uri is relative, the absolute uri is calculated automatically. All files in the DTS are schema validated. Some of the schemas may not be part of the DTS. All Infoset properties of the loaded files are readed The load process does not include XBRL 2.1 validation
    
    Parameters:
    
    source - a Taxonomy schema, linkbase or instance document as a javax.xml.transform.Source. Note the SystemId value in the source will be used for the resolution of relative URLs in the file
    
    Returns:
    
    an XBRLDocument object
    
    Throws:
    
    DTSDiscoveryException - is XBRL errors were found
    
    com.rs.lic.LicenseVerificationException - Only thrown when the license is limited to a set of files and there is a file in the DTS for which there is no license
    
    Since:
    
    2.6.4
  - load
```
public XBRLDocument[] load(javax.xml.transform.Source[] ss)
                    throws DTSDiscoveryException,
                           com.rs.lic.LicenseVerificationException
```
    Load a DTS from a set of urls. The DTS Discovery rules start at every one of the urls in the set. If the url is relative, the absolute uri is calculated automatically using the current folder as the base url. All files in the DTS are schema validated. Some of the schemas may not be part of the DTS. All Infoset properties of the loaded files are readed The load process does not include XBRL 2.1 validation. It includes: - DTS discovery - Schema validation - Infoset process
    
    Parameters:
    
    ss - array of Source objects
    
    Returns:
    
    array of XBRLDocument objects
    
    Throws:
    
    DTSDiscoveryException - the DTS discovery exception
    
    com.rs.lic.LicenseVerificationException - the license verification exception
    
    Since:
    
    2.6.4
  - loadIntoConfiguration
```
public void loadIntoConfiguration()
                           throws XBRLValidationException,
                                  com.rs.lic.LicenseVerificationException
```
    Switch the configuration object to strict schema validation, then loads all documents in this DTS (thus in the cache) into the configuration object. Finally, the Infoset is populated
    
    Throws:
    
    XBRLValidationException - the XBRL validation exception
    
    com.rs.lic.LicenseVerificationException - Thrown if there is a file in the DTS for which the license is not valid. Only happens if the license is limited to a set of files. Open licenses does not generate this exception
  - getRootURI
```
public java.net.URI getRootURI()
```
    Returns the DTS root URI or the starting point of the DTS Discovery. If the DTS was opened from a set of URIs this method returns the first one only. If the DTSContainer is empty, this method returns null
    
    Returns:
    
    a URI or null
  - getRootURIs
```
public java.net.URI[] getRootURIs()
```
    Returns an array of URIs that contains the DTS Discovery starting points.
    
    Returns:
    
    array of URIs or null if not set or not DTS is loaded
  - setRootURI
```
public void setRootURI(java.net.URI newURI)
```
    Sets the root uri.
    
    Parameters:
    
    newURI - the new root uri
  - loadIntoConfiguration
```
public void loadIntoConfiguration(XBRLTaxonomy taxonomy)
                           throws net.sf.saxon.type.SchemaException
```
    Load a new schema into the schema compiler. If the schema already exist in the configuration object it is not loaded
    
    Parameters:
    
    taxonomy - the taxonomy
    
    Throws:
    
    net.sf.saxon.type.SchemaException - the schema exception
  - addError
```
public void addError(java.lang.Exception e)
```
    Adds the error.
    
    Parameters:
    
    e - the e
  - getErrors
```
public java.lang.String[] getErrors()
```
    Gets the errors.
    
    Returns:
    
    the errors
  - getStaticArcroleTypeByURI
```
public XBRLArcroleType getStaticArcroleTypeByURI(java.lang.String arcrole)
```
    Gets the static arcrole type by uri. This is one of the 9 arc roles defined in the XBRL 2.1 specification
    Note, this method registers the arcroleURI within the loaded DTSContainer even if no relationships exists using the arcrole. If this is not a desired collateral effect you can check the existence of a previous registration with a call to isArcroleTypeUsed(String)
    
    Parameters:
    
    arcrole - the arcrole
    
    Returns:
    
    the static arcrole type by uri
  - isStandardArcrole
```
public static boolean isStandardArcrole(java.lang.String arcrole)
```
    Detects if an arcrole is defined in the XBRL 2.1 specification or not
    Note, this method does not registers the arcrole uri within the loaded DTSContainer
    
    Parameters:
    
    arcrole - the arcrole
    
    Returns:
    
    true or false
  - getStaticRoleTypeByURI
```
public XBRLRoleType getStaticRoleTypeByURI(java.lang.String role)
```
    Gets the static role type by uri.
    Note, this method registers the role uri within the loaded DTSContainer even if the role uri is nowhere referenced. If this is not a desired collateral effect you can check the existence of a previous registration with a call to isRoleTypeUsed(String)
    
    Parameters:
    
    role - the role
    
    Returns:
    
    the static role type by uri
  - isStandardRole
```
public static boolean isStandardRole(java.lang.String role)
```
    Detects if a role is defined in the XBRL 2.1 specification or not
    Note, this method does not registers the role uri within the loaded DTSContainer
    
    Parameters:
    
    role - the role
    
    Returns:
    
    true or false
  - isStandardExtendedLink
```
public static boolean isStandardExtendedLink(javax.xml.namespace.QName extendedLinkNodeName)
```
    Detects if an extended link is defined in the XBRL 2.1 specification
    
    Parameters:
    
    extendedLinkNodeName - the extended link node name
    
    Returns:
    
    true or false
  - getRelationships
```
public java.util.Iterator<XBRLRelationship> getRelationships(DTSBase base)
                                                      throws XBRLValidationException
```
    Return all relationships in a DTSBase.
    
    Parameters:
    
    base - DTSBase The base to be interrogated
    
    Returns:
    
    Iterator<XBRLRelationship>
    
    Throws:
    
    XBRLValidationException - the XBRL validation exception
  - setSerializationMethod
```
public void setSerializationMethod(int method)
```
    Sets the serialization method to OBJECTS or ORIGINAL.
    OBJECTS means that the objects that are part of this document will be used to serialize the document. This is the default value and it is safe because during the loading phase the infoset is read and the infoset contains an object model representation of all possible content.
    ORIGINAL is faster and even safer than OBJECTS unless the application has changed things in the objects of this document.
    
    Parameters:
    
    method - integer code of the new Method
  - getSerializationMethod
```
public int getSerializationMethod()
```
    Obtains the value of the serialization method. This is either OBJECTS or ORIGINAL
    
    Returns:
    
    integer constant
  - getArcroleType
```
public java.util.List<XBRLArcroleType> getArcroleType(java.lang.String uri)
```
    Access to the arcroleType object from the URI regardless where it is defined or if there are multiple valid definitions of the same arcrole URI. If the arcroleType is not declared in the DTS the function returns an empty List the function tries to locate the arcroleType definition in the following order:
    1. in the DTS cache (All defined in a taxonomy schema in the DTS)
    2. statically defined in the XBRL 2.1 specification
    3. in the set of virtual arcroleTypes (arcroleTypes not defined in the DTS but used in other extended links)
    Parameters:
    
    uri - String with the arcroleURI to search for
    
    Returns:
    
    a List of XBRLArcroleType definitions for the same role uri within the entire DTS or an empty list
  - getRoleType
```
public java.util.List<XBRLRoleType> getRoleType(java.lang.String uri)
```
    Access to the roleType object from the URI regardless where it is defined or if there are multiple valid definitions of the same role URI.
    If the roleType is not declared in the DTS the function returns an empty Vector.
    The method tries to locate the roleType definition in the following order:
    1. in the DTS cache (All defined in a taxonomy schema in the DTS)
    2. statically defined in the XBRL 2.1 specification
    3. in the set of virtual roleTypes (roleTypes not defined in the DTS but used in other extended links)
    Parameters:
    
    uri - String with the roleURI to search for
    
    Returns:
    
    Vector of XBRLRoleType including all definitions within the DTS
  - getRoleTypes
```
public java.util.Iterator<XBRLRoleType> getRoleTypes()
```
    Access to an iterator over defined XBRL Role Types defined on all taxonomies in the loaded DTS.
    
    Returns:
    
    Iterator<XBRLRoleType>
  - getArcroleTypes
```
public java.util.Iterator<XBRLArcroleType> getArcroleTypes()
```
    Access to an iterator over defined XBRL Arcrole Types defined on all taxonomies in the loaded DTS.
    
    Returns:
    
    Iterator<XBRLArcroleType>
  - getRoleCode
```
public java.lang.Integer getRoleCode(java.lang.String roleURI)
```
    Gets the role code (an Integer) from the roleURI (an String)
    If there is no code already defined for the given roleURI a new code is created.
    The code string is first converted to an URI. In case of any URISyntaxException if the value of the property DTS_DISCOVERY_ALLOWSPACESONURIS is true, then an inconsistency is added to the DTS validation report.
    
    Parameters:
    
    roleURI - the role URI
    
    Returns:
    
    the role code
    
    See Also:
    
    isRoleTypeUsed(String)
  - getArcroleCode
```
public java.lang.Integer getArcroleCode(java.lang.String arcroleURI)
```
    Gets the arc role code (an Integer) from the arcroleURI (an String)
    If there is no code already defined for the given arcroleURI a new code is created.
    The code string is first converted to an URI. In case of any URISyntaxException if the value of the property DTS_DISCOVERY_ALLOWSPACESONURIS is true, then an inconsistency is added to the DTS validation report.
    
    Parameters:
    
    arcroleURI - the arc role URI
    
    Returns:
    
    the role code
    
    See Also:
    
    isArcroleTypeUsed(String)
  - getRoleType
```
public XBRLRoleType getRoleType(java.lang.Integer roleType)
```
    Obtains the XBRLRoleType associated to the given roleType code (an Integer)
    If no role type was registered for the given code null is returned.
    
    Parameters:
    
    roleType - the role type
    
    Returns:
    
    the role type
  - addRoleType
```
public java.lang.Integer addRoleType(XBRLRoleType role)
```
    Register a new roleType declaration. This function is called from the XBRLTaxonomy object when the roleTypes are read.
    
    Parameters:
    
    role - the role
    
    Returns:
    
    the integer
  - delRoleType
```
public void delRoleType(XBRLRoleType role)
```
    Unregister a registered roleType.
    
    Parameters:
    
    role - XBRLRoleType
  - getArcroleType
```
public XBRLArcroleType getArcroleType(java.lang.Integer arcroleType)
```
    Let's store all arcroletypes and assign an index to them.
    
    Parameters:
    
    arcroleType - the arcrole type
    
    Returns:
    
    the arcrole type
  - addArcroleType
```
public java.lang.Integer addArcroleType(XBRLArcroleType arcrole)
```
    Register a new arcroleType declaration. This function is called from the XBRLTaxonomy object when the arcroleTypes are read.
    
    Parameters:
    
    arcrole - XBRLArcroleType definition to add to this DTS
    
    Returns:
    
    the integer
  - delArcroleType
```
public void delArcroleType(XBRLArcroleType arcrole)
```
    Unregister a loaded arcroleType declaration.
    
    Parameters:
    
    arcrole - XBRLArcroleType
  - getLRRAndRelationshipsConstraintsChecker
```
public XBRLlrrAndRelationshipConstraints getLRRAndRelationshipsConstraintsChecker()
```
    Obtains an instance of the XBRLlrrAndRelationshipConstraints class that is unique for the entire DTSContainer live cycle. This class is used to validate all relationship constraints.
    
    Returns:
    
    instance of XBRLlrrAndRelationshipConstraints
  - getNumberOfItemDeclarations
```
public int getNumberOfItemDeclarations()
                                throws XBRLValidationException
```
    Gets the number of item declarations.
    
    Returns:
    
    the number of item declarations in the whole DTS. Only XBRLConcepts in the xbrli:item substitution group counts
    
    Throws:
    
    XBRLValidationException - the XBRL validation exception
  - getNumberOfTupleDeclarations
```
public int getNumberOfTupleDeclarations()
                                 throws XBRLValidationException
```
    Gets the number of tuple declarations.
    
    Returns:
    
    the number of tuple declarations in the whole DTS. Only XBRLConcepts in the xbrli:tuple substitution group counts
    
    Throws:
    
    XBRLValidationException - the XBRL validation exception
  - getItemDeclarations
```
public java.util.Iterator<XBRLItem> getItemDeclarations()
```
    Iterator over all Item concepts declarations in the DTS (crosses all taxonomies).
    
    Returns:
    
    Iterator<XBRLItem>
  - getTupleDeclarations
```
public java.util.Iterator<XBRLTuple> getTupleDeclarations()
```
    Iterator over all Tuple concept declarations in the DTS (crosses all taxonomies).
    
    Returns:
    
    Iterator<XBRLTuple>
  - getConcepts
```
public java.util.Iterator<XMLElementDefinition> getConcepts()
```
    Iterator over all XBRL Concept declarations (Items and Tuples) in the DTS (crosses all taxonomies).
    
    Returns:
    
    Iterator<XMLElementDefinition>
  - getResources
```
public java.util.Iterator<XBRLResource> getResources()
```
    Make sure the DTS has beed validated or the list of resources may not be complete.
    
    Returns:
    
    Iterator<XBRLResource>
  - getTaxonomyByPrefix
```
public java.util.Iterator<XBRLTaxonomy> getTaxonomyByPrefix(java.lang.String conceptPrefix)
```
    Returns an iterator over all taxonomy schemas whose target namespace matches the prefix. This function is used to find the apropriate namespace in a loop. Use with caution, because different namespaces in different files may use the same prefix. If there is no taxonomies matching the prefix, the function returns an empty sequence
    
    Parameters:
    
    conceptPrefix - the concept prefix
    
    Returns:
    
    Iterator<XBRLTaxonomy>
  - getTaxonomyByNamespaceInDts
```
public java.util.Iterator<XBRLTaxonomy> getTaxonomyByNamespaceInDts(java.lang.String namespace)
```
    Returns an iterator over all taxonomy schemas that matches the corresponding namespace and are loaded into the DTS. Never returns null.
    
    Parameters:
    
    namespace - the namespace
    
    Returns:
    
    Iterator<XBRLTaxonomy>
  - isTaxonomyLoadedByNamespace
```
public boolean isTaxonomyLoadedByNamespace(java.lang.String namespace)
```
    Fast implementation of a mechanism to check if a taxonomy schema has been loaded using the schema namespace.
    
    Parameters:
    
    namespace - the namespace
    
    Returns:
    
    true if the schema has been loaded
    
    Since:
    
    3.2.0
  - getTaxonomyByNamespace
```
public java.util.Iterator<XBRLTaxonomy> getTaxonomyByNamespace(java.lang.String namespace)
```
    Returns an iterator over all taxonomy schemas that matches the corresponding namespace and are loaded into the DTS or has been loaded to validate elements even it is not loaded in the DTS. Never returns null.
    
    Parameters:
    
    namespace - the namespace
    
    Returns:
    
    Iterator<XBRLTaxonomy>
    
    See Also:
    
    getTaxonomyByNamespaceInDts(String)
  - getTaxonomyCodes
```
public java.util.Iterator<java.lang.Integer> getTaxonomyCodes()
```
    Returns an iterator over all taxonomy codes in the DTS.
    
    Returns:
    
    Iterator<Integer> that might be faster than processing URIs or the XBRLTaxonomies in some circumstances
    
    Since:
    
    3.1.0
  - getTaxonomyURIs
```
public java.util.Iterator<java.net.URI> getTaxonomyURIs()
```
    Returns an iterator over all taxonomy documents in the DTS.
    
    Returns:
    
    Iterator<URI>
  - getTaxonomies
```
public java.util.Iterator<XBRLTaxonomy> getTaxonomies()
```
    Returns an iterator over all taxonomy documents in the DTS.
    
    Returns:
    
    Iterator<URI>
  - getNumberOfTaxonomyURIs
```
public int getNumberOfTaxonomyURIs()
```
    Returns the number of taxonomy URIs in the DTS.
    
    Returns:
    
    int
  - getLinkbaseURIs
```
public java.util.Iterator<java.net.URI> getLinkbaseURIs()
```
    Returns an iterator over all linkbase documents in the DTS.
    
    Returns:
    
    Iterator<URI>
  - getLinkbases
```
public java.util.Iterator<XBRLLinkbase> getLinkbases()
```
    Returns an iterator over all linkbase documents in the DTS.
    
    Returns:
    
    Iterator<XBRLLinkbase>
  - getLinkbaseCodes
```
public java.util.Iterator<java.lang.Integer> getLinkbaseCodes()
```
    Returns an iterator over all linkbase codes in the DTS.
    
    Returns:
    
    Iterator<Integer> that might be faster than processing URIs or the XBRLLinkbase in some circumstances
    
    Since:
    
    3.1.0
  - getExtendedLinkCodes
```
public java.util.Iterator<java.lang.Integer> getExtendedLinkCodes()
```
    Returns an iterator over all extended link codes in the DTS.
    
    Returns:
    
    Iterator<Integer> that might be faster than processing URIs or the XBRLExtendedLink in some circumstances
    
    Since:
    
    3.1.0
  - getNumberOfLinkbaseURIs
```
public int getNumberOfLinkbaseURIs()
```
    Returns the number of linkbase URIs in the DTS.
    
    Returns:
    
    int
  - getNumberOfInstanceURIs
```
public int getNumberOfInstanceURIs()
```
    Returns the number of XBRL Instances in the DTS. Note: Instance are taken from the document cache. If the DTS has validated a document that was never added to the cache, the document will not be added to this counter. XBRL reports added to URIs to the load methods will be returned.
    
    Returns:
    
    int
  - getInstanceByURI
```
public XBRLInstance getInstanceByURI(java.lang.Integer u)
```
    Returns an XBRLInstance that has been loaded into the document cache using the document URI.
    
    Parameters:
    
    u - the XBRL Report URI or null
    
    Returns:
    
    XBRLInstance
    
    See Also:
    
    getInstanceURIs()
  - getInstanceURIs
```
public java.util.Iterator<java.net.URI> getInstanceURIs()
```
    Returns an iterator over URIs of loaded instances in the document cache.
    
    Returns:
    
    Iterator of URIs of loaded XBRLInstance
  - getTaxonomyByURI
```
public XBRLTaxonomy getTaxonomyByURI(java.net.URI u)
```
    Returns the XBRLTaxonomy corresponding to the Document URI or null if the URI cannot be found or does not corresponds to a taxonomy.
    
    Parameters:
    
    u - URI of the taxonomy to retrieve
    
    Returns:
    
    XBRLTaxonomy
  - getTaxonomyByURI
```
public XBRLTaxonomy getTaxonomyByURI(java.lang.Integer u)
```
    Returns the XBRLTaxonomy corresponding to the Document URI or null if the URI cannot be found or does not corresponds to a taxonomy.
    
    Parameters:
    
    u - Integer of the taxonomy URI to retrieve
    
    Returns:
    
    XBRLTaxonomy
  - getLinkbaseByURI
```
public XBRLLinkbase getLinkbaseByURI(java.net.URI u)
```
    Returns the XBRLLinkbase corresponding to the Document URI or null if the URI cannot be found or does not corresponds to a linkbase.
    
    Parameters:
    
    u - URI of the linkbase to retrieve
    
    Returns:
    
    XBRLLinkbase object
  - getLinkbaseByCode
```
public XBRLLinkbase getLinkbaseByCode(java.lang.Integer code)
```
    Returns the XBRLLinkbase corresponding with the code or null if the code does not corresponds with a linkbase.
    
    Parameters:
    
    code - the linkbase document key
    
    Returns:
    
    XBRLLinkbase instance or null
    
    Since:
    
    3.1.0
  - getTaxonomyByCode
```
public XBRLTaxonomy getTaxonomyByCode(java.lang.Integer code)
```
    Returns the XBRLTaxonomy corresponding with the code or null if the code does not corresponds with a taxonomy.
    
    Parameters:
    
    code - the taxonomy schema document key
    
    Returns:
    
    XBRLTaxonomyInstance or null
    
    Since:
    
    3.1.0
  - getXBRLExtendedLink
```
public XBRLExtendedLink getXBRLExtendedLink(java.lang.Integer code)
```
    Obtains an extended link from the extended link code.
    
    Parameters:
    
    code - the code
    
    Returns:
    
    the XBRL extended link
  - getLinkbaseByURI
```
public XBRLLinkbase getLinkbaseByURI(java.lang.Integer u)
```
    Returns the XBRLLinkbase corresponding to the Document URI or null if the URI cannot be found or does not corresponds to a linkbase.
    
    Parameters:
    
    u - URI of the linkbase to retrieve
    
    Returns:
    
    XBRLLinkbase object
  - readInfoset
```
public void readInfoset()
                 throws XBRLValidationException
```
    Method used to populate the object model in all objects defined within this DTS.
    
    Throws:
    
    XBRLValidationException - the XBRL validation exception
  - delayEvents
```
public void delayEvents(java.lang.Runnable runnable,
                        java.lang.String... events)
```
    This method will store locally all events of the type indicated in the array string so they will not be fired but just catch by the API. Then, at the end of the Runnable process, all events catch are fired
    
    Parameters:
    
    runnable - this is the process that will be executed and all events will be catch
    
    events - the events
  - banEvents
```
public <T> T banEvents(java.util.concurrent.Callable<T> exec,
                       java.lang.String... events)
                throws java.lang.Exception
```
    This method will ban events to be fired. It is used internally by the API when resources are compiled and transformed to other types but maintain all the information of the previous resource
    
    Type Parameters:
    
    T - the return value of the exec method
    
    Parameters:
    
    exec - this is the process that will be executed and all events will be catch
    
    events - the events
    
    Returns:
    
    the return value of the exec call
    
    Throws:
    
    java.lang.Exception - any exception that exec might raise
  - getExtendedLinks
```
public java.lang.Iterable<XBRLExtendedLink> getExtendedLinks()
```
    Gets the extended links.
    
    Returns:
    
    the extended links
  - getConcept
```
public XMLElementDefinition getConcept(javax.xml.namespace.QName concept)
```
    Returns a concept declaration in the DTS regardless it is a tuple, item or pure element
    
    returns null if the concept is not defined in the DTS or if the value of the QName for the concept parameter is null
    .
    
    Parameters:
    
    concept - the concept
    
    Returns:
    
    XMLFragment or null
  - delConcept
```
public void delConcept(javax.xml.namespace.QName concept)
```
    Removes a concept form the DTS and removes also all relationships this concept participates on.
    
    Parameters:
    
    concept - QName
    
    Since:
    
    2.6.4
  - getRelationship
```
public XBRLRelationship getRelationship(java.lang.String extendedLink,
                                        javax.xml.namespace.QName relationshipType,
                                        java.lang.String arcrole,
                                        java.util.List<XBRLAttribute> attributes,
                                        XMLFragment source,
                                        XMLFragment target)
```
    Returns the relationship that matches the search criteria. Only one relationship in the DTS matches the criteria returns null if no relationship can be found
    
    Parameters:
    
    extendedLink - the extended link
    
    relationshipType - the relationship type
    
    arcrole - the arcrole
    
    attributes - the attributes
    
    source - the source
    
    target - the target
    
    Returns:
    
    the relationship
  - getResource
```
public XBRLResource getResource(java.net.URI xpointerIdentifier)
```
    Resolves an XBRLResource from its XPointer identifier.
    The XPointer identifier is unique. This function may not work properly if the resource has been created programatically.
    
    Parameters:
    
    xpointerIdentifier - the xpointer identifier
    
    Returns:
    
    XBRLResource
    
    Since:
    
    2.7.1
  - getResource
```
public XMLFragment getResource(java.lang.String resourceRole,
                               javax.xml.namespace.QName resourceType,
                               java.lang.String content,
                               java.util.List<XBRLAttribute> attributes,
                               net.sf.saxon.om.AbstractItem value,
                               java.util.List<java.lang.String> xpathChildren)
                        throws XBRLValidationException
```
    Search for a resource in the DTS with the given id. TODO: deal with complex type resources, currently only simple type resources can be searched using parameters FIXED: Versioning now uses XPointers to locate resources
    
    Parameters:
    
    resourceRole - String
    
    resourceType - QName
    
    content - String "simple" or "complex"
    
    attributes - Vector<XBRLAttribute> attributes defined in the root element
    
    value - the value for simple type resources
    
    xpathChildren - the xpath children
    
    Returns:
    
    XMLFragment representing the resource or null if not found
    
    Throws:
    
    XBRLValidationException - the XBRL validation exception
  - isInstanceOfThisDTS
```
public XBRLInstance isInstanceOfThisDTS(XBRLInstance instance,
                                        int mode)
```
    Check whether or not the instance document received as a parameter can be used in this DTSContainer. This requires first that the two Saxon configuration objects share compatible containers and then that the instance DTS matches the loaded DTS.
    Calling to this function requires that the DTS of the instance document received as a parameter being already discovered. Otherwise the comparison will fail.
    
    Parameters:
    
    instance - the instance, can be just an instance loaded from XML without schema validation
    
    mode - can be DTSContainer.FAST constant or DTSContainer.FULL (slowest) comparison. FULL comparison considers the whole DTS. FAST comparison considers only the files explicitly referenced in this file.
    
    Returns:
    
    null if the incoming instance is not for this DTS or a new XBRLInstance schema validated that can be used for XBRL Validation
  - isBUG368Mode
```
public boolean isBUG368Mode()
```
    Returns true if the user has set the property XBRL_VERSION to the value XBRL_VERSION_EXPERIMENTAL_BUG_368.
    
    Returns:
    
    boolean value
  - isVersion20122501
```
public boolean isVersion20122501()
```
    Checks if is version20122501.
    
    Returns:
    
    true, if is version20122501
  - isVersion20132002
```
public boolean isVersion20132002()
```
    Checks if is version20132002.
    
    Returns:
    
    true, if is version20132002
  - isThin
```
public boolean isThin()
```
    Helper method to know if this DTS has the DTS_THIN property set to true or false.
    
    Returns:
    
    boolean value
  - isFailFast
```
public boolean isFailFast()
```
    Helper method to quickly check if this DTSContainer is set to FAIL_FAST under the FAIL_STRATEGY property
    
    Returns:
    
    boolean value, true if FAIL_STRATEGY is set to FAIL_FAST
  - isInstanceOfThisDTS
```
public XBRLInstance 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. Source objects may not have the system-id set to the absolute path.
    
    Parameters:
    
    xmlSource - the xml source
    
    mode - can be DTSContainer.FAST constant or DTSContainer.FULL (slowest) comparison. FULL comparison considers the whole DTS. FAST comparison considers only the files explicitly referenced in this file.
    
    Returns:
    
    DocumentInfo or null if there is no match
  - isInstanceOfThisDTS
```
public XBRLInstance isInstanceOfThisDTS(MultiDTSValidationFile item,
                                        int mode)
                                 throws java.io.IOException
```
    Check whether or not the document in the xmlSource is an instance document according to this DTS. Source objects may not have the system-id set to the absolute path.
    
    Parameters:
    
    item - this is a MultiDTSValidationFile instance, the instance document is read two times. One for testing the DTS and, if the DTS is OK, to be loaded into that DTS.
    
    mode - can be DTSContainer.FAST constant or DTSContainer.FULL (slowest) comparison. FULL comparison considers the whole DTS. FAST comparison considers only the files explicitly referenced in this file.
    
    Returns:
    
    DocumentInfo or null if there is no match
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - isTaxonomy
```
public boolean isTaxonomy(java.lang.Integer docCode)
```
    Returns true if the value of docCode corresponds with a taxonomy in the DTS.
    
    Parameters:
    
    docCode - document code obtained from XBRLDTSDocument.getDTSKey()
    
    Returns:
    
    boolean value.
    
    Since:
    
    3.1.0
  - isLinkbase
```
public boolean isLinkbase(java.lang.Integer docCode)
```
    Returns true if the value of docCode corresponds with a linkbase in the DTS.
    
    Parameters:
    
    docCode - document code obtained from XBRLDTSDocument.getDTSKey()
    
    Returns:
    
    boolean value.
    
    Since:
    
    3.1.0
  - isExtendedLink
```
public boolean isExtendedLink(java.lang.Integer docCode)
```
    Returns true if the value of docCode corresponds with an extended link in the DTS.
    
    Parameters:
    
    docCode - document code obtained from XBRLDTSDocument.getDTSKey()
    
    Returns:
    
    boolean value.
    
    Since:
    
    3.1.0
  - getTypeDefinition
```
public XBRLXSDTypeDefinition getTypeDefinition(javax.xml.namespace.QName type)
```
    Find the type definition for the specific QName
    This function does not find new types defined in taxonomy schemas that has not been read from XML files.
    
    Parameters:
    
    type - QName
    
    Returns:
    
    the XBRLTypeDefinition or null
  - getLastResolvedSystemId
```
public java.lang.String getLastResolvedSystemId()
```
    Returns the systemId of the last file resolved by the Resolver during the DTSDiscovery process or null if the DTSDiscoveryProcess is not on-going. This method is used to generate error messages
    
    Returns:
    
    string
    
    Since:
    
    2.8.1
  - addValidationException
```
public void addValidationException(XBRLValidationException e)
```
    Adds the validation exception.
    
    Parameters:
    
    e - the e
  - addInconsistency
```
public void addInconsistency(XBRLInconsistency e)
```
    Adds the inconsistency.
    
    Parameters:
    
    e - the e
  - addInconsistencey
```
@Deprecated
public void addInconsistencey(XBRLInconsistency e)
```
    Deprecated. Since version 3.2.0 the addInconsistency(XBRLInconsistency) method shall be used instead
    
    Adds the inconsistencey.
    
    Parameters:
    
    e - the e
  - getValidationReport
```
public XBRLValidationReport getValidationReport()
```
    Access to the internal validation report. This report is not complete. It contains only validation problems during the DTS loading process.
    
    Returns:
    
    XBRLValidationReport
  - resolve
```
public javax.xml.transform.Source resolve(java.net.URI resolvedURI)
                                   throws javax.xml.transform.TransformerException
```
    Resolve a URI against the base URI but considering first if this file is already part of the system registered files or if the file is in XML catalogs.
    
    Parameters:
    
    resolvedURI - the resolved URI
    
    Returns:
    
    the source
    
    Throws:
    
    javax.xml.transform.TransformerException - the transformer exception
  - loadExtraSchemas
```
public void loadExtraSchemas()
                      throws XBRLSchemaException
```
    Called internally by the API when extra schemas must be loaded in the configuration object and schema compiler.
    
    Throws:
    
    XBRLSchemaException - the XBRL schema exception
  - getSchemaCompiler
```
public com.saxonica.ee.schema.SchemaCompiler getSchemaCompiler()
```
    Returns the current schema compiler for this configuration object. This method is used to resolve unresolved references to already loaded schemas.
    This method is for internal use only.
    
    Returns:
    
    SchemaCompiler
  - stop
```
public void stop()
```
    Stop.
    
    Specified by:
    
    stop in interface Stopable
  - shouldStop
```
public boolean shouldStop()
```
    This function will be called by classes that knows what to do if the loading proces of a DTS has been cancelled by the user.
    Prior to version 2.7.0 The functions returned true if the user had requested cancellation.
    Starting from version 2.7.0 this function throws an XBRLInterruptedException that is a sub class of XBRLRuntimeException captured during the load method. If the exception is produced. the DTSContainer is cleared and then the load function ends.
    
    Returns:
    
    boolean value. True if the user has requested cancellation.
    
    Throws:
    
    XBRLInterruptedException - the XBRL interrupted exception
  - getProcessor
```
public <T extends XBRLPlugInProcessor> T getProcessor(java.lang.String processorname)
```
    Returns an already registered plug-in processor based on the processor name. In the DTS there is just one instance of a processor by processor name. For example, there is just one XBRL Dimensions processor for a loaded DTS or just one XBRLFormula processor for a loaded DTS.
    This function returns the registered, loaded, and instantiated processor using the processor name as a key. This method does not instantiates the processor if it is not already registered.
    Processors are created by calling the create function of the processor main class. They automatically self register within the DTS that is passed in as a parameter. Further calls to the create method using the same DTS as a parameter will always return the already registered processor.
    
    Type Parameters:
    
    T - the generic type
    
    Parameters:
    
    processorname - Processor token name (statically defined on each processor class)
    
    Returns:
    
    XBRLPlugInProcessor or null if it is not registered
    
    Since:
    
    2.6.8
  - registerProcessor
```
public void registerProcessor(java.lang.String processorname,
                              XBRLPlugInProcessor processor)
```
    Called by the processor to self register. This method also tells the XBRLPlugInProcessor to configure itself with the properties of this DTSContainer via a call to the configure method on the processor instance.
    
    Parameters:
    
    processorname - the processorname
    
    processor - the processor
    
    Since:
    
    2.6.8
  - getProcessors
```
public java.util.Iterator<XBRLPlugInProcessor> getProcessors()
```
    Access to all registered plug-in processors.
    
    Returns:
    
    Iterator over registered processors
    
    Since:
    
    2.6.9
  - xEqualMode
```
public boolean xEqualMode()
```
    The default value of the XEQUAL_MODE is XBRL_COMPLIANT but the conformance suite of the formula processor requires it to be set to FORMULA_COMPLIANT.
    This is because some test cases in the formula comformance suite assumes that the comparison of XBRL entities texts are trim before they are compared but this operation is not required in the XBRL specification.
    
    Returns:
    
    true or false depending on the value of the XEQUAL_MODE property on this DTSContainer instance.
  - sEqualMode
```
public boolean sEqualMode()
```
    The default value of the SEQUAL_MODE is XBRL_COMPLIANT but the conformance suite of the formula processor requires it to be set to FORMULA_COMPLIANT.
    This is because some test cases in the formula comformance suite assumes that the comparison of nodes should skip ids in nested nodes while this is not stated in the XBRL 2.1 specification.
    
    Returns:
    
    true or false depending on the value of the SEQUAL_MODE property on this DTSContainer instance.
  - getBaseURI
```
public java.net.URI getBaseURI()
```
    Access to the base URI for the XBRL processor.
    
    Returns:
    
    an URI whose value depends on the XBRL_BASE property of the XBRL processor or null if there is an error.
    
    See Also:
    
    XBRL_BASE
  - resolveXPointer
```
public XMLFragment resolveXPointer(java.net.URI uriHref,
                                   XMLDocumentURI doc)
                            throws XBRLValidationException
```
    resolve the XPointer to the node pointed to and returns the XMLFragment it points to or null if none can be found.
    The href MUST be absolute.
    
    Parameters:
    
    uriHref - the URI to resolve
    
    doc - XMLDocumentURI in which uriHRef exist. if null then the XMLDocumentURI is obtained from the cache. If the document has not been loaded in the cache (it is not in the DTS) and the doc parameter is null, most likely, this function will return null.
    
    Returns:
    
    XMLFragment if it can be found or null if it cannot be found
    
    Throws:
    
    XBRLValidationException - if the URI cannot be resolved according to the rules in the XBRL 2.1 specification
  - validate
```
public XBRLValidationReport validate(XBRLDocument doc)
```
    Validates a new document against this already loaded DTS. Then, returns an XBRLValidationReport with all validation errors.
    All registered processors are called in the order indicated in the PROCESSORS_SEQUENCE property.
    This call utilizes the XBRLPlugInProcessor.validate(XBRLDocument) method to perform validation
    
    Parameters:
    
    doc - XBRL Document to validate
    
    Returns:
    
    XBRLValidationReport
    
    Since:
    
    2.7.2
  - getWhatToValidate
```
public int getWhatToValidate()
```
    Gets the what to validate.
    
    Returns:
    
    the what to validate
  - setWhatToValidate
```
public void setWhatToValidate(int newValue)
```
    Sets the what to validate.
    
    Parameters:
    
    newValue - the new what to validate
  - getNumberOfProcessorsInSequence
```
public int getNumberOfProcessorsInSequence()
```
    Returns the number of processors added to the PROCESSORS_SEQUENCE property. Mainly used in the GUIs to update the progress bar
    
    Returns:
    
    integer
  - getUnderEvaluationInstance
```
public XBRLInstance getUnderEvaluationInstance()
```
    Gets the instance document that is under evaluation.
    
    Returns:
    
    the XBRLInstance under evaluation or null if none is set
  - setUnderEvaluationInstance
```
public XBRLInstance setUnderEvaluationInstance(XBRLInstance valInstance)
```
    Sets or clear the instance document that is under validation. This document might be in the scope of formula functions or the table processor. If the argument is null, the instance in the scope is removed.
    Warning, this method does not store the instance per thread
    
    Parameters:
    
    valInstance - the new under evaluation instance
    
    Returns:
    
    the XBRLIntance previously set
  - validate
```
public XBRLValidationReport validate()
                              throws XBRLInitializationException,
                                     com.rs.lic.LicenseVerificationException
```
    Executes all registered validators indicated in the PROCESSORS_SEQUENCE property of this DTS and returns the XBRLValidationReport instance with the validation result.
    This call utilizes the XBRLPlugInProcessor.validate() method to perform validation and might not contain an XBRLInstance in the scope. If that is desired, either call validate(XBRLDocument) or call setUnderEvaluationInstance(XBRLInstance) before calling this method.
    
    Returns:
    
    XBRLValidationReport
    
    Throws:
    
    XBRLInitializationException - If the processor under a certain name cannot be created
    
    com.rs.lic.LicenseVerificationException - If the user has no rights to use the indicated processor
  - registerProcessorFactory
```
public static boolean registerProcessorFactory(java.lang.String name,
                                               java.lang.Class<? extends XBRLProcessorFactory> clazz)
```
    Register a new processor factory for the indicated processor name.
    
    Parameters:
    
    name - the name
    
    clazz - the clazz
    
    Returns:
    
    true if the processor name is new. false if it was previously registered
  - getRegisteredProcessorNames
```
public static java.lang.String[] getRegisteredProcessorNames()
```
    Access to all registered processor names.
    
    Returns:
    
    array of strings
    
    Since:
    
    2.7.1
  - getProcessorFactory
```
public static java.lang.Class<? extends XBRLProcessorFactory> getProcessorFactory(java.lang.String processorName)
```
    Accesss to the processor factory class for the processor name.
    
    Parameters:
    
    processorName - the processor name
    
    Returns:
    
    instance of the processor factory
    
    Since:
    
    2.7.1
  - isGeneralVariableSchemaAware
```
public boolean isGeneralVariableSchemaAware()
```
    This method returns the value of the property FORMULA_PROCESSOR_GENERAL_VARIABLE_SCHEMA_AWARE
    See FORMULA_PROCESSOR_GENERAL_VARIABLE_SCHEMA_AWARE for more information.
    
    Returns:
    
    true or false
  - getTempURL
```
public static java.net.URI getTempURL()
```
    Returns a URL pointin to a temporary folder in the local drive. This URI should be used when getBaseURI() returns null and a URL must be set to a document prior to generate the document nodes.
    If the updateXML method of the XBRLDocument class is called with this URL, no document will be written in the target directory.
    
    Returns:
    
    URI
    
    Since:
    
    2.7
  - getStatus
```
public DTSContainer.Status getStatus()
```
    Access to the processor status. Can be used from external applications to check if the DTS Discovery load process completed successfully or internally by processors that perform validation to obtain an indication about the part of the process the processor is running.
    
    Returns:
    
    a value from the DTSContainer.Status enumeration
  - getCustomFunctionFactories
```
public java.util.Collection<XBRLLibraryFactory> getCustomFunctionFactories()
```
    Access to the collection of all registered Library Factories. The formula processor calls this method during initialization phase
    
    Returns:
    
    Collection<? extends XBRLLibraryFactory>
  - getResolvedSourcesByNamespace
```
public java.util.Iterator<javax.xml.transform.Source> getResolvedSourcesByNamespace(java.lang.String targetNamespace)
```
    Gets the resolved sources by namespace.
    
    Parameters:
    
    targetNamespace - the target namespace
    
    Returns:
    
    the resolved sources by namespace
  - addSourceToCacheByNamespace
```
public void addSourceToCacheByNamespace(java.lang.String targetNamespace,
                                        javax.xml.transform.Source s1)
```
    Adds the source to cache by namespace.
    
    Parameters:
    
    targetNamespace - the target namespace
    
    s1 - the s1
  - removeSourceFromCacheByNamespace
```
public void removeSourceFromCacheByNamespace(java.lang.String targetNamespace)
```
    Removes the source from cache by namespace.
    
    Parameters:
    
    targetNamespace - the target namespace
  - isShowExactitudeDetails
```
public boolean isShowExactitudeDetails()
```
    Returns true if the DTSContainer.DTS_SHOW_EXACTITUDE_DETAILS property is set to true
    
    Returns:
    
    true, if is show exactitude details
  - getOrCreateProcessor
```
public <T extends XBRLPlugInProcessor> T getOrCreateProcessor(java.lang.String processorName)
```
    This method tries to obtain the instance of the processor already registered if it is not there, this method checks if the processor indicated in the processorName parameter is in the PROCESSORS_SEQUENCE, if it is there a new processor instance is created. In case of errors this method returns null and is silent about the error
    
    Parameters:
    
    processorName - the processor name
    
    Returns:
    
    the new processor instance
  - getKeyElementsInterceptorHelper
```
public KeyElementsInterceptorHelper getKeyElementsInterceptorHelper()
```
    Gets the key elements interceptor helper.
    
    Returns:
    
    the key elements interceptor helper
  - informPossibleNamespaceGhist
```
public void informPossibleNamespaceGhist(java.lang.String uri)
```
    Detected during SAX parsing.
    
    Parameters:
    
    uri - the uri
  - makeXMLFragment
```
public XMLFragment makeXMLFragment(net.sf.saxon.om.NodeInfo parent,
                                   net.sf.saxon.om.NodeName nameCode,
                                   net.sf.saxon.type.SchemaType elementType,
                                   boolean isNilled,
                                   net.sf.saxon.tree.util.AttributeCollectionImpl attlist,
                                   net.sf.saxon.event.PipelineConfiguration pipe,
                                   int locationId)
```
    This method is called during SAX parsing of an XML document and must return an instance of a class that will contain the NodeImpl. This method is for internal use only
    
    Parameters:
    
    parent - the parent
    
    nameCode - the name code
    
    elementType - the element type
    
    isNilled - the is nilled
    
    attlist - the attlist
    
    pipe - the pipe
    
    locationId - the location id
    
    Returns:
    
    the XML fragment
  - getFactsListClassifier
```
public FactsListClassifier getFactsListClassifier(XBRLFactsList instance,
                                                  int aspectsToCover)
```
    Obtains an instance for the FactsListClassifier and stores it on an internal cache for further fast reference. The cache is clear when validation finishes
    
    Parameters:
    
    instance - the instance
    
    aspectsToCover - the aspects to cover
    
    Returns:
    
    the facts list classifier
  - getEqualsCache
```
public <T extends HasEqualsCache> EqualsCache<T> getEqualsCache(java.lang.Class<T> clazz)
```
    Gets the equals cache.
    
    Type Parameters:
    
    T - the generic type
    
    Parameters:
    
    clazz - the clazz
    
    Returns:
    
    the equals cache
  - clearEqualsCaches
```
public void clearEqualsCaches()
```
    Clear equals caches.
  - getAttributesDatabase
```
public XMLAttributesInDTS getAttributesDatabase()
```
    Gets the attributes database.
    
    Returns:
    
    the attributes database
  - getAtomicComparator
```
public AtomicComparerHelper getAtomicComparator()
```
    Gets the atomic comparator.
    
    Returns:
    
    the atomic comparator
  - isAssertionSeverityLoadedInDTS
```
public boolean isAssertionSeverityLoadedInDTS()
```
    Returns true if the assertionSeverity schema has been loaded into the DTS. The result is cached internally
    
    Returns:
    
    true, if is assertion severity loaded in DTS
  - getStringCache
```
public StringCache getStringCache()
```
    Gets the string cache.
    
    Returns:
    
    the string cache
  - addNodeToBatch
```
public void addNodeToBatch(XMLFragment parent,
                           XMLFragment newNode)
```
    Adds the node to batch.
    
    Parameters:
    
    parent - the parent
    
    newNode - the new node
  - commitBatch
```
public void commitBatch(XMLFragment parent)
```
    Commit batch.
    
    Parameters:
    
    parent - the parent
  - getInformationAboutEntryPoint
```
public java.lang.String[] getInformationAboutEntryPoint()
```
    Generates information about the entry point used to load the DTS.
    
    Returns:
    
    array of lines with information
    
    Since:
    
    3.0.6
  - getRelativeURI
```
public java.net.URI getRelativeURI(java.net.URI documentURI)
```
    Obtains a relative URI from the documentURI using the URI passed in in the load(URI) call as the base URI
    When the load(URI[]) method was used with an array of URIs the common part of those URIs is used as the base URI.
    
    Parameters:
    
    documentURI - the absolute URI to made relative
    
    Returns:
    
    relative URI from root URI(s) or absolute URI if no root URIs exists
  - getRelativeURI
```
public java.lang.String getRelativeURI(java.lang.String documentURIAsString)
```
    Obtains a relative URI from the documentURI using the URI passed in in the load(URI) call as the base URI
    When the load(URI[]) method was used with an array of URIs the common part of those URIs is used as the base URI.
    
    Parameters:
    
    documentURIAsString - the absolute URI to made relative
    
    Returns:
    
    relative URI from root URI(s) or the value of the documentURIAsString parameter if no root URIs exists or the URIs has not the host and scheme in common
  - isProperty
```
public boolean isProperty(java.lang.String property)
```
    Helper method to check the value of a DTSContainer property and return a boolean value representing the boolean value property.
    
    Parameters:
    
    property - name. See DTSContainer documentation
    
    Returns:
    
    boolean value
  - isLocalResourceInIXBRLDocumentSet
```
public boolean isLocalResourceInIXBRLDocumentSet(java.nio.file.Path src)
```
    Checks if is local resource in IXBRL document set.
    
    Parameters:
    
    src - the src
    
    Returns:
    
    true, if is local resource in IXBRL document set
  - isIXBRLDocumentSet
```
public boolean isIXBRLDocumentSet()
```
    Checks if is IXBRL document set.
    
    Returns:
    
    true, if is IXBRL document set
  - getIXBRLPackagePublishersByLang
```
public java.util.Map<java.lang.String,java.lang.String> getIXBRLPackagePublishersByLang()
```
    This method returns the map of publishers in the taxonomy package to be used later in the ESEF 3.1.5 validation rule. Otherwise this returns null
    
    Returns:

Class DTSContainer

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USE_CACHE_PROPERTY

CONSIDER_DUPLICATES_AS_INCONSISTENCIES

CONSIDER_COMPARISON_WITH_NUMBER_WITH_PRECISION_ZERO_AS_INCONSISTENCY

GENERIC_LINKBASE_REQUIRE_ROLEREF_ARCROLEREF

GENERIC_LABEL_VERSION

GENERIC_REFERENCE_VERSION

USE_GENERIC_LABEL_AS_OF_22_JUNE_2009

USE_GENERIC_LABEL_CURRENT_EXPERIMENTAL

USE_GENERIC_REFERENCE_AS_OF_22_JUNE_2009

USE_GENERIC_REFERENCE_CURRENT_EXPERIMENTAL

ALWAYS_ADD_ref_2006_02_27_xsd_SCHEMA_TO_DTS

USE_XDT_1_0_AS_OF_18_SEP_2006

USE_XDT_1_0_AS_OF_7_SEP_2009

USE_XDT_1_0_AS_OF_25_JAN_2012

USE_XEQUAL_AS_XBRL_COMPLIANT

USE_XEQUAL_AS_FORMULA_COMPLIANT

XEQUAL_MODE

USE_SEQUAL_AS_XBRL_COMPLIANT

USE_SEQUAL_AS_FORMULA_COMPLIANT

SEQUAL_MODE

XDT_VERSION

XBRL_VERSION

XBRL_VERSION_2_JUL_2008

XBRL_VERSION_EXPERIMENTAL_BUG_368

XBRL_VERSION_25_JAN_2012

XBRL_VERSION_20_FEB_2013

XBRL_BASE

DTS_DISCOVERY_ON_DIFFERENT_FILE_NAMES

DTS_DISCOVERY_TRUST_NAMESPACES_ONLY

DTS_DISCOVERY_TRUST_NAMESPACES_ONLY_FOR_OFFICIAL_FILES

DTS_DISCOVERY_RAISE_WARNING_IF_TWO_FILES_HAVE_SAME_NAMESPACE

DTS_DISCOVERY_PRELOAD_OFFICIAL_SCHEMAS

DTS_DISCOVERY_REPLACE_OFFICIAL_SCHEMAS_SCHEMALOCATION

DTS_DISCOVERY_ALLOWSPACESONURIS

DTS_STORE_CACHE_PATH

DTS_STORE_CACHE_ENABLE

DTS_RESOLVER

DTS_THIN

DTS_SHOW_EXACTITUDE_DETAILS

DTS_CHECK_TOP_LEVEL_SCHEMAS

DTS_USER_LANGUAGES

DTS_ERROR_MESSAGE_MAX_CHARS

LOG_LEVEL

DTS_PROXY_HEADER

AUTHENTICATOR_DELEGATE_INSTANCE

PROCESSORS_SEQUENCE

WARNING_PROPERTY_VALUE

ERROR_PROPERTY_VALUE

IGNORE_PROPERTY_VALUE

FORMULA_PROCESSOR_GENERAL_VARIABLE_SCHEMA_AWARE

FORMULA_PROCESSOR_PARAMETER_RESOLVER

FORMULA_PROCESSOR_RETAIN_INPUT_INTANCE_ON_ASSERTION_RESULTS

FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS

PARALLEL_PROCESSING

PARALLEL_PROCESSORS

FORMULA_PROCESSOR_ENABLE_ASSERTION_MESSAGE_EXTENSIONS

FORMULA_PROCESSOR_DEFAULT_MESSAGE_ROLE

FORMULA_PROCESSOR_LEVEL_OF_EXCEPTIONS_INSIDE_FILTER_XPATH_EXPRESSIONS

FORMULA_PROCESSOR_USE_STRICT_SPECIFICATION_XPATH

IXBRL_DEDUPLICATE_FACTS_AFTER_LOAD

IXBRL_DOCTYPE_VALIDATION

IXBRL_VERSION

IXBRL_V10

IXBRL_V11

FUNCTIONS_USE_TARGETROLE_IN_XFI_FILTER_MEMBER_NETWORK_SELECTION

FUNCTIONS_CREATE_PHANTOM_RELATIONSHIPS_WHEN_NEEDED_TO_MAKE_FILTER_MEMBER_NETWORK_SELECTION_TO_WORK_UNDER_CERTAIN_PROJECTS

FORMULA_PROCESSOR_RETAIN_USED_FACTS

FORMULA_PROCESSOR_IGNORE_ASSERTION_SATISFIED

FORMULA_PROCESSOR_IGNORE_ASSERTION_NOT_SATISFIED

FORMULA_PROCESSOR_RETAIN_ASSERTION_RESOURCES

FORMULA_PROCESSOR_FILTER_ORDER_CLASS

FORMULA_PROCESSOR_USE_GLOBAL_PARAMETERS

FORMULA_PROCESSOR_SCHEMA_VALIDATE_EXTERNAL_DOCS

FORMULA_PROCESSOR_INTERRUPT_VALIDATION_MODE