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(Concept, String, URI) - Method in class org.xbrlapi.data.bdbxml.examples.render.Concepts

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

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

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

add(Network) - Method in interface org.xbrlapi.networks.Network

Adds relationships from the supplied network to this network where they are not already included.

add(Network) - Method in class org.xbrlapi.networks.NetworkImpl

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(Concepts) - Method in class org.xbrlapi.data.bdbxml.examples.render.Concepts

addAll(List<Language>) - Method in class org.xbrlapi.impl.LanguageMap

Adds a list of languages to the map.

addAll(Networks) - Method in interface org.xbrlapi.networks.Networks

Merges the specified set of networks into this set of networks.

addAll(Networks) - Method in class org.xbrlapi.networks.NetworksImpl

AddAnIndex - Class in org.xbrlapi.data.bdbxml.examples.utilities

Adds a new index to the data store.

AddAnIndex(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.AddAnIndex

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.

addArgumentDocumentation() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.AddAnIndex

addArgumentDocumentation() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseRelationshipsForAFragment

addArgumentDocumentation() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

Provides documentation of the usage of the utility.

addArgumentDocumentation() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.DeleteSpecificDocument

addArgumentDocumentation() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.FindLinksToGivenDocument

addArgumentDocumentation() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.FindLocatorsWithMultipleTargetsForADocument

addArgumentDocumentation() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.LoadCacheDocuments

addArgumentDocumentation() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.LoadSpecificDocument

addBaseURI(String) - Method in interface org.xbrlapi.xmlbase.BaseURISAXResolver

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

addBaseURI(String) - Method in class org.xbrlapi.xmlbase.BaseURISAXResolverImpl

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

addChild() - Method in class org.xbrlapi.xlink.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.

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.

addFact(Fact) - Method in interface org.xbrlapi.aspects.Aspect

Adds the fact to the aspect, generating the aspect value, and storing the fact for later retrieval by that aspect value.

addFact(Fact) - Method in interface org.xbrlapi.aspects.AspectModel

addFact(Fact) - Method in class org.xbrlapi.aspects.BaseAspect

addFact(Fact) - Method in class org.xbrlapi.aspects.BaseAspectModel

addFact(Fact) - Method in class org.xbrlapi.xdt.aspects.DimensionalAspectModel

Adds in the ability to detect new dimensional aspects inherent in the fact itself.

addIdentifier(Identifier) - Method in class org.xbrlapi.sax.ContentHandlerImpl

addIdentifier(int, Identifier) - Method in class org.xbrlapi.sax.ContentHandlerImpl

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

addLanguage(Language) - Method in class org.xbrlapi.impl.LanguageMap

Adds a language to the map.

addMatchedURI(URI) - Method in class org.xbrlapi.impl.MatchImpl

addMatchedURI(URI) - Method in interface org.xbrlapi.Match

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

If the collection of networks already has a network with the same role and arcrole, then the relationships from the added network are added into the existing network.

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

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

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

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

Adds the relationship to the network.

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

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

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

addRelationships(Collection<Relationship>) - Method in interface org.xbrlapi.networks.Network

Adds the set of relationships to the network.

addRelationships(Collection<Relationship>) - Method in class org.xbrlapi.networks.NetworkImpl

addRelationships(Collection<Relationship>) - Method in interface org.xbrlapi.networks.Networks

addRelationships(URI) - Method in interface org.xbrlapi.networks.Networks

Adds all relationships with the given arcrole to the set of networks.

addRelationships(URI) - Method in class org.xbrlapi.networks.NetworksImpl

addRelationships(Collection<Relationship>) - Method in class org.xbrlapi.networks.NetworksImpl

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.

addValue(A) - Method in interface org.xbrlapi.aspects.Aspect

addValue(AspectValue) - Method in class org.xbrlapi.aspects.BaseAspect

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

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

AllAnalyserImpl - Class in org.xbrlapi.networks

This Analyser returns information based upon all relationships (whether they are active or inactive or prohibited).

AllAnalyserImpl(Store) - Constructor for class org.xbrlapi.networks.AllAnalyserImpl

AnalyseCacheForMatchedDocuments - Class in org.xbrlapi.data.bdbxml.examples.utilities

Tests each document in the taxonomy cache to see if it has matching documents based on the @link org.xbrlapi.resource.Matcher used by the underlying data store.

AnalyseCacheForMatchedDocuments(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseCacheForMatchedDocuments

AnalyseEntityResources - Class in org.xbrlapi.data.bdbxml.examples.utilities

Reports on entity resources that have data.

AnalyseEntityResources(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseEntityResources

AnalyseLoadFailures - Class in org.xbrlapi.data.bdbxml.examples.utilities

Reports information about the documents that failed to load properly.

AnalyseLoadFailures(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseLoadFailures

AnalysePersistedRelationships - Class in org.xbrlapi.data.bdbxml.examples.utilities

Reports the number of persisted relationships in the data store.

AnalysePersistedRelationships(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.AnalysePersistedRelationships

Analyser - Interface in org.xbrlapi.networks

Classes implementing this interface support analysis of persisted relationship information in a data store.

AnalyseRelationshipsForAFragment - Class in org.xbrlapi.data.bdbxml.examples.utilities

Provides a range of diagnostic information about the XLink relationships involving the specified fragment.

AnalyseRelationshipsForAFragment(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseRelationshipsForAFragment

AnalyserImpl - Class in org.xbrlapi.networks

This Analyser returns information based upon all active relationships.

AnalyserImpl(Store) - Constructor for class org.xbrlapi.networks.AnalyserImpl

AnalyseUnitMeasures - Class in org.xbrlapi.data.bdbxml.examples.utilities

Provides a summary of the units of measurement set out in an given XBRL document.

AnalyseUnitMeasures(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseUnitMeasures

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.

appendDataElement(URI, String, String) - Method in class org.xbrlapi.impl.MockImpl

appendDataElement(URI, String, String) - Method in interface org.xbrlapi.Mock

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

Append an element node.

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

Insert a new element without attributes.

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

Append an element node.

appendElement(URI, 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 class org.xbrlapi.impl.XMLImpl

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

Appends a child element to the root metadata element.

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.

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

argumentDocumentation - Variable in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

arguments - Variable in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

arrangeAspect(String, String) - Method in interface org.xbrlapi.aspects.AspectModel

arrangeAspect(String, String, String) - Method in interface org.xbrlapi.aspects.AspectModel

arrangeAspect(String, String) - Method in class org.xbrlapi.aspects.BaseAspectModel

arrangeAspect(String, String, String) - Method in class org.xbrlapi.aspects.BaseAspectModel

Aspect - Interface in org.xbrlapi.aspects

AspectModel - Interface in org.xbrlapi.aspects

AspectValue - Interface in org.xbrlapi.aspects

AspectValueTransformer - Interface in org.xbrlapi.aspects

assessCustomEquality(Object, Object) - Method in class org.xbrlapi.utilities.BaseTestCase

Tests if the object and the copy are equal and have the same hash code.

AttributeDeclaration - Interface in org.xbrlapi

Used for attribute declaration fragments

AttributeDeclarationImpl - Class in org.xbrlapi.impl

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

AttributeGroupDeclaration - Interface in org.xbrlapi

Attribute group declaration interface.

AttributeGroupDeclarationImpl - Class in org.xbrlapi.impl

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

augmentNetworkForFragment(Fragment, Network) - Method in class org.xbrlapi.data.BaseStoreImpl

augmentNetworkForFragment(Fragment, Network) - Method in interface org.xbrlapi.data.Store

This method is recursive.

augmentNetworksForFragment(Fragment, URI, Networks) - Method in class org.xbrlapi.data.BaseStoreImpl

augmentNetworksForFragment(Fragment, URI, Networks) - Method in interface org.xbrlapi.data.Store

This method is recursive.

B

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

badUsage(String) - Method in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

Report incorrect usage of the utility.

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

Report incorrect usage of the command line XLink validator

BaseAspect - Class in org.xbrlapi.aspects

Abstract implementation of common aspect methods.

BaseAspect(AspectModel) - Constructor for class org.xbrlapi.aspects.BaseAspect

BaseAspectModel - Class in org.xbrlapi.aspects

Abstract implementation of common aspect model methods.

BaseAspectModel() - Constructor for class org.xbrlapi.aspects.BaseAspectModel

BaseAspectValue - Class in org.xbrlapi.aspects

BaseAspectValue(Aspect, Fragment) - Constructor for class org.xbrlapi.aspects.BaseAspectValue

BaseAspectValueTransformer - Class in org.xbrlapi.aspects

BaseAspectValueTransformer() - Constructor for class org.xbrlapi.aspects.BaseAspectValueTransformer

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

BaseContentHandlerImpl - Class in org.xbrlapi.sax

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

BaseContentHandlerImpl(Loader, URI) - Constructor for class org.xbrlapi.sax.BaseContentHandlerImpl

BaseIdentifier - Class in org.xbrlapi.sax.identifiers

The class implements the common methods for a fragment identifier.

BaseIdentifier(ContentHandler) - Constructor for class org.xbrlapi.sax.identifiers.BaseIdentifier

BaseMatcherImpl - Class in org.xbrlapi.data.resource

BaseMatcherImpl(Cache, 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.data.bdbxml

Provides a base test case for tests involving the BDB XML database.

BaseTestCase(String) - Constructor for class org.xbrlapi.data.bdbxml.BaseTestCase

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.

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

Base URI for test data

BaseURIDOMResolver - Interface in org.xbrlapi.xmlbase

BaseURIDOMResolverImpl - Class in org.xbrlapi.xmlbase

BaseURIDOMResolverImpl(URI) - Constructor for class org.xbrlapi.xmlbase.BaseURIDOMResolverImpl

Constructor takes the absolute URI of the document to be processed using this BaseURISAXResolver implementation as an input.

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

Constructor for processing documents without a base URI.

baseURIResolver - Variable in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

The base URI resolver used by the XLink handler

BaseURIResolver - Interface in org.xbrlapi.xmlbase

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

BaseURIResolverImpl - Class in org.xbrlapi.xmlbase

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

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

Constructor does nothing

BaseURISAXResolver - Interface in org.xbrlapi.xmlbase

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

BaseURISAXResolverImpl - Class in org.xbrlapi.xmlbase

BaseURISAXResolverImpl(URI) - Constructor for class org.xbrlapi.xmlbase.BaseURISAXResolverImpl

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

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

Constructor for processing documents without a base URI.

BaseUtilityExample - Class in org.xbrlapi.data.bdbxml.examples.utilities

Provides a base class that all of the concrete utility examples extend.

BaseUtilityExample() - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

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 controlling which XML DOM is being used.

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

Cache - Interface in org.xbrlapi.cache

cache - Variable in class org.xbrlapi.data.bdbxml.BaseTestCase

cache - Variable in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

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

CacheImpl - Class in org.xbrlapi.cache

Translates 1.

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

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

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

Constructs a URI 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.sax.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

clearAllCriteria() - Method in interface org.xbrlapi.aspects.AspectModel

Clears all fact selection criteria in the aspect model.

clearAllCriteria() - Method in class org.xbrlapi.aspects.BaseAspectModel

clearFacts() - Method in interface org.xbrlapi.aspects.Aspect

Removes all facts from the aspect and all aspect values from the aspect.

clearFacts() - Method in interface org.xbrlapi.aspects.AspectModel

Removes all facts from the aspect model and all aspect values from the aspects in the aspect models.

clearFacts() - Method in class org.xbrlapi.aspects.BaseAspect

clearFacts() - Method in class org.xbrlapi.aspects.BaseAspectModel

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

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

Specify that the data store is not to filter query results to only come from a specified set of URIs.

clearIdentifiers() - Method in interface org.xbrlapi.aspects.AspectValueTransformer

Empties the map of entity identifiers so that there are no aspect values pointing to identifiers anymore.

clearIdentifiers() - Method in class org.xbrlapi.aspects.BaseAspectValueTransformer

clearSelectionCriterion() - Method in interface org.xbrlapi.aspects.Aspect

Sets the selection criterion to null.

clearSelectionCriterion() - Method in class org.xbrlapi.aspects.BaseAspect

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.StoreImpl

Close the data store.

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

Close the data store.

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.

compare(Language, Language) - Method in class org.xbrlapi.impl.LanguageComparator

compare(Relationship, Relationship) - Method in class org.xbrlapi.impl.RelationshipOrderComparator

Persisted relationships with lower order values come first in the ordering.

compare(Relationship, Relationship) - Method in class org.xbrlapi.impl.RelationshipPriorityComparator

Persisted relationships with lower priority values come later in the ordering.

compare(DimensionValue, DimensionValue) - Method in class org.xbrlapi.xdt.values.DimensionValueComparator

compare(DimensionValue, DimensionValue) - Method in class org.xbrlapi.xdt.values.ExplicitDimensionValueLabelComparator

compare(DimensionValue, DimensionValue) - Method in class org.xbrlapi.xdt.values.ExplicitDimensionValueTreeComparator

compareDimensions(DimensionValue, DimensionValue) - Method in class org.xbrlapi.xdt.values.DimensionValueComparator

Do a comparison of the dimensions themselves.

compareItems(DimensionValue, DimensionValue) - Method in class org.xbrlapi.xdt.values.DimensionValueComparator

Do a comparison of the items that the dimension values are for, ranking them based on the string comparison of their index values.

compareTo(XML) - Method in class org.xbrlapi.impl.XMLImpl

Comparison is based upon the fragment index.

compareTypedDimensionValues(DimensionValue, DimensionValue) - Method in class org.xbrlapi.xdt.values.DimensionValueComparator

complete() - Method in interface org.xbrlapi.networks.Network

Complete the network, finding all active relationships in the data store that participate in the network.

complete() - Method in class org.xbrlapi.networks.NetworkImpl

complete() - Method in interface org.xbrlapi.networks.Networks

Complete the networks, finding all active relationships in the data store that participate in the networks.

complete() - Method in class org.xbrlapi.networks.NetworksImpl

ComplexTypeDeclaration - Interface in org.xbrlapi

Used for complex type declarations in XML Schemas.

ComplexTypeDeclarationImpl - Class in org.xbrlapi.impl

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

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

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

Concept - Interface in org.xbrlapi

ConceptAspect - Class in org.xbrlapi.aspects

All facts have a value for the concept aspect.

ConceptAspect(AspectModel) - Constructor for class org.xbrlapi.aspects.ConceptAspect

ConceptAspect.Transformer - Class in org.xbrlapi.aspects

ConceptAspect.Transformer() - Constructor for class org.xbrlapi.aspects.ConceptAspect.Transformer

ConceptAspectValue - Class in org.xbrlapi.aspects

ConceptAspectValue(Aspect, Concept) - Constructor for class org.xbrlapi.aspects.ConceptAspectValue

ConceptImpl - Class in org.xbrlapi.impl

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

Concepts - Class in org.xbrlapi.data.bdbxml.examples.render

Convenience class to help with the rendering process.

Concepts() - Constructor for class org.xbrlapi.data.bdbxml.examples.render.Concepts

concepts - Variable in class org.xbrlapi.data.bdbxml.examples.render.Concepts

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

configurationRoot - Static variable in class org.xbrlapi.data.exist.StoreImpl

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

constructXSModel() - Method in class org.xbrlapi.sax.identifiers.SchemaIdentifier

(Commented out!) Modified on 13 February, 2007 by Howard Ungar to use the static grammar pool provided by the GrammarCache implementation.

containerName - Variable in class org.xbrlapi.data.bdbxml.BaseTestCase

contains(String, String) - Method in class org.xbrlapi.impl.LanguageMap

contains(String) - Method in interface org.xbrlapi.networks.Network

contains(String) - Method in class org.xbrlapi.networks.NetworkImpl

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

ContentHandler - Interface in org.xbrlapi.sax

ContentHandlerImpl - Class in org.xbrlapi.sax

SAX content handler used to parse a document into an XBRL API data store.

ContentHandlerImpl(Loader, URI) - Constructor for class org.xbrlapi.sax.ContentHandlerImpl

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

ContentHandlerImpl(Loader, URI, String) - Constructor for class org.xbrlapi.sax.ContentHandlerImpl

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

ContentHandlerImpl - Class in org.xbrlapi.xdt

ContentHandlerImpl(Loader, URI) - Constructor for class org.xbrlapi.xdt.ContentHandlerImpl

ContentHandlerImpl(Loader, URI, String) - Constructor for class org.xbrlapi.xdt.ContentHandlerImpl

Context - Interface in org.xbrlapi

ContextAspect - Class in org.xbrlapi.aspects

ContextAspect(AspectModel) - Constructor for class org.xbrlapi.aspects.ContextAspect

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(URI, File) - Method in interface org.xbrlapi.cache.Cache

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(URI, String) - Method in interface org.xbrlapi.cache.Cache

Copy the original resource into the local cache.

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

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

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

Create a collection.

createLoader(Store) - Method in class org.xbrlapi.data.bdbxml.BaseTestCase

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

Convenience method for creating a root collection.

createStore(String, String) - Method in class org.xbrlapi.data.bdbxml.BaseTestCase

createStore() - Method in class org.xbrlapi.data.bdbxml.BaseTestCase

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

CustomLinkRecogniserImpl - Class in org.xbrlapi.xdt

This class provides an example custom link recogniser tailored to the needs of the non-xlink links used by XBRL.

CustomLinkRecogniserImpl() - Constructor for class org.xbrlapi.xdt.CustomLinkRecogniserImpl

Constructor for the XBRL custom link recogniser

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.

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

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

defaultDimensionArcrole - Static variable in class org.xbrlapi.xdt.XDTConstants

defaultDimensionArcrole() - Static method in class org.xbrlapi.xdt.XDTConstants

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(URI) - Method in class org.xbrlapi.data.resource.DefaultMatcherImpl

delete(URI) - Method in class org.xbrlapi.data.resource.InMemoryMatcherImpl

delete(URI) - Method in class org.xbrlapi.data.resource.InStoreMatcherImpl

delete(URI) - Method in interface org.xbrlapi.data.resource.Matcher

Deletes the given URI from the matcher.

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

Close and then delete the data store.

deleteAspect(String) - Method in interface org.xbrlapi.aspects.AspectModel

deleteAspect(String) - Method in class org.xbrlapi.aspects.BaseAspectModel

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.

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

Algorithm: Check if the matcher indicate that the URI has matching URIs. If the URI has matching URIs: If the URI is the one used for the document in the data store: Delete the URI from the matcher, getting the new matching URI back as a result of the deletion operation and update the document fragments to use the new matching URI instead of the deleted URI. Otherwise, just delete the URI from the matcher and we are done. Otherwise, the URI does not have matching URIs so just delete the URI from the matcher and delete the relevant fragments from the data store.

deleteDocument(URI) - 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.

deleteInactiveRelationships(URI, URI) - Method in interface org.xbrlapi.networks.Storer

Removes persisted prohibited or overridden relationships from a network.

deleteInactiveRelationships() - Method in interface org.xbrlapi.networks.Storer

Removes all persisted prohibited or overridden relationships from a network.

deleteInactiveRelationships() - Method in class org.xbrlapi.networks.StorerImpl

deleteInactiveRelationships(URI, URI) - Method in class org.xbrlapi.networks.StorerImpl

DeletePersistedRelationships - Class in org.xbrlapi.data.bdbxml.examples.utilities

Deletes all of the persisted relationship XML resources from the data store.

DeletePersistedRelationships(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.DeletePersistedRelationships

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

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

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

deleteRelationships(URI, URI) - Method in interface org.xbrlapi.networks.Storer

Deletes the persisted relationships with the given link and arc role from the data store.

deleteRelationships(URI) - Method in interface org.xbrlapi.networks.Storer

Deletes the persisted relationships that are related to arcs in the specified document.

deleteRelationships() - Method in interface org.xbrlapi.networks.Storer

Deletes all persisted relationships in the data store.

deleteRelationships(URI, URI) - Method in class org.xbrlapi.networks.StorerImpl

deleteRelationships(URI) - Method in class org.xbrlapi.networks.StorerImpl

deleteRelationships() - Method in class org.xbrlapi.networks.StorerImpl

DeleteSpecificDocument - Class in org.xbrlapi.data.bdbxml.examples.utilities

Deletes a specific document from the data store.

DeleteSpecificDocument(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.DeleteSpecificDocument

DeleteStubs - Class in org.xbrlapi.data.bdbxml.examples.utilities

Deletes all of the stubs from the data store.

DeleteStubs(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.DeleteStubs

deleteURI(URI) - Method in class org.xbrlapi.impl.MatchImpl

deleteURI(URI) - Method in interface org.xbrlapi.Match

Call this method, for example, when a document is deleted from the data store so matching information needs to be updated.

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

Dimension - Interface in org.xbrlapi.xdt

dimension - Static variable in class org.xbrlapi.xdt.XDTConstants

DimensionalAspectModel - Class in org.xbrlapi.xdt.aspects

DimensionalAspectModel() - Constructor for class org.xbrlapi.xdt.aspects.DimensionalAspectModel

XDT Aspects are only added as they are required.

DimensionAspect - Class in org.xbrlapi.xdt.aspects

Provides common functionality for XDT dimension aspects.

DimensionAspect(AspectModel, Dimension) - Constructor for class org.xbrlapi.xdt.aspects.DimensionAspect

DimensionImpl - Class in org.xbrlapi.xdt

DimensionImpl() - Constructor for class org.xbrlapi.xdt.DimensionImpl

DimensionValue - Interface in org.xbrlapi.xdt.values

DimensionValueAccessor - Interface in org.xbrlapi.xdt.values

DimensionValueAccessorImpl - Class in org.xbrlapi.xdt.values

DimensionValueAccessorImpl() - Constructor for class org.xbrlapi.xdt.values.DimensionValueAccessorImpl

Create a dimension value accessor.

DimensionValueComparator - Class in org.xbrlapi.xdt.values

Supports a naive sorting of dimension values.

DimensionValueComparator() - Constructor for class org.xbrlapi.xdt.values.DimensionValueComparator

DimensionValueImpl - Class in org.xbrlapi.xdt.values

DimensionValueImpl(Item, Dimension, OpenContextComponent, Object) - Constructor for class org.xbrlapi.xdt.values.DimensionValueImpl

Construct a dimension value.

DimensionValues - Interface in org.xbrlapi.xdt.values

This inteface defines the methods available to interact with a list of values for a given dimension.

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 URIs that are already in the loading/discovery queue.

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

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

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

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

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

Trigger the discovery process given a single URI.

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

Trigger the discovery process given a single URI.

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

discover(URI) - 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(URI, 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

The discovery manager is responsible for managing the discovery process in a manner that interrupts the discovery thread every so often (based upon a default or user specified time interval before the interrupt is sent to the loader).

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

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

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

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

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

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.

domainMemberArcrole - Static variable in class org.xbrlapi.xdt.XDTConstants

domainMemberArcrole() - Static method in class org.xbrlapi.xdt.XDTConstants

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.xlink

Assists in the tracking of document state information during SAX parsing, retaining the necessary information to construct all element scheme XPointer expressions that can be used to identify each element in a document.

ElementState(ElementState, Attributes) - Constructor for class org.xbrlapi.xlink.ElementState

elementState - Variable in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

Data required to track the element scheme XPointer expressions that can be used to identify XBRL fragments.

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.xdt.XLinkHandlerImpl

Handle the end of the arc.

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.

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.sax.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, Attributes) - Method in class org.xbrlapi.sax.identifiers.BaseIdentifier

endElement(String, String, String, Attributes) - Method in interface org.xbrlapi.sax.identifiers.Identifier

Updates the state of the fragment identifier when the end of an element is parsed.

endElement(String, String, String, Attributes) - Method in class org.xbrlapi.sax.identifiers.SchemaIdentifier

The implementation assumes that XML schemas do not nest XML schemas.

endElement(String, String, String, Attributes) - Method in class org.xbrlapi.sax.identifiers.XBRLIdentifier

Set the boolean state variables based upon whether the next element can be a tuple in an XBRL instance and whether the parser is within an XBRL instance and whether the parser is within a reference resource.

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

Fire off necessary XLink events on end of elements

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

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

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

endExtendedLink(String, String, String) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

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

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.xdt.XLinkHandlerImpl

Handle the end of the locator.

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.xdt.XLinkHandlerImpl

Handle the end of the resource.

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.xdt.XLinkHandlerImpl

Handle the end of the simple link

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

ENTITY_IDENTIFIER - Static variable in interface org.xbrlapi.aspects.Aspect

EntityIdentifierAspect - Class in org.xbrlapi.aspects

EntityIdentifierAspect(AspectModel) - Constructor for class org.xbrlapi.aspects.EntityIdentifierAspect

EntityIdentifierAspect.Transformer - Class in org.xbrlapi.aspects

EntityIdentifierAspect.Transformer() - Constructor for class org.xbrlapi.aspects.EntityIdentifierAspect.Transformer

EntityIdentifierAspectValue - Class in org.xbrlapi.aspects

EntityIdentifierAspectValue(Aspect, Entity) - Constructor for class org.xbrlapi.aspects.EntityIdentifierAspectValue

EntityImpl - Class in org.xbrlapi.impl

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

EntityResolverImpl - Class in org.xbrlapi.sax

Entity resolver that dynamically adds to the local document cache if it is set up and that gives preference to the local cache (if it is set up) as resources are identified by the resolution process.

EntityResolverImpl() - Constructor for class org.xbrlapi.sax.EntityResolverImpl

Construct the entity resolver without a cache.

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

Construct the entity resolver by storing the cache root.

EntityResolverImpl(File, Map<URI, URI>) - Constructor for class org.xbrlapi.sax.EntityResolverImpl

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

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

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(Object) - Method in class org.xbrlapi.aspects.BaseAspect

equals(Object) - Method in class org.xbrlapi.aspects.BaseAspectModel

equals(Object) - Method in class org.xbrlapi.aspects.BaseAspectValue

equals(Object) - Method in class org.xbrlapi.aspects.ConceptAspect

equals(Object) - Method in class org.xbrlapi.aspects.ContextAspect

equals(Object) - Method in class org.xbrlapi.aspects.EntityIdentifierAspect

equals(Object) - Method in class org.xbrlapi.aspects.LocationAspect

equals(Object) - Method in class org.xbrlapi.aspects.NonDimensionalAspectModel

equals(Object) - Method in class org.xbrlapi.aspects.PeriodAspect

equals(Object) - Method in class org.xbrlapi.aspects.QuarterlyPeriodAspect

equals(Object) - Method in class org.xbrlapi.aspects.ScenarioAspect

equals(Object) - Method in class org.xbrlapi.aspects.SegmentAspect

equals(Object) - Method in class org.xbrlapi.aspects.UnitAspect

equals(Object) - Method in class org.xbrlapi.cache.CacheImpl

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 class org.xbrlapi.data.BaseStoreImpl

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

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

The two stores are equal if they have equal caches and matchers and if they have the same number of fragments with the same indices.

equals(Object) - Method in class org.xbrlapi.data.resource.BaseMatcherImpl

equals(Object) - Method in class org.xbrlapi.data.resource.DefaultMatcherImpl

equals(Object) - Method in class org.xbrlapi.data.resource.InMemoryMatcherImpl

equals(Object) - Method in class org.xbrlapi.data.resource.InStoreMatcherImpl

equals(Object) - Method in class org.xbrlapi.data.resource.MD5SignerImpl

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(OpenContextComponent) - Method in class org.xbrlapi.impl.OpenContextComponentImpl

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

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

Tests if the unit is u-equal to another unit

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

equals(Object) - Method in class org.xbrlapi.loader.LoaderImpl

equals(Object) - Method in class org.xbrlapi.networks.EquivalentRelationshipsImpl

equals(Object) - Method in class org.xbrlapi.networks.NetworkImpl

equals(Object) - Method in class org.xbrlapi.networks.NetworksImpl

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

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

equals(Object) - Method in class org.xbrlapi.sax.EntityResolverImpl

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

equals(Object) - Method in class org.xbrlapi.xdt.aspects.DimensionAspect

equals(Object) - Method in class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect

equals(Object) - Method in class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect

equals(Object) - Method in class org.xbrlapi.xdt.aspects.SegmentRemainderAspect

equals(Object) - Method in class org.xbrlapi.xdt.aspects.TypedDimensionAspect

equals(Object) - Method in class org.xbrlapi.xlink.CustomLinkRecogniser

equals(Object) - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

equals(Object) - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

equals(Object) - Method in class org.xbrlapi.xlink.XLinkProcessorImpl

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

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

equals(Object) - Method in class org.xbrlapi.xmlbase.BaseURIDOMResolverImpl

equals(Object) - Method in class org.xbrlapi.xmlbase.BaseURISAXResolverImpl

equalValues(Item, Item, Dimension) - Method in interface org.xbrlapi.xdt.values.DimensionValueAccessor

TODO move this equalValues method out of the dimension value accessor.

equalValues(Item, Item, Dimension) - Method in class org.xbrlapi.xdt.values.DimensionValueAccessorImpl

EquivalentRelationships - Interface in org.xbrlapi.networks

EquivalentRelationshipsImpl - Class in org.xbrlapi.networks

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

Error - Interface in org.xbrlapi

error(SAXParseException) - Method in class org.xbrlapi.sax.BaseContentHandlerImpl

error(SAXParseException) - Method in interface org.xbrlapi.sax.ContentHandler

Handles SAX parsing exceptions.

error(String, String, String, Attributes, String) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

Walter Hamscher has identified documents in the XBRL community that violate the constraint that attributes not defined in the XLink specification must not be in the XLink namespace.

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

Walter Hamscher has identified documents in the XBRL community that violate the constraint that attributes not defined in the XLink specification must not be in the XLink namespace.

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

ErrorImpl - Class in org.xbrlapi.impl

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

No argument constructor.

ErrorImpl(String) - Constructor for class org.xbrlapi.impl.ErrorImpl

ErrorImpl(String, URI, String) - Constructor for class org.xbrlapi.impl.ErrorImpl

Use this constructor if the problem is not related to a specific fragment.

ErrorImpl(String, URI, String, String) - Constructor for class org.xbrlapi.impl.ErrorImpl

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.

ExplicitDimension - Interface in org.xbrlapi.xdt

ExplicitDimensionAspect - Class in org.xbrlapi.xdt.aspects

ExplicitDimensionAspect(AspectModel, ExplicitDimension) - Constructor for class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect

ExplicitDimensionAspect.Transformer - Class in org.xbrlapi.xdt.aspects

ExplicitDimensionAspect.Transformer() - Constructor for class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect.Transformer

ExplicitDimensionAspectValue - Class in org.xbrlapi.xdt.aspects

ExplicitDimensionAspectValue(Aspect, Concept) - Constructor for class org.xbrlapi.xdt.aspects.ExplicitDimensionAspectValue

ExplicitDimensionImpl - Class in org.xbrlapi.xdt

ExplicitDimensionImpl() - Constructor for class org.xbrlapi.xdt.ExplicitDimensionImpl

ExplicitDimensionValueLabelComparator - Class in org.xbrlapi.xdt.values

Replaces the naive sorting of explicit dimension values for the same explicit dimension with one based upon the labels of the domain members (XBRL 2.1 or generic labels).

ExplicitDimensionValueLabelComparator(String, URI) - Constructor for class org.xbrlapi.xdt.values.ExplicitDimensionValueLabelComparator

ExplicitDimensionValueTreeComparator - Class in org.xbrlapi.xdt.values

Replaces the naive sorting of explicit dimension values for the same explicit dimension with one based upon a tree of domain members.

ExplicitDimensionValueTreeComparator(Network, Fragment) - Constructor for class org.xbrlapi.xdt.values.ExplicitDimensionValueTreeComparator

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.sax.BaseContentHandlerImpl

fatalError(SAXParseException) - Method in interface org.xbrlapi.sax.ContentHandler

Handles fatal SAX parsing exceptions.

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

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

finalize() - Method in class org.xbrlapi.impl.XMLImpl

finalizeBuilder() - Method in class org.xbrlapi.impl.NonFragmentXMLImpl

Used to eliminate the builder once the XML resource has been constructed.

FindLinksToGivenDocument - Class in org.xbrlapi.data.bdbxml.examples.utilities

Lists all documents that enable XBRL discovery of the document with the specified URI.

FindLinksToGivenDocument(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.FindLinksToGivenDocument

FindLocatorsWithMultipleTargetsForADocument - Class in org.xbrlapi.data.bdbxml.examples.utilities

Finds all locators in a document that identify more than one locator target.

FindLocatorsWithMultipleTargetsForADocument(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.FindLocatorsWithMultipleTargetsForADocument

FootnoteResource - Interface in org.xbrlapi

FootnoteResourceImpl - Class in org.xbrlapi.impl

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

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

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

G

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

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

GenericDocumentRootIdentifier - Class in org.xbrlapi.sax.identifiers

Identifies XML Schema fragments.

GenericDocumentRootIdentifier(ContentHandler) - Constructor for class org.xbrlapi.sax.identifiers.GenericDocumentRootIdentifier

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

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

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

get(String, String) - Method in class org.xbrlapi.impl.LanguageMap

get(String) - Method in interface org.xbrlapi.networks.Network

get(String) - Method in class org.xbrlapi.networks.NetworkImpl

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

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.

getAbsoluteHref() - Method in class org.xbrlapi.xdt.TypedDimensionImpl

getAccessor() - Method in class org.xbrlapi.xdt.aspects.DimensionAspect

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

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

getActiveRelationships() - Method in interface org.xbrlapi.networks.Networks

getActiveRelationships() - Method in class org.xbrlapi.networks.NetworksImpl

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

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

getActiveRelationshipsFrom(String) - Method in interface org.xbrlapi.networks.Networks

getActiveRelationshipsFrom(String) - Method in class org.xbrlapi.networks.NetworksImpl

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

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

getActiveRelationshipsTo(String) - Method in interface org.xbrlapi.networks.Networks

getActiveRelationshipsTo(String) - Method in class org.xbrlapi.networks.NetworksImpl

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

getAllActiveRelationships() - Method in interface org.xbrlapi.networks.Network

getAllActiveRelationships() - Method in class org.xbrlapi.networks.NetworkImpl

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

Gets all child fragments.

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

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

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

getAllConcepts() - Method in class org.xbrlapi.impl.InstanceImpl

getAllConcepts() - Method in interface org.xbrlapi.Instance

getAllConceptsCount() - Method in class org.xbrlapi.impl.InstanceImpl

getAllConceptsCount() - Method in interface org.xbrlapi.Instance

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

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

getAllFacts() - Method in interface org.xbrlapi.aspects.AspectModel

getAllFacts() - Method in class org.xbrlapi.aspects.BaseAspectModel

getAllFacts(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getAllFacts(URI) - Method in interface org.xbrlapi.data.Store

getAllFacts() - Method in class org.xbrlapi.impl.InstanceImpl

getAllFacts() - Method in interface org.xbrlapi.Instance

getAllFactsCount() - Method in class org.xbrlapi.impl.InstanceImpl

getAllFactsCount() - Method in interface org.xbrlapi.Instance

getAllMatchingURIs(URI) - Method in class org.xbrlapi.data.resource.DefaultMatcherImpl

getAllMatchingURIs(URI) - Method in class org.xbrlapi.data.resource.InMemoryMatcherImpl

getAllMatchingURIs(URI) - Method in class org.xbrlapi.data.resource.InStoreMatcherImpl

getAllMatchingURIs(URI) - Method in interface org.xbrlapi.data.resource.Matcher

getAllRelationships() - Method in interface org.xbrlapi.networks.Analyser

getAllRelationships() - Method in class org.xbrlapi.networks.AnalyserImpl

getAllRelationships() - Method in interface org.xbrlapi.networks.Network

getAllRelationships() - Method in class org.xbrlapi.networks.NetworkImpl

getAllUris(URI) - Method in interface org.xbrlapi.cache.Cache

This method provides a useful means of getting a list of the URIs for all documents in a branch of the cache.

getAllUris(URI) - Method in class org.xbrlapi.cache.CacheImpl

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

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

getAncestorCount() - Method in interface org.xbrlapi.aspects.Aspect

getAncestorCount() - Method in class org.xbrlapi.aspects.BaseAspect

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.SchemaContentImpl

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

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

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

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

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

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

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

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

Use this method if the attribute on the arc does not have 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.

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

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

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

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

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

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

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

getArcIndices(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

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

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

getArcIndices(URI) - Method in interface org.xbrlapi.data.Store

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

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

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

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

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

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

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

getArcPriority() - 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.RelationshipImpl

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

Get the link arcrole attribute value, before any resolution.

getArcrole() - Method in interface org.xbrlapi.networks.Network

getArcrole() - Method in class org.xbrlapi.networks.NetworkImpl

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

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

Get the link arcrole attribute value, before any resolution.

getArcrole() - Method in class org.xbrlapi.xdt.TypedDimensionImpl

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 class org.xbrlapi.data.BaseStoreImpl

getArcroles(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

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

getArcroles(URI) - Method in interface org.xbrlapi.data.Store

getArcroles() - Method in interface org.xbrlapi.networks.Analyser

getArcroles(URI) - Method in interface org.xbrlapi.networks.Analyser

getArcroles() - Method in class org.xbrlapi.networks.AnalyserImpl

getArcroles(URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getArcroles() - Method in interface org.xbrlapi.networks.Networks

getArcroles() - Method in class org.xbrlapi.networks.NetworksImpl

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

getArcroleTypes(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

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

getArcroleTypes(URI) - Method in interface org.xbrlapi.data.Store

getArcroleTypes() - Method in class org.xbrlapi.impl.SchemaImpl

getArcroleTypes() - Method in interface org.xbrlapi.Schema

getArcs(URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

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

getArcs(URI, String) - Method in interface org.xbrlapi.data.Store

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

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

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

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

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

getArcsFromWithArcrole(URI) - Method in class org.xbrlapi.impl.ArcEndImpl

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

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

Get the list of arcs that are to the arc end.

getArcsToWithArcrole(URI) - Method in interface org.xbrlapi.ArcEnd

getArcsToWithArcrole(URI) - Method in class org.xbrlapi.impl.ArcEndImpl

getArcsWithArcrole(URI) - Method in interface org.xbrlapi.ExtendedLink

getArcsWithArcrole(URI) - Method in class org.xbrlapi.impl.ExtendedLinkImpl

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

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

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

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

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

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

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

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

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

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

getAspect(String) - Method in interface org.xbrlapi.aspects.AspectModel

getAspect() - Method in interface org.xbrlapi.aspects.AspectValue

getAspect(String) - Method in class org.xbrlapi.aspects.BaseAspectModel

getAspect() - Method in class org.xbrlapi.aspects.BaseAspectValue

getAspectModel() - Method in interface org.xbrlapi.aspects.Aspect

getAspectModel() - Method in class org.xbrlapi.aspects.BaseAspect

getAspects() - Method in interface org.xbrlapi.aspects.AspectModel

getAspects() - Method in class org.xbrlapi.aspects.BaseAspectModel

getAspectValueCombinationsForAxis(String) - Method in interface org.xbrlapi.aspects.AspectModel

getAspectValueCombinationsForAxis(String) - Method in class org.xbrlapi.aspects.BaseAspectModel

getAspectValues(Fact) - Method in interface org.xbrlapi.aspects.AspectModel

getAspectValues(Fact) - Method in class org.xbrlapi.aspects.BaseAspectModel

getAttribute(URI, String) - Method in interface org.xbrlapi.Arc

getAttribute(String) - Method in interface org.xbrlapi.Arc

getAttribute(URI, String) - Method in class org.xbrlapi.impl.ArcImpl

getAttribute(String) - Method in class org.xbrlapi.impl.ArcImpl

getAttribute(URI, String) - Method in class org.xbrlapi.xdt.TypedDimensionImpl

getAttribute(String) - Method in class org.xbrlapi.xdt.TypedDimensionImpl

getAttribute(URI, String) - Method in interface org.xbrlapi.Xlink

Get a non-xlink attribute value.

getAttribute(String) - Method in interface org.xbrlapi.Xlink

Get a no-namespace attribute value.

getAttributes() - Method in class org.xbrlapi.xlink.ElementState

getAxis() - Method in interface org.xbrlapi.aspects.Aspect

getAxis() - Method in class org.xbrlapi.aspects.BaseAspect

getAxisAspects(String) - Method in interface org.xbrlapi.aspects.AspectModel

getAxisAspects(String) - Method in class org.xbrlapi.aspects.BaseAspectModel

getBalance() - Method in interface org.xbrlapi.Concept

Get the concept's balance, one of debit or credit

getBalance() - Method in class org.xbrlapi.impl.ConceptImpl

Get the concept's balance, one of debit or credit

getBaseURI(Element) - Method in interface org.xbrlapi.xmlbase.BaseURIDOMResolver

getBaseURI(Element) - Method in class org.xbrlapi.xmlbase.BaseURIDOMResolverImpl

getBaseURI() - Method in interface org.xbrlapi.xmlbase.BaseURISAXResolver

Returns the XML Base URI of the given element.

getBaseURI() - Method in class org.xbrlapi.xmlbase.BaseURISAXResolverImpl

getBaseURISAXResolver() - Method in class org.xbrlapi.sax.ContentHandlerImpl

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

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

getBuilder() - Method in class org.xbrlapi.impl.XMLImpl

getBuilder() - Method in interface org.xbrlapi.XML

Get the fragment builder.

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

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

getCache() - Method in class org.xbrlapi.data.resource.BaseMatcherImpl

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

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

getCacheFile(URI) - Method in interface org.xbrlapi.cache.Cache

Gets the cache file for an original URI.

getCacheFile(URI) - Method in class org.xbrlapi.cache.CacheImpl

getCacheRoot() - Method in class org.xbrlapi.cache.CacheImpl

getCacheURI(URI) - Method in interface org.xbrlapi.cache.Cache

TODO Modify to use the java.net.URIEncoder and java.net.URIDecoder classes.

getCacheURI(URI) - Method in class org.xbrlapi.cache.CacheImpl

getCause() - Method in exception org.xbrlapi.utilities.XBRLException

getCause() - Method in exception org.xbrlapi.xlink.XLinkException

getCause() - Method in exception org.xbrlapi.xmlbase.XMLBaseException

getChild(String, int) - Method in interface org.xbrlapi.Fragment

Get a specific child fragment.

getChild(String, int) - Method in class org.xbrlapi.impl.FragmentImpl

getChildConcepts() - Method in class org.xbrlapi.impl.InstanceImpl

getChildConcepts() - Method in interface org.xbrlapi.Instance

getChildConceptsCount() - Method in class org.xbrlapi.impl.InstanceImpl

getChildConceptsCount() - Method in interface org.xbrlapi.Instance

getChildElements() - Method in class org.xbrlapi.impl.OpenContextComponentImpl

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

getChildEquivalents() - Method in class org.xbrlapi.impl.EntityResourceImpl

getChildFacts() - Method in class org.xbrlapi.impl.InstanceImpl

getChildFacts() - Method in class org.xbrlapi.impl.TupleImpl

Get the list of child facts

getChildFacts(URI, String) - Method in class org.xbrlapi.impl.TupleImpl

Get a list of facts matching the specified fact name.

getChildFacts(URI, String, String) - Method in class org.xbrlapi.impl.TupleImpl

Get a list of facts matching the specified fact name and context id.

getChildFacts() - Method in interface org.xbrlapi.Instance

Get the list of facts that are children of the instance.

getChildFacts() - Method in interface org.xbrlapi.Tuple

Get the child facts

getChildFacts(URI, String) - Method in interface org.xbrlapi.Tuple

Get a list of facts matching the specified fact name.

getChildFacts(URI, String, String) - Method in interface org.xbrlapi.Tuple

Get a list of facts matching the specified fact name and context id.

getChildFactsCount() - Method in class org.xbrlapi.impl.InstanceImpl

getChildFactsCount() - Method in interface org.xbrlapi.Instance

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

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

getChildren() - Method in interface org.xbrlapi.aspects.AspectValue

This method supports aspects, such as the location aspect where values can be given a heirarchical organisation, such that an aspect value can be associated with an ordered set of children aspect values.

getChildren() - Method in class org.xbrlapi.aspects.BaseAspectValue

getChildren() - Method in class org.xbrlapi.aspects.LocationAspectValue

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

Gets the child fragments with the specified fragment type.

getChildren(Class<?>) - Method in interface org.xbrlapi.Fragment

Gets the child fragments with the specified fragment type.

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

getChildren(Class<?>) - Method in class org.xbrlapi.impl.FragmentImpl

getChildren(String) - Method in interface org.xbrlapi.networks.Network

getChildren(String) - Method in class org.xbrlapi.networks.NetworkImpl

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

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

getChildrenSoFar() - Method in class org.xbrlapi.xlink.ElementState

getClass(String) - Static method in class org.xbrlapi.impl.FragmentFactory

Get the class for the specified class name.

getCode() - Method in class org.xbrlapi.impl.LanguageImpl

getCode() - Method in interface org.xbrlapi.Language

getCodes() - Method in class org.xbrlapi.impl.LanguageMap

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

Get a specific collection from the database connection

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

Get a collection given the name of the collection (not its full path) and its container collection.

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

Deprecated.

getComplexContent() - Method in class org.xbrlapi.impl.OpenContextComponentImpl

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

Gets the complex content

getCompositeDocument() - 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.

getCompositeDocument() - 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.

getConcept(URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

getConcept(URI, String) - Method in interface org.xbrlapi.data.Store

getConcept() - Method in interface org.xbrlapi.Fact

Get the concept that defines the syntax for this fact.

getConcept() - Method in class org.xbrlapi.impl.FactImpl

getConceptByName(String) - Method in class org.xbrlapi.impl.SchemaImpl

getConceptByName(String) - Method in interface org.xbrlapi.Schema

Get a specific concept by its name.

getConcepts() - Method in class org.xbrlapi.impl.LabelResourceImpl

getConcepts() - Method in class org.xbrlapi.impl.SchemaImpl

getConcepts() - Method in interface org.xbrlapi.LabelResource

getConcepts() - Method in interface org.xbrlapi.Schema

Get the fragment list of concepts in the schema.

getConceptsBySubstitutionGroup(URI, String) - Method in class org.xbrlapi.impl.SchemaImpl

getConceptsBySubstitutionGroup(URI, String) - Method in interface org.xbrlapi.Schema

Get a list concepts based on their substitution group.

getConceptsByType(URI, String) - Method in class org.xbrlapi.impl.SchemaImpl

getConceptsByType(URI, String) - Method in interface org.xbrlapi.Schema

Get a list of concepts based on their type.

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

getContent() - Method in class org.xbrlapi.impl.MixedContentResourceImpl

Get the value of the resource as a NodeList containing all of the children elements and text nodes nested in the resource.

getContent() - Method in interface org.xbrlapi.MixedContentResource

Get the value of the resource as a NodeList containing all of the children elements and text nodes nested in the resource.

getContentHandler() - Method in class org.xbrlapi.sax.identifiers.BaseIdentifier

getContentHandler() - Method in interface org.xbrlapi.sax.identifiers.Identifier

getContext() - Method in interface org.xbrlapi.ContextComponent

Determine the context that contains this component

getContext() - Method in class org.xbrlapi.impl.ContextComponentImpl

Determine the context that contains this component

getContext(String) - Method in class org.xbrlapi.impl.InstanceImpl

getContext() - Method in class org.xbrlapi.impl.ItemImpl

getContext(String) - Method in interface org.xbrlapi.Instance

Get a specified context from the instance based on its id.

getContext() - Method in interface org.xbrlapi.Item

Get the context for this item.

getContextFromStore(Fact) - Method in class org.xbrlapi.aspects.ContextAspect

getContextId() - Method in class org.xbrlapi.impl.ItemImpl

getContextId() - Method in interface org.xbrlapi.Item

getContexts() - Method in class org.xbrlapi.impl.InstanceImpl

getContexts() - Method in interface org.xbrlapi.Instance

Get list contexts contained in the instance.

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

Returns the current fragment index (the one before the next fragment index)

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

getCustomTypeId() - Method in interface org.xbrlapi.CustomType

Get the id of the customType.

getCustomTypeId() - Method in class org.xbrlapi.impl.CustomTypeImpl

Get the id of the customType.

getCustomURI() - Method in interface org.xbrlapi.CustomType

Get the custom URI being defined.

getCustomURI() - Method in class org.xbrlapi.impl.CustomTypeImpl

Get the custom URI being defined.

getCyclesAllowed() - Method in interface org.xbrlapi.ArcroleType

Get the cyclesAllowed attribute value.

getCyclesAllowed() - Method in class org.xbrlapi.impl.ArcroleTypeImpl

Get the cyclesAllowed attribute value (one of any, directed or none).

getData() - Method in interface org.xbrlapi.builder.Builder

Get the Document object used to build the fragment.

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

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

Returns the URI to access the Xindice database for this connection.

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

Get the root element of the fragment data.

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

getDecimals() - Method in class org.xbrlapi.impl.NumericItemImpl

Get the decimals attribute for this item.

getDecimals() - Method in interface org.xbrlapi.NumericItem

Get the decimals attribute for this item.

getDeclaration() - Method in class org.xbrlapi.impl.ReferencePartImpl

getDeclaration() - Method in interface org.xbrlapi.ReferencePart

Currently implemented by a brute force search of the reference part declarations with the given local name.

getDeepCopy(Object) - Method in class org.xbrlapi.utilities.BaseTestCase

getDefault() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

getDefault() - Method in interface org.xbrlapi.SchemaContentDeclaration

getDefaultDomainMember() - Method in interface org.xbrlapi.xdt.ExplicitDimension

getDefaultDomainMember() - Method in class org.xbrlapi.xdt.ExplicitDimensionImpl

getDefinition() - Method in interface org.xbrlapi.CustomType

getDefinition() - Method in class org.xbrlapi.impl.CustomTypeImpl

getDenominator() - Method in interface org.xbrlapi.FractionItem

Get the fraction denominator.

getDenominator() - Method in class org.xbrlapi.impl.FractionItemImpl

getDenominatorMeasures() - Method in class org.xbrlapi.impl.UnitImpl

Get the set of measure elements in the denominator.

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

Get the set of measure elements in the denominator.

getDepth() - Method in interface org.xbrlapi.aspects.AspectValue

getDepth() - Method in class org.xbrlapi.aspects.BaseAspectValue

getDescendantCount() - Method in interface org.xbrlapi.aspects.Aspect

getDescendantCount() - Method in class org.xbrlapi.aspects.BaseAspect

getDimension() - Method in class org.xbrlapi.xdt.aspects.DimensionAspect

getDimension() - Method in interface org.xbrlapi.xdt.values.DimensionValue

getDimension() - Method in class org.xbrlapi.xdt.values.DimensionValueImpl

getDimensions() - Method in interface org.xbrlapi.xdt.Hypercube

getDimensions() - Method in class org.xbrlapi.xdt.HypercubeImpl

getDirectEquivalents() - Method in class org.xbrlapi.impl.EntityResourceImpl

getDocument(URI) - Static method in class org.xbrlapi.grabber.AbstractGrabberImpl

getDocumentAsDOM(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

Get a single document in the store as a DOM.

getDocumentAsDOM(URI) - Method in interface org.xbrlapi.data.Store

Get a single document in the store as a DOM.

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

Get the list of documentation fragments contained by the extended link.

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

Get the list of documentation fragments contained by the extended link.

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

Get the list of documentation fragments that are children of the linkbase.

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

Get the list of documentation fragments that are children of the linkbase.

getDocumentNode() - Method in class org.xbrlapi.impl.XMLImpl

getDocumentNode() - Method in interface org.xbrlapi.XML

Get the XML DOM Document for the fragment data.

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

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

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

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

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

Get the URI for the document being parsed.

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

Get the URI for the document being parsed.

getDocumentURI() - Method in interface org.xbrlapi.xmlbase.BaseURIDOMResolver

getDocumentURI() - Method in class org.xbrlapi.xmlbase.BaseURIDOMResolverImpl

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

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

Get a list of the URIs that have been stored.

getDomainMemberFromOpenContextComponent(OpenContextComponent, Dimension) - Method in interface org.xbrlapi.xdt.values.DimensionValueAccessor

getDomainMemberFromOpenContextComponent(OpenContextComponent, Dimension) - Method in class org.xbrlapi.xdt.values.DimensionValueAccessorImpl

getEarliestPeriod() - Method in class org.xbrlapi.impl.InstanceImpl

getEarliestPeriod() - Method in interface org.xbrlapi.Instance

getElementSchemePointers() - Method in class org.xbrlapi.xlink.ElementState

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

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

getElementState() - Method in class org.xbrlapi.sax.BaseContentHandlerImpl

getElementState() - Method in interface org.xbrlapi.sax.ContentHandler

getElementState() - Method in class org.xbrlapi.sax.identifiers.BaseIdentifier

getElementState() - Method in interface org.xbrlapi.sax.identifiers.Identifier

getEncoding() - Method in class org.xbrlapi.impl.LanguageImpl

getEncoding() - Method in interface org.xbrlapi.Language

getEnd() - Method in class org.xbrlapi.impl.PeriodImpl

getEnd() - Method in interface org.xbrlapi.Period

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

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

getEntities() - Method in interface org.xbrlapi.EntityResource

getEntities(URI) - Method in interface org.xbrlapi.EntityResource

getEntities() - Method in class org.xbrlapi.impl.EntityResourceImpl

getEntities(URI) - Method in class org.xbrlapi.impl.EntityResourceImpl

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

Get the entity of the context.

getEntity() - Method in class org.xbrlapi.impl.ContextImpl

Get the entity of the context.

getEntity() - Method in class org.xbrlapi.impl.SegmentImpl

Gets the containing entity

getEntity() - Method in interface org.xbrlapi.Segment

Gets the containing entity

getEntityIdentifiers() - Method in class org.xbrlapi.impl.InstanceImpl

getEntityIdentifiers() - Method in interface org.xbrlapi.Instance

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

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

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

Return the entity resolver being used by the loader.

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

Return the entity resolver being used by the loader.

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

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

getEntityResources() - Method in class org.xbrlapi.impl.InstanceImpl

getEntityResources() - Method in interface org.xbrlapi.Instance

getEquivalents() - Method in interface org.xbrlapi.EntityResource

getEquivalents() - Method in class org.xbrlapi.impl.EntityResourceImpl

getEquivalentsSet(Set<EntityResource>) - Method in class org.xbrlapi.impl.EntityResourceImpl

Augments a map of equivalent entities

getEscapedSchemeData() - Method in interface org.xbrlapi.xpointer.PointerPart

getEscapedSchemeData() - Method in class org.xbrlapi.xpointer.PointerPartImpl

getExplanation() - Method in interface org.xbrlapi.Error

getExplanation() - Method in class org.xbrlapi.impl.ErrorImpl

getExplicitDimensionValue(Item, Dimension) - Method in interface org.xbrlapi.xdt.values.DimensionValueAccessor

getExplicitDimensionValue(Item, Dimension) - Method in class org.xbrlapi.xdt.values.DimensionValueAccessorImpl

getExtendedLink() - Method in interface org.xbrlapi.ExtendedLinkContent

Get the extended link containing the extended link xlink content.

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

getExtendedLink() - Method in class org.xbrlapi.impl.ExtendedLinkContentImpl

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

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

getExtendedLink() - Method in class org.xbrlapi.impl.ResourceImpl

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

getExtendedLinkIndices(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getExtendedLinkIndices(URI) - Method in interface org.xbrlapi.data.Store

getExtendedLinks(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getExtendedLinks(URI) - Method in interface org.xbrlapi.data.Store

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

Gets the list of extended links in a linkbase

getExtendedLinks() - Method in class org.xbrlapi.impl.SchemaImpl

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

Gets the list of extended links in a linkbase

getExtendedLinks() - Method in interface org.xbrlapi.Schema

getFactCount() - Method in interface org.xbrlapi.Concept

getFactCount() - Method in class org.xbrlapi.impl.ConceptImpl

getFactIndices() - Method in interface org.xbrlapi.Concept

getFactIndices() - Method in class org.xbrlapi.impl.ConceptImpl

getFacts(AspectValue) - Method in interface org.xbrlapi.aspects.Aspect

getFacts(Collection<AspectValue>) - Method in interface org.xbrlapi.aspects.AspectModel

getFacts(AspectValue) - Method in class org.xbrlapi.aspects.BaseAspect

getFacts(Collection<AspectValue>) - Method in class org.xbrlapi.aspects.BaseAspectModel

getFacts() - Method in interface org.xbrlapi.Concept

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

getFacts(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

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

getFacts(URI) - Method in interface org.xbrlapi.data.Store

getFacts() - Method in class org.xbrlapi.impl.ConceptImpl

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

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

getFinal() - Method in class org.xbrlapi.impl.TypeDeclarationImpl

getFinal() - Method in interface org.xbrlapi.TypeDeclaration

getFixed() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

getFixed() - Method in interface org.xbrlapi.SchemaContentDeclaration

getFollowingSibling(Element, int) - Method in class org.xbrlapi.data.BaseStoreImpl

Get the following sibling of this fragment's root in the parent fragment's data.

getFootnoteLinks() - Method in class org.xbrlapi.impl.InstanceImpl

getFootnoteLinks() - Method in interface org.xbrlapi.Instance

Get a list of footnote link fragments Returns null if none are contained by the XBRL instance.

getForm() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

getForm() - Method in interface org.xbrlapi.SchemaContentDeclaration

getFragment(Fact) - Method in interface org.xbrlapi.aspects.Aspect

getFragment() - Method in interface org.xbrlapi.aspects.AspectValue

getFragment(Fact) - Method in class org.xbrlapi.aspects.BaseAspect

getFragment() - Method in class org.xbrlapi.aspects.BaseAspectValue

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

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

getFragmentFromStore(Fact) - Method in interface org.xbrlapi.aspects.Aspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.aspects.ConceptAspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.aspects.EntityIdentifierAspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.aspects.LocationAspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.aspects.PeriodAspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.aspects.QuarterlyPeriodAspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.aspects.ScenarioAspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.aspects.SegmentAspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.aspects.UnitAspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect

When you are confused by the return type, recall that explicit dimension values are all requried to be XBRL concepts - wierd but true!

getFragmentFromStore(Fact) - Method in class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.xdt.aspects.SegmentRemainderAspect

getFragmentFromStore(Fact) - Method in class org.xbrlapi.xdt.aspects.TypedDimensionAspect

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

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

getFragmentIndicesFromDocument(URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

getFragmentIndicesFromDocument(URI, String) - Method in interface org.xbrlapi.data.Store

getFragmentsFromDocument(URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

getFragmentsFromDocument(URI, String) - Method in interface org.xbrlapi.data.Store

Utility method to return a list of fragments in a data store that have a type corresponding to the specified fragment interface name and that are in the document with the specified URI.

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

Get the xlink:from attribute value.

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

getGlobalComplexTypes() - Method in class org.xbrlapi.impl.SchemaImpl

getGlobalComplexTypes() - Method in interface org.xbrlapi.Schema

getGlobalDeclaration(URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

getGlobalDeclaration(URI, String) - Method in interface org.xbrlapi.data.Store

getGlobalDeclaration(String) - Method in class org.xbrlapi.impl.SchemaImpl

getGlobalDeclaration(String) - Method in interface org.xbrlapi.Schema

getGlobalSimpleTypes() - Method in class org.xbrlapi.impl.SchemaImpl

getGlobalSimpleTypes() - Method in interface org.xbrlapi.Schema

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

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

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

Get the raw xlink:href attribute value (before any resolution).

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

Get the link HREF attribute value, before any resolution.

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

Get the raw xlink:href attribute value (before any resolution).

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

Get the link HREF attribute value, before any resolution.

getHref(String, String, String, Attributes) - Method in class org.xbrlapi.xdt.CustomLinkRecogniserImpl

Get the href from the custom link

getHref() - Method in class org.xbrlapi.xdt.TypedDimensionImpl

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

Get the href equivalent for the link

getHref(String, String, String, Attributes) - Method in class org.xbrlapi.xlink.handler.XBRLCustomLinkRecogniserImpl

Get the href from the custom link

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

This implementation generates the an ID for a document being stored with a prefix that is a random string of characters including a-z, A-Z and 0-9.

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

getId() - Method in interface org.xbrlapi.FactDimensionContainer

Get the id attribute value of the container

getId() - Method in class org.xbrlapi.impl.FactDimensionContainerImpl

Get the id attribute value of the container

getId() - Method in class org.xbrlapi.xlink.ElementState

getIdentifier() - Method in interface org.xbrlapi.aspects.AspectValue

getIdentifier(AspectValue) - Method in interface org.xbrlapi.aspects.AspectValueTransformer

getIdentifier() - Method in class org.xbrlapi.aspects.BaseAspectValue

getIdentifier(AspectValue) - Method in class org.xbrlapi.aspects.BaseAspectValueTransformer

getIdentifier(AspectValue) - Method in class org.xbrlapi.aspects.ConceptAspect.Transformer

getIdentifier(AspectValue) - Method in class org.xbrlapi.aspects.EntityIdentifierAspect.Transformer

getIdentifier(AspectValue) - Method in class org.xbrlapi.aspects.LocationAspect.Transformer

getIdentifier(AspectValue) - Method in class org.xbrlapi.aspects.PeriodAspect.Transformer

getIdentifier(AspectValue) - Method in class org.xbrlapi.aspects.QuarterlyPeriodAspect.Transformer

getIdentifier(AspectValue) - Method in class org.xbrlapi.aspects.ScenarioAspect.Transformer

getIdentifier(AspectValue) - Method in class org.xbrlapi.aspects.SegmentAspect.Transformer

getIdentifier(AspectValue) - Method in class org.xbrlapi.aspects.UnitAspect.Transformer

getIdentifier(ExplicitDimensionAspectValue) - Method in class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect.Transformer

For explicit XDT dimensions, the identifier is based on the QName of the dimension member representing the dimension value.

getIdentifier(AspectValue) - Method in class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect.Transformer

getIdentifier(AspectValue) - Method in class org.xbrlapi.xdt.aspects.SegmentRemainderAspect.Transformer

getIdentifier(TypedDimensionAspectValue) - Method in class org.xbrlapi.xdt.aspects.TypedDimensionAspect.Transformer

getIdentifiers() - Method in class org.xbrlapi.sax.BaseContentHandlerImpl

getIdentifiers() - Method in interface org.xbrlapi.sax.ContentHandler

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

Get the entity identifier scheme.

getIdentifierScheme() - Method in interface org.xbrlapi.EntityResource

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

getIdentifierScheme() - Method in class org.xbrlapi.impl.EntityResourceImpl

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

Get the entity identifier

getIdentifierValue() - Method in interface org.xbrlapi.EntityResource

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

getIdentifierValue() - Method in class org.xbrlapi.impl.EntityResourceImpl

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

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

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

getImports() - Method in class org.xbrlapi.impl.SchemaImpl

getImports() - Method in interface org.xbrlapi.Schema

getIncludes() - Method in class org.xbrlapi.impl.SchemaImpl

getIncludes() - Method in interface org.xbrlapi.Schema

getIndex() - Method in class org.xbrlapi.impl.XMLImpl

getIndex() - Method in interface org.xbrlapi.XML

Get the index of the XML resource.

getInferredPrecision() - Method in class org.xbrlapi.impl.SimpleNumericItemImpl

Get the inferred value for precision from the value for decimals and the value of the fact.

getInferredPrecision() - Method in interface org.xbrlapi.SimpleNumericItem

Get the inferred value for precision from the value for decimals and the value of the fact.

getInsertionPoint() - Method in interface org.xbrlapi.builder.Builder

Get the insertion point for new content.

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

Get the insertion point for new data content.

getInstance() - Method in interface org.xbrlapi.Fact

Get the instance that this fact is a part of

getInstance() - Method in class org.xbrlapi.impl.FactImpl

getInstant() - Method in class org.xbrlapi.impl.PeriodImpl

getInstant() - Method in interface org.xbrlapi.Period

Get the instant.

getItem() - Method in interface org.xbrlapi.xdt.values.DimensionValue

getItem() - Method in class org.xbrlapi.xdt.values.DimensionValueImpl

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

getItems(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

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

getItems(URI) - Method in interface org.xbrlapi.data.Store

getItems() - Method in class org.xbrlapi.impl.InstanceImpl

getItems() - Method in interface org.xbrlapi.Instance

getIterator() - Method in interface org.xbrlapi.aspects.Aspect

getIterator() - Method in class org.xbrlapi.aspects.BaseAspect

getKey(Fact) - Method in interface org.xbrlapi.aspects.Aspect

getKey(Fact) - Method in class org.xbrlapi.aspects.BaseAspect

This basic implementation has a unique key for each fact This is not efficient from a memory footprint perspective and should be overridden where feasible.

getKey(Fact) - Method in class org.xbrlapi.aspects.ConceptAspect

getKey(Fact) - Method in class org.xbrlapi.aspects.ContextAspect

getKey(Fact) - Method in class org.xbrlapi.aspects.LocationAspect

getKey(Fact) - Method in class org.xbrlapi.aspects.UnitAspect

getKey(Fact) - Method in class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect

getKey(Fact) - Method in class org.xbrlapi.xdt.aspects.TypedDimensionAspect

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

Get the xlink:label attribute value.

getLabel() - Method in interface org.xbrlapi.aspects.AspectValue

getLabel(AspectValue) - Method in interface org.xbrlapi.aspects.AspectValueTransformer

getLabel() - Method in class org.xbrlapi.aspects.BaseAspectValue

getLabel(AspectValue) - Method in class org.xbrlapi.aspects.BaseAspectValueTransformer

getLabel(AspectValue) - Method in class org.xbrlapi.aspects.ConceptAspect.Transformer

getLabel(AspectValue) - Method in class org.xbrlapi.aspects.EntityIdentifierAspect.Transformer

getLabel(AspectValue) - Method in class org.xbrlapi.aspects.LocationAspect.Transformer

getLabel(AspectValue) - Method in class org.xbrlapi.aspects.PeriodAspect.Transformer

getLabel(AspectValue) - Method in class org.xbrlapi.aspects.QuarterlyPeriodAspect.Transformer

getLabel(AspectValue) - Method in class org.xbrlapi.aspects.ScenarioAspect.Transformer

getLabel(AspectValue) - Method in class org.xbrlapi.aspects.SegmentAspect.Transformer

getLabel(AspectValue) - Method in class org.xbrlapi.aspects.UnitAspect.Transformer

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

Get the xlink:label attribute value.

getLabel(ExplicitDimensionAspectValue) - Method in class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect.Transformer

getLabel(AspectValue) - Method in class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect.Transformer

getLabel(AspectValue) - Method in class org.xbrlapi.xdt.aspects.SegmentRemainderAspect.Transformer

getLabel(TypedDimensionAspectValue) - Method in class org.xbrlapi.xdt.aspects.TypedDimensionAspect.Transformer

getLabelFromElement(Element) - Method in class org.xbrlapi.aspects.BaseAspect

Convenience method to return a label generated from a single element.

getLabelFromElements(List<Element>) - Method in class org.xbrlapi.aspects.BaseAspect

Convenience method to enable a list of elements to be converted into something a bit more readable for display purposes.

getLabelRelationships(String) - Method in interface org.xbrlapi.networks.Analyser

getLabelRelationships(String) - Method in class org.xbrlapi.networks.AnalyserImpl

getLabelRelationshipsByLanguage(String, String) - Method in interface org.xbrlapi.networks.Analyser

getLabelRelationshipsByLanguage(String, String) - Method in class org.xbrlapi.networks.AnalyserImpl

getLabelRelationshipsByLanguageAndRole(String, String, URI) - Method in interface org.xbrlapi.networks.Analyser

getLabelRelationshipsByLanguageAndRole(String, String, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getLabelRelationshipsByLanguages(String, List<String>) - Method in interface org.xbrlapi.networks.Analyser

getLabelRelationshipsByLanguages(String, List<String>) - Method in class org.xbrlapi.networks.AnalyserImpl

getLabelRelationshipsByRole(String, URI) - Method in interface org.xbrlapi.networks.Analyser

getLabelRelationshipsByRole(String, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getLabelRelationshipsByRoles(String, List<URI>) - Method in interface org.xbrlapi.networks.Analyser

getLabelRelationshipsByRoles(String, List<String>, List<URI>) - Method in interface org.xbrlapi.networks.Analyser

getLabelRelationshipsByRoles(String, List<String>, List<URI>) - Method in class org.xbrlapi.networks.AnalyserImpl

getLabelRelationshipsByRoles(String, List<URI>) - Method in class org.xbrlapi.networks.AnalyserImpl

getLabelRole() - Method in class org.xbrlapi.aspects.ConceptAspect.Transformer

getLabelRole() - Method in class org.xbrlapi.aspects.EntityIdentifierAspect.Transformer

getLabelRole() - Method in class org.xbrlapi.aspects.LocationAspect.Transformer

getLabelRole() - Method in class org.xbrlapi.xdt.aspects.DimensionAspect

getLabels(String, URI, URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

getLabels(String, URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

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

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

getLabels(String, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getLabels(String, URI, URI, String) - Method in interface org.xbrlapi.data.Store

If using persisted relationships then the set of relationships used to generate the results can be modified by appropriate choice of

getLabels(String, URI, String) - Method in interface org.xbrlapi.data.Store

Implemented by Store.getLabels(String,URI,URI,String).

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

Implemented by Store.getLabels(String,URI,URI,String).

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

Implemented by Store.getLabels(String,URI,URI,String).

getLabels(String, URI) - Method in interface org.xbrlapi.data.Store

Implemented by Store.getLabels(String,URI,URI,String).

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

getLabels(List<String>, List<URI>) - Method in interface org.xbrlapi.Fragment

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

getLabels(List<String>, List<URI>) - Method in class org.xbrlapi.impl.FragmentImpl

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

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

getLabelsWithLanguageAndResourceRole(String, URI) - Method in interface org.xbrlapi.Fragment

getLabelsWithLanguageAndResourceRole(String, URI) - Method in class org.xbrlapi.impl.FragmentImpl

getLabelsWithLanguageAndResourceRoleAndLinkRole(String, URI, URI) - Method in interface org.xbrlapi.Fragment

getLabelsWithLanguageAndResourceRoleAndLinkRole(String, URI, URI) - Method in class org.xbrlapi.impl.FragmentImpl

getLabelsWithResourceRole(URI) - Method in interface org.xbrlapi.Fragment

getLabelsWithResourceRole(URI) - Method in class org.xbrlapi.impl.FragmentImpl

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

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

getLanguage() - Method in class org.xbrlapi.impl.MixedContentResourceImpl

Get the value of the xml:lang attribute on the resource.

getLanguage() - Method in class org.xbrlapi.impl.ResourceImpl

getLanguage() - Method in class org.xbrlapi.impl.TitleImpl

Get the xlink title language code.

getLanguage() - Method in interface org.xbrlapi.MixedContentResource

Get the value of the xml:lang attribute on the resource.

getLanguage() - Method in interface org.xbrlapi.Resource

getLanguage() - Method in interface org.xbrlapi.Title

Get the documentation language code.

getLanguageCode() - Method in class org.xbrlapi.aspects.ConceptAspect.Transformer

getLanguageCode() - Method in class org.xbrlapi.aspects.EntityIdentifierAspect.Transformer

getLanguageCode() - Method in class org.xbrlapi.aspects.LocationAspect.Transformer

getLanguageCode() - Method in class org.xbrlapi.xdt.aspects.DimensionAspect

getLanguageCode() - Method in class org.xbrlapi.xlink.ElementState

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

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

getLanguageName(String) - Method in class org.xbrlapi.impl.ResourceImpl

getLanguageName(List<String>) - Method in class org.xbrlapi.impl.ResourceImpl

getLanguageName(String) - Method in interface org.xbrlapi.Resource

getLanguageName(List<String>) - Method in interface org.xbrlapi.Resource

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

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

getLatestPeriod() - Method in class org.xbrlapi.impl.InstanceImpl

getLatestPeriod() - Method in interface org.xbrlapi.Instance

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

Deprecated.

getLinkbaseRefs() - Method in class org.xbrlapi.impl.InstanceImpl

getLinkbaseRefs() - Method in interface org.xbrlapi.Instance

Get the list of linkbaseRef fragments in the instance Returns null if none are contained by the XBRL instance.

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

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

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

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

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

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

getLinkRole() - Method in class org.xbrlapi.impl.LinkImpl

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

getLinkRole() - Method in interface org.xbrlapi.Link

getLinkRole() - Method in interface org.xbrlapi.networks.Network

getLinkRole() - Method in class org.xbrlapi.networks.NetworkImpl

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

getLinkRole() - Method in class org.xbrlapi.xdt.TypedDimensionImpl

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

getLinkRoles(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

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

getLinkRoles(URI) - Method in interface org.xbrlapi.data.Store

getLinkRoles() - Method in interface org.xbrlapi.networks.Analyser

getLinkRoles(URI) - Method in interface org.xbrlapi.networks.Analyser

getLinkRoles() - Method in class org.xbrlapi.networks.AnalyserImpl

getLinkRoles(URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getLinkRoles(URI) - Method in interface org.xbrlapi.networks.Networks

getLinkRoles(URI) - Method in class org.xbrlapi.networks.NetworksImpl

getLoader() - Method in class org.xbrlapi.sax.BaseContentHandlerImpl

getLoader() - Method in interface org.xbrlapi.sax.ContentHandler

getLoader() - Method in class org.xbrlapi.sax.identifiers.BaseIdentifier

getLoader() - Method in interface org.xbrlapi.sax.identifiers.Identifier

getLocalComplexType() - Method in interface org.xbrlapi.ElementDeclaration

getLocalComplexType() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

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

Get the local name of the fragment's root element

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

getLocalname() - Method in class org.xbrlapi.impl.MeasureImpl

getLocalname() - Method in interface org.xbrlapi.Measure

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

Returns the local name for a QName

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

getLocalType() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

getLocalType() - Method in interface org.xbrlapi.SchemaContentDeclaration

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

Get the list of locators contained by the extended link.

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

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

Get the list of locators in the extended link with a specified absolute HREF.

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

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

Get the list of locators with a specified label in the extended link.

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

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

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

getMapId(AspectValue) - Method in class org.xbrlapi.aspects.BaseAspectValueTransformer

getMapLabel(String) - Method in class org.xbrlapi.aspects.BaseAspectValueTransformer

getMatch(URI) - Method in class org.xbrlapi.data.resource.DefaultMatcherImpl

getMatch(URI) - Method in class org.xbrlapi.data.resource.InMemoryMatcherImpl

getMatch(URI) - Method in class org.xbrlapi.data.resource.InStoreMatcherImpl

getMatch(URI) - Method in interface org.xbrlapi.data.resource.Matcher

As a side effect, this method adds the specified URI to the matcher.

getMatch() - Method in class org.xbrlapi.impl.MatchImpl

getMatch() - Method in interface org.xbrlapi.Match

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

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

getMatchingFacts() - Method in interface org.xbrlapi.aspects.Aspect

getMatchingFacts() - Method in interface org.xbrlapi.aspects.AspectModel

getMatchingFacts() - Method in class org.xbrlapi.aspects.BaseAspect

getMatchingFacts() - Method in class org.xbrlapi.aspects.BaseAspectModel

getMaxOccurs() - Method in interface org.xbrlapi.ElementDeclaration

getMaxOccurs() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

getMembers() - Method in interface org.xbrlapi.AttributeGroupDeclaration

getMembers() - Method in class org.xbrlapi.impl.AttributeGroupDeclarationImpl

getMembers() - Method in class org.xbrlapi.impl.SchemaCompositorImpl

getMembers() - Method in interface org.xbrlapi.SchemaCompositor

getMessage() - Method in exception org.xbrlapi.utilities.XBRLException

getMessage() - Method in exception org.xbrlapi.xlink.XLinkException

getMessage() - Method in exception org.xbrlapi.xmlbase.XMLBaseException

getMessage() - Method in exception org.xbrlapi.xpointer.ParseException

This method has the standard behavior when this object has been created using the standard constructors.

getMessage() - Method in error org.xbrlapi.xpointer.TokenMgrError

You can also modify the body of this method to customize your error messages.

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

Get a metadata attribute.

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

getMetaAttribute(String) - Method in class org.xbrlapi.impl.XMLImpl

getMetaAttribute(String) - Method in interface org.xbrlapi.XML

Get a fragment metadata attribute.

getMetadata() - Method in interface org.xbrlapi.builder.Builder

Get the metadata DOM document.

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

Get the metadata DOM document.

getMetadataRootElement() - Method in class org.xbrlapi.impl.XMLImpl

getMetadataRootElement() - Method in interface org.xbrlapi.XML

Get the root element of the fragment metadata.

getMinimalAspectValueCombinationsForAxis(String) - Method in interface org.xbrlapi.aspects.AspectModel

getMinimalAspectValueCombinationsForAxis(String) - Method in class org.xbrlapi.aspects.BaseAspectModel

getMinimalNetwork(Set<Fragment>, URI, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getMinimalNetwork(Set<Fragment>, URI, URI) - Method in interface org.xbrlapi.data.Store

getMinimalNetworksWithArcrole(Fragment, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getMinimalNetworksWithArcrole(Set<Fragment>, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getMinimalNetworksWithArcrole(Set<Fragment>, URI) - Method in interface org.xbrlapi.data.Store

Get the networks that, at a minimum, contain the relationships from each of the given fragments working back through ancestor relationships as far as possible.

getMinimalNetworksWithArcrole(Fragment, URI) - Method in interface org.xbrlapi.data.Store

Convenience method for a single fragment.

getMinimumDocumentSet(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getMinimumDocumentSet(List<URI>) - Method in class org.xbrlapi.data.BaseStoreImpl

getMinimumDocumentSet(List<URI>) - Method in interface org.xbrlapi.data.Store

getMinimumDocumentSet(URI) - Method in interface org.xbrlapi.data.Store

This is just a convenience method.

getMinOccurs() - Method in interface org.xbrlapi.ElementDeclaration

getMinOccurs() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

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

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

getName() - Method in class org.xbrlapi.impl.LanguageImpl

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

Get the name of structure being declared.

getName() - Method in interface org.xbrlapi.Language

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

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

Get the namespace of the fragment root element.

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

getNamespace() - Method in class org.xbrlapi.impl.MeasureImpl

getNamespace() - Method in interface org.xbrlapi.Measure

getNamespaceFromQName(String, Node) - Method in interface org.xbrlapi.Fragment

Returns the Namespace for a QName in the context of a node in the fragment.

getNamespaceFromQName(String, Node) - Method in class org.xbrlapi.impl.FragmentImpl

Algorithm is as follows: If the node is an attribute, redo with the parent node. If the node is a XBRLAPI metadata element redo with right node in parent fragment. If the node is an element in the fragment data: Generate namespace declaration attribute name - 'xmlns:...' to search for. Try to match the QName prefix to the element's prefix to see if the element namespace is appropriate to return. Try to find the attribute doing the namespace declaration on the element and use that. If that fails, redo the search using the parent node.

getNetwork(URI, URI) - Method in interface org.xbrlapi.networks.Networks

getNetwork(URI, URI) - Method in class org.xbrlapi.networks.NetworksImpl

getNetworkRoots(URI, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getNetworkRoots(URI, URI) - Method in interface org.xbrlapi.data.Store

This implementation is not as strict as the XBRL 2.1 specification requires but it is generally faster and delivers sensible results.

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

getNetworks(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getNetworks(URI, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getNetworks(URI, URI) - Method in interface org.xbrlapi.data.Store

getNetworks(URI) - Method in interface org.xbrlapi.data.Store

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

Note that this can massively overload resources if the data store is large because much of the information in the store will be reflected in -in-memory objects.

getNetworks() - Method in class org.xbrlapi.impl.ArcroleTypeImpl

get the collection of networks expressed using arcs that involve this arc role.

getNetworks(URI) - Method in interface org.xbrlapi.networks.Networks

getNetworks(URI) - Method in class org.xbrlapi.networks.NetworksImpl

getNetworksFrom(String, URI, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getNetworksFrom(String, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

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

getNetworksFrom(String, URI) - Method in interface org.xbrlapi.data.Store

Implemented by Store.getNetworksFrom(String,URI,URI).

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

Implemented by Store.getNetworksFrom(String,URI,URI).

getNetworksFrom(String, URI, URI) - Method in interface org.xbrlapi.data.Store

getNetworksTo(String, URI, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getNetworksTo(String, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

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

getNetworksTo(String, URI, URI) - Method in interface org.xbrlapi.data.Store

If using persisted relationships then the set of relationships used to generate the results can be modified by appropriate choice of

getNetworksTo(String, URI) - Method in interface org.xbrlapi.data.Store

Implemented by Store.getNetworksTo(String,URI,URI).

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

Implemented by Store.getNetworksTo(String,URI,URI).

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

Also increments the fragment index as a side-effect.

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

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

getNextToken() - Method in class org.xbrlapi.xpointer.PointerGrammarTokenManager

getNumberOfActiveRelationships() - Method in interface org.xbrlapi.networks.Network

getNumberOfActiveRelationships() - Method in class org.xbrlapi.networks.NetworkImpl

getNumberOfRelationships() - Method in interface org.xbrlapi.networks.Network

getNumberOfRelationships() - Method in class org.xbrlapi.networks.NetworkImpl

getNumerator() - Method in interface org.xbrlapi.FractionItem

Get the fraction numerator.

getNumerator() - Method in class org.xbrlapi.impl.FractionItemImpl

getNumeratorMeasures() - Method in class org.xbrlapi.impl.UnitImpl

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

Get the numerator set of measures for the unit

getOpenContextComponent() - Method in interface org.xbrlapi.xdt.values.DimensionValue

getOpenContextComponent() - Method in class org.xbrlapi.xdt.values.DimensionValueImpl

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

Get the order attribute value.

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

getOriginalURI(URI) - Method in interface org.xbrlapi.cache.Cache

getOriginalURI(File) - Method in interface org.xbrlapi.cache.Cache

getOriginalURI(URI) - Method in class org.xbrlapi.cache.CacheImpl

getOriginalURI(File) - Method in class org.xbrlapi.cache.CacheImpl

getOrphanAspects() - Method in interface org.xbrlapi.aspects.AspectModel

getOrphanAspects() - Method in class org.xbrlapi.aspects.BaseAspectModel

getOtherAttribute(URI, String) - Method in class org.xbrlapi.impl.SchemaContentImpl

getOtherAttribute(URI, String) - Method in interface org.xbrlapi.SchemaContent

Mirrors the getAttributeNS method of the org.w3c.dom.Element class.

getOtherAttributes() - Method in class org.xbrlapi.impl.SchemaContentImpl

getOtherAttributes() - Method in interface org.xbrlapi.SchemaContent

getOtherElementDeclarations() - Method in class org.xbrlapi.impl.SchemaImpl

getOtherElementDeclarations() - Method in interface org.xbrlapi.Schema

Get the fragment list of element declarations (that are not concepts) in the schema.

getParent() - Method in interface org.xbrlapi.aspects.AspectValue

This method supports aspects, such as the location aspect, where aspect values can have a heirarchical organisation, such that an aspect value can be associated with an ordered set of children aspect values.

getParent() - Method in class org.xbrlapi.aspects.BaseAspectValue

getParent() - Method in class org.xbrlapi.aspects.LocationAspectValue

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

Get the parent fragment of this fragment or null if there is none.

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

getParent() - Method in class org.xbrlapi.xlink.ElementState

getParentElement(Element) - Method in interface org.xbrlapi.Fragment

Get the element in the parent fragment that has this fragment as its child.

getParentElement(Element) - Method in class org.xbrlapi.impl.FragmentImpl

This method operates as follows: If the sequence to the parent element indicates that the data root element is the parent - use that. Loop through the sequence to the parent element.

getParentEquivalents() - Method in class org.xbrlapi.impl.EntityResourceImpl

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

Get the index of the parent fragment or null if the fragment does not have a parent fragment.

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

getParents(String) - Method in interface org.xbrlapi.networks.Network

Note that a fragment can have more than one parent fragment given that the networks are not just trees.

getParents(String) - Method in class org.xbrlapi.networks.NetworkImpl

getParentType() - Method in class org.xbrlapi.impl.TypeDeclarationImpl

getParentType() - Method in interface org.xbrlapi.TypeDeclaration

getParentTypeLocalname() - Method in class org.xbrlapi.impl.TypeDeclarationImpl

getParentTypeLocalname() - Method in interface org.xbrlapi.TypeDeclaration

getParentTypeNamespace() - Method in class org.xbrlapi.impl.TypeDeclarationImpl

getParentTypeNamespace() - Method in interface org.xbrlapi.TypeDeclaration

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

Get the period of the context.

getPeriod() - Method in class org.xbrlapi.impl.ContextImpl

Get the period of the context.

getPeriodType() - Method in interface org.xbrlapi.Concept

getPeriodType() - Method in class org.xbrlapi.impl.ConceptImpl

getPrecision() - Method in class org.xbrlapi.impl.NumericItemImpl

Get the precision attribute for this item.

getPrecision() - Method in interface org.xbrlapi.NumericItem

Get the precision attribute for this item.

getPrecisionAdjustedValue() - Method in class org.xbrlapi.impl.SimpleNumericItemImpl

Get the value of the fact after adjusting for the specified precision.

getPrecisionAdjustedValue() - Method in interface org.xbrlapi.SimpleNumericItem

Get the value of the fact after adjusting for the specified precision.

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

This method is useful in the context of parent-child presentation relationships as defined in the XBRL 2.1 specification.

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

getPrefix() - Method in class org.xbrlapi.impl.MeasureImpl

getPrefix() - Method in interface org.xbrlapi.Measure

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

Returns the Namespace prefix for a QName

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

getPresentationNetworkLinkroles() - Method in interface org.xbrlapi.Concept

getPresentationNetworkLinkroles() - Method in class org.xbrlapi.impl.ConceptImpl

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

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

getProblemIndex() - Method in interface org.xbrlapi.Error

getProblemIndex() - Method in class org.xbrlapi.impl.ErrorImpl

getProblemURI() - Method in interface org.xbrlapi.Error

getProblemURI() - Method in class org.xbrlapi.impl.ErrorImpl

getReason() - Method in class org.xbrlapi.impl.StubImpl

getReason() - Method in interface org.xbrlapi.Stub

getReferencedDocuments(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getReferencedDocuments(URI) - Method in interface org.xbrlapi.data.Store

Override this method in a data store implementation if the data store implementation supports XQuery (rather than XPath).

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

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

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

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

Retrieve the type local name.

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

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

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

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

getReferencePart(URI, String) - Method in class org.xbrlapi.impl.ReferenceResourceImpl

Get a specific reference part from a reference.

getReferencePart(URI, String) - Method in interface org.xbrlapi.ReferenceResource

Get a specific reference part from a reference.

getReferencePartDeclaration(String) - Method in class org.xbrlapi.impl.SchemaImpl

getReferencePartDeclaration(String) - Method in interface org.xbrlapi.Schema

Get a reference part declaration in a schema.

getReferencePartDeclarations() - Method in class org.xbrlapi.impl.SchemaImpl

getReferencePartDeclarations() - Method in interface org.xbrlapi.Schema

Get a list of the reference part declarations in a schema.

getReferenceParts() - Method in class org.xbrlapi.impl.ReferenceResourceImpl

Get a list of reference part fragments.

getReferenceParts() - Method in interface org.xbrlapi.ReferenceResource

Get a list of reference part fragments.

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

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

getReferenceRelationships(String) - Method in interface org.xbrlapi.networks.Analyser

getReferenceRelationships(String) - Method in class org.xbrlapi.networks.AnalyserImpl

getReferenceRelationshipsByLanguage(String, String) - Method in interface org.xbrlapi.networks.Analyser

getReferenceRelationshipsByLanguage(String, String) - Method in class org.xbrlapi.networks.AnalyserImpl

getReferenceRelationshipsByLanguageAndRole(String, String, URI) - Method in interface org.xbrlapi.networks.Analyser

getReferenceRelationshipsByLanguageAndRole(String, String, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getReferenceRelationshipsByLanguages(String, List<String>) - Method in interface org.xbrlapi.networks.Analyser

getReferenceRelationshipsByLanguages(String, List<String>) - Method in class org.xbrlapi.networks.AnalyserImpl

getReferenceRelationshipsByRole(String, URI) - Method in interface org.xbrlapi.networks.Analyser

getReferenceRelationshipsByRole(String, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getReferenceRelationshipsByRoles(String, List<URI>) - Method in interface org.xbrlapi.networks.Analyser

getReferenceRelationshipsByRoles(String, List<String>, List<URI>) - Method in interface org.xbrlapi.networks.Analyser

getReferenceRelationshipsByRoles(String, List<String>, List<URI>) - Method in class org.xbrlapi.networks.AnalyserImpl

getReferenceRelationshipsByRoles(String, List<URI>) - Method in class org.xbrlapi.networks.AnalyserImpl

getReferences(String, URI, URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

getReferences(String, URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

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

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

getReferences(String, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getReferences(String, URI, URI, String) - Method in interface org.xbrlapi.data.Store

If using persisted relationships then the set of relationships used to generate the results can be modified by appropriate choice of

getReferences(String, URI, String) - Method in interface org.xbrlapi.data.Store

Implemented by Store.getReferences(String,URI,URI,String).

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

Implemented by Store.getReferences(String,URI,URI,String).

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

Implemented by Store.getReferences(String,URI,URI,String).

getReferences(String, URI) - Method in interface org.xbrlapi.data.Store

Implemented by Store.getReferences(String,URI,URI,String).

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

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

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

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

getReferencesWithLanguageAndResourceRoleAndLinkRole(String, URI, URI) - Method in interface org.xbrlapi.Fragment

getReferencesWithLanguageAndResourceRoleAndLinkRole(String, URI, URI) - Method in class org.xbrlapi.impl.FragmentImpl

getReferencesWithLanguageAndRole(String, URI) - Method in interface org.xbrlapi.Fragment

getReferencesWithLanguageAndRole(String, URI) - Method in class org.xbrlapi.impl.FragmentImpl

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

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

getReferencingDocuments(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getReferencingDocuments(URI) - Method in interface org.xbrlapi.data.Store

getReferencingFragments(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getReferencingFragments(URI) - Method in interface org.xbrlapi.data.Store

getReferencingItems() - Method in interface org.xbrlapi.FactDimensionContainer

getReferencingItems() - Method in class org.xbrlapi.impl.ContextImpl

getReferencingItems() - Method in class org.xbrlapi.impl.FactDimensionContainerImpl

getReferencingItems() - Method in class org.xbrlapi.impl.UnitImpl

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

Retrieves a list of all locators that target this fragment.

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

getRelationships(String) - Method in class org.xbrlapi.networks.AllAnalyserImpl

This method does not filter out any relationships.

getRelationships(URI, Set<URI>) - Method in interface org.xbrlapi.networks.Analyser

getRelationships(Set<URI>) - Method in interface org.xbrlapi.networks.Analyser

getRelationships(URI) - Method in interface org.xbrlapi.networks.Analyser

getRelationships(URI, URI) - Method in interface org.xbrlapi.networks.Analyser

getRelationships(String, String, URI, URI) - Method in interface org.xbrlapi.networks.Analyser

getRelationships(String) - Method in class org.xbrlapi.networks.AnalyserImpl

This method provides a place to filter relationships after retrieving them to eliminate overridden and prohibited relationships as desired.

getRelationships(Set<URI>) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationships(URI, Set<URI>) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationships(URI, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationships(URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationships(String, String, URI, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationships(String) - Method in class org.xbrlapi.networks.NonProhibitedAnalyserImpl

Filters out relationships with use=prohibited on the arcs expressing them.

getRelationshipsFrom(String, URI, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getRelationshipsFrom(String, URI, URI) - Method in interface org.xbrlapi.data.Store

If using persisted relationships then the set of relationships used to generate the results can be modified by appropriate choice of

getRelationshipsFrom(String, URI, URI) - Method in interface org.xbrlapi.networks.Analyser

getRelationshipsFrom(String, URI) - Method in interface org.xbrlapi.networks.Analyser

getRelationshipsFrom(String, URI, Set<URI>) - Method in interface org.xbrlapi.networks.Analyser

getRelationshipsFrom(String, Set<URI>) - Method in interface org.xbrlapi.networks.Analyser

getRelationshipsFrom(String, Set<URI>) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationshipsFrom(String, URI, Set<URI>) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationshipsFrom(String, URI, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationshipsFrom(String, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationshipsTo(String, URI, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

If using persisted relationships then the set of relationships used to generate the results can be modified by appropriate choice of

getRelationshipsTo(String, URI, URI) - Method in interface org.xbrlapi.data.Store

getRelationshipsTo(String, URI, URI) - Method in interface org.xbrlapi.networks.Analyser

getRelationshipsTo(String, URI) - Method in interface org.xbrlapi.networks.Analyser

getRelationshipsTo(String, URI, Set<URI>) - Method in interface org.xbrlapi.networks.Analyser

getRelationshipsTo(String, Set<URI>) - Method in interface org.xbrlapi.networks.Analyser

getRelationshipsTo(String, Set<URI>) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationshipsTo(String, URI, Set<URI>) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationshipsTo(String, URI, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getRelationshipsTo(String, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getResolvedDenominatorMeasures() - Method in class org.xbrlapi.impl.UnitImpl

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

getResolvedNumeratorMeasures() - Method in class org.xbrlapi.impl.UnitImpl

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

getResourceContent(File) - Method in class org.xbrlapi.data.resource.BaseMatcherImpl

getResourceContent(URI) - Method in class org.xbrlapi.data.resource.BaseMatcherImpl

getResourceRole() - Method in class org.xbrlapi.impl.ResourceImpl

getResourceRole() - Method in interface org.xbrlapi.Resource

Get the value of the resource role (xlink:role attribute) for the resource.

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

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

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

Get the list of resources contained by the extended link.

getResources() - Method in interface org.xbrlapi.grabber.Grabber

getResources() - Method in class org.xbrlapi.grabber.SecGrabberImpl

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

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

Get the list of resources with the specified label.

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

getResourceURI() - Method in class org.xbrlapi.impl.StubImpl

getResourceURI() - Method in interface org.xbrlapi.Stub

getResults() - Method in class org.xbrlapi.xlink.Validator

Returns an XML DOM document that contains one message element (as a child of the root message element) for each of the errors and warnings generated during the validation process.

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

Get the xlink:role attribute value.

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

Get the xlink:role attribute value.

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

Get the simple link role equivalent if it exists

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

Retrieve an roleRef from a linkbase.

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

Retrieve an roleRef from a linkbase.

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

Gets the list of roleRefs in a linkbase.

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

Gets the list of roleRefs in a linkbase.

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

getRoleTypes(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

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

getRoleTypes(URI) - Method in interface org.xbrlapi.data.Store

getRoleTypes() - Method in class org.xbrlapi.impl.SchemaImpl

getRoleTypes() - Method in interface org.xbrlapi.Schema

getRootFragmentForDocument(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getRootFragmentForDocument(URI) - Method in interface org.xbrlapi.data.Store

getRootFragmentIndexes() - Method in interface org.xbrlapi.networks.Network

getRootFragmentIndexes() - Method in class org.xbrlapi.networks.NetworkImpl

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

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

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

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

getRootFragments() - Method in interface org.xbrlapi.networks.Network

getRootFragments() - Method in class org.xbrlapi.networks.NetworkImpl

getRootIndices(URI, URI) - Method in interface org.xbrlapi.networks.Analyser

getRootIndices(URI, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getRootRelationships(URI, URI) - Method in interface org.xbrlapi.networks.Analyser

getRootRelationships(URI, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

getRoots(URI, URI) - Method in interface org.xbrlapi.networks.Analyser

getRoots(URI, URI) - Method in class org.xbrlapi.networks.AnalyserImpl

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

Get the scenario of the context.

getScenario() - Method in class org.xbrlapi.impl.ContextImpl

Get the scenario of the context.

getSchema(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getSchema(URI) - Method in interface org.xbrlapi.data.Store

getSchema() - Method in class org.xbrlapi.impl.ConceptImpl

Retrieves the fragment that is the schema for this concept.

getSchema() - Method in class org.xbrlapi.impl.SchemaContentImpl

getSchema() - Method in interface org.xbrlapi.SchemaContent

getSchemaContent(URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

getSchemaContent(URI, String) - Method in interface org.xbrlapi.data.Store

getSchemaId() - Method in class org.xbrlapi.impl.SchemaContentImpl

getSchemaId() - Method in interface org.xbrlapi.SchemaContent

getSchemaRefs() - Method in class org.xbrlapi.impl.InstanceImpl

getSchemaRefs() - Method in interface org.xbrlapi.Instance

Get the list of schemaRef fragments in the instance Returns null if none are contained by the XBRL instance.

getSchemeLocalName() - Method in interface org.xbrlapi.xpointer.PointerPart

getSchemeLocalName() - Method in class org.xbrlapi.xpointer.PointerPartImpl

getSchemeNamespace() - Method in interface org.xbrlapi.xpointer.PointerPart

getSchemeNamespace() - Method in class org.xbrlapi.xpointer.PointerPartImpl

getSchemePrefix() - Method in interface org.xbrlapi.xpointer.PointerPart

getSchemePrefix() - Method in class org.xbrlapi.xpointer.PointerPartImpl

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

Get the segment of the entity

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

getSelectionCriterion() - Method in interface org.xbrlapi.aspects.Aspect

getSelectionCriterion() - Method in class org.xbrlapi.aspects.BaseAspect

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

Gets a list of the attributes that define the semantics of an arc.

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

TODO Add in PSVI information re default and fixed attribute values.

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

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

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

Get the sequence of steps through the parent fragment DOM to the parent element.

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

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

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

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

Get the xlink:show attribute value.

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

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

Get the simple link show equivalent if it exists

getSignature(URI) - Method in class org.xbrlapi.data.resource.BaseMatcherImpl

getSignature(URI) - Method in class org.xbrlapi.data.resource.DefaultMatcherImpl

getSignature(URI) - Method in interface org.xbrlapi.data.resource.Matcher

getSignature(List<String>) - Method in class org.xbrlapi.data.resource.MD5SignerImpl

getSignature(List<String>) - Method in interface org.xbrlapi.data.resource.Signer

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

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

getSigner() - Method in class org.xbrlapi.data.resource.BaseMatcherImpl

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

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

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

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

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

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

getSize() - Method in interface org.xbrlapi.networks.Networks

getSize() - Method in class org.xbrlapi.networks.NetworksImpl

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

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

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

Get the list of ArcEnd fragments that the arc runs from.

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

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

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

getSourceIndices(String, URI, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getSourceIndices(String, URI, URI) - Method in interface org.xbrlapi.data.Store

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

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

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

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

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

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

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

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

getSources(String, URI, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getSources(String, URI, URI) - Method in interface org.xbrlapi.data.Store

getSources(String, URI) - Method in interface org.xbrlapi.networks.Networks

getSources(String, URI, URI) - Method in interface org.xbrlapi.networks.Networks

getSources(String, URI) - Method in class org.xbrlapi.networks.NetworksImpl

getSources(String, URI, URI) - Method in class org.xbrlapi.networks.NetworksImpl

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

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

getStart() - Method in class org.xbrlapi.impl.PeriodImpl

getStart() - Method in interface org.xbrlapi.Period

getState() - Method in class org.xbrlapi.xlink.ValidatorSAXContentHandlerImpl

getStore() - Method in class org.xbrlapi.data.resource.InStoreMatcherImpl

getStore() - Method in class org.xbrlapi.impl.XMLImpl

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

Get the DTS storage implementation

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

Get the data store used by a loader.

getStore() - Method in class org.xbrlapi.networks.AnalyserImpl

getStore() - Method in interface org.xbrlapi.networks.Network

getStore() - Method in class org.xbrlapi.networks.NetworkImpl

getStore() - Method in interface org.xbrlapi.networks.Networks

getStore() - Method in class org.xbrlapi.networks.NetworksImpl

getStore() - Method in interface org.xbrlapi.XML

Get the data store that manages this fragment.

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

Get all documents in the store as a single DOM.

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

Get the actual DOM that is used to hold the data store.

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

Get all data in the store as a single XML DOM object.

getStringIdentifier() - Method in class org.xbrlapi.impl.EntityResourceImpl

getStringValue() - Method in class org.xbrlapi.impl.LabelResourceImpl

getStringValue() - Method in interface org.xbrlapi.LabelResource

Get the value of the XHTML resource as a text string,

getStub(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getStub(URI) - Method in interface org.xbrlapi.data.Store

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

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

getSubstitutionGroupDeclaration() - Method in interface org.xbrlapi.ElementDeclaration

getSubstitutionGroupDeclaration() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

getSubstitutionGroupLocalname() - Method in interface org.xbrlapi.ElementDeclaration

Retrieve the substitution group local name.

getSubstitutionGroupLocalname() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

getSubstitutionGroupNamespace() - Method in interface org.xbrlapi.ElementDeclaration

Retrieve the substitution group namespace.

getSubstitutionGroupNamespace() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

getSubstitutionGroupNamespaceAlias() - Method in interface org.xbrlapi.ElementDeclaration

Retrieve the substitution group namespace alias (also known as a namespace prefix).

getSubstitutionGroupNamespaceAlias() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

getSubstitutionGroupQName() - Method in interface org.xbrlapi.ElementDeclaration

Retrieve the substitution group QName.

getSubstitutionGroupQName() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

getSubtree(Fragment) - Method in class org.xbrlapi.data.BaseStoreImpl

Returns the root element of the subtree starting with the fragment with the specified index.

getSubtree(Fragment) - Method in interface org.xbrlapi.data.Store

Returns the root element of the subtree starting with the fragment with the specified index.

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

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

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

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

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

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

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

getTarget() - Method in class org.xbrlapi.xdt.TypedDimensionImpl

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

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

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

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

getTargetDocumentURI(URI) - Method in class org.xbrlapi.xdt.TypedDimensionImpl

Get the URI of the document containing the fragment targetted by the supplied URI.

getTargetDocumentURI() - Method in class org.xbrlapi.xdt.TypedDimensionImpl

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

Get the list of ArcEnd fragments that the arc runs to.

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

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

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

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

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

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

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

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

getTargetNamespace() - Method in class org.xbrlapi.impl.SchemaContentImpl

getTargetNamespace() - Method in class org.xbrlapi.impl.SchemaImpl

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

getTargetNamespace() - Method in class org.xbrlapi.sax.identifiers.SchemaIdentifier

getTargetNamespace() - Method in interface org.xbrlapi.SchemaContent

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

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

getTargetPointerValue(String) - Method in class org.xbrlapi.xdt.TypedDimensionImpl

Get the value of the XPointer that corresponds to the XPointer information stored in the metadata of all fragments.

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

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

getTargets(String, URI, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

getTargets(String, URI, URI) - Method in interface org.xbrlapi.data.Store

getTargets(String, URI) - Method in interface org.xbrlapi.networks.Networks

getTargets(String, URI, URI) - Method in interface org.xbrlapi.networks.Networks

getTargets(String, URI) - Method in class org.xbrlapi.networks.NetworksImpl

getTargets(String, URI, URI) - Method in class org.xbrlapi.networks.NetworksImpl

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

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

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

Get the simple link title attribute equivalent if it exists

getTitleAttribute() - Method in class org.xbrlapi.xdt.TypedDimensionImpl

getTitleAttribute() - Method in interface org.xbrlapi.Xlink

Get the title (The xlink:title attribute value).

getTitleElement(int) - Method in class org.xbrlapi.xdt.TypedDimensionImpl

Get a specific title fragment

getTitleElement(int) - Method in interface org.xbrlapi.Xlink

Get a list of titles (The xlink:title children elements).

getTitleElements() - Method in class org.xbrlapi.xdt.TypedDimensionImpl

getTitleElements() - Method in interface org.xbrlapi.Xlink

Get a list of titles (The xlink:title children elements).

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

Get the xlink:to attribute value.

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

getToken(int) - Method in class org.xbrlapi.xpointer.PointerGrammar

getTransformer() - Method in interface org.xbrlapi.aspects.Aspect

getTransformer() - Method in class org.xbrlapi.aspects.BaseAspect

getTuple() - Method in interface org.xbrlapi.Fact

Get the tuple that this fact is a part of

getTuple() - Method in class org.xbrlapi.impl.FactImpl

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

getTuples(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

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

getTuples(URI) - Method in interface org.xbrlapi.data.Store

getTuples() - Method in class org.xbrlapi.impl.InstanceImpl

getTuples() - Method in interface org.xbrlapi.Instance

getType() - Method in interface org.xbrlapi.aspects.Aspect

getType() - Method in interface org.xbrlapi.aspects.AspectModel

getType() - Method in class org.xbrlapi.aspects.ConceptAspect

getType() - Method in class org.xbrlapi.aspects.EntityIdentifierAspect

getType() - Method in class org.xbrlapi.aspects.LocationAspect

getType() - Method in class org.xbrlapi.aspects.NonDimensionalAspectModel

getType() - Method in class org.xbrlapi.aspects.PeriodAspect

getType() - Method in class org.xbrlapi.aspects.QuarterlyPeriodAspect

getType() - Method in class org.xbrlapi.aspects.ScenarioAspect

getType() - Method in class org.xbrlapi.aspects.SegmentAspect

getType() - Method in class org.xbrlapi.aspects.UnitAspect

getType() - Method in class org.xbrlapi.impl.XMLImpl

getType() - Method in class org.xbrlapi.xdt.aspects.DimensionalAspectModel

getType() - Method in class org.xbrlapi.xdt.aspects.DimensionAspect

getType() - Method in class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect

getType() - Method in class org.xbrlapi.xdt.aspects.SegmentRemainderAspect

getType() - Method in interface org.xbrlapi.XML

Get the Fragment type.

getTypedDimensionContentFromOpenContextComponent(OpenContextComponent, Dimension) - Method in interface org.xbrlapi.xdt.values.DimensionValueAccessor

getTypedDimensionContentFromOpenContextComponent(OpenContextComponent, Dimension) - Method in class org.xbrlapi.xdt.values.DimensionValueAccessorImpl

getTypedDimensionValue(Item, Dimension) - Method in interface org.xbrlapi.xdt.values.DimensionValueAccessor

getTypedDimensionValue(Item, Dimension) - Method in class org.xbrlapi.xdt.values.DimensionValueAccessorImpl

getTypeDeclaration() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

getTypeDeclaration() - Method in interface org.xbrlapi.SchemaContentDeclaration

getTypeLocalname() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

getTypeLocalname() - Method in interface org.xbrlapi.SchemaContentDeclaration

Retrieve the type local name.

getTypeNamespace() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

getTypeNamespace() - Method in interface org.xbrlapi.SchemaContentDeclaration

Retrieve the type namespace.

getTypeNamespaceAlias() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

getTypeNamespaceAlias() - Method in interface org.xbrlapi.SchemaContentDeclaration

Retrieve the type namespace alias.

getTypeQName() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

getTypeQName() - Method in interface org.xbrlapi.SchemaContentDeclaration

Retrieve the type QName.

getUnescapedSchemeData() - Method in interface org.xbrlapi.xpointer.PointerPart

getUnescapedSchemeData() - Method in class org.xbrlapi.xpointer.PointerPartImpl

getUnit(String) - Method in class org.xbrlapi.impl.InstanceImpl

getUnit() - Method in class org.xbrlapi.impl.NumericItemImpl

getUnit(String) - Method in interface org.xbrlapi.Instance

Get a specified unit from the instance based on its id.

getUnit() - Method in interface org.xbrlapi.NumericItem

getUnitId() - Method in class org.xbrlapi.impl.NumericItemImpl

getUnitId() - Method in interface org.xbrlapi.NumericItem

getUnits() - Method in class org.xbrlapi.impl.InstanceImpl

getUnits() - Method in interface org.xbrlapi.Instance

Get the list of units contained in the instance.

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

Get the URI of the document containing this fragment.

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

getURI() - Method in class org.xbrlapi.sax.BaseContentHandlerImpl

getURI() - Method in interface org.xbrlapi.sax.ContentHandler

getURI(String) - Method in class org.xbrlapi.utilities.BaseTestCase

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

getURIs() - Method in class org.xbrlapi.impl.MatchImpl

getURIs() - Method in interface org.xbrlapi.Match

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

getUse() - Method in interface org.xbrlapi.AttributeDeclaration

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

getUse() - Method in class org.xbrlapi.impl.AttributeDeclarationImpl

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

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

getUsedOnLocalname() - Method in class org.xbrlapi.impl.UsedOnImpl

getUsedOnLocalname() - Method in interface org.xbrlapi.UsedOn

getUsedOnNamespace() - Method in class org.xbrlapi.impl.UsedOnImpl

getUsedOnNamespace() - Method in interface org.xbrlapi.UsedOn

getUsedOns() - Method in interface org.xbrlapi.CustomType

getUsedOns() - Method in class org.xbrlapi.impl.CustomTypeImpl

getValue(String) - Method in interface org.xbrlapi.aspects.Aspect

getValue(Fact) - Method in interface org.xbrlapi.aspects.Aspect

getValue(String) - Method in class org.xbrlapi.aspects.BaseAspect

getValue(Fact) - Method in class org.xbrlapi.aspects.ConceptAspect

getValue(Fact) - Method in class org.xbrlapi.aspects.EntityIdentifierAspect

getValue(Fact) - Method in class org.xbrlapi.aspects.LocationAspect

getValue(Fact) - Method in class org.xbrlapi.aspects.PeriodAspect

getValue(Fact) - Method in class org.xbrlapi.aspects.QuarterlyPeriodAspect

getValue(Fact) - Method in class org.xbrlapi.aspects.ScenarioAspect

getValue(Fact) - Method in class org.xbrlapi.aspects.SegmentAspect

getValue(Fact) - Method in class org.xbrlapi.aspects.UnitAspect

getValue() - Method in class org.xbrlapi.impl.NonNumericItemImpl

Get the value of the fact.

getValue() - Method in class org.xbrlapi.impl.ReferencePartImpl

Get the value of the reference part.

getValue() - Method in class org.xbrlapi.impl.SimpleNumericItemImpl

Get the value of the fact as a string.

getValue() - Method in class org.xbrlapi.impl.TitleImpl

Get the documentation text, with the leading and trailing spaces trimmed off.

getValue() - Method in class org.xbrlapi.impl.XlinkDocumentationImpl

TODO Provide a set value method for Xlink documentation fragments.

getValue() - Method in interface org.xbrlapi.NonNumericItem

Get the value of the fact.

getValue() - Method in interface org.xbrlapi.ReferencePart

Get the value of the reference part.

getValue() - Method in interface org.xbrlapi.SimpleNumericItem

Get the value of the fact

getValue() - Method in interface org.xbrlapi.Title

Get the documentation text, with the leading and trailing spaces trimmed off.

getValue(Fact) - Method in class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect

getValue(Fact) - Method in class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect

getValue(Fact) - Method in class org.xbrlapi.xdt.aspects.SegmentRemainderAspect

getValue(Fact) - Method in class org.xbrlapi.xdt.aspects.TypedDimensionAspect

getValue() - Method in interface org.xbrlapi.xdt.values.DimensionValue

getValue(Item, Dimension) - Method in interface org.xbrlapi.xdt.values.DimensionValueAccessor

getValue(Item, Dimension) - Method in class org.xbrlapi.xdt.values.DimensionValueAccessorImpl

getValue() - Method in class org.xbrlapi.xdt.values.DimensionValueImpl

getValue() - Method in interface org.xbrlapi.XlinkDocumentation

Get the value of the documentation fragment.

getValues() - Method in interface org.xbrlapi.aspects.Aspect

getValues() - Method in class org.xbrlapi.aspects.BaseAspect

getValuesByHierarchy() - Method in interface org.xbrlapi.aspects.Aspect

getValuesByHierarchy() - Method in class org.xbrlapi.aspects.BaseAspect

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

This method is useful in the context of summation-item calculation relationships as defined in the XBRL 2.1 specification.

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

getXLinkHandler() - Method in interface org.xbrlapi.xlink.XLinkProcessor

Provides access to the XLink handler being used by the XLink processor.

getXLinkHandler() - Method in class org.xbrlapi.xlink.XLinkProcessorImpl

Provides access to the XLink handler being used by the XLink processor.

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

Get the XLink processor

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

Get the Xlink processor used by the loader.

getXlinkType() - Method in class org.xbrlapi.xdt.TypedDimensionImpl

getXlinkType() - Method in interface org.xbrlapi.Xlink

Get the xlink type (The xxlink:type attribute value).

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

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

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

Retrieves a fragment from an XBRL API data store.

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

Retrieves an XML Resource from a data store.

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

getXMLResources(Class<?>) - Method in class org.xbrlapi.data.BaseStoreImpl

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

Return a list of XML resources in a data store that have a type corresponding to the specified XML resource interface name.

getXMLResources(Class<?>) - Method in interface org.xbrlapi.data.Store

Return a list of XML resources in a data store that have a type corresponding to the specified XML resource interface name.

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

Get the XPath to the element in the parent fragment that is the parent element of this fragment's root element.

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

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

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

getXSModel() - Method in class org.xbrlapi.sax.identifiers.SchemaIdentifier

Grabber - Interface in org.xbrlapi.grabber

Defines an XBRL grabber

GrammarCacheImpl - Class in org.xbrlapi.utilities

Title: GrammarCache

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

H

hasActiveRelationshipsFrom(String) - Method in interface org.xbrlapi.networks.Network

hasActiveRelationshipsFrom(String) - Method in class org.xbrlapi.networks.NetworkImpl

hasActiveRelationshipsTo(String) - Method in interface org.xbrlapi.networks.Network

hasActiveRelationshipsTo(String) - Method in class org.xbrlapi.networks.NetworkImpl

hasAllRelationships(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

hasAllRelationships(URI) - Method in interface org.xbrlapi.data.Store

hasAllRelationships(URI) - Method in interface org.xbrlapi.networks.Analyser

hasAllRelationships(URI) - Method in class org.xbrlapi.networks.AnalyserImpl

Algorithm involves: Getting all persisted relationships in the document Getting all arc+arcend+arcsource combinations in the document Matching each arc to its persisted relationships Returning false if any arc does not have persisted relationships

hasAspect(String) - Method in interface org.xbrlapi.aspects.AspectModel

hasAspect(String) - Method in class org.xbrlapi.aspects.BaseAspectModel

hasAttribute(String, String) - Method in interface org.xbrlapi.Arc

hasAttribute(String) - Method in interface org.xbrlapi.Arc

hasAttribute(String, String) - Method in class org.xbrlapi.impl.ArcImpl

hasAttribute(String) - Method in class org.xbrlapi.impl.ArcImpl

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

Test if a specific collection exists.

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

Test if a specific collection exists.

hasDecimals() - Method in class org.xbrlapi.impl.NumericItemImpl

Returns true if the fact has a decimals attribute.

hasDecimals() - Method in interface org.xbrlapi.NumericItem

Returns true if the fact has a decimals attribute.

hasDefaultDomainMember() - Method in interface org.xbrlapi.xdt.ExplicitDimension

hasDefaultDomainMember() - Method in class org.xbrlapi.xdt.ExplicitDimensionImpl

hasDenominator() - Method in class org.xbrlapi.impl.UnitImpl

Determines if the unit has a denominator

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

Determines if the unit has a denominator

hasDocument(URI) - Method in class org.xbrlapi.data.BaseStoreImpl

hasDocument(URI) - Method in interface org.xbrlapi.data.Store

Test if a particular URI is already in the data store.

hasFragment(String) - Method in interface org.xbrlapi.networks.Network

hasFragment(String) - Method in class org.xbrlapi.networks.NetworkImpl

hashCode() - Method in class org.xbrlapi.aspects.BaseAspect

hashCode() - Method in class org.xbrlapi.aspects.BaseAspectModel

hashCode() - Method in class org.xbrlapi.aspects.BaseAspectValue

hashCode() - Method in class org.xbrlapi.aspects.ConceptAspect

hashCode() - Method in class org.xbrlapi.aspects.ContextAspect

hashCode() - Method in class org.xbrlapi.aspects.EntityIdentifierAspect

hashCode() - Method in class org.xbrlapi.aspects.LocationAspect

hashCode() - Method in class org.xbrlapi.aspects.NonDimensionalAspectModel

hashCode() - Method in class org.xbrlapi.aspects.PeriodAspect

hashCode() - Method in class org.xbrlapi.aspects.QuarterlyPeriodAspect

hashCode() - Method in class org.xbrlapi.aspects.ScenarioAspect

hashCode() - Method in class org.xbrlapi.aspects.SegmentAspect

hashCode() - Method in class org.xbrlapi.aspects.UnitAspect

hashCode() - Method in class org.xbrlapi.cache.CacheImpl

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

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

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

hashCode() - Method in class org.xbrlapi.data.resource.BaseMatcherImpl

hashCode() - Method in class org.xbrlapi.data.resource.DefaultMatcherImpl

hashCode() - Method in class org.xbrlapi.data.resource.InMemoryMatcherImpl

hashCode() - Method in class org.xbrlapi.data.resource.MD5SignerImpl

hashCode() - Method in class org.xbrlapi.impl.XMLImpl

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

hashCode() - Method in class org.xbrlapi.networks.EquivalentRelationshipsImpl

hashCode() - Method in class org.xbrlapi.networks.NetworkImpl

hashCode() - Method in class org.xbrlapi.networks.NetworksImpl

hashCode() - Method in class org.xbrlapi.sax.EntityResolverImpl

hashCode() - Method in class org.xbrlapi.xdt.aspects.DimensionAspect

hashCode() - Method in class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect

hashCode() - Method in class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect

hashCode() - Method in class org.xbrlapi.xdt.aspects.SegmentRemainderAspect

hashCode() - Method in class org.xbrlapi.xdt.aspects.TypedDimensionAspect

hashCode() - Method in class org.xbrlapi.xlink.CustomLinkRecogniser

hashCode() - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

hashCode() - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

hashCode() - Method in class org.xbrlapi.xlink.XLinkProcessorImpl

hashCode() - Method in interface org.xbrlapi.XML

Override the Object hashCode method to provide for equality comparisons that are based on the fragment index.

hashCode() - Method in class org.xbrlapi.xmlbase.BaseURIDOMResolverImpl

hashCode() - Method in class org.xbrlapi.xmlbase.BaseURISAXResolverImpl

hasId() - Method in class org.xbrlapi.xlink.ElementState

hasLocalComplexType() - Method in interface org.xbrlapi.ElementDeclaration

hasLocalComplexType() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

hasLocalType() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

hasLocalType() - Method in interface org.xbrlapi.SchemaContentDeclaration

hasMapId(AspectValue) - Method in class org.xbrlapi.aspects.BaseAspectValueTransformer

hasMapLabel(String) - Method in class org.xbrlapi.aspects.BaseAspectValueTransformer

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

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

hasMetaAttribute(String) - Method in class org.xbrlapi.impl.XMLImpl

hasMetaAttribute(String) - Method in interface org.xbrlapi.XML

hasNetwork(URI, URI) - Method in interface org.xbrlapi.networks.Networks

hasNetwork(URI, URI) - Method in class org.xbrlapi.networks.NetworksImpl

hasNext() - Method in class org.xbrlapi.networks.TreeIterator

hasOtherAttribute(URI, String) - Method in class org.xbrlapi.impl.SchemaContentImpl

hasOtherAttribute(URI, String) - Method in interface org.xbrlapi.SchemaContent

Mirrors the hasAttributeNS method of the org.w3c.dom.Element class.

hasParent() - Method in interface org.xbrlapi.aspects.AspectValue

hasParent() - Method in class org.xbrlapi.aspects.BaseAspectValue

hasParent() - Method in class org.xbrlapi.aspects.LocationAspectValue

hasParent() - Method in class org.xbrlapi.xlink.ElementState

hasPrecision() - Method in class org.xbrlapi.impl.NumericItemImpl

Returns true if the fact has a precision attribute.

hasPrecision() - Method in interface org.xbrlapi.NumericItem

Returns true if the fact has a precision attribute.

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

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

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

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

hasSelectionCriterion() - Method in interface org.xbrlapi.aspects.Aspect

hasSelectionCriterion() - Method in class org.xbrlapi.aspects.BaseAspect

hasSingleParent(String) - Method in interface org.xbrlapi.networks.Network

hasSingleParent(String) - Method in class org.xbrlapi.networks.NetworkImpl

hasSubstitutionGroup() - Method in interface org.xbrlapi.ElementDeclaration

hasSubstitutionGroup() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

hasTypeReference() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

hasTypeReference() - Method in interface org.xbrlapi.SchemaContentDeclaration

hasURI(URI) - Method in class org.xbrlapi.data.resource.DefaultMatcherImpl

hasURI(URI) - Method in class org.xbrlapi.data.resource.InMemoryMatcherImpl

hasURI(URI) - Method in class org.xbrlapi.data.resource.InStoreMatcherImpl

hasURI(URI) - Method in interface org.xbrlapi.data.resource.Matcher

hasValue(AspectValue) - Method in interface org.xbrlapi.aspects.Aspect

hasValue(String) - Method in interface org.xbrlapi.aspects.Aspect

hasValue(String) - Method in class org.xbrlapi.aspects.BaseAspect

hasValue(AspectValue) - Method in class org.xbrlapi.aspects.BaseAspect

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

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

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

Test if a store contains a specific fragment, as identified by its index.

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

Test if a store contains a specific fragment, as identified by its index.

Hypercube - Interface in org.xbrlapi.xdt

hypercube - Static variable in class org.xbrlapi.xdt.XDTConstants

HypercubeImpl - Class in org.xbrlapi.xdt

HypercubeImpl() - Constructor for class org.xbrlapi.xdt.HypercubeImpl

I

Identifier - Interface in org.xbrlapi.sax.identifiers

The fragment identifier interface is implemented by any class that is to be used by a SAX content handler to identify fragments.

identifiers - Variable in class org.xbrlapi.sax.ContentHandlerImpl

The list of fragment identifiers

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

ignorableWhitespace(char[], int, int) - Method in class org.xbrlapi.sax.ContentHandlerImpl

Ignore ignorable whitespace

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

The string image of the token.

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

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

initialize() - Method in class org.xbrlapi.aspects.ConceptAspect

initialize() - Method in class org.xbrlapi.aspects.ContextAspect

initialize() - Method in class org.xbrlapi.aspects.EntityIdentifierAspect

initialize() - Method in class org.xbrlapi.aspects.LocationAspect

initialize() - Method in class org.xbrlapi.aspects.NonDimensionalAspectModel

initialize() - Method in class org.xbrlapi.aspects.PeriodAspect

initialize() - Method in class org.xbrlapi.aspects.QuarterlyPeriodAspect

initialize() - Method in class org.xbrlapi.aspects.ScenarioAspect

initialize() - Method in class org.xbrlapi.aspects.SegmentAspect

initialize() - Method in class org.xbrlapi.aspects.UnitAspect

initialize() - Method in class org.xbrlapi.xdt.aspects.DimensionalAspectModel

initialize(Dimension) - Method in class org.xbrlapi.xdt.aspects.DimensionAspect

initialize() - Method in class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect

initialize() - Method in class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect

initialize() - Method in class org.xbrlapi.xdt.aspects.SegmentRemainderAspect

initialize() - Method in class org.xbrlapi.xdt.aspects.TypedDimensionAspect

InMemoryMatcherImpl - Class in org.xbrlapi.data.resource

The in-memory resource matcher implementation, for use with the DOM data store implementation.

InMemoryMatcherImpl(Cache) - Constructor for class org.xbrlapi.data.resource.InMemoryMatcherImpl

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

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

Instance - Interface in org.xbrlapi

InstanceImpl - Class in org.xbrlapi.impl

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

InStoreMatcherImpl - Class in org.xbrlapi.data.resource

The in-store resource matcher implementation, for use with the persistent store implementations.

InStoreMatcherImpl(Store, Cache) - Constructor for class org.xbrlapi.data.resource.InStoreMatcherImpl

isa(String) - Method in class org.xbrlapi.impl.XMLImpl

isa(Class<?>) - Method in class org.xbrlapi.impl.XMLImpl

isa(String) - Method in interface org.xbrlapi.XML

isa(Class<?>) - Method in interface org.xbrlapi.XML

isAbstract() - Method in interface org.xbrlapi.ComplexTypeDeclaration

isAbstract() - Method in interface org.xbrlapi.ElementDeclaration

isAbstract() - Method in class org.xbrlapi.impl.ComplexTypeDeclarationImpl

isAbstract() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

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

isAncestorOf(Fragment) - Method in class org.xbrlapi.impl.FragmentImpl

isBlockingExtension() - Method in interface org.xbrlapi.ComplexTypeDeclaration

isBlockingExtension() - Method in interface org.xbrlapi.ElementDeclaration

isBlockingExtension() - Method in class org.xbrlapi.impl.ComplexTypeDeclarationImpl

isBlockingExtension() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

isBlockingRestriction() - Method in interface org.xbrlapi.ComplexTypeDeclaration

isBlockingRestriction() - Method in interface org.xbrlapi.ElementDeclaration

isBlockingRestriction() - Method in class org.xbrlapi.impl.ComplexTypeDeclarationImpl

isBlockingRestriction() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

isBlockingSubstitution() - Method in interface org.xbrlapi.ElementDeclaration

isBlockingSubstitution() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

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

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

isCacheURI(URI) - Method in interface org.xbrlapi.cache.Cache

Tests if a URI is a URI of a resource in the local cache.

isCacheURI(URI) - Method in class org.xbrlapi.cache.CacheImpl

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

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

isDerivedFrom(TypeDeclaration) - Method in class org.xbrlapi.impl.TypeDeclarationImpl

isDerivedFrom(URI, String) - Method in class org.xbrlapi.impl.TypeDeclarationImpl

isDerivedFrom(URI, String) - Method in interface org.xbrlapi.TypeDeclaration

isDerivedFrom(TypeDeclaration) - Method in interface org.xbrlapi.TypeDeclaration

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

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

isElementFormQualified() - Method in class org.xbrlapi.impl.SchemaImpl

isElementFormQualified() - Method in interface org.xbrlapi.Schema

Checks if the element form is qualified.

isEmpty() - Method in interface org.xbrlapi.aspects.Aspect

isEmpty() - Method in class org.xbrlapi.aspects.BaseAspect

isExplicitDimension() - Method in interface org.xbrlapi.xdt.Dimension

isExplicitDimension() - Method in class org.xbrlapi.xdt.DimensionImpl

isExplicitDimensionValue() - Method in interface org.xbrlapi.xdt.values.DimensionValue

isExplicitDimensionValue() - Method in class org.xbrlapi.xdt.values.DimensionValueImpl

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

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

isFinal() - Method in class org.xbrlapi.impl.TypeDeclarationImpl

isFinal() - Method in interface org.xbrlapi.TypeDeclaration

isFinalForExtension() - Method in interface org.xbrlapi.ComplexTypeDeclaration

isFinalForExtension() - Method in interface org.xbrlapi.ElementDeclaration

isFinalForExtension() - Method in class org.xbrlapi.impl.ComplexTypeDeclarationImpl

isFinalForExtension() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

isFinalForExtension() - Method in class org.xbrlapi.impl.TypeDeclarationImpl

isFinalForExtension() - Method in interface org.xbrlapi.TypeDeclaration

isFinalForRestriction() - Method in interface org.xbrlapi.ComplexTypeDeclaration

isFinalForRestriction() - Method in interface org.xbrlapi.ElementDeclaration

isFinalForRestriction() - Method in class org.xbrlapi.impl.ComplexTypeDeclarationImpl

isFinalForRestriction() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

isFinalForRestriction() - Method in class org.xbrlapi.impl.TypeDeclarationImpl

isFinalForRestriction() - Method in interface org.xbrlapi.TypeDeclaration

isFiniteDurationPeriod() - Method in class org.xbrlapi.impl.PeriodImpl

isFiniteDurationPeriod() - Method in interface org.xbrlapi.Period

Returns true if the period is a duration.

isFixed() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

isFixed() - Method in interface org.xbrlapi.SchemaContentDeclaration

isForeverPeriod() - Method in class org.xbrlapi.impl.PeriodImpl

isForeverPeriod() - Method in interface org.xbrlapi.Period

Returns true if the period is forever.

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

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

isGlobal() - Method in class org.xbrlapi.impl.SchemaContentDeclarationImpl

isGlobal() - Method in interface org.xbrlapi.SchemaContentDeclaration

isInstantPeriod() - Method in class org.xbrlapi.impl.PeriodImpl

isInstantPeriod() - Method in interface org.xbrlapi.Period

Returns true if the period is an instant.

isItem() - Method in interface org.xbrlapi.ElementDeclaration

isItem() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

isLeaf(String) - Method in interface org.xbrlapi.networks.Network

isLeaf(String) - Method in class org.xbrlapi.networks.NetworkImpl

isLink(String, String, String, Attributes) - Method in class org.xbrlapi.xdt.CustomLinkRecogniserImpl

Added the ability to detect custom links from typed dimensions to their domain declarations.

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

Returns true if the element with the supplied characteristics is a custom simple link.

isLink(String, String, String, Attributes) - Method in class org.xbrlapi.xlink.handler.XBRLCustomLinkRecogniserImpl

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

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

isMissing() - Method in interface org.xbrlapi.aspects.Aspect

isMissing() - Method in interface org.xbrlapi.aspects.AspectValue

isMissing() - Method in class org.xbrlapi.aspects.BaseAspect

isMissing() - Method in class org.xbrlapi.aspects.BaseAspectValue

isMixed() - Method in interface org.xbrlapi.ComplexTypeDeclaration

isMixed() - Method in class org.xbrlapi.impl.ComplexTypeDeclarationImpl

isNewFragment() - Method in interface org.xbrlapi.builder.Builder

Returns true iff the builder has not yet added an element to the fragment.

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

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

Tests if a fragment is new in the sense that it does not have a root data element.

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

isNil() - Method in interface org.xbrlapi.Fact

Return true if the fact has a nill value.

isNil() - Method in class org.xbrlapi.impl.FactImpl

isNillable() - Method in interface org.xbrlapi.ElementDeclaration

Determine if a concept is nillable

isNillable() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

isNumeric() - Method in interface org.xbrlapi.Concept

isNumeric() - Method in interface org.xbrlapi.Fact

isNumeric() - Method in class org.xbrlapi.impl.ConceptImpl

isNumeric() - Method in class org.xbrlapi.impl.FactImpl

isNumericItemType() - Method in class org.xbrlapi.impl.TypeDeclarationImpl

isNumericItemType() - Method in interface org.xbrlapi.TypeDeclaration

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

isOrphan() - Method in interface org.xbrlapi.aspects.Aspect

isOrphan() - Method in class org.xbrlapi.aspects.BaseAspect

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

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

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

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

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

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

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

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

isRoot(String) - Method in interface org.xbrlapi.networks.Network

isRoot(String) - Method in class org.xbrlapi.networks.NetworkImpl

isSingular() - Method in interface org.xbrlapi.aspects.Aspect

isSingular() - Method in class org.xbrlapi.aspects.BaseAspect

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

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

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

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

isTuple() - Method in interface org.xbrlapi.ElementDeclaration

isTuple() - Method in interface org.xbrlapi.Fact

Return true if the fact is a tuple and false otherwise

isTuple() - Method in class org.xbrlapi.impl.ElementDeclarationImpl

isTuple() - Method in class org.xbrlapi.impl.FactImpl

Return true if the fact is a tuple and false otherwise

isTypedDimension() - Method in interface org.xbrlapi.xdt.Dimension

isTypedDimension() - Method in class org.xbrlapi.xdt.DimensionImpl

isTypedDimensionValue() - Method in interface org.xbrlapi.xdt.values.DimensionValue

isTypedDimensionValue() - Method in class org.xbrlapi.xdt.values.DimensionValueImpl

isUsedCorrectly(Fragment) - Method in interface org.xbrlapi.CustomType

isUsedCorrectly(Fragment) - Method in class org.xbrlapi.impl.CustomTypeImpl

isUsedOn(URI, String) - Method in interface org.xbrlapi.CustomType

Returns true only if the arcrole can be used on the specified element

isUsedOn(URI, String) - Method in class org.xbrlapi.impl.CustomTypeImpl

isUsedOn(URI, String) - Method in class org.xbrlapi.impl.UsedOnImpl

isUsedOn(URI, String) - Method in interface org.xbrlapi.UsedOn

Returns true only if the custom role type can be used on the specified element based on this usedOn fragment.

Item - Interface in org.xbrlapi

ItemImpl - Class in org.xbrlapi.impl

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

iterator() - Method in class org.xbrlapi.networks.NetworksImpl

J

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

jj_nt - Variable in class org.xbrlapi.xpointer.PointerGrammar

jjFillToken() - Method in class org.xbrlapi.xpointer.PointerGrammarTokenManager

jjnewLexState - Static variable in class org.xbrlapi.xpointer.PointerGrammarTokenManager

jjstrLiteralImages - Static variable in class org.xbrlapi.xpointer.PointerGrammarTokenManager

K

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

An integer that describes the kind of this token.

L

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

LabelResource - Interface in org.xbrlapi

LabelResourceImpl - Class in org.xbrlapi.impl

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

labelRoles - Variable in class org.xbrlapi.data.bdbxml.examples.render.Concepts

labels - Variable in class org.xbrlapi.data.bdbxml.examples.render.Concepts

Language - Interface in org.xbrlapi

LanguageComparator - Class in org.xbrlapi.impl

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

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

LanguageIdentifier - Class in org.xbrlapi.sax.identifiers

LanguageIdentifier(ContentHandler) - Constructor for class org.xbrlapi.sax.identifiers.LanguageIdentifier

LanguageImpl - Class in org.xbrlapi.impl

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

LanguageMap - Class in org.xbrlapi.impl

Enables easy management of collections of language definitions.

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

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

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

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

LexicalError(boolean, int, int, int, String, char) - Static method in error org.xbrlapi.xpointer.TokenMgrError

Returns a detailed message for the Error when it is thrown by the token manager to indicate a lexical error.

lexStateNames - Static variable in class org.xbrlapi.xpointer.PointerGrammarTokenManager

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

Link - Interface in org.xbrlapi

Linkbase - Interface in org.xbrlapi

LinkbaseImpl - Class in org.xbrlapi.impl

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

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

LinkImpl - Class in org.xbrlapi.impl

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

ListDuplicateStoredDocuments - Class in org.xbrlapi.data.bdbxml.examples.utilities

Lists the URIs of all documents that have multiple versions stored with the same URI.

ListDuplicateStoredDocuments(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.ListDuplicateStoredDocuments

ListStoredDocuments - Class in org.xbrlapi.data.bdbxml.examples.utilities

Lists all documents in the data store.

ListStoredDocuments(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.ListStoredDocuments

Load - Class in org.xbrlapi.data.bdbxml.examples.load

This example loads a set of documents, including one or more XBRL instances, based on the list of URLs provided on the command line.

Load() - Constructor for class org.xbrlapi.data.bdbxml.examples.load.Load

LoadAllSECFilings - Class in org.xbrlapi.data.bdbxml.examples.load

This example loads all of the data identified in the SEC RSS feed.

LoadAllSECFilings() - Constructor for class org.xbrlapi.data.bdbxml.examples.load.LoadAllSECFilings

LoadCacheDocuments - Class in org.xbrlapi.data.bdbxml.examples.utilities

Loads all of the documents, from the specified cache directory, into the underlying data store.

LoadCacheDocuments(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.LoadCacheDocuments

loader - Variable in class org.xbrlapi.data.bdbxml.BaseTestCase

loader - Variable in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

loader - Variable in class org.xbrlapi.DOMLoadingTestCase

Loader - Interface in org.xbrlapi.loader

Loader defines the functions required to get a DTS into the data store ready for interactions via the XBRL API.

loader - Variable in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

The XBRL DTS loader that is using this XLink handler

LoaderImpl - Class in org.xbrlapi.loader

Implementation of the XBRL API Loader interface.

LoaderImpl(Store, XLinkProcessor) - Constructor for class org.xbrlapi.loader.LoaderImpl

LoaderImpl(Store, XLinkProcessor, List<URI>) - Constructor for class org.xbrlapi.loader.LoaderImpl

LoaderImpl - Class in org.xbrlapi.xdt

Modified loader, adapted to use the XDT SAX content handler to detect XDT fragments.

LoaderImpl(Store, XLinkProcessor) - Constructor for class org.xbrlapi.xdt.LoaderImpl

LoaderImpl(Store, XLinkProcessor, List<URI>) - Constructor for class org.xbrlapi.xdt.LoaderImpl

LoadSpecificDocument - Class in org.xbrlapi.data.bdbxml.examples.utilities

Loads a specific document, and all of the documents that it enables discovery of, into the data store.

LoadSpecificDocument(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.LoadSpecificDocument

LOCATION - Static variable in interface org.xbrlapi.aspects.Aspect

location - Variable in class org.xbrlapi.data.bdbxml.BaseTestCase

LocationAspect - Class in org.xbrlapi.aspects

LocationAspect(AspectModel) - Constructor for class org.xbrlapi.aspects.LocationAspect

LocationAspect.Transformer - Class in org.xbrlapi.aspects

LocationAspect.Transformer() - Constructor for class org.xbrlapi.aspects.LocationAspect.Transformer

LocationAspectValue - Class in org.xbrlapi.aspects

LocationAspectValue(Aspect, Fact) - Constructor for class org.xbrlapi.aspects.LocationAspectValue

Locator - Interface in org.xbrlapi

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

LocatorImpl - Class in org.xbrlapi.impl

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

logger - Static variable in class org.xbrlapi.data.bdbxml.BaseTestCase

logger - Static variable in class org.xbrlapi.data.bdbxml.examples.render.Run

logger - Static variable in class org.xbrlapi.data.bdbxml.examples.render.RunWithPersistedNetworks

logger - Static variable in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

logger - Static variable in class org.xbrlapi.impl.LanguageComparator

logger - Static variable in class org.xbrlapi.impl.XMLImpl

logger - Static variable in class org.xbrlapi.networks.AllAnalyserImpl

logger - Static variable in class org.xbrlapi.networks.AnalyserImpl

logger - Static variable in class org.xbrlapi.networks.NonProhibitedAnalyserImpl

logger - Static variable in class org.xbrlapi.networks.StorerImpl

logger - Static variable in class org.xbrlapi.sax.BaseContentHandlerImpl

logger - Static variable in class org.xbrlapi.sax.identifiers.BaseIdentifier

logger - Static variable in class org.xbrlapi.utilities.BaseTestCase

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

logger - Static variable in class org.xbrlapi.utilities.XBRLAPIGrammarPoolImpl

logger - Static variable in class org.xbrlapi.xdt.ContentHandlerImpl

logger - Static variable in class org.xbrlapi.xdt.values.DimensionValueAccessorImpl

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

Log information about all the indexes in the data store.

lookingAhead - Variable in class org.xbrlapi.xpointer.PointerGrammar

M

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.load.Load

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.load.LoadAllSECFilings

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.render.Run

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.render.RunWithPersistedNetworks

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.AddAnIndex

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseCacheForMatchedDocuments

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseEntityResources

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseLoadFailures

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.AnalysePersistedRelationships

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseRelationshipsForAFragment

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseUnitMeasures

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.DeletePersistedRelationships

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.DeleteSpecificDocument

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.DeleteStubs

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.FindLinksToGivenDocument

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.FindLocatorsWithMultipleTargetsForADocument

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.ListDuplicateStoredDocuments

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.ListStoredDocuments

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.LoadCacheDocuments

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.LoadSpecificDocument

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.PersistAllRelationshipsInStore

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.PersistRelationshipsInSpecifiedDocument

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.PurgeIdenticalDocuments

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.ReloadLoadFailures

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.ReportIdenticalDocuments

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.ReportUnitMisuses

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.TestQuery

main(String[]) - Static method in class org.xbrlapi.data.bdbxml.examples.utilities.UpdateAllRelationshipsInStore

main(String[]) - Static method in class org.xbrlapi.xlink.Validator

Enable commandline usage of the XLink validator

main(String[]) - Static method in class org.xbrlapi.xpointer.PointerGrammar

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

mapArgument(String, String) - Method in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

Adds an argument to the argument map.

markDocumentAsExplored(URI) - Method in class org.xbrlapi.loader.LoaderImpl

Flag the document as being explored.

Match - Interface in org.xbrlapi

Used to store URI mapping information about identical documents.

matcher - Variable in class org.xbrlapi.data.BaseStoreImpl

Resource matcher

Matcher - Interface in org.xbrlapi.data.resource

The resource matcher interface, defining all methods that need to be implemented by a resource matcher to support XBRLAPI data stores.

MatchImpl - Class in org.xbrlapi.impl

Note that the first match child element of the metadata is the URI of the matching document that is actually stored in the data store.

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

No argument constructor.

MatchImpl(String) - Constructor for class org.xbrlapi.impl.MatchImpl

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

MD5SignerImpl - Class in org.xbrlapi.data.resource

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

Measure - Interface in org.xbrlapi

MeasureImpl - Class in org.xbrlapi.impl

MeasureImpl(URI, String, String) - Constructor for class org.xbrlapi.impl.MeasureImpl

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

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

MixedContentResource - Interface in org.xbrlapi

MixedContentResourceImpl - Class in org.xbrlapi.impl

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

Mock - Interface in org.xbrlapi

MockImpl - Class in org.xbrlapi.impl

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

No argument constructor.

MockImpl(String) - Constructor for class org.xbrlapi.impl.MockImpl

MockImpl(String, URI, String, String) - Constructor for class org.xbrlapi.impl.MockImpl

N

namespaceBindings - Variable in class org.xbrlapi.data.BaseStoreImpl

Namespace bindings

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

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

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

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

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

Network - Interface in org.xbrlapi.networks

The network interface combines relationships that are not prohibited and that are not over-ridden and that: have the same link role have the same arc role

NetworkImpl - Class in org.xbrlapi.networks

NetworkImpl(Store, URI, URI) - Constructor for class org.xbrlapi.networks.NetworkImpl

Networks - Interface in org.xbrlapi.networks

The networks interface defines the functionality provided by a collection of individual network objects.

NetworksImpl - Class in org.xbrlapi.networks

NetworksImpl(Store) - Constructor for class org.xbrlapi.networks.NetworksImpl

newDocument() - Method in class org.xbrlapi.utilities.XMLDOMBuilder

Create an XML DOM document object that will contain the fragment content.

newDocument(InputStream) - Method in class org.xbrlapi.utilities.XMLDOMBuilder

newDocument(URI) - Method in class org.xbrlapi.utilities.XMLDOMBuilder

newDocument(String) - Method in class org.xbrlapi.utilities.XMLDOMBuilder

newFragment(Store, Element) - Static method in class org.xbrlapi.impl.FragmentFactory

Instantiate a fragment using its type.

newToken(int) - Static method in class org.xbrlapi.xpointer.Token

Returns a new Token object, by default.

next() - Method in class org.xbrlapi.networks.TreeIterator

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

A reference to the next regular (non-special) token from the input stream.

NonDimensionalAspectModel - Class in org.xbrlapi.aspects

NonDimensionalAspectModel() - Constructor for class org.xbrlapi.aspects.NonDimensionalAspectModel

NonFragmentXML - Interface in org.xbrlapi

parent interface for non-fragment XML resources in the data store.

NonFragmentXMLImpl - Class in org.xbrlapi.impl

An implementation of the non-fragment XML interface.

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

NonNumericItem - Interface in org.xbrlapi

NonNumericItemImpl - Class in org.xbrlapi.impl

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

NonProhibitedAnalyserImpl - Class in org.xbrlapi.networks

This Analyser returns information based upon all relationships that are not expressed by an arc with a use that is prohibited.

NonProhibitedAnalyserImpl(Store) - Constructor for class org.xbrlapi.networks.NonProhibitedAnalyserImpl

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

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

NumericItem - Interface in org.xbrlapi

NumericItemImpl - Class in org.xbrlapi.impl

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

O

OpenContextComponent - Interface in org.xbrlapi

OpenContextComponentImpl - Class in org.xbrlapi.impl

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

org.xbrlapi - package org.xbrlapi

Provides interface declarations for the xbrlapi XBRL API.

org.xbrlapi.aspects - package org.xbrlapi.aspects

The aspects package provides some basic support of an OLAP view of XBRL data.

org.xbrlapi.builder - package org.xbrlapi.builder

The builder constructs an XML representation of a fragment.

org.xbrlapi.cache - package org.xbrlapi.cache

org.xbrlapi.data - package org.xbrlapi.data

Defines the contract to be met by data storage implementations.

org.xbrlapi.data.bdbxml - package org.xbrlapi.data.bdbxml

Implements the data store using Oracle Berkeley DB XML database.

org.xbrlapi.data.bdbxml.examples.load - package org.xbrlapi.data.bdbxml.examples.load

Provides simple examples of loading XBRL.

org.xbrlapi.data.bdbxml.examples.render - package org.xbrlapi.data.bdbxml.examples.render

Provides an example of loading and rendering the data in an XBRL instance.

org.xbrlapi.data.bdbxml.examples.utilities - package org.xbrlapi.data.bdbxml.examples.utilities

Example command-line programs that provide a variety of large database analysis and maintenance functions.

org.xbrlapi.data.dom - package org.xbrlapi.data.dom

Implements the XBRL API data store using in-memory XML DOM objects.

org.xbrlapi.data.exist - package org.xbrlapi.data.exist

Implements the data store using eXist (http://exist.soureforge.net/).

org.xbrlapi.data.resource - package org.xbrlapi.data.resource

Defines and implements resource matching implementations.

org.xbrlapi.grabber - package org.xbrlapi.grabber

org.xbrlapi.impl - package org.xbrlapi.impl

Provides the implementations of all of the objects that expose the XBRL data for the user of the XBRLAPI.

org.xbrlapi.loader - package org.xbrlapi.loader

The loader managesthe data discovery process.

org.xbrlapi.loader.discoverer - package org.xbrlapi.loader.discoverer

org.xbrlapi.networks - package org.xbrlapi.networks

Provides XBRLAPI relationship networking classes.

org.xbrlapi.sax - package org.xbrlapi.sax

Provides the SAX handling involved in the DTS discovery process.

org.xbrlapi.sax.identifiers - package org.xbrlapi.sax.identifiers

Each identifier identifies a specific kind of fragment.

org.xbrlapi.utilities - package org.xbrlapi.utilities

Creates a new XML DOM (for use by the fragment builder).

org.xbrlapi.xdt - package org.xbrlapi.xdt

Supports the XDT specification for dimensions.

org.xbrlapi.xdt.aspects - package org.xbrlapi.xdt.aspects

Provides aspect and aspect model implementations for XDT XBRL Dimensions.

org.xbrlapi.xdt.values - package org.xbrlapi.xdt.values

Supports the XDT specification for dimension values.

org.xbrlapi.xlink - package org.xbrlapi.xlink

Defines the contract to be met by the XLink processor.

org.xbrlapi.xlink.handler - package org.xbrlapi.xlink.handler

Defines XLink event handling required for XBRL DTS discovery.

org.xbrlapi.xmlbase - package org.xbrlapi.xmlbase

Defines the XML Base functionality required for the XBRL API.

org.xbrlapi.xpointer - package org.xbrlapi.xpointer

Defines the XPointer functionality needed by the XLink processor.

P

parse(URI) - Method in class org.xbrlapi.loader.LoaderImpl

Parse an XML Document supplied as a URI.

parse(URI, String) - Method in class org.xbrlapi.loader.LoaderImpl

Parse an XML Document supplied as a string the next part of the DTS.

parse(URI, InputSource, ContentHandler) - Method in class org.xbrlapi.loader.LoaderImpl

Parse the supplied input source.

parse(URI) - Method in class org.xbrlapi.xdt.LoaderImpl

Parse an XML Document supplied as a URI the next part of the DTS.

parse(URI, String) - Method in class org.xbrlapi.xdt.LoaderImpl

Parse an XML Document supplied as a string the next part of the DTS.

parseArguments(String[]) - Method in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

Responsible for parsing the command line arguments into a hashmap that maps from the text string that is the argument name (prefixed by a hyphen that is not part of the string used in the mapping) to the argument value, represented as a text string.

ParseException - Exception in org.xbrlapi.xpointer

This exception is thrown when parse errors are encountered.

ParseException(Token, int[][], String[]) - Constructor for exception org.xbrlapi.xpointer.ParseException

This constructor is used by the method "generateParseException" in the generated parser.

ParseException() - Constructor for exception org.xbrlapi.xpointer.ParseException

The following constructors are for use by you for whatever purpose you can think of.

ParseException(String) - Constructor for exception org.xbrlapi.xpointer.ParseException

PERIOD - Static variable in interface org.xbrlapi.aspects.Aspect

Period - Interface in org.xbrlapi

PeriodAspect - Class in org.xbrlapi.aspects

PeriodAspect(AspectModel) - Constructor for class org.xbrlapi.aspects.PeriodAspect

PeriodAspect.Transformer - Class in org.xbrlapi.aspects

PeriodAspect.Transformer() - Constructor for class org.xbrlapi.aspects.PeriodAspect.Transformer

PeriodAspectValue - Class in org.xbrlapi.aspects

PeriodAspectValue(Aspect, Period) - Constructor for class org.xbrlapi.aspects.PeriodAspectValue

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

PeriodImpl - Class in org.xbrlapi.impl

Implementation of context period fragments for instants and durations.

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

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

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

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

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

Add a fragment to the DTS.

persist(XML) - Method in interface org.xbrlapi.data.Store

Store a fragment.

PersistAllRelationshipsInStore - Class in org.xbrlapi.data.bdbxml.examples.utilities

Persists all of the relationships in the data store.

PersistAllRelationshipsInStore(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.PersistAllRelationshipsInStore

persistLoaderState(Map<URI, String>) - Method in class org.xbrlapi.data.BaseStoreImpl

persistLoaderState(Map<URI, String>) - Method in interface org.xbrlapi.data.Store

Stores the state of the document discovery process.

PersistRelationshipsInSpecifiedDocument - Class in org.xbrlapi.data.bdbxml.examples.utilities

Persists all of the relationships defined by arcs in the specified document.

PersistRelationshipsInSpecifiedDocument(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.PersistRelationshipsInSpecifiedDocument

persistStub(URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

persistStub(URI, String) - Method in interface org.xbrlapi.data.Store

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

PointerGrammar - Class in org.xbrlapi.xpointer

DO NOT EDIT THIS FILE.

PointerGrammar(InputStream) - Constructor for class org.xbrlapi.xpointer.PointerGrammar

PointerGrammar(Reader) - Constructor for class org.xbrlapi.xpointer.PointerGrammar

PointerGrammar(PointerGrammarTokenManager) - Constructor for class org.xbrlapi.xpointer.PointerGrammar

PointerGrammarConstants - Interface in org.xbrlapi.xpointer

PointerGrammarTokenManager - Class in org.xbrlapi.xpointer

PointerGrammarTokenManager(SimpleCharStream) - Constructor for class org.xbrlapi.xpointer.PointerGrammarTokenManager

PointerGrammarTokenManager(SimpleCharStream, int) - Constructor for class org.xbrlapi.xpointer.PointerGrammarTokenManager

PointerPart - Interface in org.xbrlapi.xpointer

Defines the functionality associated with a single scheme component of an XPointer expression.

PointerPartImpl - Class in org.xbrlapi.xpointer

PointerPartImpl() - Constructor for class org.xbrlapi.xpointer.PointerPartImpl

Create an uninitialised pointer part.

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

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

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

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

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

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

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

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

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

printMessages() - Method in class org.xbrlapi.xlink.Validator

Print the errors and warnings to System out

printStackTrace() - Method in exception org.xbrlapi.utilities.XBRLException

printStackTrace(PrintStream) - Method in exception org.xbrlapi.utilities.XBRLException

printStackTrace(PrintWriter) - Method in exception org.xbrlapi.utilities.XBRLException

printStackTrace() - Method in exception org.xbrlapi.xlink.XLinkException

printStackTrace(PrintStream) - Method in exception org.xbrlapi.xlink.XLinkException

printStackTrace(PrintWriter) - Method in exception org.xbrlapi.xlink.XLinkException

printStackTrace() - Method in exception org.xbrlapi.xmlbase.XMLBaseException

printStackTrace(PrintStream) - Method in exception org.xbrlapi.xmlbase.XMLBaseException

printStackTrace(PrintWriter) - Method in exception org.xbrlapi.xmlbase.XMLBaseException

problems - Variable in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

processFragment(Fragment, Attributes) - Method in class org.xbrlapi.sax.identifiers.BaseIdentifier

Performs the following operations on the fragment: Sets its fragment index Determines if the fragment as an ID attribute and if so, appends an ID ( @see org.xbrlapi.Fragment#appendID(String) ) and sets the ID in the element state. Adds the fragment ( @see org.xbrlapi.loader.Loader#add(org.xbrlapi.Fragment,org.xbrlapi.xlink.ElementState) ) Override this base implementation if an ID of the fragment root element can be expressed by an attribute other than "id".

processFragment(Fragment, Attributes) - Method in interface org.xbrlapi.sax.identifiers.Identifier

Set up the fragment index, handle ID metadata for the fragment and add it to the loader.

processingInstruction(String, String) - Method in class org.xbrlapi.sax.ContentHandlerImpl

Copy across processing instructions to the DTSImpl

purge(URI) - Method in interface org.xbrlapi.cache.Cache

Delete a resource from the cache.

purge(URI) - Method in class org.xbrlapi.cache.CacheImpl

PurgeIdenticalDocuments - Class in org.xbrlapi.data.bdbxml.examples.utilities

Purges and then reloads any documents where there are multiple versions of them in the data store.

PurgeIdenticalDocuments(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.PurgeIdenticalDocuments

putGrammar(Grammar) - Method in class org.xbrlapi.utilities.XBRLAPIGrammarPoolImpl

Q

QName(PointerPart) - Method in class org.xbrlapi.xpointer.PointerGrammar

QuarterlyPeriodAspect - Class in org.xbrlapi.aspects

QuarterlyPeriodAspect(AspectModel) - Constructor for class org.xbrlapi.aspects.QuarterlyPeriodAspect

QuarterlyPeriodAspect.Transformer - Class in org.xbrlapi.aspects

QuarterlyPeriodAspect.Transformer() - Constructor for class org.xbrlapi.aspects.QuarterlyPeriodAspect.Transformer

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

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

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

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

This method must be synchronised

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

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

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

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

Run a query against the collection of all fragments in the store.

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

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

Run a query that is required to return a single string.

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

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

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

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

Run a query that is required to return a list of strings.

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

TODO Make sure that queries finding a node within a fragment return the fragment itself.

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

Run a query against the collection of all fragments in the store.

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

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

Run a query against the collection of all fragments in the store.

R

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

recindLoadingRightsFor(Loader, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

recindLoadingRightsFor(Loader, URI) - Method in interface org.xbrlapi.data.Store

Loaders need to call this method to indicate that they are recinding responsibility for loading the document.

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

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

ReferencePart - Interface in org.xbrlapi

ReferencePartDeclaration - Interface in org.xbrlapi

ReferencePartDeclarationImpl - Class in org.xbrlapi.impl

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

ReferencePartIdentifier - Class in org.xbrlapi.sax.identifiers

Identifies reference part fragments.

ReferencePartIdentifier(ContentHandler) - Constructor for class org.xbrlapi.sax.identifiers.ReferencePartIdentifier

ReferencePartImpl - Class in org.xbrlapi.impl

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

ReferenceResource - Interface in org.xbrlapi

ReferenceResourceImpl - Class in org.xbrlapi.impl

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

ReInit(InputStream) - Method in class org.xbrlapi.xpointer.PointerGrammar

ReInit(Reader) - Method in class org.xbrlapi.xpointer.PointerGrammar

ReInit(PointerGrammarTokenManager) - Method in class org.xbrlapi.xpointer.PointerGrammar

ReInit(SimpleCharStream) - Method in class org.xbrlapi.xpointer.PointerGrammarTokenManager

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

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

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

ReInit(Reader) - Method in class org.xbrlapi.xpointer.SimpleCharStream

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

ReInit(InputStream) - Method in class org.xbrlapi.xpointer.SimpleCharStream

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

Relationship - Interface in org.xbrlapi

This XML resource supports capture of active relationship information directly in the data store.

RelationshipImpl - Class in org.xbrlapi.impl

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

No argument constructor.

RelationshipImpl(Arc, Fragment, Fragment) - Constructor for class org.xbrlapi.impl.RelationshipImpl

RelationshipOrderComparator - Class in org.xbrlapi.impl

Facilitates sorting of relationships by arc order.

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

RelationshipPriorityComparator - Class in org.xbrlapi.impl

Facilitates sorting of relationships by arc order.

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

ReloadLoadFailures - Class in org.xbrlapi.data.bdbxml.examples.utilities

Attempts to reload all of the documents that are identified in the data store as having not yet loaded properly.

ReloadLoadFailures(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.ReloadLoadFailures

remove(XML) - Method in class org.xbrlapi.data.BaseStoreImpl

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

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

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

Remove a fragment from the store.

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

Remove a fragment from the DTS.

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

Remove a fragment from the underlying data structure.

remove(XML) - Method in interface org.xbrlapi.data.Store

Remove a XML resource from the underlying data structure.

remove() - Method in class org.xbrlapi.networks.TreeIterator

This method is not supported by this implementation.

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

Remove a arcroleRef from a linkbase.

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

Remove a arcroleRef from a linkbase.

removeBaseURI() - Method in interface org.xbrlapi.xmlbase.BaseURISAXResolver

Reverts to the previous Base URI - used on the end of element XML base event.

removeBaseURI() - Method in class org.xbrlapi.xmlbase.BaseURISAXResolverImpl

Reverts to the previous Base URI - used on the end of element XML base event.

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

Remove a link documentation child fragment from the linkbase.

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

Remove a link documentation child fragment from the linkbase.

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

Remove a roleRef from a linkbase.

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

Remove a roleRef from a linkbase.

removeIdentifier(int) - Method in class org.xbrlapi.sax.ContentHandlerImpl

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

Remove a metadata attribute.

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

Remove a metadata attribute.

removeMetaAttribute(String) - Method in class org.xbrlapi.impl.XMLImpl

removeMetaAttribute(String) - Method in interface org.xbrlapi.XML

Removes a metadata attribute

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

Removes a child element from the metadata root element by specifying the name of the child and the value of the element's text content and/or the value of a named attribute.

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

Removes a child element from the metadata root element by specifying the name of the child and the value of the element's text content and/or the value of a named attribute.

removeMetadataElement(String, HashMap<String, String>) - Method in class org.xbrlapi.impl.XMLImpl

removeMetadataElement(String, HashMap<String, String>) - Method in interface org.xbrlapi.XML

removes a child element from the metadata root element by specifying the name of the child and the value of the element's text content and/or the value of a named attribute.

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

Remove a roleRef from a linkbase.

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

Remove a roleRef from a linkbase.

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

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

replaceCurrentFragment(Fragment) - Method in interface org.xbrlapi.loader.Loader

This is particularly useful when you can only fully determine the fragment type by reading in the complex element content of the data corresponding to the fragment.

replaceCurrentFragment(Fragment) - Method in class org.xbrlapi.loader.LoaderImpl

ReportIdenticalDocuments - Class in org.xbrlapi.data.bdbxml.examples.utilities

Lists all sets of identical documents in the data store.

ReportIdenticalDocuments(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.ReportIdenticalDocuments

reportTime(String) - Static method in class org.xbrlapi.data.bdbxml.examples.render.Run

Convenience method to report durations required to perform various tasks.

reportTime(String) - Static method in class org.xbrlapi.data.bdbxml.examples.render.RunWithPersistedNetworks

Convenience method to report durations required to perform various tasks.

ReportUnitMisuses - Class in org.xbrlapi.data.bdbxml.examples.utilities

Lists all facts where the data type is derives from the monetary item type but the unit is not reported using the right ISO currency code.

ReportUnitMisuses(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.ReportUnitMisuses

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

Interrupts the loading process once the current document discovery has been completed.

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

requestLoadingRightsFor(Loader, URI) - Method in class org.xbrlapi.data.BaseStoreImpl

requestLoadingRightsFor(Loader, URI) - Method in interface org.xbrlapi.data.Store

Loaders need to call this method to indicate that they are going to take responsibility for loading the document.

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

resolveEntity(String, String) - Method in class org.xbrlapi.sax.EntityResolverImpl

Resolve the entity for a SAX parser using the system identifier.

resolveEntity(XMLResourceIdentifier) - Method in class org.xbrlapi.sax.EntityResolverImpl

Implements the resolveEntity method defined in the org.apache.xerces.xni.parser.XMLEntityResolver interface, incorporating interactions with the local document cache (if it exists) to ensure that any new documents are cached and any documents already in the cache are sourced from the cache.

Resource - Interface in org.xbrlapi

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

ResourceImpl - Class in org.xbrlapi.impl

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

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

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

RoleType - Interface in org.xbrlapi

RoleTypeImpl - Class in org.xbrlapi.impl

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

Run - Class in org.xbrlapi.data.bdbxml.examples.render

Run() - Constructor for class org.xbrlapi.data.bdbxml.examples.render.Run

run() - Method in class org.xbrlapi.loader.discoverer.Discoverer

run() - Method in class org.xbrlapi.loader.discoverer.DiscoveryManager

RunWithPersistedNetworks - Class in org.xbrlapi.data.bdbxml.examples.render

RunWithPersistedNetworks() - Constructor for class org.xbrlapi.data.bdbxml.examples.render.RunWithPersistedNetworks

S

saveDocuments(File) - Method in class org.xbrlapi.data.BaseStoreImpl

Saves the individual documents in the data store into a directory structure that is placed into the specified directory.

saveDocuments(File, String) - Method in class org.xbrlapi.data.BaseStoreImpl

Serializes those documents in the data store with a URI that begins with the specified URI prefix.

saveDocuments(File) - Method in interface org.xbrlapi.data.Store

Serializes the individual documents in the data store, saving them into a directory structure that is placed into the specified directory.

saveDocuments(File, String) - Method in interface org.xbrlapi.data.Store

Serializes those documents in the data store with a URI that begins with the specified URI prefix.

saveStoreAsSingleDocument(File) - Method in class org.xbrlapi.data.BaseStoreImpl

Creates a single DOM structure from all documents in the data store and saves this single XML structure in the specified file.

saveStoreAsSingleDocument(File) - Method in interface org.xbrlapi.data.Store

Creates a single DOM structure from all documents in the data store and saves this single XML structure in the specified file.

SCENARIO - Static variable in interface org.xbrlapi.aspects.Aspect

Scenario - Interface in org.xbrlapi

ScenarioAspect - Class in org.xbrlapi.aspects

ScenarioAspect(AspectModel) - Constructor for class org.xbrlapi.aspects.ScenarioAspect

ScenarioAspect.Transformer - Class in org.xbrlapi.aspects

ScenarioAspect.Transformer() - Constructor for class org.xbrlapi.aspects.ScenarioAspect.Transformer

ScenarioAspectValue - Class in org.xbrlapi.aspects

ScenarioAspectValue(Aspect, Scenario) - Constructor for class org.xbrlapi.aspects.ScenarioAspectValue

ScenarioImpl - Class in org.xbrlapi.impl

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

ScenarioRemainderAspect - Class in org.xbrlapi.xdt.aspects

ScenarioRemainderAspect(AspectModel) - Constructor for class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect

ScenarioRemainderAspect.Transformer - Class in org.xbrlapi.xdt.aspects

ScenarioRemainderAspect.Transformer() - Constructor for class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect.Transformer

ScenarioRemainderAspectValue - Class in org.xbrlapi.xdt.aspects

ScenarioRemainderAspectValue(Aspect, OpenContextComponent) - Constructor for class org.xbrlapi.xdt.aspects.ScenarioRemainderAspectValue

Schema - Interface in org.xbrlapi

SchemaAllCompositor - Interface in org.xbrlapi

Interface for xsd:all element fragments.

SchemaAllCompositorImpl - Class in org.xbrlapi.impl

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

SchemaChoiceCompositor - Interface in org.xbrlapi

Interface for xsd:choice element fragments.

SchemaChoiceCompositorImpl - Class in org.xbrlapi.impl

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

SchemaCompositor - Interface in org.xbrlapi

base interface for xsd:choice and xsd:selection element fragments.

SchemaCompositorImpl - Class in org.xbrlapi.impl

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

SchemaContent - Interface in org.xbrlapi

SchemaContentDeclaration - Interface in org.xbrlapi

Base interface for XML Schema element and attribute declarations

SchemaContentDeclarationImpl - Class in org.xbrlapi.impl

Base interface for XML Schema element and attribute declaration fragments.

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

SchemaContentImpl - Class in org.xbrlapi.impl

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

SchemaDeclaration - Interface in org.xbrlapi

Base interface for all kinds of XML Schema declarations

SchemaDeclarationImpl - Class in org.xbrlapi.impl

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

SchemaGroupCompositor - Interface in org.xbrlapi

Interface for xsd:group element fragments.

SchemaGroupCompositorImpl - Class in org.xbrlapi.impl

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

SchemaIdentifier - Class in org.xbrlapi.sax.identifiers

Identifies XML Schema fragments.

SchemaIdentifier(ContentHandler) - Constructor for class org.xbrlapi.sax.identifiers.SchemaIdentifier

SchemaIdentifier - Class in org.xbrlapi.xdt

Identifies XDT Schema Fragments.

SchemaIdentifier(ContentHandler) - Constructor for class org.xbrlapi.xdt.SchemaIdentifier

SchemaImpl - Class in org.xbrlapi.impl

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

SchemaSequenceCompositor - Interface in org.xbrlapi

Interface for xsd:sequence element fragments.

SchemaSequenceCompositorImpl - Class in org.xbrlapi.impl

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

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

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

SchemeName(PointerPart) - Method in class org.xbrlapi.xpointer.PointerGrammar

SecGrabberImpl - Class in org.xbrlapi.grabber

Implementation of an XBRL document URI grabber for the SEC RSS feed.

SecGrabberImpl(URI) - Constructor for class org.xbrlapi.grabber.SecGrabberImpl

SEGMENT - Static variable in interface org.xbrlapi.aspects.Aspect

Segment - Interface in org.xbrlapi

TODO Extend the Segment and scenario interfaces.

SegmentAspect - Class in org.xbrlapi.aspects

SegmentAspect(AspectModel) - Constructor for class org.xbrlapi.aspects.SegmentAspect

SegmentAspect.Transformer - Class in org.xbrlapi.aspects

SegmentAspect.Transformer() - Constructor for class org.xbrlapi.aspects.SegmentAspect.Transformer

SegmentAspectValue - Class in org.xbrlapi.aspects

SegmentAspectValue(Aspect, Segment) - Constructor for class org.xbrlapi.aspects.SegmentAspectValue

SegmentImpl - Class in org.xbrlapi.impl

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

SegmentRemainderAspect - Class in org.xbrlapi.xdt.aspects

SegmentRemainderAspect(AspectModel) - Constructor for class org.xbrlapi.xdt.aspects.SegmentRemainderAspect

SegmentRemainderAspect.Transformer - Class in org.xbrlapi.xdt.aspects

SegmentRemainderAspect.Transformer() - Constructor for class org.xbrlapi.xdt.aspects.SegmentRemainderAspect.Transformer

SegmentRemainderAspectValue - Class in org.xbrlapi.xdt.aspects

SegmentRemainderAspectValue(Aspect, Segment) - Constructor for class org.xbrlapi.xdt.aspects.SegmentRemainderAspectValue

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

Returns true if this arc is semantically equal to the other arc.

semanticEquals(Arc) - Method in class org.xbrlapi.impl.ArcImpl

serialize(Element, OutputStream) - Method in class org.xbrlapi.data.BaseStoreImpl

Serialize the specified XML DOM to the specified destination.

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

Serialize the specified XML DOM to System.out.

serialize(XML) - Method in class org.xbrlapi.data.BaseStoreImpl

Serialize the specified fragment.

serialize(Element, File) - Method in class org.xbrlapi.data.BaseStoreImpl

Serialize the specified XML DOM to the specified destination.

serialize(Element, String) - Method in class org.xbrlapi.data.BaseStoreImpl

Serialize the specified XML DOM to the specified destination file.

serialize(Element, OutputStream) - Method in interface org.xbrlapi.data.Store

Serialize the specified XML DOM to the specified destination.

serialize(Element, File) - Method in interface org.xbrlapi.data.Store

Serialize the specified XML DOM to the specified destination.

serialize(Element, String) - Method in interface org.xbrlapi.data.Store

Serialize the specified XML DOM to the specified destination.

serialize(Element) - Method in interface org.xbrlapi.data.Store

Serialize the specified XML DOM to System.out.

serialize(XML) - Method in interface org.xbrlapi.data.Store

Serialize the specified fragment

serialize() - Method in class org.xbrlapi.impl.XMLImpl

serialize(File) - Method in class org.xbrlapi.impl.XMLImpl

serialize(OutputStream) - Method in class org.xbrlapi.impl.XMLImpl

serialize(String) - Method in class org.xbrlapi.impl.XMLImpl

serialize(Node) - Method in class org.xbrlapi.utilities.BaseTestCase

Serializes an XML fragment to the output stream.

serialize() - Method in interface org.xbrlapi.XML

serializes the XML to standard output.

serialize(File) - Method in interface org.xbrlapi.XML

Serializes the XML to the specified file.

serialize(OutputStream) - Method in interface org.xbrlapi.XML

Serializes the XML to the specified output stream.

serialize(String) - Method in interface org.xbrlapi.XML

Serializes the XML to the specified output string.

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

Serialize the specified XML DOM node.

serializeToString(Element) - Method in interface org.xbrlapi.data.Store

Serialize the specified XML DOM node.

setAnalyser(Analyser) - Method in class org.xbrlapi.data.BaseStoreImpl

setAnalyser(Analyser) - Method in interface org.xbrlapi.data.Store

setArcrole(URI) - Method in interface org.xbrlapi.networks.Network

setArcrole(URI) - Method in class org.xbrlapi.networks.NetworkImpl

setAspect(Aspect) - Method in interface org.xbrlapi.aspects.AspectModel

setAspect(Aspect) - Method in class org.xbrlapi.aspects.BaseAspectModel

setAspectModel(AspectModel) - Method in interface org.xbrlapi.aspects.Aspect

setAspectModel(AspectModel) - Method in class org.xbrlapi.aspects.BaseAspect

setAxis(String) - Method in interface org.xbrlapi.aspects.Aspect

setAxis(String) - Method in class org.xbrlapi.aspects.BaseAspect

setBaseURISAXResolver(BaseURISAXResolver) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

Set the base URI resolver for the XBRL XLink handler.

setBaseURISAXResolver(BaseURISAXResolver) - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

Set the base URI resolver for the XBRL XLink handler.

setBuilder(Builder) - Method in class org.xbrlapi.impl.XMLImpl

setBuilder(Builder) - Method in interface org.xbrlapi.XML

Set the builder that constructs the fragment XML during parsing.

setCache(Cache) - Method in class org.xbrlapi.data.resource.BaseMatcherImpl

setCache(Cache) - Method in interface org.xbrlapi.loader.Loader

This method specifies a cache to use when loading data into the data store.

setCache(Cache) - Method in class org.xbrlapi.loader.LoaderImpl

setContentHandler(ContentHandler) - Method in class org.xbrlapi.sax.identifiers.BaseIdentifier

setContentHandler(ContentHandler) - Method in interface org.xbrlapi.sax.identifiers.Identifier

setCriteria(Collection<AspectValue>) - Method in interface org.xbrlapi.aspects.AspectModel

Adds a collection of fact selection criteria.

setCriteria(Collection<AspectValue>) - Method in class org.xbrlapi.aspects.BaseAspectModel

setCriterion(AspectValue) - Method in interface org.xbrlapi.aspects.AspectModel

Adds a fact selection criterion used in selecting a set of the facts in the aspect model.

setCriterion(AspectValue) - Method in class org.xbrlapi.aspects.BaseAspectModel

setCustomLinkRecogniser(CustomLinkRecogniser) - Method in interface org.xbrlapi.xlink.XLinkProcessor

Set the custom link recogniser

setCustomLinkRecogniser(CustomLinkRecogniser) - Method in class org.xbrlapi.xlink.XLinkProcessorImpl

Set the custom link recogniser

setDebugStream(PrintStream) - Method in class org.xbrlapi.xpointer.PointerGrammarTokenManager

setDocumentLocator(Locator) - Method in class org.xbrlapi.sax.ContentHandlerImpl

The locator for a document is stored to facilitate resolution of CacheURIImpl's relative to that location.

setElementState(ElementState) - Method in class org.xbrlapi.sax.BaseContentHandlerImpl

setElementState(ElementState) - Method in interface org.xbrlapi.sax.ContentHandler

setElementState(ElementState) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

setElementState(ElementState) - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

setEntityResolver(EntityResolver) - Method in interface org.xbrlapi.loader.Loader

Set the resolver for the resolution of entities found during the loading and XLink processing

setEntityResolver(EntityResolver) - Method in class org.xbrlapi.loader.LoaderImpl

Set the resolver for the resolution of entities found during the loading and XLink processing

setEscapedSchemeData(String) - Method in interface org.xbrlapi.xpointer.PointerPart

setEscapedSchemeData(String) - Method in class org.xbrlapi.xpointer.PointerPartImpl

setExplanation(String) - Method in interface org.xbrlapi.Error

setExplanation(String) - Method in class org.xbrlapi.impl.ErrorImpl

setFilteringURIs(List<URI>) - Method in class org.xbrlapi.data.BaseStoreImpl

setFilteringURIs(List<URI>) - Method in interface org.xbrlapi.data.Store

setId(String) - Method in class org.xbrlapi.xlink.ElementState

setIndex(String) - Method in class org.xbrlapi.impl.XMLImpl

setIndex(String) - Method in interface org.xbrlapi.XML

Set the fragment index.

setLabelRole(URI) - Method in class org.xbrlapi.aspects.ConceptAspect.Transformer

setLabelRole(URI) - Method in class org.xbrlapi.aspects.EntityIdentifierAspect.Transformer

setLabelRole(URI) - Method in class org.xbrlapi.aspects.LocationAspect.Transformer

setLabelRole(URI) - Method in class org.xbrlapi.xdt.aspects.DimensionAspect

setLanguageCode(String) - Method in class org.xbrlapi.aspects.ConceptAspect.Transformer

setLanguageCode(String) - Method in class org.xbrlapi.aspects.EntityIdentifierAspect.Transformer

setLanguageCode(String) - Method in class org.xbrlapi.aspects.LocationAspect.Transformer

setLanguageCode(String) - Method in class org.xbrlapi.xdt.aspects.DimensionAspect

setLinkRole(URI) - Method in interface org.xbrlapi.networks.Network

setLinkRole(URI) - Method in class org.xbrlapi.networks.NetworkImpl

setLoader(Loader) - Method in class org.xbrlapi.sax.BaseContentHandlerImpl

setLoader(Loader) - Method in interface org.xbrlapi.sax.ContentHandler

setLoader(Loader) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

Set the XBRL DTS loader

setLoader(Loader) - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

Set the XBRL DTS loader

setMapId(AspectValue, String) - Method in class org.xbrlapi.aspects.BaseAspectValueTransformer

setMapLabel(String, String) - Method in class org.xbrlapi.aspects.BaseAspectValueTransformer

setMatcher(Matcher) - Method in class org.xbrlapi.data.BaseStoreImpl

setMatcher(Matcher) - Method in interface org.xbrlapi.data.Store

Sets the matcher for the store to use.

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

Set a metadata attribute.

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

Set a metadata attribute.

setMetaAttribute(String, String) - Method in class org.xbrlapi.impl.XMLImpl

setMetaAttribute(String, String) - Method in interface org.xbrlapi.XML

Set a fragment metadata attribute.

setNamespaceBinding(URI, String) - Method in class org.xbrlapi.data.BaseStoreImpl

setNamespaceBinding(URI, String) - Method in interface org.xbrlapi.data.Store

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

Set the index of the parent fragment.

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

setProblemIndex(String) - Method in interface org.xbrlapi.Error

The index can be null if the problem cannot be sheeted back to a specific fragment.

setProblemIndex(String) - Method in class org.xbrlapi.impl.ErrorImpl

setReason(String) - Method in class org.xbrlapi.impl.StubImpl

setReason(String) - Method in interface org.xbrlapi.Stub

setResource(Element) - Method in class org.xbrlapi.impl.XMLImpl

setResource(Element) - Method in interface org.xbrlapi.XML

Closes down the fragment builder and sets the data and metadata resources for the fragment.

setResourceURI(URI) - Method in interface org.xbrlapi.Error

setResourceURI(URI) - Method in class org.xbrlapi.impl.ErrorImpl

setResourceURI(URI) - Method in class org.xbrlapi.impl.StubImpl

setResourceURI(URI) - Method in interface org.xbrlapi.Stub

setSchemaLocationAttributeUsage(boolean) - Method in interface org.xbrlapi.loader.Loader

setSchemaLocationAttributeUsage(boolean) - Method in class org.xbrlapi.loader.LoaderImpl

setSchemeLocalName(String) - Method in interface org.xbrlapi.xpointer.PointerPart

setSchemeLocalName(String) - Method in class org.xbrlapi.xpointer.PointerPartImpl

setSchemeNamespace(URI) - Method in interface org.xbrlapi.xpointer.PointerPart

setSchemeNamespace(URI) - Method in class org.xbrlapi.xpointer.PointerPartImpl

setSchemePrefix(String) - Method in interface org.xbrlapi.xpointer.PointerPart

setSchemePrefix(String) - Method in class org.xbrlapi.xpointer.PointerPartImpl

setSelectionCriterion(AspectValue) - Method in interface org.xbrlapi.aspects.Aspect

setSelectionCriterion(AspectValue) - Method in class org.xbrlapi.aspects.BaseAspect

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

Specifies the set of ancestor elements of the element in the parent fragment that is the insertion point for this fragment's root element.

setSequenceToParentElement(Fragment) - Method in class org.xbrlapi.impl.FragmentImpl

setSequenceToParentElement(String) - Method in class org.xbrlapi.impl.MockImpl

Set the information about the sequence to be followed to reach the parent element of the fragment.

setSigner(Signer) - Method in class org.xbrlapi.data.resource.BaseMatcherImpl

setSigner(Signer) - Method in class org.xbrlapi.data.resource.DefaultMatcherImpl

setSigner(Signer) - Method in interface org.xbrlapi.data.resource.Matcher

Call this method if you need to use a different signature generator for the resources you are working with.

setStartingURIs(List<URI>) - Method in class org.xbrlapi.loader.LoaderImpl

Set the starting points for DTSImpl discovery using a linked list

setState(ElementState) - Method in class org.xbrlapi.xlink.ValidatorSAXContentHandlerImpl

setStore(Store) - Method in class org.xbrlapi.impl.XMLImpl

setStore(Store) - Method in interface org.xbrlapi.XML

Set the data store that manages this fragment.

setTarget(URI) - Method in class org.xbrlapi.impl.LocatorImpl

setTarget(URI) - Method in class org.xbrlapi.impl.SimpleLinkImpl

setTarget(URI) - Method in interface org.xbrlapi.Locator

Set metadata about the target of the locator.

setTarget(URI) - Method in interface org.xbrlapi.SimpleLink

Set metadata about the target of the simple link.

setTarget(URI) - Method in class org.xbrlapi.xdt.TypedDimensionImpl

setTargetNamespace(URI) - Method in class org.xbrlapi.impl.RelationshipImpl

setTargetNamespace(String) - Method in class org.xbrlapi.sax.identifiers.SchemaIdentifier

setTransformer(AspectValueTransformer) - Method in interface org.xbrlapi.aspects.Aspect

setTransformer(AspectValueTransformer) - Method in class org.xbrlapi.aspects.BaseAspect

setUnescapedSchemeData(String) - Method in interface org.xbrlapi.xpointer.PointerPart

setUnescapedSchemeData(String) - Method in class org.xbrlapi.xpointer.PointerPartImpl

setUp() - Method in class org.xbrlapi.data.bdbxml.BaseTestCase

setUp() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.AddAnIndex

setUp() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.AnalyseRelationshipsForAFragment

setUp() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

Sets up the database store, the loader and the cache.

setUp() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.DeleteSpecificDocument

setUp() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.FindLinksToGivenDocument

setUp() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.FindLocatorsWithMultipleTargetsForADocument

setUp() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.LoadCacheDocuments

setUp() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.LoadSpecificDocument

setUp() - Method in class org.xbrlapi.DOMLoadingTestCase

setUp() - Method in class org.xbrlapi.utilities.BaseTestCase

setURI(URI) - Method in interface org.xbrlapi.Fragment

Set the URI of the fragment's document.

setURI(URI) - Method in class org.xbrlapi.impl.FragmentImpl

setURI(URI) - Method in class org.xbrlapi.sax.BaseContentHandlerImpl

setURI(URI) - Method in interface org.xbrlapi.sax.ContentHandler

setXSModel(XSModel) - Method in class org.xbrlapi.sax.identifiers.SchemaIdentifier

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

Signer - Interface in org.xbrlapi.data.resource

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

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

SimpleCharStream - Class in org.xbrlapi.xpointer

An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).

SimpleCharStream(Reader, int, int, int) - Constructor for class org.xbrlapi.xpointer.SimpleCharStream

SimpleCharStream(Reader, int, int) - Constructor for class org.xbrlapi.xpointer.SimpleCharStream

SimpleCharStream(Reader) - Constructor for class org.xbrlapi.xpointer.SimpleCharStream

SimpleCharStream(InputStream, int, int, int) - Constructor for class org.xbrlapi.xpointer.SimpleCharStream

SimpleCharStream(InputStream, int, int) - Constructor for class org.xbrlapi.xpointer.SimpleCharStream

SimpleCharStream(InputStream) - Constructor for class org.xbrlapi.xpointer.SimpleCharStream

SimpleLink - Interface in org.xbrlapi

SimpleLinkImpl - Class in org.xbrlapi.impl

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

SimpleNumericItem - Interface in org.xbrlapi

SimpleNumericItemImpl - Class in org.xbrlapi.impl

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

SimpleTypeDeclaration - Interface in org.xbrlapi

Used for simple type declarations in XML Schemas.

SimpleTypeDeclarationImpl - Class in org.xbrlapi.impl

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

size() - Method in interface org.xbrlapi.aspects.Aspect

size() - Method in class org.xbrlapi.aspects.BaseAspect

size() - Method in class org.xbrlapi.data.bdbxml.examples.render.Concepts

size() - Method in interface org.xbrlapi.networks.EquivalentRelationships

size() - Method in class org.xbrlapi.networks.EquivalentRelationshipsImpl

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

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

This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).

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

This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.

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

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

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

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

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

startArc(String, String, String, Attributes, String, String, String, String, String, String) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

Create the arc fragment first.

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

Create the arc fragment first.

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

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

Handles the start of processing an arc.

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

startDocument() - Method in class org.xbrlapi.sax.ContentHandlerImpl

On starting to parse a document the Base URI resolver is set up with the documents absolute URI.

startDocument() - Method in class org.xbrlapi.xdt.ContentHandlerImpl

Use an XBRL Dimensions aware Schema fragment identifier to pick out the XDT element declarations for hypercubes, explicit dimensions and typed dimensions.

startElement(String, String, String, Attributes) - Method in class org.xbrlapi.sax.ContentHandlerImpl

Sets the element state.

startElement(String, String, String, Attributes) - Method in class org.xbrlapi.sax.identifiers.BaseIdentifier

startElement(String, String, String, Attributes) - Method in class org.xbrlapi.sax.identifiers.GenericDocumentRootIdentifier

Add a generic fragment for a document root element if we have not already done so.

startElement(String, String, String, Attributes) - Method in interface org.xbrlapi.sax.identifiers.Identifier

Determines if the element starts a new fragment and if so: creates the fragment sets the fragment index stores any ID attributes on the fragment root in the fragment metadata and in the element state object adds the fragment to the loader

startElement(String, String, String, Attributes) - Method in class org.xbrlapi.sax.identifiers.LanguageIdentifier

Find fragments defining and labelling XML language codes.

startElement(String, String, String, Attributes) - Method in class org.xbrlapi.sax.identifiers.ReferencePartIdentifier

startElement(String, String, String, Attributes) - Method in class org.xbrlapi.sax.identifiers.SchemaIdentifier

Find fragments with root elements in the XML Schema namespace.

startElement(String, String, String, Attributes) - Method in class org.xbrlapi.sax.identifiers.XBRLIdentifier

Finds fragments in the XBRL 2.1 namespace and keeps track of boolean state variables tracking whether the parser is inside and XBRL instance and whether the current element can be a tuple in an XBRL instance.

startElement(String, String, String, Attributes) - Method in class org.xbrlapi.sax.identifiers.XBRLXLinkIdentifier

Passes responsibility along to the XLink handler via the XLink Processor.

startElement(String, String, String, Attributes) - Method in class org.xbrlapi.xdt.SchemaIdentifier

Finds Sschema fragments including XDT-specific fragments

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

Fire off necessary XLink events on start of elements

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

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

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

startExtendedLink(String, String, String, Attributes, String, String) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

The extended link processing algorithm, central to this implementation, operates as follows: Store all locators and resources that are found in the extended link in a map of lists where the map is indexed by XLink label attribute values and each list is made up of the locators and resources that have been found in the extended link that carry the same XLink label.

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

The extended link processing algorithm, central to this implementation, operates as follows: Store all locators and resources that are found in the extended link in a map of lists where the map is indexed by XLink label attribute values and each list is made up of the locators and resources that have been found in the extended link that carry the same XLink label.

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

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

Handles the start of processing an extended link.

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

startLoading(Loader) - Method in class org.xbrlapi.data.BaseStoreImpl

startLoading(Loader) - Method in interface org.xbrlapi.data.Store

startLocator(String, String, String, Attributes, String, String, String, String) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

Create the locator fragment and then add it to the map of arc anchors.

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

Create the locator fragment and then add it to the map of arc anchors.

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

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

Handles the start of processing a locator.

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

startResource(String, String, String, Attributes, String, String, String) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

TODO Avoid using classes to differentiate XLink resources.

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

TODO Avoid using classes to differentiate XLink resources.

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

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

Handles the start of processing a local resource.

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

startSimpleLink(String, String, String, Attributes, String, String, String, String, String, String) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

Add the href to the set of XML documents to be explored and create the fragment for the simple link.

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

Add the href to the set of XML documents to be explored and create the fragment for the simple link.

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

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

Handles the start of processing a simple link (and custom links).

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

startTitle(String, String, String, Attributes) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

Creates and stores an XLink title fragment.

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

Creates and stores an XLink title fragment.

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

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

Handles straight pass through of SAX event for XLink title elements

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

stashURI(URI) - Method in interface org.xbrlapi.loader.Loader

Stash a URI to await loading into DTS.

stashURI(URI) - Method in class org.xbrlapi.loader.LoaderImpl

stashURIs(List<URI>) - Method in interface org.xbrlapi.loader.Loader

stashURIs(List<URI>) - Method in class org.xbrlapi.loader.LoaderImpl

staticFlag - Static variable in class org.xbrlapi.xpointer.SimpleCharStream

stopLoading(Loader) - Method in class org.xbrlapi.data.BaseStoreImpl

stopLoading(Loader) - Method in interface org.xbrlapi.data.Store

store - Variable in class org.xbrlapi.data.bdbxml.BaseTestCase

store - Variable in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

Store - Interface in org.xbrlapi.data

The data store interface, defining all methods that need to be implemented by a data store to support the XBRLAPI.

store - Variable in class org.xbrlapi.DOMLoadingTestCase

storeAllRelationships() - Method in interface org.xbrlapi.networks.Storer

Stores all active relationships in the entire data store.

storeAllRelationships() - Method in class org.xbrlapi.networks.StorerImpl

+++

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

Stores the stubs for the documents still to be analysed in the data store being used by the loader.

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

storeDOM - Variable in class org.xbrlapi.data.BaseStoreImpl

The DOM document used to construct DOM representations of subtrees of documents in the store.

StoreImpl - Class in org.xbrlapi.data.bdbxml

Implementation of the data store using the Oracle Berkeley Database.

StoreImpl(String, String) - Constructor for class org.xbrlapi.data.bdbxml.StoreImpl

This uses the default 1 GB cache size.

StoreImpl(String, String, int) - Constructor for class org.xbrlapi.data.bdbxml.StoreImpl

StoreImpl - Class in org.xbrlapi.data.dom

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

Initialise the data store.

StoreImpl - Class in org.xbrlapi.data.exist

Implementation of the XBRL data store using eXist as the underlying database.

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

Initialise the database connection.

Storer - Interface in org.xbrlapi.networks

Classes implementing this interface support persistance of relationship information in a data store.

storeRelationship(Relationship) - Method in interface org.xbrlapi.networks.Storer

When the relationship is persisted in the data store, any equivalent relationship will be removed from the data store.

storeRelationship(Arc, Fragment, Fragment) - Method in interface org.xbrlapi.networks.Storer

Persist the relationship defined by the given fragments.

storeRelationship(Relationship) - Method in class org.xbrlapi.networks.StorerImpl

storeRelationship(Arc, Fragment, Fragment) - Method in class org.xbrlapi.networks.StorerImpl

storeRelationships(Networks) - Method in interface org.xbrlapi.networks.Storer

storeRelationships(Collection<URI>) - Method in interface org.xbrlapi.networks.Storer

storeRelationships(URI) - Method in interface org.xbrlapi.networks.Storer

storeRelationships(Network) - Method in interface org.xbrlapi.networks.Storer

storeRelationships(Network) - Method in class org.xbrlapi.networks.StorerImpl

storeRelationships(Networks) - Method in class org.xbrlapi.networks.StorerImpl

storeRelationships(Collection<URI>) - Method in class org.xbrlapi.networks.StorerImpl

storeRelationships(URI) - Method in class org.xbrlapi.networks.StorerImpl

This implementation uses just 3 database queries for the document.

StorerImpl - Class in org.xbrlapi.networks

StorerImpl(Store) - Constructor for class org.xbrlapi.networks.StorerImpl

stores - Variable in class org.xbrlapi.data.bdbxml.BaseTestCase

Stub - Interface in org.xbrlapi

StubImpl - Class in org.xbrlapi.impl

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

No argument constructor.

StubImpl(String, URI, String) - Constructor for class org.xbrlapi.impl.StubImpl

SwitchTo(int) - Method in class org.xbrlapi.xpointer.PointerGrammarTokenManager

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

Default implementation does nothing.

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

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

Flush all database updates to the data store.

T

tearDown() - Method in class org.xbrlapi.data.bdbxml.BaseTestCase

tearDown() - Method in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

Closes the data store.

tearDown() - Method in class org.xbrlapi.DOMLoadingTestCase

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

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

TestQuery - Class in org.xbrlapi.data.bdbxml.examples.utilities

Tests an XQuery against an existing data store.

TestQuery(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.TestQuery

Title - Interface in org.xbrlapi

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

titleCharacters(char[], int, int) - Method in class org.xbrlapi.xlink.Validator

titleCharacters(char[], int, int) - Method in interface org.xbrlapi.xlink.XLinkHandler

Handles the character content of a title element

titleCharacters(char[], int, int) - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

titleCharacters(char[], int, int) - Method in interface org.xbrlapi.xlink.XLinkProcessor

Handles the character content for a title element

titleCharacters(char[], int, int) - Method in class org.xbrlapi.xlink.XLinkProcessorImpl

TitleImpl - Class in org.xbrlapi.impl

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

token - Variable in class org.xbrlapi.xpointer.PointerGrammar

Token - Class in org.xbrlapi.xpointer

Describes the input token stream.

Token() - Constructor for class org.xbrlapi.xpointer.Token

token_source - Variable in class org.xbrlapi.xpointer.PointerGrammar

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

This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.

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

TokenMgrError - Error in org.xbrlapi.xpointer

TokenMgrError() - Constructor for error org.xbrlapi.xpointer.TokenMgrError

TokenMgrError(String, int) - Constructor for error org.xbrlapi.xpointer.TokenMgrError

TokenMgrError(boolean, int, int, int, String, char, int) - Constructor for error org.xbrlapi.xpointer.TokenMgrError

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

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

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

toString() - Method in class org.xbrlapi.xpointer.Token

Returns the image.

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

TreeIterator - Class in org.xbrlapi.networks

This iterator iterates over the fragments in a relationship network.

TreeIterator(Network) - Constructor for class org.xbrlapi.networks.TreeIterator

Use this constructor when the network defines a single tree.

TreeIterator(Network, Fragment) - Constructor for class org.xbrlapi.networks.TreeIterator

Use this constructor when the network defines a number of trees, each distinguished by its own root fragment.

Tuple - Interface in org.xbrlapi

TupleImpl - Class in org.xbrlapi.impl

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

TYPE - Static variable in class org.xbrlapi.aspects.ConceptAspect

TYPE - Static variable in class org.xbrlapi.aspects.EntityIdentifierAspect

TYPE - Static variable in class org.xbrlapi.aspects.LocationAspect

TYPE - Static variable in class org.xbrlapi.aspects.PeriodAspect

TYPE - Static variable in class org.xbrlapi.aspects.QuarterlyPeriodAspect

TYPE - Static variable in class org.xbrlapi.aspects.ScenarioAspect

TYPE - Static variable in class org.xbrlapi.aspects.SegmentAspect

TYPE - Static variable in class org.xbrlapi.aspects.UnitAspect

TYPE - Static variable in class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect

TYPE - Static variable in class org.xbrlapi.xdt.aspects.SegmentRemainderAspect

TypedDimension - Interface in org.xbrlapi.xdt

TypedDimensionAspect - Class in org.xbrlapi.xdt.aspects

TypedDimensionAspect(AspectModel, TypedDimension) - Constructor for class org.xbrlapi.xdt.aspects.TypedDimensionAspect

TypedDimensionAspect.Transformer - Class in org.xbrlapi.xdt.aspects

TypedDimensionAspect.Transformer() - Constructor for class org.xbrlapi.xdt.aspects.TypedDimensionAspect.Transformer

TypedDimensionAspectValue - Class in org.xbrlapi.xdt.aspects

TypedDimensionAspectValue(Aspect, OpenContextComponent) - Constructor for class org.xbrlapi.xdt.aspects.TypedDimensionAspectValue

TypedDimensionImpl - Class in org.xbrlapi.xdt

TypedDimensionImpl() - Constructor for class org.xbrlapi.xdt.TypedDimensionImpl

TypeDeclaration - Interface in org.xbrlapi

base interface for all type declarations in XML Schemas.

TypeDeclarationImpl - Class in org.xbrlapi.impl

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

U

UNIT - Static variable in interface org.xbrlapi.aspects.Aspect

Unit - Interface in org.xbrlapi

UnitAspect - Class in org.xbrlapi.aspects

UnitAspect(AspectModel) - Constructor for class org.xbrlapi.aspects.UnitAspect

UnitAspect.Transformer - Class in org.xbrlapi.aspects

UnitAspect.Transformer() - Constructor for class org.xbrlapi.aspects.UnitAspect.Transformer

UnitAspectValue - Class in org.xbrlapi.aspects

UnitAspectValue(Aspect, Unit) - Constructor for class org.xbrlapi.aspects.UnitAspectValue

UnitImpl - Class in org.xbrlapi.impl

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

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

UpdateAllRelationshipsInStore - Class in org.xbrlapi.data.bdbxml.examples.utilities

Updates all relationships in the store to include the arc URI.

UpdateAllRelationshipsInStore(String[]) - Constructor for class org.xbrlapi.data.bdbxml.examples.utilities.UpdateAllRelationshipsInStore

updateInStore() - Method in class org.xbrlapi.impl.XMLImpl

updateInStore() - Method in interface org.xbrlapi.XML

Updates the data store to reflect the current state of this XML object.

UpdateLineColumn(char) - Method in class org.xbrlapi.xpointer.SimpleCharStream

updateState(ElementState) - Method in interface org.xbrlapi.loader.Loader

If a fragment is completed, remove the fragment from the stack being maintained by the loader, store it in the data store and make the necessary update to the stack of child counts for the fragments.

updateState(ElementState) - Method in class org.xbrlapi.loader.LoaderImpl

usage - Variable in class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

UsedOn - Interface in org.xbrlapi

UsedOnImpl - Class in org.xbrlapi.impl

TODO Eliminate the usedOn fragment

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

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

The default behaviour is to ignore the content of XML Schema instance schemaLocation attributes.

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

V

Validator - Class in org.xbrlapi.xlink

Utility handler to perform validation of XLink content in XML documents

Validator(URI) - Constructor for class org.xbrlapi.xlink.Validator

Constructor that is given the URI of the document to be validated

Validator(File) - Constructor for class org.xbrlapi.xlink.Validator

Constructor that is given the URI of the document to be validated

Validator(InputSource) - Constructor for class org.xbrlapi.xlink.Validator

Constructor that is given the URI of the document to be validated.

ValidatorSAXContentHandlerImpl - Class in org.xbrlapi.xlink

ValidatorSAXContentHandlerImpl(XLinkProcessor) - Constructor for class org.xbrlapi.xlink.ValidatorSAXContentHandlerImpl

Test handler constructor.

values - Variable in class org.xbrlapi.aspects.BaseAspect

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

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

W

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

warning(SAXParseException) - Method in class org.xbrlapi.sax.BaseContentHandlerImpl

warning(SAXParseException) - Method in interface org.xbrlapi.sax.ContentHandler

Handles warnings based on SAX parsing exceptions.

warning(String, String, String, Attributes, String) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

Log a warning message

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

Log a warning message

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

Record the warning

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

Handle a warning that the document may not be doing what the creator of the XLink intended

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

Default warning behaviour is to ignore the warning

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

X

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

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

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

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

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

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

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

XBRLAPIGrammarPoolImpl - Class in org.xbrlapi.utilities

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

XBRLAPIGrammarPoolImpl(int) - Constructor for class org.xbrlapi.utilities.XBRLAPIGrammarPoolImpl

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

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

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

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

XBRLCustomLinkRecogniserImpl - Class in org.xbrlapi.xlink.handler

This class provides an example custom link recogniser tailored to the needs of the non-xlink links used by XBRL.

XBRLCustomLinkRecogniserImpl() - Constructor for class org.xbrlapi.xlink.handler.XBRLCustomLinkRecogniserImpl

Constructor for the XBRL custom link recogniser

XBRLDINamespace - Static variable in class org.xbrlapi.xdt.XDTConstants

XBRLDINamespace() - Static method in class org.xbrlapi.xdt.XDTConstants

XBRLDIPrefix - Static variable in class org.xbrlapi.xdt.XDTConstants

XBRLDTNamespace - Static variable in class org.xbrlapi.xdt.XDTConstants

XBRLDTNamespace() - Static method in class org.xbrlapi.xdt.XDTConstants

XBRLDTPrefix - Static variable in class org.xbrlapi.xdt.XDTConstants

XBRLException - Exception in org.xbrlapi.utilities

XBRLException() - Constructor for exception org.xbrlapi.utilities.XBRLException

XBRLException(Throwable) - Constructor for exception org.xbrlapi.utilities.XBRLException

XBRLException(String) - Constructor for exception org.xbrlapi.utilities.XBRLException

XBRLException(String, Throwable) - Constructor for exception org.xbrlapi.utilities.XBRLException

XBRLIdentifier - Class in org.xbrlapi.sax.identifiers

Identifies fragments in the XBRL 2.1 namespace.

XBRLIdentifier(ContentHandler) - Constructor for class org.xbrlapi.sax.identifiers.XBRLIdentifier

XBRLXLinkHandlerImpl - Class in org.xbrlapi.xlink.handler

XBRL XLink Handler This class provides a real world example of an XLink handler for XBRL.

XBRLXLinkHandlerImpl() - Constructor for class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

XBRL XLink handler constructor

XBRLXLinkIdentifier - Class in org.xbrlapi.sax.identifiers

XBRLXLinkIdentifier(ContentHandler) - Constructor for class org.xbrlapi.sax.identifiers.XBRLXLinkIdentifier

XDTConcept - Interface in org.xbrlapi.xdt

XDTConceptImpl - Class in org.xbrlapi.xdt

XDTConceptImpl() - Constructor for class org.xbrlapi.xdt.XDTConceptImpl

XDTConstants - Class in org.xbrlapi.xdt

Defines a range of constants (namespaces etc) that are used for the XDT module.

XDTConstants() - Constructor for class org.xbrlapi.xdt.XDTConstants

Xlink - Interface in org.xbrlapi

XlinkDocumentation - Interface in org.xbrlapi

XlinkDocumentationImpl - Class in org.xbrlapi.impl

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

XLinkException - Exception in org.xbrlapi.xlink

XLinkException() - Constructor for exception org.xbrlapi.xlink.XLinkException

XLinkException(Throwable) - Constructor for exception org.xbrlapi.xlink.XLinkException

XLinkException(String) - Constructor for exception org.xbrlapi.xlink.XLinkException

XLinkException(String, Exception) - Constructor for exception org.xbrlapi.xlink.XLinkException

XLinkHandler - Interface in org.xbrlapi.xlink

Event handler for the XLink processor, responsible for performing the user required responses to the XLink structures being processed by the XLink processor.

XLinkHandlerDefaultImpl - Class in org.xbrlapi.xlink

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

Default XLink handler constructor

XLinkHandlerImpl - Class in org.xbrlapi.xdt

XBRL XLink Handler This class provides a real world example of an XLink handler for XBRL.

XLinkHandlerImpl() - Constructor for class org.xbrlapi.xdt.XLinkHandlerImpl

XBRL XLink handler constructor

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

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

XLinkProcessor - Interface in org.xbrlapi.xlink

The XLink processor is responsible for taking the input from a SAX event and recognising any XLink events resulting from that SAX event and then passing the XLink event through to the chosen XLinkHandler.

XLinkProcessorImpl - Class in org.xbrlapi.xlink

XLink 1.1 processor for use with SAX parsers.

XLinkProcessorImpl(XLinkHandler) - Constructor for class org.xbrlapi.xlink.XLinkProcessorImpl

constructor

XLinkProcessorImpl(XLinkHandler, CustomLinkRecogniser) - Constructor for class org.xbrlapi.xlink.XLinkProcessorImpl

constructor

XML - Interface in org.xbrlapi

XML_NAMESPACE - Static variable in interface org.xbrlapi.xmlbase.BaseURIResolver

xmlBaseEnd() - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

Handle the change of XML Base scope as you step back up the tree

xmlBaseEnd() - Method in class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl

Handle the change of XML Base scope as you step back up the tree

xmlBaseEnd() - Method in class org.xbrlapi.xlink.Validator

xmlBaseEnd() - Method in interface org.xbrlapi.xlink.XLinkHandler

Handles end of an element so that XML base related operations can to done

xmlBaseEnd() - Method in class org.xbrlapi.xlink.XLinkHandlerDefaultImpl

XMLBaseException - Exception in org.xbrlapi.xmlbase

XMLBaseException() - Constructor for exception org.xbrlapi.xmlbase.XMLBaseException

XMLBaseException(Throwable) - Constructor for exception org.xbrlapi.xmlbase.XMLBaseException

XMLBaseException(String) - Constructor for exception org.xbrlapi.xmlbase.XMLBaseException

XMLBaseException(String, Exception) - Constructor for exception org.xbrlapi.xmlbase.XMLBaseException

xmlBaseStart(String) - Method in class org.xbrlapi.xdt.XLinkHandlerImpl

Handle the XML Base attribute discovery

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

Handle the XML Base attribute discovery

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

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

Handles the start of an element, providing any XML Base attribute value.

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

XMLDOMBuilder - Class in org.xbrlapi.utilities

Utility methods for constructing XML DOM objects.

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

XMLImpl - Class in org.xbrlapi.impl

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

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

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

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

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

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

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

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

Z

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

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

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

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