org.xbrlapi.data.bdbxml.examples.utilities
Class LoadCacheDocuments

java.lang.Object
  org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample
      org.xbrlapi.data.bdbxml.examples.utilities.LoadCacheDocuments

public class LoadCacheDocuments
extends BaseUtilityExample

Loads all of the documents, from the specified cache directory, into the underlying data store. This operation is recursive in that all documents within the specified directory and any descendant directories are loaded. Additional commandline arguments (optional ones marked with an *)

• -directory [The cache directory to start loading from]

These are in addition to those commandline arguments documented at

Author:

Geoff Shuetrim (geoff@galexy.net)

Field Summary

Fields inherited from class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

argumentDocumentation, arguments, cache, loader, logger, problems, store, usage

Constructor Summary

LoadCacheDocuments(String[] args)

Method Summary

protected String	addArgumentDocumentation() Provides documentation of the usage of the utility.
static void	main(String[] args)
protected String	setUp() Sets up the database store, the loader and the cache.

Methods inherited from class org.xbrlapi.data.bdbxml.examples.utilities.BaseUtilityExample

badUsage, mapArgument, parseArguments, tearDown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoadCacheDocuments

public LoadCacheDocuments(String[] args)

Method Detail

setUp

protected String setUp()

Description copied from class: BaseUtilityExample

Sets up the database store, the loader and the cache. Also checks that the base arguments (database, container and cache) have been supplied. (Overrides should also call this method).

Overrides:

setUp in class BaseUtilityExample

main

public static void main(String[] args)

Parameters:

args - The array of commandline arguments.

addArgumentDocumentation

protected String addArgumentDocumentation()

Description copied from class: BaseUtilityExample

Provides documentation of the usage of the utility. Override this to generate the utility documentation, calling this first to get the initial part of the documentation.

Overrides:

addArgumentDocumentation in class BaseUtilityExample

Returns:

the documentation of the command line arguments.