ITreeFactory

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

hep.aida
Interface ITreeFactory

All Known Implementing Classes:: TreeFactory

public interface ITreeFactory

The creator of trees.

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

static final int AUTO

Constants specifying legal values for the mode argument.

See Also:: Constant Field Values

CREATE

static final int CREATE

Constants specifying legal values for the mode argument.

See Also:: Constant Field Values

RECREATE

static final int RECREATE

Constants specifying legal values for the mode argument.

See Also:: Constant Field Values

READONLY

static final int READONLY

Constants specifying legal values for the mode argument.

See Also:: Constant Field Values

UPDATE

static final int UPDATE

Constants specifying legal values for the mode argument.

See Also:: Constant Field Values

Method Detail

createTree

ITree createTree()

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

createTree

ITree createTree(String options)

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

createTree

ITree createTree(String storeName,
                 String storeType)
                 throws IllegalArgumentException,
                        IOException

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.

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

createTree

ITree createTree(String storeName,
                 String storeType,
                 int mode)
                 throws IllegalArgumentException,
                        IOException

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.

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:: IOException - if the store already exists; IllegalArgumentException

createTree

ITree createTree(String storeName,
                 String storeType,
                 int mode,
                 String options)
                 throws IllegalArgumentException,
                        IOException

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.

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:: IOException - if the store already exists; IllegalArgumentException

createNamedTree

ITree createNamedTree(String name,
                      String storeName,
                      String storeType)
                      throws IllegalArgumentException,
                             IOException

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:: IOException - if the store already exists; IllegalArgumentException

createNamedTree

ITree createNamedTree(String name,
                      String storeName,
                      String storeType,
                      int mode)
                      throws IllegalArgumentException,
                             IOException

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:: IOException - if the store already exists; IllegalArgumentException

createNamedTree

ITree createNamedTree(String name,
                      String storeName,
                      String storeType,
                      int mode,
                      String options)
                      throws IllegalArgumentException,
                             IOException

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:: IOException - if the store already exists; IllegalArgumentException

create

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

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. 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:: IOException - if the store already exists; IllegalArgumentException

create

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. 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:: IOException - if the store already exists; IllegalArgumentException

create

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. 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:: IOException - if the store already exists; IllegalArgumentException

create

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. 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:: IOException - if the store already exists; IllegalArgumentException

create

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. 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:: IOException - if the store already exists; IllegalArgumentException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jHepWork 3.2 © jWork.org