Package com.ihr.xbrl.om

Provides the classes necessary to start processing XBRL information.

See:
          Description

Interface Summary
DTSCascadeURIResolver A URI resolver that implements this interface can be installed in a cascade of uri resolvers.
HasCreateDTSUriResolver This interface defines a method called createAndRegisterDTSUriResolver that must be implemented by classes able to create an URI Resolver for the DTSContainer suitable to provide documents during the DTS Discovery process.
HasCreateFormulaParameterResolver This interface defines a method called createAndRegisterFormulaParameterResolver that must be implemented by classes able to create an Formula Parameter Resolver for the DTSContainer suitable to provide values for parameters required during formula evaluation.
MultiDTSValidationFile Interface for a file that wraps a ZIP file that may contain other XBRL files inside.
MultiDTSValidationHandler Interface for all classes that receives an XBRLValidationReport and prepares other report that can be used by applications
NoReusableSource When a source is not reusable because the surrounding stream cannot be processed twice, the wrapping class implements this interface
XBRLDTSDocument This is the interface with methods that every document in the DTS Must have.
XBRLHasDTSTarget Interface for methods implemented by classes in the DTS in order to traverse a DTS from a document to the documents included from this document
XBRLLibraryFactory Interface for XBRL custom function factories.
XBRLPlugInProcessor This interface contains methods for the declaration of a plug-in processor that will be integrated with Reporting Standard XBRL processor.
XBRLProcessorFactory Interface for XBRL processors factories.
XBRLSourceCatalogInterface A class implementing this interface will be able to provide a local file association to a remote file.
XBRLValidation Incorporates all methods required for an object to perform XBRL validation.
XBRLValueKey Objects implementing this interface can generate a representation of a key for the object.
XBRLVariableResolver This interface allows variable resolvers to add variables for the XPath expressions executed in XMLFragment objects.
XMLHasParent  
 

Class Summary
DTSCatalogURIResolver This is a wrapper class to a CatalogResolver.
DTSContainer 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.
DTSContainer.IteratorConcepts This class joins an iterator over XBRLItem and another iterator over XBRLTuple together into a single Iterator over XMLElementDefinition objects.
DTSContainer.ProcessorAndSchemaCompiler Helper class to encapsulate the saxonica Processor of this DTSContainer and a saxonica SchemaCompiler together.
DTSContainerPropertiesHelper This class holds a static configuration of DTSContainer properties in order to help in the development of GUIs about which properties belongs to every processor and which are the allowed property values.
GUIURIResolver After creating a DTSContainer, applications with an user interface can create an instance of the GUIURIResolverFactory class and then call the DTSContainer method doCallInstallDTSURIResolver on the DTSContainer object in order to register the new resolver.
GUIURIResolverFactory This is the factory class to create an URI resolver that will tell the user that a file has not been found in the file system and allows him to select a local file instead.
MultiDTSUriResolverFactory This class can be used when multiple URI Resolvers shall be created and registered one after another.
MultiDTSValidationFileImpl Simple implementation of the MultiDTSValidationFile for a single File instance
MultiDTSValidationService This class supports hyper fast XBRL validation by using a configuration file where multiple DTS are pre-defined.
Platform This class will provide static methods to obtain configuration data on different platforms.
RSRemoteCatalogResolver This new resolver is inserted to allow for dynamic installation of taxonomy catalogs.
RSRemoteCatalogResolver.StaticCatalogEntry This is the object model representation of an entry in the static catalog
RSRemoteCatalogResolverFactory Factory class to create an instance of the RSRemoteCatalogResolver and register with the DTS
SimpleMatchURIResolver Resolves URIs according to a local map.
SourceBridge  
URIIndexableDocument<O> Template class to create sets of documents indexed by a document key.
VoidErrorListener Used to avoid errors to appear in the standad error while errors are thrown.
XBRL This class is a container for static content related to XBRL
XBRLAttribute This is an XML Attribute used in relation with an XMLFragment
XBRLCatalogSAXSource This is a wrapper class over a SAXSource. the class contains additional information about the source file so it can be recognized as a file found in the XBRL Catalog.
XBRLCatalogStreamSource In order to allow this instance to be reused twice as the input stream, this specialization of StreamSource contains a cache of the original StreamSource input stream.
XBRLCoreProcessor This class is a XBRLPlugInProcessor for doing XBRL 2.1 validation of the DTS.
XBRLCoreProcessorFactory Factory class to create XBRLCoreProcessor instances.
XBRLDocument Contains the Properties of the object 2.2.2 XBRL Document Information Item The [Document URI] property is provided by the parent class XMLDocumentURI The [Document Information Item] property is provided by the root class XMLFragment The [Additional Properties] Properties are provided by classes derived by extension of this class
XBRLNamespaceContext This class handles resolution of prefixes to namespaces and vice-versa.
XBRLProcessorFactoryBase Base class for processor factories Provides a protected field called theDTS and implements the XBRLProcessorFactoryBase.setDTSContainer(DTSContainer) method on the XBRLProcessorFactory interface.
XBRLSchemaErrorListener  
XBRLSchemaURIResolver Resolves a schema that exist in this DTS and returns a Source object to it As this object is created under a DTSContainer object it access all schemas loaded in this DTSContainer cache
XBRLSimpleLink This class represents a simple link XBRL simple links are: schemaRef, linkbaseRef, roleRef, arcroleRef As this class is abstract this object takes care just the details about XLink simple links as, for example, the attributes.
XBRLValidationImpl This class implements XBRLValidation interface and adds a validation call back method that must be implemented by the parent class.
XBRLValidationReport This objects holds the result of the XBRL validation
XMLDocumentURI This class represents an XML Document that exist in a DTS.
XMLFragment This is the bottom class of almost every object on this API that represents a node in an XML document.
ZipCascadeURIResolver  
ZipCascadeURIResolver.ZipPackage Handles extraction of Source from a document inside the ZIP file
 

Enum Summary
DTSContainer.Status  
XBRLValidation.Direction when invalidate is called, invalidation can go up to the parent elements to the root element or down to the children elements
XBRLValidationReport.ReportParts This enumeration can be used by report serializers.
ZipCascadeURIResolver.ZipPackage.CaseType  
 

Package com.ihr.xbrl.om Description

Provides the classes necessary to start processing XBRL information.

The main class is the DTSContainer class. A DTSContainer will be used to load the content of an XBRL DTS and operate with it.

Operations may include XBRL Validation, XBRL Dimensions Validation, XBRL Formula processing, Creation of additional components in the DTS or DTS Extensions, XBRL Mapping to other sources, XBRL Transformation, GUI tools, etc...

Since:
1.0 Created: 31/08/2008
Author:
Ignacio


Copyright 2006-2009 Reporting Standard S.L., C/ Torrecilla del Puerto 1, 28043, Madrid, Espaņa