File 'lib/indexBase.cls' (part of 'AutoDOC')

Description (short): General interface of an index.
Written by: Andreas Kupries
Description: General interface of an index.
Keywords: indices, general interface to index.

Class 'indexBase'

Description

Baseclass of all indices. Contains their common behaviour and member variables.

Superclasses

distInterface
formatterInterface
problemIndex

Methods

public: addItem (item)
clear ()
code ()
getRef (name)
itemByName (name)
items ()
link ()
name ()
number ()
page ()
ref (name)
refError (name)
title ()
write ()
writeIndexBody ()
~indexBase ()

Membervariables

public: indexPage
indexName
indexTitle
indexShortTitle
entity
items
name2Item
refs

Methods

addItem (item)

Adds an item to the index. The item has to support the interface provided by indexBaseEntry.

Argument: item Handle of the object added to the index.

clear ()

Overrides problemIndex:clear
Resets state information and destroys the indexed objects.

code ()

Returns: The internal logicval name of the index.

getRef (name)

Determines wether name is a registered item or not and returns appropriately formatted text (a hyperlink, or the name, marked as error). Indirectly used by distribution:crResolve to resolve embedded crossreferences. The workhorse method, called by ref, but only if the cache does not have the answer.

Argument: name The name of the item to look for.

Returns: Formatted text for hyperlink to definition of name or a error markup for unknown entities.

itemByName (name)

Argument: name The name of the object searched by the caller.

Returns: The object having the specified name.

items ()

Returns: A list containing the items registered in the index.

link ()

Returns: A string containing a hyperlink to the page of this index.

name ()

Returns: The name of the index, as used by the jumpbars.

number ()

Returns: The number of registered items

page ()

Notes: The codes assumes that only one index exists.

Returns: The filename of the page containing the index.

ref (name)

Determines wether name is a registered item or not and returns appropriately formatted text (a hyperlink, or the name, marked as error). Indirectly used by distribution:crResolve to resolve embedded crossreferences. Uses an internal cache to speed processing.

Argument: name The name of the item to look for.

Returns: Formatted text for hyperlink to definition of name or a error markup for unknown entities.

refError (name)

Argument: name The name of the unknown entity.

Returns: A string formatted as error for cross references to unknown entities. Additionally adds the error to the list of problems associated to the entity containing the bogus cross reference.

title ()

Returns: The title of the index.

write ()

Generates and writes the index.

writeIndexBody ()

Generates the body of the index. Indices having specialities should override this method, not write to get the frame for free.

~indexBase ()

Destructor, clears out all state information.

Membervariables

indexPage: The name of the page to use for the index during output.
indexName: The internal logical name of the index, used to control the generation of its jumpbar.
indexTitle: The name of the index, used as the title of its page.
indexShortTitle: The short name of the index, as used in the jumpbars.
entity: Description of the entities referenced by a concrete index.
initial value: entity
items: List of objects known to the index.
name2Item: Mapping from the object names to their handles.
refs: Cache holding the results of all calls to ref.

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,

addItem (item)
Adds an item to the index. The item has to support the interface provided by indexBaseEntry.
Argument: item	Handle of the object added to the index.

clear ()
Overrides problemIndex:clear Resets state information and destroys the indexed objects.

getRef (name)
Determines wether name is a registered item or not and returns appropriately formatted text (a hyperlink, or the name, marked as error). Indirectly used by distribution:crResolve to resolve embedded crossreferences. The workhorse method, called by ref, but only if the cache does not have the answer.
Argument: name	The name of the item to look for.
Returns: Formatted text for hyperlink to definition of name or a error markup for unknown entities.

itemByName (name)
Argument: name	The name of the object searched by the caller.
Returns: The object having the specified name.

items ()
Returns: A list containing the items registered in the index.

link ()
Returns: A string containing a hyperlink to the page of this index.

name ()
Returns: The name of the index, as used by the jumpbars.

page ()
Notes: The codes assumes that only one index exists.
Returns: The filename of the page containing the index.

ref (name)
Determines wether name is a registered item or not and returns appropriately formatted text (a hyperlink, or the name, marked as error). Indirectly used by distribution:crResolve to resolve embedded crossreferences. Uses an internal cache to speed processing.
Argument: name	The name of the item to look for.
Returns: Formatted text for hyperlink to definition of name or a error markup for unknown entities.

refError (name)
Argument: name	The name of the unknown entity.
Returns: A string formatted as error for cross references to unknown entities. Additionally adds the error to the list of problems associated to the entity containing the bogus cross reference.

writeIndexBody ()
Generates the body of the index. Indices having specialities should override this method, not write to get the frame for free.