CAR (Context-Aware Retrieval) v1.0

Class CarLibraryA

java.lang.Object
  |
  +--CarLibraryA
All Implemented Interfaces:
CarFace

public class CarLibraryA
extends java.lang.Object
implements CarFace

This class contains a constructor and methods that are accessible to the CAR researcher through parameter fields of the session control file.

Its use is explained and exemplified in the documentUpdate section of the User Manual.


Fields inherited from interface CarFace
BOOLEAN_LITERAL, COLLECTION, DOUBLE_LITERAL, EXTERNAL, grammarNames, INTERNAL, KEYPHRASE, LITERALcapacityIncrement, LITERALinitialCapacity, MARKUP, SERIAL, SESSION, STRING_LITERAL, STRINGVALUE_LITERAL
 
Constructor Summary
CarLibraryA(ValueTuple valueTuple)
          for system programmer's use only
 
Method Summary
 void celsiusToFahrenheit(Document doc, ValueTuple vt)
          converts the value in a temperature field from Celsius to Fahrenheit
 void fahrenheitToCelsius(Document doc, ValueTuple vt)
          converts the value in a temperature field from Fahrenheit to Celsius
 void setScores(Document doc, ValueTuple vt)
          sets the score attribute of all fields in a given document to the given value.
 void setWeights(Document doc, ValueTuple vt)
          sets the weight attribute of all fields in a given document, that match the given field name, to the given value.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CarLibraryA

public CarLibraryA(ValueTuple valueTuple)
for system programmer's use only
Method Detail

setScores

public void setScores(Document doc,
                      ValueTuple vt)
sets the score attribute of all fields in a given document to the given value.
Parameters:
doc - the document to be updated.
vt - a ValueTuple containing 2 strings - the method name and the score
See Also:
ValueTuple

setWeights

public void setWeights(Document doc,
                       ValueTuple vt)
sets the weight attribute of all fields in a given document, that match the given field name, to the given value.
Parameters:
doc - the document to be updated.
vt - a valueTuple containing 3 strings - the method name, the field name, and the weight value
See Also:
ValueTuple

celsiusToFahrenheit

public void celsiusToFahrenheit(Document doc,
                                ValueTuple vt)
converts the value in a temperature field from Celsius to Fahrenheit
Parameters:
doc - the document to be updated.
vt - a valueTuple containing 1 string - the method name
See Also:
ValueTuple

fahrenheitToCelsius

public void fahrenheitToCelsius(Document doc,
                                ValueTuple vt)
converts the value in a temperature field from Fahrenheit to Celsius
Parameters:
doc - the document to be updated.
vt - a valueTuple containing 1 string - the method name
See Also:
ValueTuple

CAR (Context-Aware Retrieval) v1.0

Submit bugs to Lindsey