hep.aida
Interface ITreeFactory

public interface ITreeFactory

The creator of trees.

Author:

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

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.

Method Detail

create

public ITree create()

Creates a new tree that is not associated with a store.

create

public ITree create(String storeName)
             throws IllegalArgumentException,
                    IOException

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.

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:

IOException - if the store already exists

IllegalArgumentException

create

public ITree create(String storeName,
                    String storeType)
             throws IllegalArgumentException,
                    IOException

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.

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:

IOException - if the store already exists

IllegalArgumentException

create

public ITree create(String storeName,
                    String storeType,
                    boolean readOnly)
             throws IllegalArgumentException,
                    IOException

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.

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:

IOException - if the store already exists

IllegalArgumentException

create

public ITree create(String storeName,
                    String storeType,
                    boolean readOnly,
                    boolean createNew)
             throws IllegalArgumentException,
                    IOException

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.

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:

IOException - if the store already exists

IllegalArgumentException

create

public ITree create(String storeName,
                    String storeType,
                    boolean readOnly,
                    boolean createNew,
                    String options)
             throws IllegalArgumentException,
                    IOException

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.

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:

IOException - if the store already exists

IllegalArgumentException