All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class SHOE.Def_Category

java.lang.Object
   |
   +----SHOE.SHOE_Obj
           |
           +----SHOE.Def_Category

public class Def_Category
extends SHOE_Obj
A object that represents a tag in a SHOE document.


Constructor Index

 o Def_Category(SGML_Tag)
Creates a new Def_Category object using the given SGML tag.
 o Def_Category(String, Vector)
Creates a new Def_Category object with the given name and set of direct super-categories.
 o Def_Category(String, Vector, String, String)
Creates a new Def_Category object with the given name, set of direct super-categories, description, and short phrase.

Method Index

 o getChildIds()
Returns the unique element ids of each child category, including those of categories defined in other ontologies.
 o getDescription()
Returns a description of the category.
 o getIsaString()
Returns the list of prefixed names of parent categories as a whitespace separated string.
 o getKey()
Returns an identifier for the SHOE object.
 o getLabel()
Returns a label suitable for display the Category name to a user.
 o getName()
Returns the name of the category.
 o getParentIds()
Returns the unique element ids of each parent category, including those of categories defined in other ontologies.
 o getParentNames()
Returns an array of the prefixed names of the category's parents.
 o getPhrase()
Returns a short phrase that describes the category.
 o printSGML(PrintStream)
Writes the objects and its components to the given print stream in SGML format.
 o readSubTags(HTML_Tokenizer)
Reads and processes the tokens from an HTML_Tokenizer until the appropriate closing tag is encountered.
 o toString()
Returns the string representation of the tag.
 o validate(SHOE_Obj, OntManager)
Validate the Def_Category by determining the element ids for each of its parents.

Constructors

 o Def_Category
 public Def_Category(String name,
                     Vector isa)
Creates a new Def_Category object with the given name and set of direct super-categories. The super-categories are specified as Strings, where each is a SHOE prefixed name.

 o Def_Category
 public Def_Category(String name,
                     Vector isa,
                     String description,
                     String short_para)
Creates a new Def_Category object with the given name, set of direct super-categories, description, and short phrase.

 o Def_Category
 public Def_Category(SGML_Tag sgmltag)
Creates a new Def_Category object using the given SGML tag.

Methods

 o getDescription
 public String getDescription()
Returns a description of the category.

 o getKey
 public String getKey()
Returns an identifier for the SHOE object.

Overrides:
getKey in class SHOE_Obj
 o getName
 public String getName()
Returns the name of the category.

 o getParentNames
 public String[] getParentNames()
Returns an array of the prefixed names of the category's parents.

 o getPhrase
 public String getPhrase()
Returns a short phrase that describes the category. This is the SHORT field in the DEF-CATEGORY tag.

 o getLabel
 public String getLabel()
Returns a label suitable for display the Category name to a user. If the category has a SHORT name, it is returned, otherwise the name of the category is returned

 o getIsaString
 public String getIsaString()
Returns the list of prefixed names of parent categories as a whitespace separated string.

 o getParentIds
 public Enumeration getParentIds()
Returns the unique element ids of each parent category, including those of categories defined in other ontologies.

 o getChildIds
 public Enumeration getChildIds()
Returns the unique element ids of each child category, including those of categories defined in other ontologies.

 o readSubTags
 public Vector readSubTags(HTML_Tokenizer intokens)
Reads and processes the tokens from an HTML_Tokenizer until the appropriate closing tag is encountered.

Overrides:
readSubTags in class SHOE_Obj
 o validate
 public Vector validate(SHOE_Obj parent,
                        OntManager ontman)
Validate the Def_Category by determining the element ids for each of its parents. In the process we also add the current category as a child to each of those. Here, parent is the ontology that contains the Def-Category.

 o printSGML
 public void printSGML(PrintStream out)
Writes the objects and its components to the given print stream in SGML format.

Overrides:
printSGML in class SHOE_Obj
 o toString
 public String toString()
Returns the string representation of the tag. Any contents or end tags are not included.

Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index