edu.mit.jverbnet.data
Interface IVerbClass

All Known Implementing Classes:
VerbClass

public interface IVerbClass

The main object in a verb index

Since:
JVerbnet 1.0.0
Version:
1.2.0
Author:
Mark A. Finlayson

Method Summary
 java.util.List<IFrame> getFrames()
          Returns the frames this verb class.
 java.lang.String getID()
          Returns the id of the verbnet class.
 java.util.List<IMember> getMembers()
          Returns the members of this verb class.
 IVerbClass getParent()
          Returns the parent class of this verb class, or null if this class is a root class.
 java.util.List<IVerbClass> getSubclasses()
          Returns the subclasses of this verb class.
 java.util.List<IThematicRole> getThematicRoles()
          Returns the thematic roles of this verb class.
 boolean isRoot()
          Returns true if this verb class has no parent; false otherwise.
 void setParent(IVerbClass parent)
          Sets the parent of this verb class.
 

Method Detail

getID

java.lang.String getID()
Returns the id of the verbnet class.

Returns:
the id of this verbnet class; neither empty, all whitespace, or null
Since:
JVerbnet 1.0.0

getParent

IVerbClass getParent()
Returns the parent class of this verb class, or null if this class is a root class.

Returns:
the parent class of this verb class, or null if this class is a root class.
Since:
JVerbnet 1.0.0

setParent

void setParent(IVerbClass parent)
Sets the parent of this verb class. The parent may be set to null. The parent may only be set once: the method will throw an exception if it is called a second time.

Parameters:
parent - the parent of the class; may be null, in which case the class will be a root class
Throws:
java.lang.IllegalStateException - if the method is called a second time
Since:
JVerbnet 1.0.0

isRoot

boolean isRoot()
Returns true if this verb class has no parent; false otherwise.

Returns:
true if this verb class has no parent; false otherwise.
Since:
JVerbnet 1.0.0

getMembers

java.util.List<IMember> getMembers()
Returns the members of this verb class. Will never return a null or empty list.

Returns:
the non-null, non-empty list of members of this verb class.
Since:
JVerbnet 1.0.0

getThematicRoles

java.util.List<IThematicRole> getThematicRoles()
Returns the thematic roles of this verb class. Will never return a null or empty list.

Returns:
the non-null, non-empty list of thematic roles of this verb class.
Since:
JVerbnet 1.0.0

getFrames

java.util.List<IFrame> getFrames()
Returns the frames this verb class. Will never return a null or empty list.

Returns:
the non-null, non-empty list of frames of this verb class.
Since:
JVerbnet 1.0.0

getSubclasses

java.util.List<IVerbClass> getSubclasses()
Returns the subclasses of this verb class. Will never return a null list, but it may be empty. Each verb class in the returned list will return this object via its getParent() method.

Returns:
the non-null list of subclasses of this verb class.
Since:
JVerbnet 1.0.0


Copyright © 2012 ${project.organization.name}. All Rights Reserved.