com.ihr.xbrl.om

Interface XBRLDTSDocument

All Known Implementing Classes:

CalculationLinkbase, DefinitionLinkbase, FootnoteLinkbase, FormulaLinkbase, GenericLinkbase, LabelLinkbase, OtherLinkbase, PresentationLinkbase, ReferenceLinkbase, VersionLinkbase, XBRLDocument, XBRLExtendedLink, XBRLInstance, XBRLLinkbase, XBRLTaxonomy, XMLDocumentURI

public interface XBRLDTSDocument

This is the interface with methods that every document in the DTS Must have. Linkbases are documents ExtendedLinks are not documents, they are XML Fragments that belongs to the DTS

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
void	clear() Frees-up used memory.
void	discoverDTS(XBRLDTSDocument parent) Fires the rules of DTS Discovery for this object.
DTSContainer	getContainer() returns the DTSContainer this XBRLDTSDocument has been created.
java.lang.Integer	getDTSKey() Provides a key (a number) that can be used to index each document piece in the DTSContainer.

Method Detail

discoverDTS

void discoverDTS(XBRLDTSDocument parent)
          throws DTSDiscoveryException,
                 com.rs.lic.LicenseVerificationException

Fires the rules of DTS Discovery for this object.

Parameters:

parent - the parent

Throws:

DTSDiscoveryException - the DTS discovery exception

com.rs.lic.LicenseVerificationException - the license verification exception

getDTSKey

java.lang.Integer getDTSKey()

Provides a key (a number) that can be used to index each document piece in the DTSContainer.

Note 1, every document in the cache contains a document key that is the key for the document URI. that URI key IS NOT the DTS Key.

Note 2, every document contains a DTS key even if the document is not part of the included documents in the DTS. Documents included in the DTS are those whose Document Key is part of the DTS. The method DTSContainer.isDocumentInDTS(Integer) can be used to check if a particular document has been included in the DTS.

Returns:

URI

clear

void clear()
    throws java.lang.Throwable

Frees-up used memory.

Throws:

java.lang.Throwable - the throwable

getContainer

DTSContainer getContainer()

returns the DTSContainer this XBRLDTSDocument has been created.

Returns:

DTSContainer