arom.kr.parser.standard
Class AromDocTreeNode

java.lang.Object
  |
  +--arom.kr.parser.standard.SimpleNode
        |
        +--arom.kr.parser.standard.AromTreeNode
              |
              +--arom.kr.parser.standard.AromDocTreeNode

All Implemented Interfaces:

arom.kr.parser.standard.Node

Direct Known Subclasses:

AromInstanceNode, AromKnowledgeBaseNode, AromSlotNode, AromStructureNode

public class AromDocTreeNode

extends AromTreeNode

AromDocTreeNode.java This class is the common generic class for all Arom Nodes which defines a documentation. Created: Thu Jan 17 13:25:19 2002

Author:

Veronique DUPIERRIS

Field Summary

static int	DOCUMENTATION_NONE
static int	DOCUMENTATION_TEXT
static int	DOCUMENTATION_URL

Constructor Summary

AromDocTreeNode(int id)

AromDocTreeNode(arom.kr.parser.standard.StandardParser p, int id)

Method Summary

String	getDocumentation(int type) Get the specified type documentation of the represented knowledge base.
int	getDocumentationType() Get an integer indicating which documentation have been set.
void	setDocumentation(String doc, int type) Set the documentation of the knowledge base represented by this node.

Methods inherited from class arom.kr.parser.standard.AromTreeNode

childrenAccept, dump, getName, jjtAccept, setName, toString

Methods inherited from class arom.kr.parser.standard.SimpleNode

jjtAddChild, jjtClose, jjtGetChild, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DOCUMENTATION_NONE

public static int DOCUMENTATION_NONE

DOCUMENTATION_TEXT

public static int DOCUMENTATION_TEXT

DOCUMENTATION_URL

public static int DOCUMENTATION_URL

Constructor Detail

AromDocTreeNode

public AromDocTreeNode(int id)

AromDocTreeNode

public AromDocTreeNode(arom.kr.parser.standard.StandardParser p,
                       int id)

Method Detail

setDocumentation

public void setDocumentation(String doc,
                             int type)

Set the documentation of the knowledge base represented by this node.

Parameters:

doc - the documentation of the knowledge base.

type - the type of the documentation to set, text or url

getDocumentation

public String getDocumentation(int type)

Get the specified type documentation of the represented knowledge base.

Parameters:

type - the type of the requested documentation, text or URL

Returns:

the documentation of the knowledge base.

getDocumentationType

public int getDocumentationType()

Get an integer indicating which documentation have been set. if returned type | DOCUMENTATION_TEXT = DOCUMENTATION_TEXT then text Doc has been provided. if returned type | DOCUMENTATION_URL = DOCUMENTATION_URL then URL Doc has been provided.