atg.search.routing.command.search
Class RankingGroupLoop

java.lang.Object
  atg.search.routing.command.search.RankingGroupBlock
      atg.search.routing.command.search.RankingGroupLoop

All Implemented Interfaces:

RankingGroup, java.io.Serializable

public class RankingGroupLoop
extends RankingGroupBlock

Ranking expression group for a loop structure

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

RankingGroupLoop()
Constructs an empty loop

RankingGroupLoop(java.util.List rankingGroups, java.lang.Integer initVal, java.lang.Integer finalVal)
Constructs an expression group

Method Summary

protected java.lang.String	getAttributesXML()
java.lang.Integer	getFinalVal() Returns final value for the loop iterator, or -1 for the end group
java.lang.Integer	getInitVal() Returns initial value for the loop iterator
protected java.lang.String	getType()
void	setFinalVal(java.lang.Integer finalVal) Sets final value for the loop iterator, or -1 for the end group
void	setInitVal(java.lang.Integer initVal) Sets initial value for the loop iterator

Methods inherited from class atg.search.routing.command.search.RankingGroupBlock

addRankingGroup, getRankingGroups, setRankingGroups, toXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

RankingGroupLoop

public RankingGroupLoop(java.util.List rankingGroups,
                        java.lang.Integer initVal,
                        java.lang.Integer finalVal)

Constructs an expression group

Parameters:

rankingGroups - ranking groups, maybe be empty but not null

initVal - initial value for the loop iterator, null for default

finalVal - final value for the loop iterator, or -1 for the end group, null for default

RankingGroupLoop

public RankingGroupLoop()

Constructs an empty loop

Method Detail

getFinalVal

public java.lang.Integer getFinalVal()

Returns final value for the loop iterator, or -1 for the end group

Returns:

final value for the loop iterator, or -1 for the end group

setFinalVal

public void setFinalVal(java.lang.Integer finalVal)

Sets final value for the loop iterator, or -1 for the end group

Parameters:

finalVal - final value for the loop iterator, or -1 for the end group

getInitVal

public java.lang.Integer getInitVal()

Returns initial value for the loop iterator

Returns:

initial value for the loop iterator

setInitVal

public void setInitVal(java.lang.Integer initVal)

Sets initial value for the loop iterator

Parameters:

initVal - initial value for the loop iterator

getType

protected java.lang.String getType()

Overrides:

getType in class RankingGroupBlock

getAttributesXML

protected java.lang.String getAttributesXML()

Overrides:

getAttributesXML in class RankingGroupBlock