Class CarLibraryC

java.lang.Object
  |
  +--CarLibraryC

public class CarLibraryC

extends java.lang.Object

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 generalUpdate section of the User Manual.

Constructor Summary

CarLibraryC(ValueTuple valueTuple)

Method Summary

Collection[]	concatenate(Collection[] inCollections, ValueTuple vt) concatenates input document collections.
Collection[]	createFieldWeights(Collection[] inCollections, ValueTuple vt) Processes a diary determining which fields in the current context have changed value most often, and uses this to create a weights document.

Methods inherited from class java.lang.Object

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

Constructor Detail

CarLibraryC

public CarLibraryC(ValueTuple valueTuple)

Method Detail

createFieldWeights

public Collection[] createFieldWeights(Collection[] inCollections,
                                       ValueTuple vt)

Processes a diary determining which fields in the current context have changed value most often, and uses this to create a weights document.

Parameters:

obj - a Collection[] containing: 0 - the diary (a collection), 1 - the current context (a collection of usually one document)

vt - not used by this method

concatenate

public Collection[] concatenate(Collection[] inCollections,
                                ValueTuple vt)

concatenates input document collections. If a collection contains a single document which itself does not contain a note field, the note field will be inserted in the document.

Parameters:

obj - an array of collections i.e. Collection[] (but passed as an Object)

vt - a valueTuple (but not used for this method)

Returns:

a Collection[] ... the first element of which is the collection resulting from the concatenation