ivory.smrf.model.potential

Class PotentialFunction

java.lang.Object

ivory.smrf.model.potential.PotentialFunction

Direct Known Subclasses:

DocumentPotential, QueryPotential

public abstract class PotentialFunction
extends Object

Abstract base class for potential functions.

Author:

Don Metzler

Constructor Summary

Constructors

Constructor and Description
PotentialFunction()

Method Summary

Methods

Modifier and Type	Method and Description
abstract float	computePotential()
abstract void	configure(RetrievalEnvironment env, Node domNode)
static PotentialFunction	create(RetrievalEnvironment env, String type, Node functionNode)
abstract float	getMaxScore()
abstract float	getMinScore()
abstract int	getNextCandidate()
abstract void	initialize(List<GraphNode> nodes, GlobalEvidence evidence)
abstract void	reset()
abstract void	setNextCandidate(int docno)

Methods inherited from class java.lang.Object

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

Constructor Detail

PotentialFunction

public PotentialFunction()

Method Detail

computePotential

public abstract float computePotential()

configure

public abstract void configure(RetrievalEnvironment env,
             Node domNode)
                        throws ConfigurationException

Throws:

ConfigurationException

create

public static PotentialFunction create(RetrievalEnvironment env,
                       String type,
                       Node functionNode)
                                throws ConfigurationException

Throws:

ConfigurationException

getMaxScore

public abstract float getMaxScore()

getMinScore

public abstract float getMinScore()

getNextCandidate

public abstract int getNextCandidate()

initialize

public abstract void initialize(List<GraphNode> nodes,
              GlobalEvidence evidence)
                         throws ConfigurationException

Throws:

ConfigurationException

reset

public abstract void reset()

setNextCandidate

public abstract void setNextCandidate(int docno)