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

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

public class AddAnIndex
extends BaseUtilityExample

Adds a new index to the data store. Index string syntax documentation is available 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

AddAnIndex(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

AddAnIndex

public AddAnIndex(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.