hep.aida
Class IAnalysisFactory

java.lang.Object
  hep.aida.IAnalysisFactory

public abstract class IAnalysisFactory

extends Object

The "master" factory from which other factories are obtained. Typically accessed in Java by:

   IAnalysisFactory af = IAnalysisFactory.create();
 

In C++:

   IAnalysisFactory* af = AIDA_createAnalysisFactory();
 

Author:

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

Constructor Summary

IAnalysisFactory()

Method Summary

static IAnalysisFactory	create()
static IAnalysisFactory	create(String options) Create an instance of an IAnalysisFactory.
IDataPointSetFactory	createDataPointSetFactory(ITree tree) Create an IDataPointSetFactory.
abstract IDataPointSetFactory	createDataPointSetFactory(ITree tree, String options) Create an IDataPointSetFactory.
IFitFactory	createFitFactory() Create an IFitFactory.
abstract IFitFactory	createFitFactory(String options) Create an IFitFactory.
IFunctionFactory	createFunctionFactory(ITree tree) Create an IFunctionFactory.
abstract IFunctionFactory	createFunctionFactory(ITree tree, String options) Create an IFunctionFactory.
IGenericFactory	createGenericFactory(String factoryType) Create an IGenericFactory.
abstract IGenericFactory	createGenericFactory(String factoryType, String options) Create an IGenericFactory.
IHistogramFactory	createHistogramFactory(ITree tree) Create an IHistogramFactory.
abstract IHistogramFactory	createHistogramFactory(ITree tree, String options) Create an IHistogramFactory.
IGenericFactory	createManagedObjectGenericFactory(String factoryType, ITree tree) Create an IGenericFactory that can create Managed Objects.
abstract IGenericFactory	createManagedObjectGenericFactory(String factoryType, ITree tree, String options) Create an IGenericFactory that can create Managed Objects.
IPlotterFactory	createPlotterFactory() Create an IPlotterFactory.
abstract IPlotterFactory	createPlotterFactory(String options) Create an IPlotterFactory.
ITreeFactory	createTreeFactory() Create an ITreeFactory.
abstract ITreeFactory	createTreeFactory(String options) Create an ITreeFactory.
ITupleFactory	createTupleFactory(ITree tree) Create an ITupleFactory.
abstract ITupleFactory	createTupleFactory(ITree tree, String options) Create an ITupleFactory.

Methods inherited from class java.lang.Object

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

Constructor Detail

IAnalysisFactory

public IAnalysisFactory()

Method Detail

createTreeFactory

public ITreeFactory createTreeFactory()

Create an ITreeFactory.

Returns:

The ITreeFactory.

createTreeFactory

public abstract ITreeFactory createTreeFactory(String options)

Create an ITreeFactory.

Returns:

The ITreeFactory.

createHistogramFactory

public IHistogramFactory createHistogramFactory(ITree tree)
                                         throws IllegalArgumentException

Create an IHistogramFactory.

Parameters:

tree - The ITree which created histograms will be associated to.

Returns:

The IHistogramFactory.

Throws:

IllegalArgumentException - if tree is null.

createHistogramFactory

public abstract IHistogramFactory createHistogramFactory(ITree tree,
                                                         String options)
                                                  throws IllegalArgumentException

Create an IHistogramFactory.

Parameters:

tree - The ITree which created histograms will be associated to.

Returns:

The IHistogramFactory.

Throws:

IllegalArgumentException - if tree is null.

createDataPointSetFactory

public IDataPointSetFactory createDataPointSetFactory(ITree tree)
                                               throws IllegalArgumentException

Create an IDataPointSetFactory.

Parameters:

tree - The ITree which created IDataPointSet will be associated to.

Returns:

The IDataPointSetFactory.

Throws:

IllegalArgumentException - if tree is null.

createDataPointSetFactory

public abstract IDataPointSetFactory createDataPointSetFactory(ITree tree,
                                                               String options)
                                                        throws IllegalArgumentException

Create an IDataPointSetFactory.

Parameters:

tree - The ITree which created IDataPointSet will be associated to.

Returns:

The IDataPointSetFactory.

Throws:

IllegalArgumentException - if tree is null.

createTupleFactory

public ITupleFactory createTupleFactory(ITree tree)
                                 throws IllegalArgumentException

Create an ITupleFactory.

Parameters:

tree - The ITree which created tuples will be associated to.

Returns:

The ITupleFactory.

Throws:

IllegalArgumentException - if tree is null.

createTupleFactory

public abstract ITupleFactory createTupleFactory(ITree tree,
                                                 String options)
                                          throws IllegalArgumentException

Create an ITupleFactory.

Parameters:

tree - The ITree which created tuples will be associated to.

Returns:

The ITupleFactory.

Throws:

IllegalArgumentException - if tree is null.

createFunctionFactory

public IFunctionFactory createFunctionFactory(ITree tree)
                                       throws IllegalArgumentException

Create an IFunctionFactory.

Parameters:

tree - The ITree which created functions will be associated to.

Returns:

The IFunctionFactory.

Throws:

IllegalArgumentException - if tree is null.

createFunctionFactory

public abstract IFunctionFactory createFunctionFactory(ITree tree,
                                                       String options)
                                                throws IllegalArgumentException

Create an IFunctionFactory.

Parameters:

tree - The ITree which created functions will be associated to.

Returns:

The IFunctionFactory.

Throws:

IllegalArgumentException - if tree is null.

createPlotterFactory

public IPlotterFactory createPlotterFactory()

Create an IPlotterFactory. Due to the fact that the plotter factory may activate a GUI tookit, the process arguments (passed to the main function) could be passed to the plotter factory. Most of the GUI toolkit ask for them (Motif, gtk, Qt, FLTK).

createPlotterFactory

public abstract IPlotterFactory createPlotterFactory(String options)

Create an IPlotterFactory. Due to the fact that the plotter factory may activate a GUI tookit, the process arguments (passed to the main function) could be passed to the plotter factory. Most of the GUI toolkit ask for them (Motif, gtk, Qt, FLTK).

createFitFactory

public IFitFactory createFitFactory()

Create an IFitFactory.

Returns:

The IFitFactory.

createFitFactory

public abstract IFitFactory createFitFactory(String options)

Create an IFitFactory.

Returns:

The IFitFactory.

createGenericFactory

public IGenericFactory createGenericFactory(String factoryType)

Create an IGenericFactory. Generic factories can be used by AIDA implementations to add implementation specific functionality.

Parameters:

factoryType - The type of factory to create

Returns:

The IGenericFactory.

createGenericFactory

public abstract IGenericFactory createGenericFactory(String factoryType,
                                                     String options)

Create an IGenericFactory. Generic factories can be used by AIDA implementations to add implementation specific functionality.

Parameters:

factoryType - The type of factory to create

Returns:

The IGenericFactory.

createManagedObjectGenericFactory

public IGenericFactory createManagedObjectGenericFactory(String factoryType,
                                                         ITree tree)

Create an IGenericFactory that can create Managed Objects. Generic factories can be used by AIDA implementations to add implementation specific functionality.

Parameters:

factoryType - The type of factory to create

tree - The tree on which the managed objects are added.

Returns:

The IGenericFactory.

createManagedObjectGenericFactory

public abstract IGenericFactory createManagedObjectGenericFactory(String factoryType,
                                                                  ITree tree,
                                                                  String options)

Create an IGenericFactory that can create Managed Objects. Generic factories can be used by AIDA implementations to add implementation specific functionality.

Parameters:

factoryType - The type of factory to create

tree - The tree on which the managed objects are added.

Returns:

The IGenericFactory.

create

public static IAnalysisFactory create()

create

public static IAnalysisFactory create(String options)

Create an instance of an IAnalysisFactory. This method will attempt to locate and load an IAnalysisFactory at runtime. If one cannot be found an error message will be printed, and a RuntimeException thrown. The method first checks the System property hep.aida.IAnalysisFactory. If this is not found it uses the services API to find an IAnalysisFactory service in a jar file on the CLASSPATH.

Returns:

The IAnalysisFactory

Throws:

RuntimeException - If a concrete IAnalysisFactory implementation cannot be located