org.palo.api
Interface Subset2

All Superinterfaces:
NamedEntity
All Known Implementing Classes:
Subset2Impl

Deprecated. PLEASE DO NOT USE! SUBJECT TO CHANGE!!

public interface Subset2
extends NamedEntity

Subset2 A new subset definition which corresponds to the subset definitions specified by Jedox (and its excel client). The content of this subset is defined by its SubsetFilters. A big difference is that all added subset filters are applied to this subset. Whereas in former Subset definition only one was active.

Version:
$Id: Subset2.html,v 1.1 2007/10/29 13:51:18 ArndHouben Exp $

Method Summary
 void add(SubsetFilter filter)
          Deprecated. Adds the given subset filter to the list of all subset filters which should be applied to this subset.
 boolean contains(Element element)
          Deprecated. Checks if the given Element is inside this subset or not.
 java.lang.String[] getAliases()
          Deprecated. Returns the IDs of aliases currently set.
 Dimension getDimension()
          Deprecated. Returns the Dimension to which this subset applies.
 Element[] getElements()
          Deprecated. Returns all Elements of this subset.
 SubsetFilter getFilter(int type)
          Deprecated. Returns the subset filter which corresponds to the given type
 SubsetFilter[] getFilters()
          Deprecated. Returns all subset filters of this subset
 ElementNode[] getHierarchy()
          Deprecated.  
 java.lang.String getId()
          Deprecated. The unique subset id.
 int getIndent()
          Deprecated.  
 java.lang.String getName()
          Deprecated. Returns the name of the subset
 void remove(SubsetFilter filter)
          Deprecated. Removes the given subset filter from the list of all subset filters which should be applied to this subset.
 void reset()
          Deprecated. Resets this subset to its defaults, i.e. all filters and aliases are removed.
 boolean save()
          Deprecated. Saves this subset
 

Method Detail

getId

java.lang.String getId()
Deprecated. 
The unique subset id.

Returns:
the subset id

getDimension

Dimension getDimension()
Deprecated. 
Returns the Dimension to which this subset applies.

Returns:
the subset dimension

getName

java.lang.String getName()
Deprecated. 
Returns the name of the subset

Specified by:
getName in interface NamedEntity
Returns:
the subset name

getIndent

int getIndent()
Deprecated. 

getAliases

java.lang.String[] getAliases()
Deprecated. 
Returns the IDs of aliases currently set. If the returned array is not empty the first alias should be used. If the first alias is not valid take the second one and so on.

Returns:

reset

void reset()
Deprecated. 
Resets this subset to its defaults, i.e. all filters and aliases are removed.


add

void add(SubsetFilter filter)
Deprecated. 
Adds the given subset filter to the list of all subset filters which should be applied to this subset. Note that this will overwrite a filter of the same type which was added before.

Parameters:
the - subset filter to apply to this subset

remove

void remove(SubsetFilter filter)
Deprecated. 
Removes the given subset filter from the list of all subset filters which should be applied to this subset.

Parameters:
the - subset filter to remove

getFilters

SubsetFilter[] getFilters()
Deprecated. 
Returns all subset filters of this subset

Returns:
an array of applied subset filters

getFilter

SubsetFilter getFilter(int type)
Deprecated. 
Returns the subset filter which corresponds to the given type

Parameters:
type - a valid subset filter type
Returns:
the corresponding ISubsetFilter or null

save

boolean save()
Deprecated. 
Saves this subset


contains

boolean contains(Element element)
Deprecated. 
Checks if the given Element is inside this subset or not.

Parameters:
element - the Element to check
Returns:
true if Element is inside this subset, false if not.

getElements

Element[] getElements()
Deprecated. 
Returns all Elements of this subset.

Returns:

getHierarchy

ElementNode[] getHierarchy()
Deprecated.