gov.nih.nlm.nls.stmt.Corpus

Class Corpus

java.lang.Object

gov.nih.nlm.nls.stmt.Corpus.Corpus

public class Corpus
extends java.lang.Object

This program is to load a corpus (from a file) to a tree structure. - each team in the corpus is a branch in the tree - each word in the team is a node in the branch It is capable of handling duplicated terms in a file The format includes three fields key|level|children.

History:

Version:

V-2014

Author:

NLM NLS Development Team

Constructor Summary

Constructors

Constructor and Description
Corpus() Create a corpus java object with default values
Corpus(java.lang.String inFile) Create a corpus java object by loading a list of terms into the corpus tree from the specified file.
Corpus(java.lang.String inFile, boolean verboseFlag, int lineNum) Create a corpus java object by loading a list of terms into the corpus tree from the specified file.
Corpus(java.util.Vector<java.lang.String> terms) Create a corpus java object by loading a list of terms into the corpus tree.
Corpus(java.util.Vector<java.lang.String> terms, boolean verboseFlag, int lineNum) Create a corpus java object by loading a list of terms into the corpus tree.

Method Summary

Methods

Modifier and Type	Method and Description
static int	GetMaxChildrenNoForLevel(java.util.Collection<TreeNode> nodeList, int level) Get the maximum number of children for a specified level and node list
static int	GetMaxLevel(java.util.Collection<TreeNode> nodeList) Get the maximum level for a specified the node List.
static java.util.Collection<TreeNode>	GetNodeList(Corpus corpus) Get list of total nodes for the tree.
static java.util.Collection<TreeNode>	GetNodeListForNode(TreeNode inNode, java.util.Collection<TreeNode> inNodeList) Get total nodes list of a branch under a given node.
static java.util.Collection<java.lang.String>	GetPathList(Corpus corpus) Get the total path list in the tree.
static java.util.Collection<java.lang.String>	GetPathListForNode(TreeNode inNode, java.util.Collection<java.lang.String> inPathList, java.lang.String inPath) Get the total path list in the tree for a given node.
TreeNode	GetRoot() Get the root node of the corpus tree.
static int	GetTotalNodeNo(Corpus corpus) Get the total number of tree nodes in the corpus tree
static int	GetTotalPathNo(Corpus corpus) Get the total number of branches (paths) in the corpus tree
static int	GetTotalTermNo(Corpus corpus) Get the total number of terms in the corpus
static java.lang.String	GetTreeString(Corpus corpus) Get the entire corpus tree in a string format
static java.lang.String	GetTreeStringForNode(TreeNode node, java.lang.String inStr) Get the sub-tree (branch) string for a given node
void	LoadCorpus(java.util.Vector<java.lang.String> terms, boolean verboseFlag, int lineNum) Load the Corpus from a collections of terms.
void	LoadCorpusFromFile(java.lang.String inFile) Load the corpus tree from a specified corpus file.
void	LoadCorpusFromFile(java.lang.String inFile, boolean verboseFlag, int lineNum) Load the corpus tree from a specified corpus file with verbose option.
static void	main(java.lang.String[] args) Test driver for this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

Corpus

public Corpus()

Create a corpus java object with default values

Corpus

public Corpus(java.lang.String inFile)

Create a corpus java object by loading a list of terms into the corpus tree from the specified file.

Parameters:

inFile - corpus file including all normalized terms

Corpus

public Corpus(java.lang.String inFile,
      boolean verboseFlag,
      int lineNum)

Create a corpus java object by loading a list of terms into the corpus tree from the specified file.

Parameters:

inFile - corpus file including all normalized terms

verboseFlag - verbose flag to show loading status

lineNum - loading status of line number to be displayed

Corpus

public Corpus(java.util.Vector<java.lang.String> terms)

Create a corpus java object by loading a list of terms into the corpus tree.

Parameters:

terms - the list of all normalized terms from the corpus

Corpus

public Corpus(java.util.Vector<java.lang.String> terms,
      boolean verboseFlag,
      int lineNum)

Create a corpus java object by loading a list of terms into the corpus tree.

Parameters:

terms - the list of all normalized terms from the corpus

verboseFlag - verbose flag to show loading status

lineNum - loading status of line number to be displayed

Method Detail

GetRoot

public TreeNode GetRoot()

Get the root node of the corpus tree.

Returns:

root node of the corpus tree

LoadCorpusFromFile

public void LoadCorpusFromFile(java.lang.String inFile)

Load the corpus tree from a specified corpus file.

Parameters:

inFile - corpus file including all normalized terms

LoadCorpusFromFile

public void LoadCorpusFromFile(java.lang.String inFile,
                      boolean verboseFlag,
                      int lineNum)

Load the corpus tree from a specified corpus file with verbose option.

Parameters:

inFile - corpus file including all normalized terms

verboseFlag - verbose flag to show loading status

lineNum - loading status of line number to be displayed

LoadCorpus

public void LoadCorpus(java.util.Vector<java.lang.String> terms,
              boolean verboseFlag,
              int lineNum)

Load the Corpus from a collections of terms.

Parameters:

terms - the list of all normalized terms of the corpus

GetTreeString

public static java.lang.String GetTreeString(Corpus corpus)

Get the entire corpus tree in a string format

Parameters:

corpus - the corpus to be convert to string

Returns:

the corpus tree in string format

GetTotalTermNo

public static int GetTotalTermNo(Corpus corpus)

Get the total number of terms in the corpus

Parameters:

corpus - the corpus to be convert to string

Returns:

the total number of terms

GetTotalPathNo

public static int GetTotalPathNo(Corpus corpus)

Get the total number of branches (paths) in the corpus tree

Parameters:

corpus - the corpus to be convert to string

Returns:

the total number of paths

GetTotalNodeNo

public static int GetTotalNodeNo(Corpus corpus)

Get the total number of tree nodes in the corpus tree

Parameters:

corpus - the corpus to be convert to string

Returns:

the total number of tree nodes

GetMaxChildrenNoForLevel

public static int GetMaxChildrenNoForLevel(java.util.Collection<TreeNode> nodeList,
                           int level)

Get the maximum number of children for a specified level and node list

Parameters:

nodeList - a collection of tree nodes

level - the level of interests

Returns:

the maximum number of children

GetMaxLevel

public static int GetMaxLevel(java.util.Collection<TreeNode> nodeList)

Get the maximum level for a specified the node List. ROOT_NODE is level 0; END_NODE is one extra level. For example, the max level is 6 if maximum size of input terms (word size) is 5.

Parameters:

nodeList - a collection of tree nodes

Returns:

the maximum level of the node list

GetPathList

public static java.util.Collection<java.lang.String> GetPathList(Corpus corpus)

Get the total path list in the tree. A path is from the ROOT (current) node to END node. This list should be the same as input terms list (unique) traverses the tree from the root

Parameters:

corpus - the corpus to be convert to string

Returns:

collection of paths

GetPathListForNode

public static java.util.Collection<java.lang.String> GetPathListForNode(TreeNode inNode,
                                                        java.util.Collection<java.lang.String> inPathList,
                                                        java.lang.String inPath)

Get the total path list in the tree for a given node.

Parameters:

inNode - the tree node of interests

inPathList - the pathlist passing in

inPath - the path passing in

Returns:

the collection of paths for a given node

GetNodeList

public static java.util.Collection<TreeNode> GetNodeList(Corpus corpus)

Get list of total nodes for the tree.

Parameters:

corpus - the corpus of interests

Returns:

a collection of tree nodes

GetNodeListForNode

public static java.util.Collection<TreeNode> GetNodeListForNode(TreeNode inNode,
                                                java.util.Collection<TreeNode> inNodeList)

Get total nodes list of a branch under a given node.

Parameters:

inNode - the tree node of interests

inNodeList - the collection of tree nodes of interests

Returns:

a collection of tree node

GetTreeStringForNode

public static java.lang.String GetTreeStringForNode(TreeNode node,
                                    java.lang.String inStr)

Get the sub-tree (branch) string for a given node

Parameters:

node - the tree node of interests

inStr - the parents tree string passing in

Returns:

the branch in a string format for a given node

main

public static void main(java.lang.String[] args)

Test driver for this class.

Parameters:

args - arguments of the test friver program