: Class RetrievalModalityUnit

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gov.nist.nlpir.irf.modality
Class RetrievalModalityUnit

java.lang.Object
  |
  +--gov.nist.nlpir.irf.modality.RetrievalModalityUnit

public class RetrievalModalityUnit
extends java.lang.Object

Container for a Retrieval Modality Unit (RMU) consisting of a featurename and corresponding indexing modality unit. The RMU models information that describes/controls the role a particular document feature (i.e., field) plays in a retrieval. This role is closely related to its analogue at indexing time: the indexing modality unit.

Version:: $Revision: 1.1 $
Author:: This software was produced by NIST, an agency of the U.S. government, and by statute is not subject to copyright in the United States. Recipients of this software assume all responsibilities associated with its operation, modification and maintenance.
See Also:: IndexingModalityUnit

Field Summary
`private java.lang.String`	`featureName` Name of the feature (i.e., field within a document) associated with this RMU
`private IndexingModalityUnit`	`imu` The indexing modality unit associated with this RMU

Constructor Summary
`RetrievalModalityUnit(java.lang.String f, IndexingModalityUnit i)`

Method Summary
`java.lang.String`	`getFeatureName()` Gets the feature name of this modality unit.
`java.lang.String`	`toString()` Returns a string representation of the RetrievalModalityUnit with its featureName and the corresponding IndexingModalityUnit.

Methods inherited from class java.lang.Object

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

Field Detail

featureName

private java.lang.String featureName

Name of the feature (i.e., field within a document) associated with this RMU

imu

private IndexingModalityUnit imu

The indexing modality unit associated with this RMU

Constructor Detail

RetrievalModalityUnit

public RetrievalModalityUnit(java.lang.String f,
                             IndexingModalityUnit i)

Parameters:: f - The feature name.; i - The indexing modality unit.

Method Detail

getFeatureName

public java.lang.String getFeatureName()

Gets the feature name of this modality unit.

Returns:: The feature name as a string.

toString

public java.lang.String toString()

Returns a string representation of the RetrievalModalityUnit with its featureName and the corresponding IndexingModalityUnit.

Returns:: the string representation of this RetrievalModalityUnit.
Overrides:: toString in class java.lang.Object