ORG.oclc.obi.util
Class TopicEntry

java.lang.Object
  |
  +--ORG.oclc.obi.util.TopicEntry

public class TopicEntry

extends Object

The TopicEntry class describes each Topic area defined in the JaSSI configuration file(s). This information is used to build lists Topic Areas as HTML for display in the interface.

See Also:

Topics, IniFile, Db

Field Summary

String	allDbNames Space seperated sorted list of allowed dbnames
Hashtable	dbCheckBoxes Hashtable of currently selected database name(s) for this TopicEntry
Vector	dbNames Vector of allowed dbname(s)
Vector	disallowedNames Vector of disallowed dbname(s)
String	longName Long descriptive name of the Topic Area
String	topicName Internal name of the Topic Area
boolean	userDefinedTopic Flag to indicate for this user only

Constructor Summary

TopicEntry()
Constructs a TopicEntry object.

TopicEntry(String topicName, IniFile ini)
Constructs a TopicEntry object by reading server configuration information from the input iniFile.

TopicEntry(String topicName, String longName, Vector dbnames, Vector disallowedNames, String dbGroup)
Constructs a TopicEntry object by setting the longname and the dblist vector.

TopicEntry(String topicName, String longName, Vector dbnames, Vector disallowedNames, String dbGroup, boolean userDefinedTopic)
Constructs a TopicEntry object by setting the longname and the dblist vector.

Method Summary

void	addDbName(String dbname) Add a database to this TopicEntry allowed database list
String	allDbNames() Retrieves a space separated list of all the database names for this TopicEntry.
String	dbGroup() Retrieves the dbGroup for this TopicEntry
Vector	dbNames() Retrieves the Vector of allowed database names for this TopicEntry.
void	deleteDbName(String dbname) Delete a database name from this TopicEnty's allowed list
String	longName() Retrieves the long (descriptive) name of this TopicEntry
String	topicName() Retrieves the internal name of a TopicEntry
String	toString() Generates the String representation of this TopicEntry
void	updateDbs(Vector dbNames) Replace the allowed database list for this TopicEntry
void	updateLongName(String name) Change the longName of this TopicEntry
boolean	userDefinedTopic() Check the user-defined (for this user only) charateristic for this TopicEntry.

Methods inherited from class java.lang.Object

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

Field Detail

dbNames

public Vector dbNames

Vector of allowed dbname(s)

disallowedNames

public Vector disallowedNames

Vector of disallowed dbname(s)

longName

public String longName

Long descriptive name of the Topic Area

topicName

public String topicName

Internal name of the Topic Area

allDbNames

public String allDbNames

Space seperated sorted list of allowed dbnames

userDefinedTopic

public boolean userDefinedTopic

Flag to indicate for this user only

dbCheckBoxes

public Hashtable dbCheckBoxes

Hashtable of currently selected database name(s) for this TopicEntry

Constructor Detail

TopicEntry

public TopicEntry()

Constructs a TopicEntry object.

TopicEntry

public TopicEntry(String topicName,
                  String longName,
                  Vector dbnames,
                  Vector disallowedNames,
                  String dbGroup)

Constructs a TopicEntry object by setting the longname and the dblist vector.

Parameters:

topicName - the name of the topic area

longName - the long name of the topic area

dbnames - a vector of database names for the TopicEntry

dissallowedName - a vector of database names that CANNOT be part of the TopicEntry

dbGroup - the name of the Database Group Definition to use for searching this topic

TopicEntry

public TopicEntry(String topicName,
                  String longName,
                  Vector dbnames,
                  Vector disallowedNames,
                  String dbGroup,
                  boolean userDefinedTopic)

Constructs a TopicEntry object by setting the longname and the dblist vector.

Parameters:

topicName - the name of the topic area

longName - the long name of the topic area

dbnames - a vector of database names for the TopicEntry

dissallowedName - a vector of database names that CANNOT be part of the TopicEntry

dbGroup - the name of the Database Group Definition to use for searching this topic

userDefinedTopic - boolean to indicate if this TopicEntry is for this user only

TopicEntry

public TopicEntry(String topicName,
                  IniFile ini)

Constructs a TopicEntry object by reading server configuration information from the input iniFile.

Parameters:

topicName - the topic area name

ini - the JaSSI configuration ini file

Method Detail

allDbNames

public String allDbNames()

Retrieves a space separated list of all the database names for this TopicEntry.

Returns:

String space separated list sorted list of allowed dbnames

addDbName

public void addDbName(String dbname)

Add a database to this TopicEntry allowed database list

Parameters:

dbname - the name to add

updateDbs

public void updateDbs(Vector dbNames)

Replace the allowed database list for this TopicEntry

Parameters:

dbNames - the new Vector of database names

updateLongName

public void updateLongName(String name)

Change the longName of this TopicEntry

Parameters:

name - the new long name of the topic area

deleteDbName

public void deleteDbName(String dbname)

Delete a database name from this TopicEnty's allowed list

Parameters:

dbname - the name to delete

dbGroup

public String dbGroup()

Retrieves the dbGroup for this TopicEntry

Returns:

String TopicEntry's dbGroup

dbNames

public Vector dbNames()

Retrieves the Vector of allowed database names for this TopicEntry.

Returns:

Vector list of allowed dbnames

longName

public String longName()

Retrieves the long (descriptive) name of this TopicEntry

Returns:

String longname

topicName

public String topicName()

Retrieves the internal name of a TopicEntry

Returns:

String TopicEntry's name

userDefinedTopic

public boolean userDefinedTopic()

Check the user-defined (for this user only) charateristic for this TopicEntry.

Returns:

boolean indicating this is a user-defined TopicEntry

toString

public String toString()

Generates the String representation of this TopicEntry

Returns:

String

Overrides:

toString in class Object