: Class QueryModalityUnit

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.query
Class QueryModalityUnit

java.lang.Object
  |
  +--gov.nist.nlpir.irf.query.QueryModalityUnit

public class QueryModalityUnit
extends java.lang.Object

Holds Query Modality information to be used in retrieval.

Version:: $Revision: 1.2 $
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.

Field Summary
`private java.lang.String`	`attributeName` The name of the attribute associated with this query modality.
`private IdxWeightsWithMatchDegree`	`combiner` The combination of indexing weights and matching degree.
`private java.util.Vector`	`conditions`
`private java.lang.String`	`docType` The document type.
`private java.lang.String`	`indexName` The name of the index associated with this query modality unit.
`private Matcherbp`	`matcher` The Matcher object associated with this query modality unit.
`private int`	`number` Serves for accessing the appropriate collection of indexing features from the ordered collection of collections of indexing features derived for the query document.
`private double`	`thresholdMD` The matching threshold for this query modality.
`private double`	`weight` The weighting function for this query modality

Constructor Summary
`QueryModalityUnit(java.lang.String idx, Matcherbp ma, IdxWeightsWithMatchDegree co, java.lang.String doc, java.lang.String attr, double threshold)` Creates a QueryModalityUnit and initializes IndexName, DocType, AttributeName and ThresholdMD.

Method Summary
`java.lang.String`	`getAttributeName()` Gets the AttributeName of the QueryModalityUnit.
`IdxWeightsWithMatchDegree`	`getCombiner()` Gets the Combiner of the QueryModalityUnit.
`java.util.Vector`	`getConditions()` Gets the Conditions of the QueryModalityUnit.
`java.lang.String`	`getDocType()` Gets the DocType of the QueryModalityUnit.
`java.lang.String`	`getIndexName()` Gets the IndexName of the QueryModalityUnit.
`Matcherbp`	`getMatcher()` Gets the Matcher of the QueryModalityUnit.
`int`	`getNumber()` Gets the number of the QueryModalityUnit.
`double`	`getThresholdMD()` Gets the ThresholdMD of the QueryModalityUnit.
`double`	`getWeight()` Gets the Weight of the QueryModalityUnit.
`void`	`setConditions(java.util.Vector c)` Sets the Conditions of the QueryModalityUnit to c.
`void`	`setNumber(int n)` Sets the number of the QueryModalityUnit to c.
`void`	`setWeight(double w)` Sets the Weight of the QueryModalityUnit to c.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

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

Field Detail

indexName

private java.lang.String indexName

The name of the index associated with this query modality unit.

matcher

private Matcherbp matcher

The Matcher object associated with this query modality unit.

combiner

private IdxWeightsWithMatchDegree combiner

The combination of indexing weights and matching degree.

docType

private java.lang.String docType

The document type.

attributeName

private java.lang.String attributeName

The name of the attribute associated with this query modality.

thresholdMD

private double thresholdMD

The matching threshold for this query modality.

weight

private double weight

The weighting function for this query modality

number

private int number

Serves for accessing the appropriate collection of indexing features from the ordered collection of collections of indexing features derived for the query document.

conditions

private java.util.Vector conditions

Constructor Detail

QueryModalityUnit

public QueryModalityUnit(java.lang.String idx,
                         Matcherbp ma,
                         IdxWeightsWithMatchDegree co,
                         java.lang.String doc,
                         java.lang.String attr,
                         double threshold)

Creates a QueryModalityUnit and initializes IndexName, DocType, AttributeName and ThresholdMD. The Weight is set to 1.0 by default.

Parameters:: idx - Index name.; ma - Matcher; co - Combiner; doc - Document type.; attr - Attribute name.; threshold - ThresholdMD

Method Detail

setConditions

public void setConditions(java.util.Vector c)

Sets the Conditions of the QueryModalityUnit to c.

Parameters:: c - Conditions

getConditions

public java.util.Vector getConditions()

Gets the Conditions of the QueryModalityUnit.

Returns:: Conditions

getIndexName

public java.lang.String getIndexName()

Gets the IndexName of the QueryModalityUnit.

Returns:: Index name

getMatcher

public Matcherbp getMatcher()

Gets the Matcher of the QueryModalityUnit.

Returns:: Matcher

getCombiner

public IdxWeightsWithMatchDegree getCombiner()

Gets the Combiner of the QueryModalityUnit.

Returns:: Combiner

getDocType

public java.lang.String getDocType()

Gets the DocType of the QueryModalityUnit.

Returns:: Document type

getAttributeName

public java.lang.String getAttributeName()

Gets the AttributeName of the QueryModalityUnit.

Returns:: Attribute name

getThresholdMD

public double getThresholdMD()

Gets the ThresholdMD of the QueryModalityUnit.

Returns:: Threshold

getWeight

public double getWeight()

Gets the Weight of the QueryModalityUnit.

Returns:: Weight

setWeight

public void setWeight(double w)

Sets the Weight of the QueryModalityUnit to c.

Parameters:: w - Weight

getNumber

public int getNumber()

Gets the number of the QueryModalityUnit.

Returns:: number

setNumber

public void setNumber(int n)

Sets the number of the QueryModalityUnit to c.

Parameters:: n - number

toString

public java.lang.String toString()

Overrides:: toString in class java.lang.Object