AIDA API
Version 3.3

hep.aida
Interface ITreeFactory


public interface ITreeFactory

The creator of trees.

Author:
The AIDA team (http://aida.freehep.org/)

Field Summary
static int AUTO
          Constants specifying legal values for the mode argument.
static int CREATE
          Constants specifying legal values for the mode argument.
static int READONLY
          Constants specifying legal values for the mode argument.
static int RECREATE
          Constants specifying legal values for the mode argument.
static int UPDATE
          Constants specifying legal values for the mode argument.
 
Method Summary
 ITree create()
          Creates a new tree that is not associated with a store.
 ITree create(String storeName)
          Creates a new tree and associates it with a store.
 ITree create(String storeName, String storeType)
          Creates a new tree and associates it with a store.
 ITree create(String storeName, String storeType, boolean readOnly)
          Creates a new tree and associates it with a store.
 ITree create(String storeName, String storeType, boolean readOnly, boolean createNew)
          Creates a new tree and associates it with a store.
 ITree create(String storeName, String storeType, boolean readOnly, boolean createNew, String options)
          Creates a new tree and associates it with a store.
 ITree createNamedTree(String name, String storeName, String storeType)
          Creates a new tree which is explicitly named.
 ITree createNamedTree(String name, String storeName, String storeType, int mode)
          Creates a new tree which is explicitly named.
 ITree createNamedTree(String name, String storeName, String storeType, int mode, String options)
          Creates a new tree which is explicitly named.
 ITree createTree()
          Creates a new tree that is not associated with a store.
 ITree createTree(String options)
          Creates a new tree that is not associated with a store.
 ITree createTree(String storeName, String storeType)
          Creates a new tree and associates it with a store.
 ITree createTree(String storeName, String storeType, int mode)
          Creates a new tree and associates it with a store.
 ITree createTree(String storeName, String storeType, int mode, String options)
          Creates a new tree and associates it with a store.
 

Field Detail

AUTO

public static final int AUTO
Constants specifying legal values for the mode argument.

See Also:
Constant Field Values

CREATE

public static final int CREATE
Constants specifying legal values for the mode argument.

See Also:
Constant Field Values

RECREATE

public static final int RECREATE
Constants specifying legal values for the mode argument.

See Also:
Constant Field Values

READONLY

public static final int READONLY
Constants specifying legal values for the mode argument.

See Also:
Constant Field Values

UPDATE

public static final int UPDATE
Constants specifying legal values for the mode argument.

See Also:
Constant Field Values
Method Detail

createTree

public ITree createTree()
Creates a new tree that is not associated with a store.


createTree

public ITree createTree(String options)
Creates a new tree that is not associated with a store.


createTree

public ITree createTree(String storeName,
                        String storeType)
                 throws IllegalArgumentException,
                        RuntimeException
Creates a new tree and associates it with a store.

The definition of the various modes than can be specified are:

Parameters:
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType - Implementation specific string, may control store type
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

createTree

public ITree createTree(String storeName,
                        String storeType,
                        int mode)
                 throws IllegalArgumentException,
                        RuntimeException
Creates a new tree and associates it with a store.

The definition of the various modes than can be specified are:

Parameters:
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType - Implementation specific string, may control store type
mode - One of AUTO, CREATE, RECREATE, READONLY, UPDATE.
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

createTree

public ITree createTree(String storeName,
                        String storeType,
                        int mode,
                        String options)
                 throws IllegalArgumentException,
                        RuntimeException
Creates a new tree and associates it with a store.

The definition of the various modes than can be specified are:

Parameters:
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType - Implementation specific string, may control store type
mode - One of AUTO, CREATE, RECREATE, READONLY, UPDATE.
options - Other options, currently are not specified
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

createNamedTree

public ITree createNamedTree(String name,
                             String storeName,
                             String storeType)
                      throws IllegalArgumentException,
                             RuntimeException
Creates a new tree which is explicitly named.

Parameters:
name - The name of the tree.
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType - Implementation specific string, may control store type
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

createNamedTree

public ITree createNamedTree(String name,
                             String storeName,
                             String storeType,
                             int mode)
                      throws IllegalArgumentException,
                             RuntimeException
Creates a new tree which is explicitly named.

Parameters:
name - The name of the tree.
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType - Implementation specific string, may control store type
mode - One of AUTO, CREATE, RECREATE, READONLY, UPDATE.
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

createNamedTree

public ITree createNamedTree(String name,
                             String storeName,
                             String storeType,
                             int mode,
                             String options)
                      throws IllegalArgumentException,
                             RuntimeException
Creates a new tree which is explicitly named.

Parameters:
name - The name of the tree.
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType - Implementation specific string, may control store type
mode - One of AUTO, CREATE, RECREATE, READONLY, UPDATE.
options - Other options, currently are not specified
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

create

public ITree create()
Creates a new tree that is not associated with a store. Note We recommend using the alternative createTree methods for new applications.


create

public ITree create(String storeName)
             throws IllegalArgumentException,
                    RuntimeException
Creates a new tree and associates it with a store. The store is assumed to be read/write. The store will be created if it does not exist. Note The arguments to this method are a little confusing, so we recommend using the alternative createTree methods for new applications.

Parameters:
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

create

public ITree create(String storeName,
                    String storeType)
             throws IllegalArgumentException,
                    RuntimeException
Creates a new tree and associates it with a store. The store is assumed to be read/write. The store will be created if it does not exist. Note The arguments to this method are a little confusing, so we recommend using the alternative createTree methods for new applications.

Parameters:
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType - Implementation specific string, may control store type
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

create

public ITree create(String storeName,
                    String storeType,
                    boolean readOnly)
             throws IllegalArgumentException,
                    RuntimeException
Creates a new tree and associates it with a store. The store is assumed to be read/write. The store will be created if it does not exist. Note The arguments to this method are a little confusing, so we recommend using the alternative createTree methods for new applications.

Parameters:
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType - Implementation specific string, may control store type
readOnly - If true the store is opened readonly, an exception if it does not exist
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

create

public ITree create(String storeName,
                    String storeType,
                    boolean readOnly,
                    boolean createNew)
             throws IllegalArgumentException,
                    RuntimeException
Creates a new tree and associates it with a store. The store is assumed to be read/write. The store will be created if it does not exist. Note The arguments to this method are a little confusing, so we recommend using the alternative createTree methods for new applications.

Parameters:
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType - Implementation specific string, may control store type
readOnly - If true the store is opened readonly, an exception if it does not exist
createNew - If false the file must exist, if true the file will be created
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

create

public ITree create(String storeName,
                    String storeType,
                    boolean readOnly,
                    boolean createNew,
                    String options)
             throws IllegalArgumentException,
                    RuntimeException
Creates a new tree and associates it with a store. The store is assumed to be read/write. The store will be created if it does not exist. Note The arguments to this method are a little confusing, so we recommend using the alternative createTree methods for new applications.

Parameters:
storeName - The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType - Implementation specific string, may control store type
readOnly - If true the store is opened readonly, an exception if it does not exist
createNew - If false the file must exist, if true the file will be created
options - Other options, currently are not specified
Throws:
RuntimeException - if the store already exists
IllegalArgumentException

AIDA API
Version 3.3

Copyright © 2000-2004 AIDA Team, All Rights Reserved.