A B C D E F G H I J K L M N O P Q R S T U V W X Z

A

AbstractGrabberImpl - Class in org.xbrlapi.grabber

AbstractGrabberImpl() - Constructor for class org.xbrlapi.grabber.AbstractGrabberImpl

add_escapes(String) - Method in exception org.xbrlapi.xpointer.ParseException

Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.

addAll(FragmentList<F>) - Method in interface org.xbrlapi.FragmentList

Appends a list of fragments to this fragment list.

addAll(FragmentList<F>) - Method in class org.xbrlapi.impl.FragmentListImpl

Appends a list of fragments to this fragment list.

addArcroleRef(SimpleLink) - Method in class org.xbrlapi.impl.LinkbaseImpl

Adds an arcroleRef to a linkbase.

addArcroleRef(SimpleLink) - Method in interface org.xbrlapi.Linkbase

Adds an arcroleRef to a linkbase.

addBaseURL(String) - Method in interface org.xbrlapi.xmlbase.BaseURLSAXResolver

Updates the XML Base given new base information Used on the start of element XML base event.

addBaseURL(String) - Method in class org.xbrlapi.xmlbase.BaseURLSAXResolverImpl

Updates the XML Base given new base information Used on the start of element XML base event.

addChild() - Method in class org.xbrlapi.SAXHandlers.ElementState

addDocumentation(Fragment) - Method in class org.xbrlapi.impl.LinkbaseImpl

Add a link documentation fragment to the end of the linkbase.

addDocumentation(Fragment) - Method in interface org.xbrlapi.Linkbase

Add a link documentation fragment to the end of the linkbase.

addedAFragment() - Method in interface org.xbrlapi.loader.Loader

Tests if the element that has just been found has triggered the addition of a fragment.

addedAFragment() - Method in class org.xbrlapi.loader.LoaderImpl

Tests if the element that has just been found has triggered the addition of a fragment.

addEscapes(String) - Static method in error org.xbrlapi.xpointer.TokenMgrError

Replaces unprintable characters by their espaced (or unicode escaped) equivalents in the given string

addExtendedLink(SimpleLink) - Method in class org.xbrlapi.impl.LinkbaseImpl

Adds an extended link to a linkbase.

addExtendedLink(SimpleLink) - Method in interface org.xbrlapi.Linkbase

Adds an extended link to a linkbase.

addFragment(F) - Method in interface org.xbrlapi.FragmentList

Adds a specified fragment to the end of the list of fragments.

addFragment(F) - Method in class org.xbrlapi.impl.FragmentListImpl

Adds a specified fragment to the end of the list of fragments.

addFragment(Fragment, long, ElementState) - Method in interface org.xbrlapi.loader.Loader

Push a new fragment onto the stack of fragments that are being built by the loader.

addFragment(Fragment, long, ElementState) - Method in class org.xbrlapi.loader.LoaderImpl

Push a new fragment onto the stack of fragments that are being built by the loader.

addIndex(String, String, String) - Method in class org.xbrlapi.data.xindice.StoreImpl

Adds an index to the collection containing the DTS.

addNetwork(Network) - Method in class org.xbrlapi.impl.NetworksImpl

addNetwork(Network) - Method in interface org.xbrlapi.Networks

addRelationship(Relationship) - Method in interface org.xbrlapi.EquivalentRelationships

addRelationship(Relationship) - Method in class org.xbrlapi.impl.EquivalentRelationshipsImpl

addRelationship(Relationship) - Method in class org.xbrlapi.impl.NetworkImpl

addRelationship(Relationship) - Method in class org.xbrlapi.impl.NetworksImpl

addRelationship(Relationship) - Method in interface org.xbrlapi.Network

Adds the relationship to the network making it discoverable given the index of the source fragment and the target fragment.

addRelationship(Relationship) - Method in interface org.xbrlapi.Networks

addRoleRef(SimpleLink) - Method in class org.xbrlapi.impl.LinkbaseImpl

Adds an roleRef to a linkbase.

addRoleRef(SimpleLink) - Method in interface org.xbrlapi.Linkbase

Adds an roleRef to a linkbase.

adjustBeginLineColumn(int, int) - Method in class org.xbrlapi.xpointer.SimpleCharStream

Method to adjust line and column numbers for the start of a token.

appendAttributeDecl(String, String, String, String, String) - Method in interface org.xbrlapi.builder.Builder

Append an attribute DTD declaration

appendAttributeDecl(String, String, String, String, String) - Method in class org.xbrlapi.builder.BuilderImpl

Append an attribute DTD declaration

appendComment(String) - Method in interface org.xbrlapi.builder.Builder

Append a comment node.

appendComment(String) - Method in class org.xbrlapi.builder.BuilderImpl

Append a comment node.

appendElement(String, String, String, Attributes) - Method in interface org.xbrlapi.builder.Builder

Append an element node.

appendElement(String, String, String) - Method in interface org.xbrlapi.builder.Builder

Insert a new element without attributes.

appendElement(String, String, String, Attributes) - Method in class org.xbrlapi.builder.BuilderImpl

Append an element node.

appendElement(String, String, String) - Method in class org.xbrlapi.builder.BuilderImpl

Insert a new element without attributes.

appendElementDecl(String, String) - Method in interface org.xbrlapi.builder.Builder

Append an element DTD declaration.

appendElementDecl(String, String) - Method in class org.xbrlapi.builder.BuilderImpl

Append an element DTD declaration.

appendElementSchemeXPointer(String) - Method in interface org.xbrlapi.Fragment

Add an element Scheme XPointer Expression to the metadata.

appendElementSchemeXPointer(String) - Method in class org.xbrlapi.impl.FragmentImpl

appendExternalEntityDecl(String, String, String) - Method in interface org.xbrlapi.builder.Builder

Append an external entity DTD declarations

appendExternalEntityDecl(String, String, String) - Method in class org.xbrlapi.builder.BuilderImpl

Append an external entity DTD declarations.

appendID(String) - Method in interface org.xbrlapi.Fragment

Add an ID (used in XPointer resolution) to the metadata.

appendID(String) - Method in class org.xbrlapi.impl.FragmentImpl

appendInternalEntityDecl(String, String) - Method in interface org.xbrlapi.builder.Builder

Append an internal entity DTD declaration.

appendInternalEntityDecl(String, String) - Method in class org.xbrlapi.builder.BuilderImpl

Append an internal entity DTD declaration.

appendMetadataElement(String, HashMap<String, String>) - Method in interface org.xbrlapi.builder.Builder

Appends a child element to the root metadata element.

appendMetadataElement(String, HashMap<String, String>) - Method in class org.xbrlapi.builder.BuilderImpl

Appends a child element to the root metadata element.

appendMetadataElement(String, HashMap<String, String>) - Method in interface org.xbrlapi.Fragment

Appends a child element to the root metadata element.

appendMetadataElement(String, HashMap<String, String>) - Method in class org.xbrlapi.impl.FragmentImpl

appendNotationDecl(String, String, String) - Method in interface org.xbrlapi.builder.Builder

Append a notation declaration.

appendNotationDecl(String, String, String) - Method in class org.xbrlapi.builder.BuilderImpl

Append a notation declaration.

appendProcessingInstruction(String, String) - Method in interface org.xbrlapi.builder.Builder

Append a processing instruction node

appendProcessingInstruction(String, String) - Method in class org.xbrlapi.builder.BuilderImpl

Append a processing instruction node

appendText(String) - Method in interface org.xbrlapi.builder.Builder

Append a text node.

appendText(String) - Method in class org.xbrlapi.builder.BuilderImpl

Append a text node.

appendTitle(Title) - Method in interface org.xbrlapi.Xlink

Append a title element to the XLink fragment

appendUnparsedEntityDecl(String, String, String, String) - Method in interface org.xbrlapi.builder.Builder

Append an unparsed entity declaration.

appendUnparsedEntityDecl(String, String, String, String) - Method in class org.xbrlapi.builder.BuilderImpl

Append an unparsed entity declaration.

Arc - Interface in org.xbrlapi

ARC - Static variable in interface org.xbrlapi.xlink.XLinkProcessor

ArcEnd - Interface in org.xbrlapi

ArcEndImpl - Class in org.xbrlapi.impl

ArcEndImpl() - Constructor for class org.xbrlapi.impl.ArcEndImpl

ArcImpl - Class in org.xbrlapi.impl

Used for all extended link arcs.

ArcImpl() - Constructor for class org.xbrlapi.impl.ArcImpl

ArcroleType - Interface in org.xbrlapi

ArcroleTypeImpl - Class in org.xbrlapi.impl

ArcroleTypeImpl() - Constructor for class org.xbrlapi.impl.ArcroleTypeImpl

augmentChildren() - Method in class org.xbrlapi.loader.LoaderImpl

We need to track the number of children for all of the elements being built for all of the fragments being built.

B

backup(int) - Method in class org.xbrlapi.xpointer.SimpleCharStream

badUsage(String) - Static method in class org.xbrlapi.data.exist.Load

Report incorrect usage of the command line, with a list of the options and arguments that are available

badUsage(String) - Static method in class org.xbrlapi.data.xindice.Load

Report incorrect usage of the command line, with a list of the options and arguments that are available

badUsage(String) - Static method in class org.xbrlapi.Run

Report incorrect usage of the command line, with a list of the options and arguments that are available

badUsage(String) - Static method in class org.xbrlapi.xlink.Validator

Report incorrect usage of the command line XLink validator

BaseChar - Static variable in interface org.xbrlapi.xpointer.PointerGrammarConstants

BaseMatcherImpl - Class in org.xbrlapi.data.resource

BaseMatcherImpl(CacheImpl, Signer) - Constructor for class org.xbrlapi.data.resource.BaseMatcherImpl

BaseStoreImpl - Class in org.xbrlapi.data

Abstract base implementation of the data store providing all methods of the store interface that do not depend on the nature of the underlying data store implementation.

BaseStoreImpl() - Constructor for class org.xbrlapi.data.BaseStoreImpl

BaseTestCase - Class in org.xbrlapi.utilities

Provides a base test case for all tests in the XBRL API test suite.

BaseTestCase(String) - Constructor for class org.xbrlapi.utilities.BaseTestCase

Base test case constructor loads the test suite configuration properties.

baseURL - Variable in class org.xbrlapi.utilities.BaseTestCase

Base URL for test data

BaseURLDOMResolver - Interface in org.xbrlapi.xmlbase

BaseURLDOMResolverImpl - Class in org.xbrlapi.xmlbase

BaseURLDOMResolverImpl(URL) - Constructor for class org.xbrlapi.xmlbase.BaseURLDOMResolverImpl

Constructor takes the absolute URL of the document to be processed using this BaseURLSAXResolver Implementation as an input.

BaseURLDOMResolverImpl() - Constructor for class org.xbrlapi.xmlbase.BaseURLDOMResolverImpl

Constructor for processing documents without a base URL.

BaseURLResolver - Interface in org.xbrlapi.xmlbase

This interface declares the functionality expected of classes that provide the XML Base functionality required by XBRL API.

BaseURLResolverImpl - Class in org.xbrlapi.xmlbase

This class implements the XML Base required by the XBRL API.

BaseURLResolverImpl() - Constructor for class org.xbrlapi.xmlbase.BaseURLResolverImpl

Constructor does nothing

BaseURLSAXResolver - Interface in org.xbrlapi.xmlbase

BaseURLSAXResolverImpl - Class in org.xbrlapi.xmlbase

BaseURLSAXResolverImpl(URL) - Constructor for class org.xbrlapi.xmlbase.BaseURLSAXResolverImpl

Constructor takes the absolute URL of the document to be processed using this BaseURLSAXResolver Implementation as an input.

BaseURLSAXResolverImpl() - Constructor for class org.xbrlapi.xmlbase.BaseURLSAXResolverImpl

Constructor for processing documents without a base URL.

beginColumn - Variable in class org.xbrlapi.xpointer.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

beginLine - Variable in class org.xbrlapi.xpointer.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

BeginToken() - Method in class org.xbrlapi.xpointer.SimpleCharStream

bufcolumn - Variable in class org.xbrlapi.xpointer.SimpleCharStream

buffer - Variable in class org.xbrlapi.xpointer.SimpleCharStream

bufline - Variable in class org.xbrlapi.xpointer.SimpleCharStream

bufpos - Variable in class org.xbrlapi.xpointer.SimpleCharStream

Builder - Interface in org.xbrlapi.builder

Methods exposed by the fragment builder.

BuilderImpl - Class in org.xbrlapi.builder

Class defining the SAX event handlers that enable a fragment to be built up during DTS discovery.

BuilderImpl(Document) - Constructor for class org.xbrlapi.builder.BuilderImpl

Create the builder making sure that the static DOM is instantiated and creating the metadata root element.

BuilderImpl() - Constructor for class org.xbrlapi.builder.BuilderImpl

Create the builder making sure that the static DOM is instantiated and creating the metadata root element.

C

cacheGrammars(String, Grammar[]) - Method in class org.xbrlapi.utilities.XBRLAPIGrammarPoolImpl

CacheImpl - Class in org.xbrlapi.cache

CacheImpl(File) - Constructor for class org.xbrlapi.cache.CacheImpl

Constructs a URL translator for usage with a local cache location.

CacheImpl(File, Map<String, String>) - Constructor for class org.xbrlapi.cache.CacheImpl

Constructs a URL translator for usage with a local cache location.

cachePath - Variable in class org.xbrlapi.utilities.BaseTestCase

Absolute path to the local document cache

CalculationArcRole - Static variable in class org.xbrlapi.utilities.Constants

cancelInterrupt() - Method in interface org.xbrlapi.loader.Loader

Cancels a request for an interrupt.

cancelInterrupt() - Method in class org.xbrlapi.loader.LoaderImpl

characters(char[], int, int) - Method in class org.xbrlapi.SAXHandlers.ContentHandlerImpl

Copy characters (trimming white space as required) to the DTSImpl.

characters(char[], int, int) - Method in class org.xbrlapi.xlink.ValidatorSAXContentHandlerImpl

Handle SAX Character events

close() - Method in class org.xbrlapi.builder.BuilderImpl

Restores the builder to its pre-use state.

close() - Method in class org.xbrlapi.data.BaseStoreImpl

Close the data store.

close() - Method in class org.xbrlapi.data.bdbxml.StoreImpl

The closure operation entails closing the XML container and the XML data manager that are used by the store.

close() - Method in class org.xbrlapi.data.dom.StoreImpl

close() - Method in interface org.xbrlapi.data.exist.DBConnection

Close down the connection to the database.

close() - Method in class org.xbrlapi.data.exist.DBConnectionImpl

close() - Method in class org.xbrlapi.data.exist.StoreImpl

Close the data store.

close() - Method in interface org.xbrlapi.data.Store

Close the data store.

close() - Method in interface org.xbrlapi.data.xindice.DBConnection

Close down the connection to the database.

close() - Method in class org.xbrlapi.data.xindice.DBConnectionImpl

close() - Method in class org.xbrlapi.data.xindice.StoreImpl

Close the data store by closing the data and metadata collections.

column - Variable in class org.xbrlapi.xpointer.SimpleCharStream

CombiningChar - Static variable in interface org.xbrlapi.xpointer.PointerGrammarConstants

CommentaryGuidanceLabelRole - Static variable in class org.xbrlapi.utilities.Constants

CommentaryReferenceRole - Static variable in class org.xbrlapi.utilities.Constants

compare(Fragment, Fragment) - Method in class org.xbrlapi.impl.FragmentComparator

Compare two fragment objects and order such that fragments in different documents are grouped separately and so that the fragments are ordered from the closest to the end of the document in document order to the closest to the beginning in document order.

CompNamespace - Static variable in class org.xbrlapi.utilities.Constants

Composite document namespace as used by the composite documents produced by XBRLComposer.

Compose - Class in org.xbrlapi.data.dom

Compose() - Constructor for class org.xbrlapi.data.dom.Compose

CompPrefix - Static variable in class org.xbrlapi.utilities.Constants

Concept - Interface in org.xbrlapi

ConceptImpl - Class in org.xbrlapi.impl

ConceptImpl() - Constructor for class org.xbrlapi.impl.ConceptImpl

configuration - Variable in class org.xbrlapi.utilities.BaseTestCase

Constants - Class in org.xbrlapi.utilities

Defines a range of constants (namespaces etc) that are used throughout the XBRLAPI implementation

Constants() - Constructor for class org.xbrlapi.utilities.Constants

containsGrammar(XMLGrammarDescription) - Method in class org.xbrlapi.utilities.XBRLAPIGrammarPoolImpl

ContentHandlerImpl - Class in org.xbrlapi.SAXHandlers

SAX content handler used in construction of an XBRL Discoverable Taxonomy Set (DTS).

ContentHandlerImpl(Loader, URL) - Constructor for class org.xbrlapi.SAXHandlers.ContentHandlerImpl

Creates the content handler, starting out by identifying the DTS structure that the content handler is discovering.

ContentHandlerImpl(Loader, URL, String) - Constructor for class org.xbrlapi.SAXHandlers.ContentHandlerImpl

Creates the content handler, starting out by identifying the data structure that the content handler is discovering.

Context - Interface in org.xbrlapi

ContextComponent - Interface in org.xbrlapi

ContextComponentImpl - Class in org.xbrlapi.impl

ContextComponentImpl() - Constructor for class org.xbrlapi.impl.ContextComponentImpl

ContextImpl - Class in org.xbrlapi.impl

ContextImpl() - Constructor for class org.xbrlapi.impl.ContextImpl

copyToCache(URL, File) - Method in class org.xbrlapi.cache.CacheImpl

Copy the original resource into the local cache if the resource exists and is able to be copied into the cache and does nothing otherwise.

copyToCache(URL, String) - Method in class org.xbrlapi.cache.CacheImpl

Copy the original resource into the local cache.

createCollection(String, Collection) - Method in interface org.xbrlapi.data.exist.DBConnection

Create a collection.

createCollection(String, Collection) - Method in class org.xbrlapi.data.exist.DBConnectionImpl

Create a collection.

createCollection(String, Collection) - Method in interface org.xbrlapi.data.xindice.DBConnection

Create a collection.

createCollection(String, Collection) - Method in class org.xbrlapi.data.xindice.DBConnectionImpl

Create a collection.

createRootCollection(String) - Method in interface org.xbrlapi.data.exist.DBConnection

Convenience method for creating a root collection.

createRootCollection(String) - Method in class org.xbrlapi.data.exist.DBConnectionImpl

Convenience method for creating a root collection.

createRootCollection(String) - Method in interface org.xbrlapi.data.xindice.DBConnection

Convenience method for creating a root collection.

createRootCollection(String) - Method in class org.xbrlapi.data.xindice.DBConnectionImpl

Convenience method for creating a root collection.

curChar - Variable in class org.xbrlapi.xpointer.PointerGrammarTokenManager

currentToken - Variable in exception org.xbrlapi.xpointer.ParseException

This is the last token that has been consumed successfully.

CUSTOM_LINK - Static variable in interface org.xbrlapi.xlink.XLinkProcessor

CustomLinkRecogniser - Class in org.xbrlapi.xlink

CustomLinkRecogniser() - Constructor for class org.xbrlapi.xlink.CustomLinkRecogniser

CustomType - Interface in org.xbrlapi

Custom type of XLink arcrole or role

CustomTypeImpl - Class in org.xbrlapi.impl

CustomTypeImpl() - Constructor for class org.xbrlapi.impl.CustomTypeImpl

D

dataContainer - Variable in class org.xbrlapi.data.bdbxml.StoreImpl

dataManager - Variable in class org.xbrlapi.data.bdbxml.StoreImpl

DBConnection - Interface in org.xbrlapi.data.exist

Data store connection interface.

DBConnection - Interface in org.xbrlapi.data.xindice

Data store connection interface.

DBConnectionImpl - Class in org.xbrlapi.data.exist

DBConnectionImpl(String, String, String, String, String) - Constructor for class org.xbrlapi.data.exist.DBConnectionImpl

Constructor registers the database with the XML:DB database manager.

DBConnectionImpl - Class in org.xbrlapi.data.xindice

DBConnectionImpl(String, String, String) - Constructor for class org.xbrlapi.data.xindice.DBConnectionImpl

Constructor registers the Xindice database with the XML:DB database manager.

debugStream - Variable in class org.xbrlapi.xpointer.PointerGrammarTokenManager

DEFAULT - Static variable in interface org.xbrlapi.xpointer.PointerGrammarConstants

DefaultMatcherImpl - Class in org.xbrlapi.data.resource

The default resource matcher implementation is used by stores by default.

DefaultMatcherImpl() - Constructor for class org.xbrlapi.data.resource.DefaultMatcherImpl

DefaultPointerNamespace - Static variable in interface org.xbrlapi.xpointer.PointerPart

DefinitionGuidanceLabelRole - Static variable in class org.xbrlapi.utilities.Constants

DefinitionReferenceRole - Static variable in class org.xbrlapi.utilities.Constants

delete() - Method in class org.xbrlapi.data.bdbxml.StoreImpl

delete() - Method in class org.xbrlapi.data.dom.StoreImpl

The store is in memory so no actions are required to remove the data store from persistent storage.

delete() - Method in class org.xbrlapi.data.exist.StoreImpl

delete() - Method in interface org.xbrlapi.data.Store

Delete and close the data store.

delete() - Method in class org.xbrlapi.data.xindice.StoreImpl

deleteCollection(String) - Method in interface org.xbrlapi.data.exist.DBConnection

Delete a collection.

deleteCollection(String, Collection) - Method in interface org.xbrlapi.data.exist.DBConnection

Delete a collection.

deleteCollection(String) - Method in class org.xbrlapi.data.exist.DBConnectionImpl

Delete a collection.

deleteCollection(String, Collection) - Method in class org.xbrlapi.data.exist.DBConnectionImpl

Delete a collection.

deleteCollection(String) - Method in interface org.xbrlapi.data.xindice.DBConnection

Delete a collection.

deleteCollection(String, Collection) - Method in interface org.xbrlapi.data.xindice.DBConnection

Delete a collection.

deleteCollection(String) - Method in class org.xbrlapi.data.xindice.DBConnectionImpl

Delete a collection.

deleteCollection(String, Collection) - Method in class org.xbrlapi.data.xindice.DBConnectionImpl

Delete a collection.

deleteDocument(String) - Method in class org.xbrlapi.data.BaseStoreImpl

deleteDocument(String) - Method in interface org.xbrlapi.data.Store

This deletion method does not ensure that all other documents that link to the document being deleted are also deleted.

deleteIndex(String) - Method in class org.xbrlapi.data.xindice.StoreImpl

Deletes an index to the collection containing the DTS.

deleteRelatedDocuments(String) - Method in class org.xbrlapi.data.BaseStoreImpl

deleteRelatedDocuments(String) - Method in interface org.xbrlapi.data.Store

This deletion method ensures that all related documents are also deleted from the data store.

Digit - Static variable in interface org.xbrlapi.xpointer.PointerGrammarConstants

disable_tracing() - Method in class org.xbrlapi.xpointer.PointerGrammar

DisclosureGuidanceLabelRole - Static variable in class org.xbrlapi.utilities.Constants

DisclosureReferenceRole - Static variable in class org.xbrlapi.utilities.Constants

discover() - Method in interface org.xbrlapi.loader.Loader

Begin the XBRL DTS discovery process with the URLs that are already in the loading/discovery queue.

discover(URL, String) - Method in interface org.xbrlapi.loader.Loader

Perform a discovery starting with an XML document that is represented as a string.

discover(List<URL>) - Method in interface org.xbrlapi.loader.Loader

Begin the XBRL DTS discovery process with the specified URLs given in the provided list.

discover(URL) - Method in interface org.xbrlapi.loader.Loader

Trigger the discovery process given a single URL.

discover(String) - Method in interface org.xbrlapi.loader.Loader

Trigger the discovery process given a single URL.

discover(List<URL>) - Method in class org.xbrlapi.loader.LoaderImpl

discover(URL) - Method in class org.xbrlapi.loader.LoaderImpl

discover(String) - Method in class org.xbrlapi.loader.LoaderImpl

discover() - Method in class org.xbrlapi.loader.LoaderImpl

discover(URL, String) - Method in class org.xbrlapi.loader.LoaderImpl

Perform a discovery starting with an XML document that is represented as a string.

Discoverer - Class in org.xbrlapi.loader.discoverer

Discoverer(Loader) - Constructor for class org.xbrlapi.loader.discoverer.Discoverer

discoverNext() - Method in interface org.xbrlapi.loader.Loader

Parses the next document in the queue of documents to be discovered.

discoverNext() - Method in class org.xbrlapi.loader.LoaderImpl

DiscoveryManager - Class in org.xbrlapi.loader.discoverer

DiscoveryManager(Loader) - Constructor for class org.xbrlapi.loader.discoverer.DiscoveryManager

DiscoveryManager(Loader, long) - Constructor for class org.xbrlapi.loader.discoverer.DiscoveryManager

DiscoveryManager(Loader, List<URL>) - Constructor for class org.xbrlapi.loader.discoverer.DiscoveryManager

DiscoveryManager(Loader, List<URL>, long) - Constructor for class org.xbrlapi.loader.discoverer.DiscoveryManager

DocumentationLabelRole - Static variable in class org.xbrlapi.utilities.Constants

DOM2String(Element) - Method in class org.xbrlapi.data.BaseStoreImpl

Convert a DOM element (and its descendents) to a string.

DOMLoadingTestCase - Class in org.xbrlapi

Provides a base test case for all tests involving loading of data into a data store.

DOMLoadingTestCase(String) - Constructor for class org.xbrlapi.DOMLoadingTestCase

Done() - Method in class org.xbrlapi.xpointer.SimpleCharStream

E

ElementDeclaration - Interface in org.xbrlapi

Used for top level element declarations (where the elements are given a name and occur as children of XML Schema schema elements.

ElementDeclarationImpl - Class in org.xbrlapi.impl

ElementDeclarationImpl() - Constructor for class org.xbrlapi.impl.ElementDeclarationImpl

ElementState - Class in org.xbrlapi.SAXHandlers

ElementState(ElementState) - Constructor for class org.xbrlapi.SAXHandlers.ElementState

Initialise the own order using information about children of parent element.

ElementState() - Constructor for class org.xbrlapi.SAXHandlers.ElementState

emptyGrammarPool() - Static method in class org.xbrlapi.utilities.GrammarCacheImpl

enable_tracing() - Method in class org.xbrlapi.xpointer.PointerGrammar

endArc(String, String, String) - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

Handle the end of the arc.

endArc(String, String, String) - Method in class org.xbrlapi.xlink.Validator

endArc(String, String, String) - Method in interface org.xbrlapi.xlink.XLinkHandler

Handles straight pass through of SAX event for the end of simple link elements.

endArc(String, String, String) - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

endColumn - Variable in class org.xbrlapi.xpointer.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

endDocument() - Method in class org.xbrlapi.SAXHandlers.ContentHandlerImpl

The end of the document triggers stepping out of the document's container element

endElement(String, String, String) - Method in interface org.xbrlapi.builder.Builder

Update the insertion point for new content when reaching the end of an element.

endElement(String, String, String) - Method in class org.xbrlapi.builder.BuilderImpl

Update the insertion point for new content when reaching the end of an element.

endElement(String, String, String) - Method in class org.xbrlapi.SAXHandlers.ContentHandlerImpl

The end of an element triggers processing of an extended link if we have reached the end of an extended link.

endElement(String, String, String) - Method in class org.xbrlapi.xlink.ValidatorSAXContentHandlerImpl

Fire off necessary XLink events on end of elements

endElement(String, String, String) - Method in interface org.xbrlapi.xlink.XLinkProcessor

Respond to the end of an element, examining the element for XLink features

endElement(String, String, String) - Method in class org.xbrlapi.xlink.XLinkProcessorImpl

endExtendedLink(String, String, String) - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

Nothing needs to be done at the end of the extended link discovery.

endExtendedLink(String, String, String) - Method in class org.xbrlapi.xlink.Validator

endExtendedLink(String, String, String) - Method in interface org.xbrlapi.xlink.XLinkHandler

Handles straight pass through of SAX event for the end of extended link elements.

endExtendedLink(String, String, String) - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

endLine - Variable in class org.xbrlapi.xpointer.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

endLocator(String, String, String) - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

Handle the end of the locator.

endLocator(String, String, String) - Method in class org.xbrlapi.xlink.Validator

endLocator(String, String, String) - Method in interface org.xbrlapi.xlink.XLinkHandler

Handles straight pass through of SAX event for the end of locators.

endLocator(String, String, String) - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

endResource(String, String, String) - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

Handle the end of the resource.

endResource(String, String, String) - Method in class org.xbrlapi.xlink.Validator

endResource(String, String, String) - Method in interface org.xbrlapi.xlink.XLinkHandler

Handles straight pass through of SAX event for the end of local resources.

endResource(String, String, String) - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

endSimpleLink(String, String, String) - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

Handle the end of the simple link

endSimpleLink(String, String, String) - Method in class org.xbrlapi.xlink.Validator

endSimpleLink(String, String, String) - Method in interface org.xbrlapi.xlink.XLinkHandler

Handles straight pass through of SAX event for the end of simple link elements.

endSimpleLink(String, String, String) - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

endTitle(String, String, String) - Method in class org.xbrlapi.xlink.Validator

endTitle(String, String, String) - Method in interface org.xbrlapi.xlink.XLinkHandler

Handles straight pass through of SAX event for the end of simple title elements.

endTitle(String, String, String) - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

Entity - Interface in org.xbrlapi

EntityImpl - Class in org.xbrlapi.impl

EntityImpl() - Constructor for class org.xbrlapi.impl.EntityImpl

EntityResolverImpl - Class in org.xbrlapi.SAXHandlers

Entity resolver that dynamically adds to the local document cache and that gives preference to the local cache as resources are identified by the resolution process.

EntityResolverImpl(File) - Constructor for class org.xbrlapi.SAXHandlers.EntityResolverImpl

Construct the entity resolver by storing the cache root.

EntityResolverImpl(File, Map<String, String>) - Constructor for class org.xbrlapi.SAXHandlers.EntityResolverImpl

Create the entity resolver with a set of local URLs to be used by the loader in place of actual URLs.

EntityResource - Interface in org.xbrlapi

Defines the functionality for the custom entity resource: a extended link resource that has a 1:1 association with a given entity identifier.

EntityResourceImpl - Class in org.xbrlapi.impl

Entity resource implementation.

EntityResourceImpl() - Constructor for class org.xbrlapi.impl.EntityResourceImpl

EntryPoint - Interface in org.xbrlapi

EOF - Static variable in interface org.xbrlapi.xpointer.PointerGrammarConstants

eol - Variable in exception org.xbrlapi.xpointer.ParseException

The end of line string for this machine.

equals(Context) - Method in interface org.xbrlapi.Context

Tests if the context is c-equal to another context returning true if they are c-equal.

equals(Object) - Method in interface org.xbrlapi.Fragment

Override the Object equals method to base equality on the fragment index.

equals(Context) - Method in class org.xbrlapi.impl.ContextImpl

Tests if the context is c-equal to another context See the XBRL 2.1 specification for a definition of c-equal.

equals(Object) - Method in class org.xbrlapi.impl.FragmentImpl

equals(Relationship) - Method in class org.xbrlapi.impl.RelationshipImpl

equals(Unit) - Method in class org.xbrlapi.impl.UnitImpl

Tests if the unit is u-equal to another unit

equals(OpenContextComponent) - Method in interface org.xbrlapi.OpenContextComponent

Test c-equality of this open context component and another.

equals(Relationship) - Method in interface org.xbrlapi.Relationship

equals(Unit) - Method in interface org.xbrlapi.Unit

Tests if the unit is u-equal to another unit returning true if they are u-equal and false otherwise

EquivalentRelationships - Interface in org.xbrlapi

EquivalentRelationshipsImpl - Class in org.xbrlapi.impl

EquivalentRelationshipsImpl() - Constructor for class org.xbrlapi.impl.EquivalentRelationshipsImpl

error(SAXParseException) - Method in class org.xbrlapi.SAXHandlers.ContentHandlerImpl

error(String, String, String, Attributes, String) - Method in class org.xbrlapi.xlink.Validator

Record the error message

error(String, String, String, Attributes, String) - Method in interface org.xbrlapi.xlink.XLinkHandler

Handle an error message from the XLink processor allowing the handler to decide how seriously to take the error.

error(String, String, String, Attributes, String) - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

Default error behaviour is to throw an XLink Exception

EscapedChar - Static variable in interface org.xbrlapi.xpointer.PointerGrammarConstants

EscapedData() - Method in class org.xbrlapi.xpointer.PointerGrammar

EssenceAliasArcRole - Static variable in class org.xbrlapi.utilities.Constants

ExampleGuidanceLabelRole - Static variable in class org.xbrlapi.utilities.Constants

ExampleReferenceRole - Static variable in class org.xbrlapi.utilities.Constants

ExpandBuff(boolean) - Method in class org.xbrlapi.xpointer.SimpleCharStream

expectedTokenSequences - Variable in exception org.xbrlapi.xpointer.ParseException

Each entry in this array is an array of integers.

extendChildren() - Method in interface org.xbrlapi.loader.Loader

Add a new node to the vector of children being tracked for the current fragment.

extendChildren() - Method in class org.xbrlapi.loader.LoaderImpl

Add a new node to the vector of children being tracked for the current fragment.

EXTENDED_LINK - Static variable in interface org.xbrlapi.xlink.XLinkProcessor

ExtendedLink - Interface in org.xbrlapi

ExtendedLinkContent - Interface in org.xbrlapi

ExtendedLinkContentImpl - Class in org.xbrlapi.impl

ExtendedLinkContentImpl() - Constructor for class org.xbrlapi.impl.ExtendedLinkContentImpl

ExtendedLinkImpl - Class in org.xbrlapi.impl

ExtendedLinkImpl() - Constructor for class org.xbrlapi.impl.ExtendedLinkImpl

Extender - Static variable in interface org.xbrlapi.xpointer.PointerGrammarConstants

F

Fact - Interface in org.xbrlapi

FactDimensionContainer - Interface in org.xbrlapi

FactDimensionContainerImpl - Class in org.xbrlapi.impl

FactDimensionContainerImpl() - Constructor for class org.xbrlapi.impl.FactDimensionContainerImpl

FactFootnoteArcRole - Static variable in class org.xbrlapi.utilities.Constants

FactImpl - Class in org.xbrlapi.impl

FactImpl() - Constructor for class org.xbrlapi.impl.FactImpl

fatalError(SAXParseException) - Method in class org.xbrlapi.SAXHandlers.ContentHandlerImpl

FillBuff() - Method in class org.xbrlapi.xpointer.SimpleCharStream

FootnoteResource - Interface in org.xbrlapi

FootnoteResourceImpl - Class in org.xbrlapi.impl

FootnoteResourceImpl() - Constructor for class org.xbrlapi.impl.FootnoteResourceImpl

formCompositeDocument() - Method in class org.xbrlapi.data.BaseStoreImpl

Get all data in the store as a single XML DOM object including the annotations used in the XBRLComposer project.

formCompositeDocument() - Method in interface org.xbrlapi.data.Store

Get all data in the store as a single XML DOM object including the annotations used in the XBRLComposer project.

FractionItem - Interface in org.xbrlapi

FractionItemImpl - Class in org.xbrlapi.impl

TODO Create fraction item examples in the conformance suite to test fraction items.

FractionItemImpl() - Constructor for class org.xbrlapi.impl.FractionItemImpl

Fragment - Interface in org.xbrlapi

Defines the functionality exposed by any fragment.

FragmentComparator - Class in org.xbrlapi.impl

Facilitates sorting of fragments so that they can be organised into complete XML document in the right order.

FragmentComparator() - Constructor for class org.xbrlapi.impl.FragmentComparator

FragmentDataContainerElementName - Static variable in class org.xbrlapi.utilities.Constants

FragmentFactory<F> - Class in org.xbrlapi.impl

Fragment instantiation factory used to create new fragments of the correct fragment type from data in the data store.

FragmentFactory() - Constructor for class org.xbrlapi.impl.FragmentFactory

FragmentImpl - Class in org.xbrlapi.impl

Implements the functionality that is common to all types of XBRL fragments.

FragmentImpl() - Constructor for class org.xbrlapi.impl.FragmentImpl

No argument constructor

FragmentList<F extends Fragment> - Interface in org.xbrlapi

FragmentListImpl<F extends Fragment> - Class in org.xbrlapi.impl

FragmentListImpl() - Constructor for class org.xbrlapi.impl.FragmentListImpl

FragmentRootElementName - Static variable in class org.xbrlapi.utilities.Constants

The local name of the root element for each fragment

G

GeneralSpecialArcRole - Static variable in class org.xbrlapi.utilities.Constants

generateParseException() - Method in class org.xbrlapi.xpointer.PointerGrammar

GenericLabelArcRole - Static variable in class org.xbrlapi.utilities.Constants

GenericLabelNamespace - Static variable in class org.xbrlapi.utilities.Constants

GenericLabelPrefix - Static variable in class org.xbrlapi.utilities.Constants

GenericLinkNamespace - Static variable in class org.xbrlapi.utilities.Constants

The namespace of the generic link and generic arc elements

GenericLinkPrefix - Static variable in class org.xbrlapi.utilities.Constants

The prefix for the generic link and generic arc elements

GenericReferenceArcRole - Static variable in class org.xbrlapi.utilities.Constants

GenericReferenceNamespace - Static variable in class org.xbrlapi.utilities.Constants

GenericReferencePrefix - Static variable in class org.xbrlapi.utilities.Constants

getAbsoluteHref() - Method in class org.xbrlapi.impl.LocatorImpl

Get the absolute value of the HREF to the metadata.

getAbsoluteHref() - Method in class org.xbrlapi.impl.SimpleLinkImpl

Get the absolute value of the HREF to the metadata.

getAbsoluteHref() - Method in interface org.xbrlapi.Locator

Get the absolute value of the HREF to the metadata.

getAbsoluteHref() - Method in interface org.xbrlapi.SimpleLink

Get the absolute value of the HREF to the metadata.

getActiveRelationship() - Method in interface org.xbrlapi.EquivalentRelationships

getActiveRelationship() - Method in class org.xbrlapi.impl.EquivalentRelationshipsImpl

getActiveRelationshipsFrom(String) - Method in class org.xbrlapi.impl.NetworkImpl

getActiveRelationshipsFrom(String) - Method in interface org.xbrlapi.Network

getActiveRelationshipsTo(String) - Method in class org.xbrlapi.impl.NetworkImpl

getActiveRelationshipsTo(String) - Method in interface org.xbrlapi.Network

getActuate() - Method in interface org.xbrlapi.Arc

Get the xlink:actuate attribute value.

getActuate() - Method in class org.xbrlapi.impl.ArcImpl

getActuate(String, String, String, Attributes) - Method in class org.xbrlapi.xlink.CustomLinkRecogniser

Get the simple link actuate equivalent if it exists

getAllChildren() - Method in interface org.xbrlapi.Fragment

Gets all child fragments.

getAllChildren() - Method in class org.xbrlapi.impl.FragmentImpl

getAllEntityLabels() - Method in interface org.xbrlapi.Entity

getAllEntityLabels() - Method in class org.xbrlapi.impl.EntityImpl

getAncestorOrSelf(String) - Method in interface org.xbrlapi.Fragment

Gets the ancestor (or self) fragment with the specified fragment type.

getAncestorOrSelf(String) - Method in class org.xbrlapi.impl.FragmentImpl

getAnnotations() - Method in class org.xbrlapi.impl.SchemaDeclarationImpl

TODO Implement the getAnnotations Method for schema declarations.

getAnnotations() - Method in interface org.xbrlapi.SchemaDeclaration

Retrieves an array of annotation objects associated with the concept The array is in document order for the XML Schema document containing the concept definition.

getArc() - Method in class org.xbrlapi.impl.RelationshipImpl

getArc() - Method in interface org.xbrlapi.Relationship

getArcAttributeValue(String, String) - Method in class org.xbrlapi.impl.RelationshipImpl

getArcAttributeValue(String, String) - Method in interface org.xbrlapi.Relationship

Use this method if the attribute on the arc has its own namespace.

getArcEndId() - Method in interface org.xbrlapi.ArcEnd

Get the id attribute value.

getArcEndId() - Method in class org.xbrlapi.impl.ArcEndImpl

Get the id attribute value.

getArcEndsByLabel(String) - Method in interface org.xbrlapi.ExtendedLink

Get the list of Arc Ends (locators or resources) with a specified label in the extended link.

getArcEndsByLabel(String) - Method in class org.xbrlapi.impl.ExtendedLinkImpl

Get the list of Arc Ends (locators or resources) with a specified label in the extended link.

getArcIndex() - Method in class org.xbrlapi.impl.RelationshipImpl

getArcIndex() - Method in interface org.xbrlapi.Relationship

getArcrole() - Method in interface org.xbrlapi.Arc

getArcrole() - Method in class org.xbrlapi.impl.ArcImpl

getArcRole() - Method in class org.xbrlapi.impl.NetworkImpl

getArcRole() - Method in class org.xbrlapi.impl.RelationshipImpl

getArcrole() - Method in class org.xbrlapi.impl.SimpleLinkImpl

Get the link arcrole attribute value, before any resolution.

getArcRole() - Method in interface org.xbrlapi.Network

getArcRole() - Method in interface org.xbrlapi.Relationship

getArcrole() - Method in interface org.xbrlapi.SimpleLink

Get the link arcrole attribute value, before any resolution.

getArcrole(String, String, String, Attributes) - Method in class org.xbrlapi.xlink.CustomLinkRecogniser

Get the simple link arcrole equivalent if it exists

getArcroleRef(String) - Method in class org.xbrlapi.impl.LinkbaseImpl

Retrieve an arcroleRef from a linkbase.

getArcroleRef(String) - Method in interface org.xbrlapi.Linkbase

Retrieve an arcroleRef from a linkbase.

getArcroleRefs() - Method in class org.xbrlapi.impl.LinkbaseImpl

Gets the list of arcroleRefs in a linkbase.

getArcroleRefs() - Method in interface org.xbrlapi.Linkbase

Gets the list of arcroleRefs in a linkbase.

getArcRoles() - Method in interface org.xbrlapi.data.XBRLStore

getArcRoles() - Method in class org.xbrlapi.data.XBRLStoreImpl

getArcRoles() - Method in class org.xbrlapi.impl.NetworksImpl

getArcRoles() - Method in interface org.xbrlapi.Networks

getArcroleTypes() - Method in interface org.xbrlapi.data.XBRLStore

getArcroleTypes(String) - Method in interface org.xbrlapi.data.XBRLStore

getArcroleTypes() - Method in class org.xbrlapi.data.XBRLStoreImpl

getArcroleTypes(String) - Method in class org.xbrlapi.data.XBRLStoreImpl

getArcs() - Method in interface org.xbrlapi.ExtendedLink

Get the list of arcs contained by the extended link.

getArcs() - Method in class org.xbrlapi.impl.ExtendedLinkImpl

Get the list of arcs contained by the extended link.

getArcsByFromLabel(String) - Method in interface org.xbrlapi.ExtendedLink

getArcsByFromLabel(String) - Method in class org.xbrlapi.impl.ExtendedLinkImpl

getArcsByFromLabelAndArcrole(String, String) - Method in interface org.xbrlapi.ExtendedLink

getArcsByFromLabelAndArcrole(String, String) - Method in class org.xbrlapi.impl.ExtendedLinkImpl

getArcsByToLabel(String) - Method in interface org.xbrlapi.ExtendedLink

getArcsByToLabel(String) - Method in class org.xbrlapi.impl.ExtendedLinkImpl

Get the list of arcs with a given xlink:from label in extended link.

getArcsByToLabelAndArcrole(String, String) - Method in interface org.xbrlapi.ExtendedLink

getArcsByToLabelAndArcrole(String, String) - Method in class org.xbrlapi.impl.ExtendedLinkImpl

getArcsFrom() - Method in interface org.xbrlapi.ArcEnd

getArcsFrom() - Method in class org.xbrlapi.impl.ArcEndImpl

getArcsFromWithArcrole(String) - Method in interface org.xbrlapi.ArcEnd

getArcsFromWithArcrole(String) - Method in class org.xbrlapi.impl.