org.pageseeder.smith.function

Class LinearScore

java.lang.Object

org.pageseeder.smith.function.LinearScore

All Implemented Interfaces:

ScoreFunction, Scriptable

public class LinearScore
extends java.lang.Object
implements ScoreFunction, Scriptable

Returns the score linearly based on the given value.

Field Summary

Fields

Modifier and Type	Field and Description
static LinearScore	IDENTITY Linear scoring implementing an identity function.

Constructor Summary

Constructors

Constructor and Description
LinearScore() Creates a new linear score with a factor of 1.
LinearScore(int factor) Creates a new linear score with the specified factor;

Method Summary

Modifier and Type	Method and Description
int	factor()
int	get(int value) Returns the score based on the specified value.
java.lang.Appendable	toScript(java.lang.Appendable script) Writes the script for the object on to the specified writer.
java.lang.String	type() Returns the type for this function.

Methods inherited from class java.lang.Object

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

Field Detail

IDENTITY

public static final LinearScore IDENTITY

Linear scoring implementing an identity function.

Constructor Detail

LinearScore

public LinearScore()

Creates a new linear score with a factor of 1.

LinearScore

public LinearScore(int factor)

Creates a new linear score with the specified factor;

Parameters:

factor - the factor to apply.

Method Detail

factor

public int factor()

Returns:

the factor applied to the score.

type

public java.lang.String type()

Description copied from interface: ScoreFunction

Returns the type for this function.

Specified by:

type in interface ScoreFunction

Returns:

always "linear"

get

public int get(int value)

Description copied from interface: ScoreFunction

Returns the score based on the specified value.

Specified by:

get in interface ScoreFunction

Parameters:

value - The value

Returns:

the corresponding score.

toScript

public java.lang.Appendable toScript(java.lang.Appendable script)
                              throws java.io.IOException

Description copied from interface: Scriptable

Writes the script for the object on to the specified writer.

Specified by:

toScript in interface Scriptable

Parameters:

script - Where to write the script.

Returns:

A reference to this Appendable

Throws:

java.io.IOException - If an I/O error occurs