Home >	Contents >	Index >

Expanded TOC   |    Accordion TOC   |    Annotated TOC   |    Index

FTValList

An FTValList is a list of name/value pairs. The name is the key, and it must be unique in the list. The value is represented using the FTVAL class.

Use FTValList to pass arguments to Content Server subsystems like the CatalogManager and TreeManager, to pass named values into Seed classes being called using the CALLJAVA tag, and to return a set of variables to the element containing the CALLJAVA tag. The ARGUMENT tag is used in the CALLJAVA tag to add name/value pairs to the FTValList; those name/value pairs are then passed to the Execute method of the class being called.

FTValList Constructors

An FTValList will grow as necessary to accommodate new elements. However, it is most efficient if it starts with the capacity to hold a small number of elements, rather than growing from a size of zero. Use the following constructor to specify an initial capacity:

FTValList(int x); 

where x is the number of name/value pairs that the list can hold.

If you use the default constructor FTValList(), the default size is 32 name/value pairs.

---

List of Methods

FTValList supports the following nondeprecated methods:

 

List of FTValList Methods

Method	Summary
alphaSortedKeys	Returns an enumeration of keys, sorted alphabetically.
copy	Creates a copy of this list.
count	Returns a count of the number of name/value pairs in this list.
equals	Determines if two lists are equal.
get	Returns value, regardless of data type.
getVal	Gets the value associated with the specified key.
getValBLOB	Gets the blob of type byte[] that corresponds to the specified key name.
getValBLOBSize	Gets the size of the blob (Binary Large Object) that is associated with the specified key.
getValInt	Gets the integer value associated with the specified key.
getValString	Gets the string value that is associated with the specified key.
keys	Returns an enumeration of key names.
keysVector	Returns a vector of keys.
parse	Converts a string of form "a=b&c=d&..." to an FTValList.
put	Associates a value with a specified key.
remove	Removes one item from this list.
removeAll	Removes all items from this list.
setVal	Adds an FTVal object to this list.
setValBLOB	Adds a blob to this list, using the associated key name.
setValBLOBFile	Adds a blob file to this list, using the associated key name.
setValInt	Adds an integer value to this list.
setValString	Adds a String value to this list.
sortedKeys	Returns an enumeration of key names, sorted longest to shortest.

 

 

		Home >	Contents >	Index >
	FatWire JAVA Reference Copyright 2005 by FatWire Software All rights reserved.