Class CarLibraryB

java.lang.Object
  |
  +--CarLibraryB

public class CarLibraryB

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

Constructor Summary

CarLibraryB(ValueTuple valueTuple)

Method Summary

Collection	concatenate(java.lang.Object obj, ValueTuple vt) concatenates input document collections.
Collection	delete(Collection docs, ValueTuple vt) deletes the document (any documents) with the given id in the field.
Collection	identify(Collection docs, ValueTuple vt) sets the id attribute value in the field of each document.

Methods inherited from class java.lang.Object

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

Constructor Detail

CarLibraryB

public CarLibraryB(ValueTuple valueTuple)

Method Detail

identify

public Collection identify(Collection docs,
                           ValueTuple vt)

sets the id attribute value in the field of each document. Values are prefixed by a given string and then given an ascending serial number starting at 0.

Parameters:

docs - the collection to be updated.

vt - a valueTuple containing 2 strings - the method name and the prefix of the id value

See Also:

ValueTuple

delete

public Collection delete(Collection docs,
                         ValueTuple vt)

deletes the document (any documents) with the given id in the field.

Parameters:

docs - the collection to be updated.

vt - a valueTuple containing 2 strings - the method name and the value of the id

See Also:

ValueTuple

concatenate

public Collection concatenate(java.lang.Object obj,
                              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:

the collection resulting from the concatenation