de.unidu.is.retrieval.pire.dt
Interface DT

All Known Implementing Classes:

AbstractDT

public interface DT

A class for an IR datatype.

Since:

2004-08-16

Version:

$Revision: 1.8 $, $Date: 2005/02/21 17:29:25 $

Author:

Henrik Nottelmann

Method Summary

void	addProbRules(Index index, java.lang.String queryID, java.lang.String subqueryID, java.lang.String operator, java.util.List addList) Adds rules for computing probabilities of relevance to the list.
void	addRSVRules(Index index, java.lang.String queryID, java.lang.String subqueryID, java.lang.String operator, double weight, java.lang.Object value, java.util.List addList) Adds rules for evaluating the specified query condition to the specified list.
void	addToIndex(Index index, java.lang.String docID, java.lang.String operator, java.lang.Object value) Add the document content of the specified index.
void	computeIndex(Index index, java.lang.String operator) Computes the indexing weights for the specified index and the operator.
java.lang.String	convertOperator(java.lang.String operator) Converts the operator name into an identifier.
java.util.Iterator	getIndexTokens(Index index, java.lang.String operator) Returns an iterator over all tokens for whom the indexing weight moments have to be computed.
void	removeIndex(Index index, java.lang.String operator) Removes the datatype/operator specific relations from the specified index.
boolean	storedRSVs(java.lang.String operator) Tests whether the RSVs are already stored in the weight table, or if they are computed from outside.

Method Detail

convertOperator

public java.lang.String convertOperator(java.lang.String operator)

Converts the operator name into an identifier.

Parameters:

operator - search operator name

Returns:

identifier for operator

addToIndex

public void addToIndex(Index index,
                       java.lang.String docID,
                       java.lang.String operator,
                       java.lang.Object value)

Add the document content of the specified index.

The specified value is applied to the filter corresponding to the operator filter, and the resulting tokens are added to the tf relation (together with the document id and the frequency of the token).

Parameters:

index - underlying index

docID - document id

operator - search operator name

value - attribute value

computeIndex

public void computeIndex(Index index,
                         java.lang.String operator)

Computes the indexing weights for the specified index and the operator.

The indexing weights are computed based on the tf relation.

Parameters:

index - underlying index

operator - search operator name

getIndexTokens

public java.util.Iterator getIndexTokens(Index index,
                                         java.lang.String operator)

Returns an iterator over all tokens for whom the indexing weight moments have to be computed. TODO: really useful?

Parameters:

index - underlying index

operator - search operator name

Returns:

iterator over all tokens

removeIndex

public void removeIndex(Index index,
                        java.lang.String operator)

Removes the datatype/operator specific relations from the specified index.

Parameters:

index - underlying index

operator - search operator name

storedRSVs

public boolean storedRSVs(java.lang.String operator)

Tests whether the RSVs are already stored in the weight table, or if they are computed from outside. TODO: why do we need that?

Parameters:

operator - search operator name

Returns:

true, if the RSVs are already stored

addRSVRules

public void addRSVRules(Index index,
                        java.lang.String queryID,
                        java.lang.String subqueryID,
                        java.lang.String operator,
                        double weight,
                        java.lang.Object value,
                        java.util.List addList)

Adds rules for evaluating the specified query condition to the specified list.

Parameters:

index - underlying index

queryID - query id

subqueryID - subquery id

operator - search operator name

weight - condition weight

value - comparison value

addList - list to where the condition rules have to be added

addProbRules

public void addProbRules(Index index,
                         java.lang.String queryID,
                         java.lang.String subqueryID,
                         java.lang.String operator,
                         java.util.List addList)

Adds rules for computing probabilities of relevance to the list. The probabilities of relevance are computed from the RSVs (probabilities of inference) by applying a mapping function.

Parameters:

index - underlying index

queryID - query id

subqueryID - subquery id

operator - search operator name

addList - list to which rules can be appended