org.pageseeder.smith.function

Class ScoreArray

java.lang.Object

org.pageseeder.smith.function.ScoreFunctionBase

org.pageseeder.smith.function.ScoreArray

All Implemented Interfaces:

ScoreFunction, Scriptable

public final class ScoreArray
extends ScoreFunctionBase
implements ScoreFunction, Scriptable

A utility class for scores

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ARRAY_SIZE The maximum size of the array.

Constructor Summary

Constructors

Constructor and Description
ScoreArray() Creates a new index of scores where all scores return 0;
ScoreArray(int[] scores) Creates a new index of scores.

Method Summary

Modifier and Type	Method and Description
int	get(int i) Returns the score for the specified index.
protected static ScoreArray	linearRange(int from, int to) Linear Range
static ScoreArray	parse(java.util.Map<java.lang.String,java.lang.String> config)
protected int[]	scores()
java.lang.Appendable	toScript(java.lang.Appendable script) Writes the script for the object on to the specified writer.
java.lang.String	toString()

Methods inherited from class org.pageseeder.smith.function.ScoreFunctionBase

type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pageseeder.smith.ScoreFunction

type

Field Detail

MAX_ARRAY_SIZE

public static final int MAX_ARRAY_SIZE

The maximum size of the array.

See Also:

Constant Field Values

Constructor Detail

ScoreArray

public ScoreArray()

Creates a new index of scores where all scores return 0;

ScoreArray

public ScoreArray(int[] scores)

Creates a new index of scores.

Method Detail

get

public int get(int i)

Returns the score for the specified index.

Specified by:

get in interface ScoreFunction

Parameters:

i - The index

Returns:

the score at that index.

scores

protected int[] scores()

Returns:

a copy of the internal array.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parse

public static ScoreArray parse(java.util.Map<java.lang.String,java.lang.String> config)

Parameters:

config - the configuration

Returns:

the corresponding array

linearRange

protected static ScoreArray linearRange(int from,
                                        int to)

Linear Range

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