hep.aida.ref.tree

Class TreeFactory

java.lang.Object

hep.aida.ref.tree.TreeFactory

All Implemented Interfaces:

ITreeFactory

public class TreeFactory
extends java.lang.Object
implements ITreeFactory

Field Summary

Fields inherited from interface hep.aida.ITreeFactory

AUTO, CREATE, READONLY, RECREATE, UPDATE

Constructor Summary

Constructors

Constructor and Description
TreeFactory(IAnalysisFactory analysisFactory) The default constructor.

Method Summary

Modifier and Type	Method and Description
ITree	create() Creates a new tree and associates it with a store.
ITree	create(java.lang.String storeName) Creates a new tree and associates it with a store.
ITree	create(java.lang.String storeName, java.lang.String storeType) Creates a new tree and associates it with a store.
ITree	create(java.lang.String storeName, java.lang.String storeType, boolean readOnly) Creates a new tree and associates it with a store.
ITree	create(java.lang.String storeName, java.lang.String storeType, boolean readOnly, boolean createNew) Creates a new tree and associates it with a store.
ITree	create(java.lang.String storeName, java.lang.String storeType, boolean readOnly, boolean createNew, java.lang.String options) Creates a new tree and associates it with a store.
ITree	createNamedTree(java.lang.String name, java.lang.String storeName, java.lang.String storeType) Creates a new tree which is explicitly named.
ITree	createNamedTree(java.lang.String name, java.lang.String storeName, java.lang.String storeType, int mode) Creates a new tree which is explicitly named.
ITree	createNamedTree(java.lang.String name, java.lang.String storeName, java.lang.String storeType, int mode, java.lang.String options) Creates a new tree which is explicitly named.
ITree	createTree() Creates a new tree and associates it with a store.
ITree	createTree(java.lang.String options) Creates a new tree that is not associated with a store.
ITree	createTree(java.lang.String storeName, java.lang.String storeType) Creates a new tree and associates it with a store.
ITree	createTree(java.lang.String storeName, java.lang.String storeType, int mode) Creates a new tree and associates it with a store.
ITree	createTree(java.lang.String storeName, java.lang.String storeType, int mode, java.lang.String options) Creates a new tree and associates it with a store.
ITree	createTree(java.lang.String storeName, java.lang.String storeType, java.lang.String options)

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeFactory

public TreeFactory(IAnalysisFactory analysisFactory)

The default constructor.

Method Detail

create

public ITree create()

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. in memory and therefore will not be associated with a file.

Specified by:

create in interface ITreeFactory

create

public ITree create(java.lang.String storeName)
             throws java.lang.IllegalArgumentException,
                    java.io.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.

Specified by:

create in interface ITreeFactory

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:

java.io.IOException - if the store already exists

java.lang.IllegalArgumentException

create

public ITree create(java.lang.String storeName,
                    java.lang.String storeType)
             throws java.lang.IllegalArgumentException,
                    java.io.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.

Specified by:

create in interface ITreeFactory

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:

java.io.IOException - if the store already exists

java.lang.IllegalArgumentException

create

public ITree create(java.lang.String storeName,
                    java.lang.String storeType,
                    boolean readOnly)
             throws java.lang.IllegalArgumentException,
                    java.io.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.

Specified by:

create in interface ITreeFactory

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:

java.io.IOException - if the store already exists

java.lang.IllegalArgumentException

create

public ITree create(java.lang.String storeName,
                    java.lang.String storeType,
                    boolean readOnly,
                    boolean createNew)
             throws java.lang.IllegalArgumentException,
                    java.io.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.

Specified by:

create in interface ITreeFactory

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:

java.io.IOException - if the store already exists

java.lang.IllegalArgumentException

create

public ITree create(java.lang.String storeName,
                    java.lang.String storeType,
                    boolean readOnly,
                    boolean createNew,
                    java.lang.String options)
             throws java.lang.IllegalArgumentException,
                    java.io.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.

Specified by:

create in interface ITreeFactory

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:

java.io.IOException - if the store already exists

java.lang.IllegalArgumentException

createTree

public ITree createTree()

Creates a new tree and associates it with a store.

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

• AUTO default case: create of store does not exist
• CREATE: Create a new file (throws an exception if already exists)
• RECREATE: overwrite file if existing
• READONLY: open in read only mode
• UPDATE: read/write mode, overwriting modified objects.

Specified by:

createTree in interface ITreeFactory

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:

java.io.IOException - if the store already exists

java.lang.IllegalArgumentException

createTree

public ITree createTree(java.lang.String options)

Description copied from interface: ITreeFactory

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

Specified by:

createTree in interface ITreeFactory

createTree

public ITree createTree(java.lang.String storeName,
                        java.lang.String storeType)
                 throws java.lang.IllegalArgumentException,
                        java.io.IOException

Description copied from interface: ITreeFactory

Creates a new tree and associates it with a store.

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

• AUTO default case: create of store does not exist
• CREATE: Create a new file (throws an exception if already exists)
• RECREATE: overwrite file if existing
• READONLY: open in read only mode
• UPDATE: read/write mode, overwriting modified objects.

Specified by:

createTree in interface ITreeFactory

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:

java.lang.IllegalArgumentException

java.io.IOException - if the store already exists

createTree

public ITree createTree(java.lang.String storeName,
                        java.lang.String storeType,
                        java.lang.String options)
                 throws java.lang.IllegalArgumentException,
                        java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.io.IOException

createTree

public ITree createTree(java.lang.String storeName,
                        java.lang.String storeType,
                        int mode)
                 throws java.lang.IllegalArgumentException,
                        java.io.IOException

Description copied from interface: ITreeFactory

Creates a new tree and associates it with a store.

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

• AUTO default case: create of store does not exist
• CREATE: Create a new file (throws an exception if already exists)
• RECREATE: overwrite file if existing
• READONLY: open in read only mode
• UPDATE: read/write mode, overwriting modified objects.

Specified by:

createTree in interface ITreeFactory

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:

java.lang.IllegalArgumentException

java.io.IOException - if the store already exists

createTree

public ITree createTree(java.lang.String storeName,
                        java.lang.String storeType,
                        int mode,
                        java.lang.String options)
                 throws java.lang.IllegalArgumentException,
                        java.io.IOException

Description copied from interface: ITreeFactory

Creates a new tree and associates it with a store.

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

• AUTO default case: create of store does not exist
• CREATE: Create a new file (throws an exception if already exists)
• RECREATE: overwrite file if existing
• READONLY: open in read only mode
• UPDATE: read/write mode, overwriting modified objects.

Specified by:

createTree in interface ITreeFactory

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:

java.lang.IllegalArgumentException

java.io.IOException - if the store already exists

createNamedTree

public ITree createNamedTree(java.lang.String name,
                             java.lang.String storeName,
                             java.lang.String storeType)
                      throws java.lang.IllegalArgumentException,
                             java.io.IOException

Description copied from interface: ITreeFactory

Creates a new tree which is explicitly named.

Specified by:

createNamedTree in interface ITreeFactory

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:

java.lang.IllegalArgumentException

java.io.IOException - if the store already exists

createNamedTree

public ITree createNamedTree(java.lang.String name,
                             java.lang.String storeName,
                             java.lang.String storeType,
                             int mode)
                      throws java.lang.IllegalArgumentException,
                             java.io.IOException

Description copied from interface: ITreeFactory

Creates a new tree which is explicitly named.

Specified by:

createNamedTree in interface ITreeFactory

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:

java.lang.IllegalArgumentException

java.io.IOException - if the store already exists

createNamedTree

public ITree createNamedTree(java.lang.String name,
                             java.lang.String storeName,
                             java.lang.String storeType,
                             int mode,
                             java.lang.String options)
                      throws java.lang.IllegalArgumentException,
                             java.io.IOException

Description copied from interface: ITreeFactory

Creates a new tree which is explicitly named.

Specified by:

createNamedTree in interface ITreeFactory

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:

java.lang.IllegalArgumentException

java.io.IOException - if the store already exists