Raptor.Help
Class HelpAccessProcedures

java.lang.Object
  Raptor.Help.HelpAccessProcedures

public class HelpAccessProcedures
extends java.lang.Object

Implements a data structure for storing the Pandora IV Help Files.

Constructor Summary

HelpAccessProcedures(java.lang.String pTitle, java.lang.String pBody, java.util.LinkedList<java.lang.String> pKWList)
Creates an instance of the HelpAccessProcedures.

Method Summary

void	addKW(java.lang.String pKW) Adds the specified keyword to the keyword list of the file if it does not already contain it.
java.lang.String	getBody() Returns the body of the file.
java.util.LinkedList<java.lang.String>	getKW() Returns the keyword list of the file.
java.lang.String	getTitle() Returns the title of the file.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpAccessProcedures

public HelpAccessProcedures(java.lang.String pTitle,
                            java.lang.String pBody,
                            java.util.LinkedList<java.lang.String> pKWList)

Creates an instance of the HelpAccessProcedures.

Parameters:

pTitle - String representing the title of the file.

pBody - an HTML representation of the file body.

pKWList - LinkedList representing a list of the keywords corresponding to this file.

Method Detail

getTitle

public java.lang.String getTitle()

Returns the title of the file.

getBody

public java.lang.String getBody()

Returns the body of the file.

getKW

public java.util.LinkedList<java.lang.String> getKW()

Returns the keyword list of the file.

addKW

public void addKW(java.lang.String pKW)

Adds the specified keyword to the keyword list of the file if it does not already contain it.

Parameters:

pKW - String representing the new keyword to be added to the file.