All Packages Class Hierarchy This Package Previous Next Index
Class SHOE.Def_Relation
java.lang.Object
|
+----SHOE.SHOE_Obj
|
+----SHOE.Def_Relation
- public class Def_Relation
- extends SHOE_Obj
This class implements facilities for defining a SHOE relation.
-
Def_Relation(SGML_Tag)
- Create a new relation definition from its SGML tag representation.
-
Def_Relation(String, String, String, Vector)
- Create a new relation definition given a name, description, short
phrase and vector of argument definitions.
-
getArity()
- Return the number of arguments defined for the relation.
-
getDefArg(int)
- Returns the argument with POS field of pos.
-
getDefArgAt(int)
- Returns the argument that is located at index idx in the list.
-
getDefArgs()
-
-
getDefArgTypeClass(int)
- Returns the required type class of the argument in the desired
position.
-
getDescription()
- Returns a description of the relation.
-
getKey()
- Returns an identifier for the SHOE object.
-
getLabel()
- If the relation has a SHORT name, it is returned, otherwise the
name of the relation is returned
-
getName()
- Returns the name of the relation.
-
getPhrase()
- Returns a short phrase that describes the relation.
-
printSGML(PrintStream)
- Writes the objects and its components to the given print
stream in SGML format.
-
readSubTags(HTML_Tokenizer)
- Reads and processes the tokens from an HTML_Tokenizer until
the appropriate closing tag is encountered.
-
toString()
- Returns the string representation of the tag.
-
validate(SHOE_Obj, OntManager)
- Validates each Def_Arg contained in the Def_Relation
Def_Relation
public Def_Relation(String name,
String description,
String short_para,
Vector argList)
- Create a new relation definition given a name, description, short
phrase and vector of argument definitions.
Def_Relation
public Def_Relation(SGML_Tag sgmltag)
- Create a new relation definition from its SGML tag representation.
getDescription
public String getDescription()
- Returns a description of the relation.
getKey
public String getKey()
- Returns an identifier for the SHOE object.
- Overrides:
- getKey in class SHOE_Obj
getName
public String getName()
- Returns the name of the relation.
getPhrase
public String getPhrase()
- Returns a short phrase that describes the relation. This is
the SHORT field in the DEF-RELATION tag.
getDefArgAt
public Def_Arg getDefArgAt(int idx)
- Returns the argument that is located at index idx in the list.
Note that it is dangerous to use this method unless it is known
that the arguments are sorted by position number.
getDefArg
public Def_Arg getDefArg(int pos)
- Returns the argument with POS field of pos. Note: if we sort the
arguments, then we can have one-shot access.
getDefArgs
public Def_Arg[] getDefArgs()
getDefArgTypeClass
public int getDefArgTypeClass(int pos)
- Returns the required type class of the argument in the desired
position.
getArity
public int getArity()
- Return the number of arguments defined for the relation.
getLabel
public String getLabel()
- If the relation has a SHORT name, it is returned, otherwise the
name of the relation is returned
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
validate
public Vector validate(SHOE_Obj parent,
OntManager ontman)
- Validates each Def_Arg contained in the Def_Relation
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
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