|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.palo.api.subsets.filter.settings.AbstractFilterSettings
org.palo.api.subsets.filter.settings.DataFilterSetting
public class DataFilterSetting
DataFilterSetting
Manages the settings for the DataFilter
. Each data filter is based
on a source cube to determine filter values for elements. A slice can be
defined for this source cube. Note that the array length of this slice
corresponds to the dimension count of the source cube and that the elements
of e.g. slice[index] are part of the dimension which is returned by
sourceCube.getDimensionAt(index)
Field Summary | |
---|---|
static int |
ALL_OP
|
static int |
ANY_OP
|
static int |
AVG_OP
|
static int |
MAX_OP
|
static int |
MIN_OP
|
static int |
STR_OP
|
static int |
SUM_OP
|
Constructor Summary | |
---|---|
DataFilterSetting(java.lang.String sourceCube)
Creates a new DataFilterSetting instance for the given
source cube. |
|
DataFilterSetting(java.lang.String sourceCube,
DataCriteria criteria)
Creates a new DataFilterSetting instance for the given
source cube and criteria. |
Method Summary | |
---|---|
void |
adapt(FilterSetting from)
Adapt the filter setting from the given filter setting. |
void |
addSliceElement(java.lang.String id)
internally used method |
void |
addSliceElement(java.lang.String id,
int index)
|
void |
addSlicePart(ObjectParameter part)
internally used method |
void |
bind(Subset2 subset)
Binds this filter settings instance to the given Subset2
NOTE: PLEASE DON'T USE! |
void |
clearSlice()
|
IntegerParameter |
getCellOperator()
Returns the cell operator to use, i.e. one of the predefined operator constants. |
DataCriteria |
getCriteria()
Returns the currently used data criteria |
DoubleParameter |
getLowerPercentage()
Returns the percentage of all lower elements to select |
java.lang.String[][] |
getSlice()
Returns the element ids which should be used for the slice. |
ObjectParameter[] |
getSliceParameters()
Returns an ObjectParameter array which contains the currently
used slice of the source cube. |
ObjectParameter |
getSlicePart()
internally used method |
ObjectParameter |
getSlicePart(int index)
Returns the slice part for the given dimension index. |
StringParameter |
getSourceCube()
Returns the identifier of the source cube of this data filter |
IntegerParameter |
getTop()
Returns the number of top elements to select |
DoubleParameter |
getUpperPercentage()
Returns the percentage of all upper elements to select |
BooleanParameter |
getUseRules()
Checks if an existing rule should be used to determine element value. |
void |
reset()
Resets the filter setting to its defaults. |
void |
setCellOperator(int cellOperator)
Sets the cell operator. |
void |
setCellOperator(IntegerParameter cellOperator)
Sets the cell operator, i.e. the parameter value should be one of the predefined operator constants. |
void |
setCriteria(DataCriteria criteria)
Sets the data criteria to use |
void |
setLowerPercentage(double lowerPercentage)
Sets the percentage of all lower elements to select |
void |
setLowerPercentage(DoubleParameter lowerPercentage)
|
void |
setSliceElements(java.lang.String[] ids,
int index)
|
void |
setSourceCube(java.lang.String sourceCube)
Sets the identifier of the source cube to use |
void |
setSourceCube(StringParameter sourceCube)
Sets the identifier of the source cube to use, i.e. the parameter value should contain the id of the source cube. |
void |
setTop(int top)
Sets the number of top elements to select |
void |
setTop(IntegerParameter top)
Sets the top count, i.e. the parameter value should contain the number of elements to select. |
void |
setUpperPercentage(double upperPercentage)
Specifies the percentage of all upper elements to select |
void |
setUpperPercentage(DoubleParameter upperPercentage)
Specifies the percentage of all upper elements to select, i.e. the parameter value contains the p |
void |
setUseRules(boolean useRules)
Specifies if an existing rule should be used to determine the element value. |
void |
setUseRules(BooleanParameter useRules)
Specifies if an existing rule should be used to determine the element value. |
void |
unbind()
Releases this filter settings instance from a previously binded Subset2
NOTE: PLEASE DON'T USE! |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int SUM_OP
public static final int ALL_OP
public static final int AVG_OP
public static final int MAX_OP
public static final int ANY_OP
public static final int MIN_OP
public static final int STR_OP
Constructor Detail |
---|
public DataFilterSetting(java.lang.String sourceCube)
DataFilterSetting
instance for the given
source cube. DataCriteria.GREATER
is used as default criteria.
sourceCube
- a valid identifier of the source cube to usepublic DataFilterSetting(java.lang.String sourceCube, DataCriteria criteria)
DataFilterSetting
instance for the given
source cube and criteria.
sourceCube
- a valid identifier of the source cube to usecriteria
- the data criteria to useMethod Detail |
---|
public final IntegerParameter getTop()
public final void setTop(int top)
top
- the new number of top elementspublic final void setTop(IntegerParameter top)
top
- the new IntegerParameter
which specifies the
number of top elements to selectpublic final IntegerParameter getCellOperator()
public final void setCellOperator(int cellOperator)
cellOperator
- the new cell operatorpublic final void setCellOperator(IntegerParameter cellOperator)
cellOperator
- the new IntegerParameter
which specifies
the cell operatorpublic final void setCriteria(DataCriteria criteria)
criteria
- the new data criteriapublic final DataCriteria getCriteria()
public final void setUseRules(boolean useRules)
useRules
- set to true
to use existing rule for
determining element value, to false
otherwisepublic final void setUseRules(BooleanParameter useRules)
useRules
- the new BooleanParameter
to usepublic final BooleanParameter getUseRules()
true
if rule should be used, false
otherwisepublic final StringParameter getSourceCube()
public final void setSourceCube(java.lang.String sourceCube)
sourceCube
- the source cube idpublic final void setSourceCube(StringParameter sourceCube)
sourceCube
- the new StringParameter
to use as
source cubepublic final DoubleParameter getUpperPercentage()
public final void setUpperPercentage(double upperPercentage)
upperPercentage
- the new upper percentagepublic final void setUpperPercentage(DoubleParameter upperPercentage)
upperPercentage
- public final DoubleParameter getLowerPercentage()
public final void setLowerPercentage(double lowerPercentage)
lowerPercentage
- the new lower percentagepublic final void setLowerPercentage(DoubleParameter lowerPercentage)
public final ObjectParameter[] getSliceParameters()
ObjectParameter
array which contains the currently
used slice of the source cube. The length of the slice array corresponds
to the number of dimensions of the source cube. Each slice entry
contains a ObjectParameter
with a string array as its value.
This array holds the ids of the elements which should be used for the
slice at the current dimension.
public final java.lang.String[][] getSlice()
public final void addSliceElement(java.lang.String id, int index)
public final void setSliceElements(java.lang.String[] ids, int index)
public final ObjectParameter getSlicePart(int index)
#addNextSliceDimension()
,
addSliceElement(String);
public final void clearSlice()
public final void addSlicePart(ObjectParameter part)
public final ObjectParameter getSlicePart()
public final void addSliceElement(java.lang.String id)
public final void reset()
FilterSetting
public final void bind(Subset2 subset)
FilterSetting
Binds this filter settings instance to the given Subset2
bind
in interface FilterSetting
bind
in class AbstractFilterSettings
public final void unbind()
FilterSetting
Releases this filter settings instance from a previously binded
Subset2
unbind
in interface FilterSetting
unbind
in class AbstractFilterSettings
public final void adapt(FilterSetting from)
FilterSetting
from
- the filter setting to adapt from
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |