uk.ac.gla.terrier.structures.trees
Class FieldDocumentTreeNode

java.lang.Object
  uk.ac.gla.terrier.structures.trees.TreeNode
      uk.ac.gla.terrier.structures.trees.FieldDocumentTreeNode

All Implemented Interfaces:

java.lang.Comparable<TreeNode>

Direct Known Subclasses:

BlockFieldDocumentTreeNode

Deprecated.

public class FieldDocumentTreeNode
extends TreeNode

The tree node used by the class FieldDocumentTree, when building the direct file with field information.

Version:

$Revision: 1.12 $

Author:

Douglas Johnson, Vassilis Plachouras

See Also:

FieldDocumentTree

Field Summary

FieldDocumentTreeNode	left Deprecated. The left child of the node.
FieldDocumentTreeNode	right Deprecated. The right child of the node.

Fields inherited from class uk.ac.gla.terrier.structures.trees.TreeNode

frequency, term, termCode

Constructor Summary

FieldDocumentTreeNode(java.lang.String newTerm)
Deprecated. Constructs a tree node for the given term.

FieldDocumentTreeNode(java.lang.String newTerm, int givenTermCode)
Deprecated. Constructs a tree node for the given term, if the term code is already known.

FieldDocumentTreeNode(java.lang.String newTerm, java.util.Set<java.lang.String> fields)
Deprecated. Constructs a tree node for the given term that appears within the given fields.

FieldDocumentTreeNode(java.lang.String newTerm, java.lang.String field)
Deprecated. Constructs a tree node for the given term that appears within a field.

Method Summary

void	addToFieldScore(java.util.Set<java.lang.String> fields) Deprecated. Adds the fields to the field score of the tree node.
void	addToFieldScore(java.lang.String field) Deprecated. Adds the field to the field score of the tree node.
int	getFieldScore() Deprecated. Gets the field score of the tree node.

Methods inherited from class uk.ac.gla.terrier.structures.trees.TreeNode

compareTo, equals

Methods inherited from class java.lang.Object

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

Field Detail

left

public FieldDocumentTreeNode left

Deprecated.

The left child of the node.

right

public FieldDocumentTreeNode right

Deprecated.

The right child of the node.

Constructor Detail

FieldDocumentTreeNode

public FieldDocumentTreeNode(java.lang.String newTerm)

Deprecated.

Constructs a tree node for the given term.

Parameters:

newTerm - the term

FieldDocumentTreeNode

public FieldDocumentTreeNode(java.lang.String newTerm,
                             int givenTermCode)

Deprecated.

Constructs a tree node for the given term, if the term code is already known.

Parameters:

newTerm - the term

givenTermCode - the term code to use if it is already known

FieldDocumentTreeNode

public FieldDocumentTreeNode(java.lang.String newTerm,
                             java.lang.String field)

Deprecated.

Constructs a tree node for the given term that appears within a field.

Parameters:

newTerm - the term

field - the field containing this term

FieldDocumentTreeNode

public FieldDocumentTreeNode(java.lang.String newTerm,
                             java.util.Set<java.lang.String> fields)

Deprecated.

Constructs a tree node for the given term that appears within the given fields.

Parameters:

fields - HashSet the fields in which the term appears

Method Detail

addToFieldScore

public void addToFieldScore(java.lang.String field)

Deprecated.

Adds the field to the field score of the tree node.

Parameters:

field - String the field to add to the field score

addToFieldScore

public void addToFieldScore(java.util.Set<java.lang.String> fields)

Deprecated.

Adds the fields to the field score of the tree node.

Parameters:

fields - HashSet the fields to add to the field score

getFieldScore

public int getFieldScore()

Deprecated.

Gets the field score of the tree node.

Returns:

the field score