com.raritantechnologies.rql.topic
Class Topic

java.lang.Object
  com.raritantechnologies.rql.topic.Topic

All Implemented Interfaces:

java.lang.Cloneable

public class Topic

extends java.lang.Object

implements java.lang.Cloneable

This class represents an element in the topic tree.

Developed by Raritan Technologies .

Author:

Kepler Gelotte

Field Summary

static java.lang.String

CASE_SENSITIVE

Constructor Summary

Topic()

Topic(java.lang.String name, int level, java.lang.Object[] modifiers, java.lang.String operator, boolean isNot)
Constructor

Topic(Topic t)

Method Summary

void	addChild(int score, Topic topic)
void	addChild(Topic topic)
java.lang.Object	clone() Clones a tree (or sub-tree) and returns the root of the new tree.
static boolean	containsAlphaNumeric(java.lang.String str)
static boolean	containsParenthesis(java.lang.String str)
static Topic	createTopic(java.lang.String name, java.lang.String vqlString) Creates a Topic from a VQL String.
java.lang.String	getAttribute(java.lang.String attrName)
java.util.Iterator	getAttributeNames()
java.lang.Boolean	getCaseSensitive()
java.util.ArrayList	getChildren()
java.lang.String	getDefinition()
java.lang.String	getFieldName()
java.lang.String	getID()
int	getLevel() Returns the depth.
java.lang.Object[]	getModifiers()
java.lang.String	getName() Returns the string for the human readable name of the symbol.
java.lang.String	getOperator() Returns the operator of this node.
java.lang.String	getPath()
java.lang.String	getPhraseMatchMode()
java.util.ArrayList	getScores()
int	getWordclass()
java.lang.String	getWordtext()
java.lang.String	getZonespec() A 'zonespec' is a field name or field scope (i.e.
boolean	isNot()
java.lang.String	print(int level)
void	setAttribute(java.lang.String attrName, java.lang.String attrValue)
void	setCaseSensitive(java.lang.Boolean caseSensitive)
void	setChild(Topic childTopic, int childNum)
void	setChildren(java.util.ArrayList children)
void	setDefinition(java.lang.String d)
void	setID(java.lang.String ID)
void	setLevel(int l) Sets the nested level.
void	setModifiers(java.lang.Object[] modifiers)
void	setName(java.lang.String n) Sets the name string.
void	setOperator(java.lang.String op) Set the operator of this node.
void	setPath(java.lang.String path)
void	setPath(TreeNode pathNode)
void	setPhraseMatchMode(java.lang.String phraseMatchMode)
void	setWordclass(int i)
void	setWordtext(java.lang.String t)
void	setZonespec(java.lang.String z)

Methods inherited from class java.lang.Object

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

Field Detail

CASE_SENSITIVE

public static final java.lang.String CASE_SENSITIVE

See Also:

Constant Field Values

Constructor Detail

Topic

public Topic()

Topic

public Topic(java.lang.String name,
             int level,
             java.lang.Object[] modifiers,
             java.lang.String operator,
             boolean isNot)

Constructor

Topic

public Topic(Topic t)

Method Detail

getName

public java.lang.String getName()

Returns the string for the human readable name of the symbol.

setName

public void setName(java.lang.String n)

Sets the name string.

setPath

public void setPath(java.lang.String path)

setPath

public void setPath(TreeNode pathNode)

getPath

public java.lang.String getPath()

setID

public void setID(java.lang.String ID)

getID

public java.lang.String getID()

getLevel

public int getLevel()

Returns the depth.

setLevel

public void setLevel(int l)

Sets the nested level.

getOperator

public java.lang.String getOperator()

Returns the operator of this node.

setOperator

public void setOperator(java.lang.String op)

Set the operator of this node.

setWordtext

public void setWordtext(java.lang.String t)

getWordtext

public java.lang.String getWordtext()

setWordclass

public void setWordclass(int i)

getWordclass

public int getWordclass()

setDefinition

public void setDefinition(java.lang.String d)

getFieldName

public java.lang.String getFieldName()

getZonespec

public java.lang.String getZonespec()

A 'zonespec' is a field name or field scope (i.e. path)

setZonespec

public void setZonespec(java.lang.String z)

getDefinition

public java.lang.String getDefinition()

getChildren

public java.util.ArrayList getChildren()

getScores

public java.util.ArrayList getScores()

getModifiers

public java.lang.Object[] getModifiers()

setModifiers

public void setModifiers(java.lang.Object[] modifiers)

isNot

public boolean isNot()

setPhraseMatchMode

public void setPhraseMatchMode(java.lang.String phraseMatchMode)

getPhraseMatchMode

public java.lang.String getPhraseMatchMode()

setCaseSensitive

public void setCaseSensitive(java.lang.Boolean caseSensitive)

getCaseSensitive

public java.lang.Boolean getCaseSensitive()

addChild

public void addChild(Topic topic)

addChild

public void addChild(int score,
                     Topic topic)

setChild

public void setChild(Topic childTopic,
                     int childNum)

setChildren

public void setChildren(java.util.ArrayList children)

clone

public java.lang.Object clone()

Clones a tree (or sub-tree) and returns the root of the new tree.

containsAlphaNumeric

public static boolean containsAlphaNumeric(java.lang.String str)

containsParenthesis

public static boolean containsParenthesis(java.lang.String str)

setAttribute

public void setAttribute(java.lang.String attrName,
                         java.lang.String attrValue)

getAttributeNames

public java.util.Iterator getAttributeNames()

getAttribute

public java.lang.String getAttribute(java.lang.String attrName)

print

public java.lang.String print(int level)

createTopic

public static Topic createTopic(java.lang.String name,
                                java.lang.String vqlString)

Creates a Topic from a VQL String.