org.apache.jetspeed.profiler.rules
Interface RuleCriterion

All Superinterfaces:

java.io.Serializable

public interface RuleCriterion
extends java.io.Serializable

A RuleCriterion specifies one criterion in a list of profiling rule criteria. This list is used to build normalized profiling locator and then locate a portal resource based on the request.

Version:

$Id: RuleCriterion.java 516448 2007-03-09 16:25:47Z ate $

Author:

David Sean Taylor

Field Summary

static int	FALLBACK_CONTINUE
static int	FALLBACK_LOOP
static int	FALLBACK_STOP

Method Summary

int	getFallbackOrder() Sets the fallback order for this criterion.
int	getFallbackType() Gets the fallback type for this criterion.
java.lang.String	getName() Gets the name of the parameter, attribute or property in the portal request.
java.lang.String	getRuleId() Gets the unique rule identifier for the associated owner rule
java.lang.String	getType() Gets the rule request type for this specific criterion.
java.lang.String	getValue() Gets the value of the parameter, attribute or property in the portal request.
void	setFallbackOrder(int order) Gets the fallback order for this criterion.
void	setFallbackType(int order) Sets the fallback type for this criterion.
void	setName(java.lang.String name) Sets the name of the parameter, attribute or property in the portal request.
void	setRuleId(java.lang.String ruleId) Sets the unique rule identifier for the associated owner rule
void	setType(java.lang.String type) Sets the rule request type for this specific criterion.
void	setValue(java.lang.String value) Sets the value of the parameter, attribute or property in the portal request.

Field Detail

FALLBACK_CONTINUE

static final int FALLBACK_CONTINUE

See Also:

Constant Field Values

FALLBACK_STOP

static final int FALLBACK_STOP

See Also:

Constant Field Values

FALLBACK_LOOP

static final int FALLBACK_LOOP

See Also:

Constant Field Values

Method Detail

getType

java.lang.String getType()

Gets the rule request type for this specific criterion. Rule types determine which type of request property, parameter or attribute to look at when building a profiling locator.

Returns:

The request type associated with this criterion.

setType

void setType(java.lang.String type)

Sets the rule request type for this specific criterion. Rule types determine which type of request property, parameter or attribute to look at when building a profiling locator.

Parameters:

The - request type associated with this criterion.

getFallbackOrder

int getFallbackOrder()

Sets the fallback order for this criterion. Lower numbers are returned first during iteration. Higher numbers should be put on the locator stack first.

Returns:

The fallback order for this criterion.

setFallbackOrder

void setFallbackOrder(int order)

Gets the fallback order for this criterion. Lower numbers are returned first during iteration. Higher numbers should be put on the locator stack first.

Parameters:

order - The fallback order for this criterion.

getFallbackType

int getFallbackType()

Gets the fallback type for this criterion. Fallback types are used when locating a profiled resource. The type tells the Profiling rule what to do next on failed criterion matching. Known values: FALLBACK_CONTINUE - evaluate this criterion and if it fails continue to the next criterion FALLBACK_STOP - evaluate this criterion and if it fails stop evaluation criteria for this rule FALLBACK_LOOP - evaluate this criterion and if it fails continue evaluating

Returns:

The fallback type for this criterion, should be a valid value as shown above.

setFallbackType

void setFallbackType(int order)

Sets the fallback type for this criterion. Fallback types are used when locating a profiled resource. The type tells the Profiling rule what to do next on failed criterion matching. Known values: FALLBACK_CONTINUE - evaluate this criterion and if it fails continue to the next criterion FALLBACK_STOP - evaluate this criterion and if it fails stop evaluation criteria for this rule FALLBACK_LOOP - evaluate this criterion and if it fails continue evaluating

Parameters:

The - fallback type for this criterion, should be a valid value as shown above.

getName

java.lang.String getName()

Gets the name of the parameter, attribute or property in the portal request. This name is used to lookup the value of the request parameter, attribute, or property when building a profile locator.

Returns:

The name of the request parameter, attribute or property.

setName

void setName(java.lang.String name)

Sets the name of the parameter, attribute or property in the portal request. This name is used to lookup the value of the request parameter, attribute, or property when building a profile locator.

Parameters:

The - name of the request parameter, attribute or property.

getValue

java.lang.String getValue()

Gets the value of the parameter, attribute or property in the portal request.

Returns:

The value of the request parameter, attribute or property.

setValue

void setValue(java.lang.String value)

Sets the value of the parameter, attribute or property in the portal request.

Parameters:

The - value of the request parameter, attribute or property.

getRuleId

java.lang.String getRuleId()

Gets the unique rule identifier for the associated owner rule

Returns:

The rule's unique identifier

setRuleId

void setRuleId(java.lang.String ruleId)

Sets the unique rule identifier for the associated owner rule

Parameters:

id - The rule's unique identifier