org.eml.sir.rel.disc
Class RelatednessResult

java.lang.Object
  org.eml.sir.rel.disc.RelatednessResult

public class RelatednessResult

extends java.lang.Object

The result that a SearchRanker creates.

Author:

Hendrik Niederlich (EML-R)

Constructor Summary

RelatednessResult()
Create a new RelatednessResult instance.

Method Summary

void	createAlphabeticalFile(java.lang.String fileName) Create human readable file, ordered alphabeticaly.
void	createExplanationFile(java.lang.String fileName) Create explanation file.
void	createRelatednessFile(java.lang.String fileName) Create human readable file, ordered by relatedness.
static void	createTrecFile(java.util.ArrayList results, java.lang.String fileName) Create TREC file.
void	dropExplanations() Drop the explanations of this RelatednessResult instance.
void	setExplanations(java.util.HashMap explanations) Set explanations.
void	setInfo(java.lang.String info) Set the info regarding this result.
void	setProfessionNames(java.util.HashMap profNames) Set the profession names.
void	setProfessionsAlphabetical(java.util.ArrayList alphabet) Set alpabetical ordered professions list.
void	setQueryFile(java.lang.String queryFile) Set query file's name.
void	setRanking(java.util.ArrayList ranking) Set the ranking list.
void	setScores(java.util.HashMap scores) Set the scores.
void	setWords(java.util.ArrayList words) Set query words.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelatednessResult

public RelatednessResult()

Create a new RelatednessResult instance.

Method Detail

setQueryFile

public void setQueryFile(java.lang.String queryFile)

Set query file's name.

setWords

public void setWords(java.util.ArrayList words)

Set query words.

setProfessionsAlphabetical

public void setProfessionsAlphabetical(java.util.ArrayList alphabet)

Set alpabetical ordered professions list.

setExplanations

public void setExplanations(java.util.HashMap explanations)

Set explanations.

dropExplanations

public void dropExplanations()

Drop the explanations of this RelatednessResult instance. This nay help saving memory for explanations my get quiet large.

setProfessionNames

public void setProfessionNames(java.util.HashMap profNames)

Set the profession names.

setRanking

public void setRanking(java.util.ArrayList ranking)

Set the ranking list.

setScores

public void setScores(java.util.HashMap scores)

Set the scores.

setInfo

public void setInfo(java.lang.String info)

Set the info regarding this result.

createRelatednessFile

public void createRelatednessFile(java.lang.String fileName)
                           throws java.io.IOException

Create human readable file, ordered by relatedness.

Throws:

java.io.IOException

createAlphabeticalFile

public void createAlphabeticalFile(java.lang.String fileName)
                            throws java.io.IOException

Create human readable file, ordered alphabeticaly.

Throws:

java.io.IOException

createTrecFile

public static void createTrecFile(java.util.ArrayList results,
                                  java.lang.String fileName)
                           throws java.io.IOException

Create TREC file.

Parameters:

results - List of RelatednessResult instances in ranking order.

Throws:

java.io.IOException

createExplanationFile

public void createExplanationFile(java.lang.String fileName)
                           throws java.io.IOException

Create explanation file.

Throws:

java.io.IOException