oracle.dss.selection.step
Class MatchStep

java.lang.Object
  |
  +--oracle.dss.selection.step.Step
        |
        +--oracle.dss.selection.step.ConditionStep
              |
              +--oracle.dss.selection.step.MatchStep

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable, VectorClone

public class MatchStep

extends ConditionStep

Represents a step in a selection that specifies members of a particular dimension based on the way in which members match a specified string of characters. For example, it might specify members that match these characters: Size 12.

See Also:

Serialized Form

Field Summary

static int	ANY Any label for the dimension member, including its value.
static int	BEGINS_WITH The begins with match type, which determines which members begin with a specified string of characters.
static int	CONTAINS The contains match type, which determines which members contain a specified string of characters.
static int	ENDS_WITH The ends with match type, which determines which members end with a specified string of characters.
static int	LONGLABEL The long label for the dimension member.
static int	MATCHES_EXACTLY The matches exactly match type, which determines which members exactly match a specified string of characters.
static int	MEDIUMLABEL The medium label for the dimension member.
static int	SHORTLABEL The short label for the dimension member.
static java.lang.String	STEP_STATE State Management support
static int	VALUE The value of the dimension member, as it appears in the database.

Fields inherited from class oracle.dss.selection.step.Step

ADD, BASE_STATE_INDEX, CURRENT_STATE_INDEX, KEEP, LONG, MEDIUM, REMOVE, SELECT, SHORT

Constructor Summary

MatchStep()
Constructor that does not specify any arguments.

MatchStep(java.lang.String dimensionName)
Constructor that specifies a dimension.

MatchStep(java.lang.String dimensionName, int intMatchType, java.lang.String strMatchText)
Constructor that specifies all arguments except a hierarchy and levels.

MatchStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, int intMatchType, java.lang.String strMatchText)
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 MatchStep object.
int	getLabelType() Retrieves the type of member label to match to the matched text.
boolean	getMatchCase() Indicates whether the capitalization of the match text is used in this MatchStep object.
java.lang.String	getMatchText() Retrieves the match text of this MatchStep object.
int	getMatchType() Retrieves the match type of this MatchStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this MatchStep object.
void	setLabelType(int intLabelType) Specifies the type of member label to match to the matched text.
void	setMatchCase(boolean blnMatchCase) Specifies whether to use the capitalization of the match text in this MatchStep object.
void	setMatchText(java.lang.String strMatchText) Specifies the match text of this MatchStep object.
void	setMatchType(int intMatchType) Specifies the match type of this MatchStep object.
java.lang.String	toString() Generates the string representation of this MatchStep object.

Methods inherited from class oracle.dss.selection.step.ConditionStep

clone, 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

CONTAINS

public static final int CONTAINS

The contains match type, which determines which members contain a specified string of characters.

BEGINS_WITH

public static final int BEGINS_WITH

The begins with match type, which determines which members begin with a specified string of characters.

ENDS_WITH

public static final int ENDS_WITH

The ends with match type, which determines which members end with a specified string of characters.

MATCHES_EXACTLY

public static final int MATCHES_EXACTLY

The matches exactly match type, which determines which members exactly match a specified string of characters.

ANY

public static final int ANY

Any label for the dimension member, including its value.

VALUE

public static final int VALUE

The value of the dimension member, as it appears in the database.

LONGLABEL

public static final int LONGLABEL

The long label for the dimension member.

MEDIUMLABEL

public static final int MEDIUMLABEL

The medium label for the dimension member.

SHORTLABEL

public static final int SHORTLABEL

The short label for the dimension member.

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

MatchStep

public MatchStep()

Constructor that does not specify any arguments.

MatchStep

public MatchStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

MatchStep

public MatchStep(java.lang.String dimensionName,
                 int intMatchType,
                 java.lang.String strMatchText)

Constructor that specifies all arguments except a hierarchy and levels.

Parameters:

dimensionName - The name of the dimension.

intMatchType - A constant that represents the match type. The valid constants are listed in the See Also section.

strMatchText - The character or characters that members are to match.

See Also:

BEGINS_WITH, CONTAINS, ENDS_WITH, MATCHES_EXACTLY

MatchStep

public MatchStep(java.lang.String dimensionName,
                 java.lang.String hierarchy,
                 java.util.Vector levels,
                 int intMatchType,
                 java.lang.String strMatchText)

Constructor that specifies all arguments.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

levels - The vector of levels.

intMatchType - A constant that represents the match type. The valid constants are listed in the See Also section.

strMatchText - The character or characters that members are to match.

See Also:

BEGINS_WITH, CONTAINS, ENDS_WITH, MATCHES_EXACTLY

Method Detail

equals

public boolean equals(java.lang.Object obj)

Indicates whether one Step object is equivalent to another Step object.

Overrides:

equals in class ConditionStep

Parameters:

obj - The Step object with which to compare.

Returns:

true if the objects are completely equal; false if they are not.

copyFrom

public void copyFrom(Step step)

Copies all fields from the specified Step object.

Overrides:

copyFrom in class ConditionStep

Parameters:

step - The Step object from which to copy fields.

toString

public java.lang.String toString()

Generates the string representation of this MatchStep object.

Overrides:

toString in class ConditionStep

Returns:

The string representation of this MatchStep object.

setMatchType

public void setMatchType(int intMatchType)
                  throws InvalidStepArgException

Specifies the match type of this MatchStep object.

Parameters:

intMatchType - A constant that represents the match type. The valid constants are listed in the See Also section.

See Also:

BEGINS_WITH, CONTAINS, ENDS_WITH, MATCHES_EXACTLY

getMatchType

public int getMatchType()

Retrieves the match type of this MatchStep object.

Returns:

A constant that represents the match type. The valid constants are listed in the See Also section.

See Also:

BEGINS_WITH, CONTAINS, ENDS_WITH, MATCHES_EXACTLY

setMatchText

public void setMatchText(java.lang.String strMatchText)

Specifies the match text of this MatchStep object.

Parameters:

strMatchText - The character or characters that members are to match.

getMatchText

public java.lang.String getMatchText()

Retrieves the match text of this MatchStep object.

Returns:

The character or characters that members are to match.

setLabelType

public void setLabelType(int intLabelType)

Specifies the type of member label to match to the matched text.

Parameters:

intLabelType - A constant that represents the type of label. The valid constants are listed in the See Also section.

See Also:

ANY, LONGLABEL, MEDIUMLABEL, SHORTLABEL, VALUE

getLabelType

public int getLabelType()

Retrieves the type of member label to match to the matched text.

Returns:

A constant that represents the type of label. The valid constants are listed in the See Also section.

See Also:

ANY, LONGLABEL, MEDIUMLABEL, SHORTLABEL, VALUE

setMatchCase

public void setMatchCase(boolean blnMatchCase)

Specifies whether to use the capitalization of the match text in this MatchStep object.

Parameters:

blnMatchCase - true if the capitalization of the match text is to be used; false if it is not.

getMatchCase

public boolean getMatchCase()

Indicates whether the capitalization of the match text is used in this MatchStep object.

Returns:

true if the capitalization of the match text is used; false if it is not.

getViewClassName

public java.lang.String getViewClassName()

Retrieves the name of the StepView class to use to edit this MatchStep object. If the name is null, then retrieves the base StepView class. Overrides the same method in the base Step class.

Overrides:

getViewClassName in class Step

Returns:

The name of the StepView class.

getEvaluatorClass

public java.lang.Class getEvaluatorClass()
                                  throws SelectionException

Retrieves the StepEvaluator class object that is associated with this MatchStep object. The QueryServer object uses this class to instantiate the appropriate StepEvaluator object.

Overrides:

getEvaluatorClass in class Step

Returns:

The Class object.

Throws:

SelectionException - If the StepEvaluator class is not found.