|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Subset2
Subset2
A new subset definition which corresponds to the subset definitions
specified by Jedox (and its excel client). The content of a subset is
defined by its SubsetFilter
s.
This subset definition is different from the old Subset
in the sense
that all added subset filters are applied to this subset.
Whereas in former subset definition only one was active.
Note: call #applyFilters()
so that added filters show some
effects.
Field Summary | |
---|---|
static int |
TYPE_GLOBAL
Subset type global, i.e. this subset can be read and modified by each user who can read and modify all database cubes |
static int |
TYPE_LOCAL
Subset type local, i.e. the subset access is restricted to certain users |
Fields inherited from interface org.palo.api.PaloObject |
---|
TYPE_ATTRIBUTE, TYPE_NORMAL, TYPE_SYSTEM, TYPE_USER_INFO |
Method Summary | |
---|---|
void |
add(SubsetFilter filter)
Adds the given subset filter to the list of all subset filters which should be applied to this subset. |
boolean |
contains(Element element)
Checks if the given Element is inside this subset or not. |
Subset2 |
copy()
Creates a deep copy of this subset. |
java.lang.String |
getDescription()
Returns the subset description or null if none was set. |
Dimension |
getDimension()
Deprecated. use getDimHierarchy() instead. |
Hierarchy |
getDimHierarchy()
Returns the Hierarchy to which this subset applies. |
Element[] |
getElements()
Returns all Elements of this subset. |
SubsetFilter |
getFilter(int type)
Returns the subset filter which corresponds to the given type |
SubsetFilter[] |
getFilters()
Returns all subset filters of this subset |
ElementNode[] |
getHierarchy()
Deprecated. use getRootNodes() instead. |
int |
getIndent()
Returns the indent of this subset |
ElementNode[] |
getRootNodes()
Returns all root nodes of this subset. |
int |
getType()
Returns the subset type which is one of the predefined type constants. |
boolean |
isActive(int filterType)
Checks if the subset filter which corresponds to the given type is active, i.e. |
void |
modified()
Marks the subset as being modified. |
void |
remove(SubsetFilter filter)
Removes the given subset filter from the list of all subset filters which should be applied to this subset. |
void |
rename(java.lang.String newName)
Renames this subset. |
void |
reset()
Resets this subset to its defaults, i.e. all filters and aliases are removed. |
void |
save()
Saves this subset |
void |
setDescription(java.lang.String description)
Sets an optional description for the subset. |
void |
setIndent(int indent)
Sets the subset indent |
Methods inherited from interface org.palo.api.PaloObject |
---|
getId |
Methods inherited from interface org.palo.api.NamedEntity |
---|
getName |
Methods inherited from interface org.palo.api.Writable |
---|
canBeModified, canCreateChildren |
Field Detail |
---|
static final int TYPE_LOCAL
static final int TYPE_GLOBAL
Method Detail |
---|
Dimension getDimension()
getDimHierarchy()
instead.
Dimension
to which this subset applies.
Hierarchy getDimHierarchy()
Hierarchy
to which this subset applies.
int getIndent()
void setIndent(int indent)
indent
- the new subset indentvoid reset()
void add(SubsetFilter filter)
the
- subset filter to apply to this subsetvoid remove(SubsetFilter filter)
the
- subset filter to removeSubsetFilter[] getFilters()
SubsetFilter getFilter(int type)
type
- a valid subset filter type
ISubsetFilter
or null
boolean isActive(int filterType)
getFilter(int)
returns not null
filterType
- the type of filter to check
true
if corresponding filter is active,
false
otherwisevoid save()
boolean contains(Element element)
Element
is inside this subset or not.
element
- the Element
to check
true
if Element
is inside this subset,
false
if not.Element[] getElements()
Elements
of this subset.
Elements
of this subsetElementNode[] getHierarchy()
getRootNodes()
instead.
ElementNodes
the root nodes should be traversed.
ElementNode[] getRootNodes()
ElementNodes
the root nodes should be traversed.
void modified()
Marks the subset as being modified. The consequence of this method is that all registered filters are applied the next time the subset elements are requested.
void rename(java.lang.String newName)
newName
- the new subset nameint getType()
getType
in interface PaloObject
Subset2 copy()
void setDescription(java.lang.String description)
null
deletes the description.
description
- a description of the subsetjava.lang.String getDescription()
null
if none was set.
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |