atg.search.routing.command.search
Class RankingGroupOp

java.lang.Object
  atg.search.routing.command.search.RankingGroupOp

All Implemented Interfaces:

RankingGroup, java.io.Serializable

public class RankingGroupOp
extends java.lang.Object
implements java.io.Serializable, RankingGroup

Ranking group operation.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

RankingGroupOp()

RankingGroupOp(OpType opType, java.lang.String value)

Method Summary

OpType	getOpType() Returns the operation type
java.lang.String	getValue() Returns the value
void	setOpType(OpType opType) Sets the operation type
void	setValue(java.lang.String value) Sets the value
java.lang.String	toXML() Converts the ranking group to xml for submission to the engine.

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

RankingGroupOp

public RankingGroupOp(OpType opType,
                      java.lang.String value)

Parameters:

value - Apply the specified operation to this value, which can be a floating point constant (0-1000); $relevance (for the internal statement relevancy score); $weight (for the internal document relevancy score); and $size (for the size of the result group)

RankingGroupOp

public RankingGroupOp()

Method Detail

getOpType

public OpType getOpType()

Returns the operation type

Returns:

the operation type

setOpType

public void setOpType(OpType opType)

Sets the operation type

Parameters:

opType - the operation type

getValue

public java.lang.String getValue()

Returns the value

Returns:

the value

setValue

public void setValue(java.lang.String value)

Sets the value

Parameters:

value - the value

toXML

public java.lang.String toXML()

Description copied from interface: RankingGroup

Converts the ranking group to xml for submission to the engine.

Specified by:

toXML in interface RankingGroup

Returns:

the ranking group xml