|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.dss.selection.step.Step | +--oracle.dss.selection.step.ConditionStep | +--oracle.dss.selection.step.BasicFamilyStep | +--oracle.dss.selection.step.FamilyStep
Represents a step in a selection that specifies members of a particular dimension based on a relationship within a family. For example, it might specify the children (such as the cities, Boston, New York, Providence, and so on) of a region (such as, Eastern U.S.).
Field Summary | |
static int |
OP_ANCESTORS The ancestors family operator, which specifies members at any level above a particular member in a hierarchy. |
static int |
OP_CHILDREN The children family operator, which specifies members at the level immediately below a particular member in a hierarchy. |
static int |
OP_DESCENDANTS The descendants family operator, which specifies members at any level below a particular member in a hierarchy. |
static int |
OP_LASTDESCENDANTS The last descendants family operator, which specifies members at the very last level in a hierarchy. |
static int |
OP_PARENT The parent family operator, which specifies members at the level immediately above a particular member in a hierarchy. |
static int |
OP_SIBLINGS The siblings family operator, which specifies members at the same level as a particular member in a hierarchy. |
static java.lang.String |
STEP_STATE State Management support |
Fields inherited from class oracle.dss.selection.step.Step |
ADD, BASE_STATE_INDEX, CURRENT_STATE_INDEX, KEEP, LONG, MEDIUM, REMOVE, SELECT, SHORT |
Constructor Summary | |
FamilyStep() Constructor that does not specify any arguments. | |
FamilyStep(java.lang.String dimensionName) Constructor that specifies a dimension. | |
FamilyStep(java.lang.String dimensionName, int familyOp, java.util.Vector familyValues) Constructor that specifies all arguments except whether to include the specified family members. | |
FamilyStep(java.lang.String dimensionName, java.lang.String hierarchy, int familyOp, java.util.Vector familyValues, boolean familyValuesIncluded) Constructor that specifies all arguments. |
Method Summary | |
void |
copyFrom(Step step) Copies all fields from the specified Step object. |
boolean |
equals(java.lang.Object obj) Indicates whether one Step object is equivalent to another Step object. |
java.lang.Class |
getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this FamilyStep object. |
int |
getFamilyOp() Retrieves the family operator for this FamilyStep object. |
java.lang.String |
getViewClassName() Retrieves the name of the StepView class to use to edit this FamilyStep object. |
void |
setFamilyOp(int familyOp) Specifies the family operator for this FamilyStep object. |
java.lang.String |
toString() Generates the string representation of this FamilyStep object. |
Methods inherited from class oracle.dss.selection.step.BasicFamilyStep |
clone, getFamilyValues, isFamilyValuesIncluded, setFamilyValues, setFamilyValuesIncluded |
Methods inherited from class oracle.dss.selection.step.ConditionStep |
getLevels, setLevels |
Methods inherited from class oracle.dss.selection.step.Step |
addPropertyChangeListener, getAction, getDescription, getDimension, getDispQDR, getHierarchy, getQDR, getQDRDescription, isEnabled, isValid, removePropertyChangeListener, setAction, setDescription, setDimension, setDispQDR, setEnabled, setHierarchy, setQDR, setQDRDescription, setValid |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int OP_CHILDREN
public static final int OP_PARENT
public static final int OP_SIBLINGS
public static final int OP_ANCESTORS
public static final int OP_DESCENDANTS
public static final int OP_LASTDESCENDANTS
public static final java.lang.String STEP_STATE
Constructor Detail |
public FamilyStep()
public FamilyStep(java.lang.String dimensionName)
dimensionName
- The name of the dimension.public FamilyStep(java.lang.String dimensionName, int familyOp, java.util.Vector familyValues)
dimensionName
- The name of the dimension.familyOp
- A constant that represents the family operator. The valid constants are listed in the See Also section.familyMembers
- The vector of family members whose families are to be specified.OP_ANCESTORS
, OP_CHILDREN
, OP_DESCENDANTS
, OP_LASTDESCENDANTS
, OP_PARENT
, OP_SIBLINGS
public FamilyStep(java.lang.String dimensionName, java.lang.String hierarchy, int familyOp, java.util.Vector familyValues, boolean familyValuesIncluded)
dimensionName
- The name of the dimension.hierarchy
- The name of the hierarchy.familyOp
- A constant that represents the family operator. The valid constants are listed in the See Also section.familyMembers
- The vector of family members whose families are to be specified.FamilyMembersIncluded
- true
if the specified family members are to be included; false
if they are not.OP_ANCESTORS
, OP_CHILDREN
, OP_DESCENDANTS
, OP_LASTDESCENDANTS
, OP_PARENT
, OP_SIBLINGS
Method Detail |
public boolean equals(java.lang.Object obj)
Step
object is equivalent to another Step
object.equals
in class BasicFamilyStep
obj
- The Step
object with which to compare.true
if the objects are completely equal; false
if they are not.public void copyFrom(Step step)
Step
object.copyFrom
in class BasicFamilyStep
step
- The Step
object from which to copy fields.public java.lang.String toString()
FamilyStep
object.toString
in class BasicFamilyStep
FamilyStep
object.public void setFamilyOp(int familyOp)
FamilyStep
object.familyOp
- A constant that represents the family operator. The valid constants are listed in the See Also section.OP_ANCESTORS
, OP_CHILDREN
, OP_DESCENDANTS
, OP_LASTDESCENDANTS
, OP_PARENT
, OP_SIBLINGS
public int getFamilyOp()
FamilyStep
object.OP_ANCESTORS
, OP_CHILDREN
, OP_DESCENDANTS
, OP_LASTDESCENDANTS
, OP_PARENT
, OP_SIBLINGS
public java.lang.String getViewClassName()
StepView
class to use to edit this FamilyStep
object. If the name is null, then retrieves the base StepView
class. Overrides the same method in the base Step
class.getViewClassName
in class Step
StepView
class.public java.lang.Class getEvaluatorClass() throws SelectionException
StepEvaluator
class object that is associated with this FamilyStep
object. The QueryServer
object uses this class to instantiate the appropriate StepEvaluator
object.getEvaluatorClass
in class Step
Class
object.SelectionException
- If the StepEvaluator
class is not found.
|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |