Package org.xbrlapi.data.bdbxml.examples.utilities

Example command-line programs that provide a variety of large database analysis and maintenance functions.

See:
Description

Class Summary

AddAnIndex	Adds a new index to the data store.
AnalyseCacheForMatchedDocuments	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.
AnalyseEntityResources	Reports on entity resources that have data.
AnalyseLoadFailures	Reports information about the documents that failed to load properly.
AnalysePersistedRelationships	Reports the number of persisted relationships in the data store.
AnalyseRelationshipsForAFragment	Provides a range of diagnostic information about the XLink relationships involving the specified fragment.
AnalyseUnitMeasures	Provides a summary of the units of measurement set out in an given XBRL document.
BaseUtilityExample	Provides a base class that all of the concrete utility examples extend.
DeletePersistedRelationships	Deletes all of the persisted relationship XML resources from the data store.
DeleteSpecificDocument	Deletes a specific document from the data store.
DeleteStubs	Deletes all of the stubs from the data store.
FindLinksToGivenDocument	Lists all documents that enable XBRL discovery of the document with the specified URI.
FindLocatorsWithMultipleTargetsForADocument	Finds all locators in a document that identify more than one locator target.
ListDuplicateStoredDocuments	Lists the URIs of all documents that have multiple versions stored with the same URI.
ListStoredDocuments	Lists all documents in the data store.
LoadCacheDocuments	Loads all of the documents, from the specified cache directory, into the underlying data store.
LoadSpecificDocument	Loads a specific document, and all of the documents that it enables discovery of, into the data store.
PersistAllRelationshipsInStore	Persists all of the relationships in the data store.
PersistRelationshipsInSpecifiedDocument	Persists all of the relationships defined by arcs in the specified document.
PurgeIdenticalDocuments	Purges and then reloads any documents where there are multiple versions of them in the data store.
ReloadLoadFailures	Attempts to reload all of the documents that are identified in the data store as having not yet loaded properly.
ReportIdenticalDocuments	Lists all sets of identical documents in the data store.
ReportUnitMisuses	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.
TestQuery	Tests an XQuery against an existing data store.
UpdateAllRelationshipsInStore	Updates all relationships in the store to include the arc URI.

Package org.xbrlapi.data.bdbxml.examples.utilities Description

Example command-line programs that provide a variety of large database analysis and maintenance functions.

Package Specification

These command-line programs provide a useful set of examples showing how custom queries can be used to analyse a broad range of data store characteristics and to do a range of batch database modifications.

xbrlapi.org Java library providing XBRL functionality

Copyright (C) 2005, Geoffrey Shuetrim (geoff@galexy.net)

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA