org.palo.api.ext.favoriteviews
Class FavoriteViewFactory

java.lang.Object
  extended by org.palo.api.ext.favoriteviews.FavoriteViewFactory
Direct Known Subclasses:
FavoriteViewFactoryImpl

public abstract class FavoriteViewFactory
extends java.lang.Object

FavoriteViewFactory

An instance of FavoriteViewFactory is obtained with the getInstance() method. Subsequently a favorite view or a favorite view folder can be created by one of the create methods below.

Example:

        FavoriteView favoriteView = FavoriteViewFactory.getInstance().
                createFolder("MyFolder", connection);            
 

Version:
$Id: FavoriteViewFactory.html,v 1.10 2009/07/09 11:01:47 ArndHouben Exp $

Constructor Summary
FavoriteViewFactory()
           
 
Method Summary
abstract  FavoriteView createFavoriteView(java.lang.String name, CubeView view)
          Creates a new FavoriteView with a name and an attached cube view.
abstract  FavoriteView createFavoriteView(java.lang.String name, CubeView view, int position)
          Creates a new FavoriteView with a name, an attached cube view, and a position.
abstract  FavoriteViewsFolder createFolder(java.lang.String name, Connection con)
          Creates a new FavoriteViewsFolder with the specified name and connection.
abstract  FavoriteViewsFolder createFolder(java.lang.String name, Connection con, int position)
          Creates a new FavoriteViewsFolder with the specified name and connection.
static FavoriteViewFactory getInstance()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FavoriteViewFactory

public FavoriteViewFactory()
Method Detail

getInstance

public static FavoriteViewFactory getInstance()

createFavoriteView

public abstract FavoriteView createFavoriteView(java.lang.String name,
                                                CubeView view)
Creates a new FavoriteView with a name and an attached cube view.

Parameters:
name - the name of the new favorite view.
view - the attached cube view.
Returns:
a new FavoriteView with the specified parameters.

createFavoriteView

public abstract FavoriteView createFavoriteView(java.lang.String name,
                                                CubeView view,
                                                int position)
Creates a new FavoriteView with a name, an attached cube view, and a position.

Parameters:
name - the name of the new favorite view.
view - the attached cube view.
position - the position of this favorite view (the index to the children of its parent).
Returns:
a new FavoriteView with the specified parameters.

createFolder

public abstract FavoriteViewsFolder createFolder(java.lang.String name,
                                                 Connection con)
Creates a new FavoriteViewsFolder with the specified name and connection. Folders have to be created with a fixed connection, because all favorite views are saved per connection.

Parameters:
name - the name of the folder.
con - the connection to which this favorite views folder belongs.
Returns:
a new FavoriteViewFolder with the specified parameters.

createFolder

public abstract FavoriteViewsFolder createFolder(java.lang.String name,
                                                 Connection con,
                                                 int position)
Creates a new FavoriteViewsFolder with the specified name and connection. Folders have to be created with a fixed connection, because all favorite views are saved per connection.

Parameters:
name - the name of the folder.
con - the connection to which this favorite views folder belongs.
position - the position in relation to its siblings.
Returns:
a new FavoriteViewFolder with the specified parameters.