|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DiscourseAPI
This interface defines public methods for accessing MMAX2Discourse objects.
Method Summary | |
---|---|
MMAX2Discourse |
_buildDiscourse(java.lang.String inFileName,
java.lang.String commonPathsFileName)
(API) Loads the .mmax file of name inFileName, using the common_paths.xml file specified in commonPathsFileName. |
MMAX2DiscourseElement |
getDiscourseElementAtDiscoursePosition(int discoursePosition)
(API) Returns the MMAX2DiscourseElement object (i.e. |
MMAX2DiscourseElement |
getDiscourseElementByID(java.lang.String discourseElementID)
(API) Returns the MMAX2DiscourseElement object (i.e. |
int |
getDiscourseElementCount()
(API) Returns the number of MMAX2DiscourseElement objects in this discourse. |
MMAX2DiscourseElement[] |
getDiscourseElements()
(API) Returns an array containing all MMAX2DiscourseElement objects in the current discourse, ordered in discourse order. |
MMAX2DiscourseElement[] |
getDiscourseElements(Markable markable)
(API) Returns an array containing all MMAX2DiscourseElement objects in Markable markable, ordered in discourse order. |
MarkableLevel |
getMarkableLevelByName(java.lang.String levelName,
boolean interactive)
(API) Returns the MarkableLevel object of name levelName, or null if no MarkableLevel of this name exists. |
MMAX2DiscourseElement |
getNextDiscourseElement(MMAX2DiscourseElement currentElement)
(API) Returns the MMAX2DiscourseElement object at discourse position currentElement.DiscourseElementAPI.getDiscoursePosition() +1, or null if none exists at this position. |
MMAX2DiscourseElement |
getPreviousDiscourseElement(MMAX2DiscourseElement currentElement)
(API) Returns the MMAX2DiscourseElement object at discourse position currentElement.DiscourseElementAPI.getDiscoursePosition() -1, or null if none exists at this position. |
Method Detail |
---|
MarkableLevel getMarkableLevelByName(java.lang.String levelName, boolean interactive)
levelName
- The name of the MarkableLevel
to return.interactive
- If true, a message box will be displayed if no MarkableLevel
of name levelName could be found.
MarkableLevel
object of name levelName, or null.MMAX2Discourse _buildDiscourse(java.lang.String inFileName, java.lang.String commonPathsFileName)
inFileName
- The name and path of the .mmax file to load.commonPathsFileName
- The name (and possibly path) of the common_paths.xml file to use. If this parameter is an empty string, the file common_paths.xml in the current directory will be used.
MMAX2DiscourseElement getDiscourseElementAtDiscoursePosition(int discoursePosition)
MMAX2DiscourseElement
object (i.e. base data element) associated with discourse position discoursePosition, or null if none exists at this position.
discoursePosition
- The numeric discourse position of the MMAX2DiscourseElement
to return. This is normally the base data element's position in the base data file.
MMAX2DiscourseElement
at discourse position discoursePosition.MMAX2DiscourseElement getDiscourseElementByID(java.lang.String discourseElementID)
MMAX2DiscourseElement
object (i.e. base data element) associated with the ID discourseElementID (e.g. 'word_4'), or null if none exists.
discourseElementID
- The ID of the MMAX2DiscourseElement
to return.
MMAX2DiscourseElement
with ID discourseElementID.MMAX2DiscourseElement[] getDiscourseElements()
MMAX2DiscourseElement
objects in the current discourse, ordered in discourse order.
MMAX2DiscourseElement
objects in the current discourse.MMAX2DiscourseElement[] getDiscourseElements(Markable markable)
MMAX2DiscourseElement
objects in Markable
markable, ordered in discourse order.
markable
- The Markable object whose MMAX2DiscourseElement
objects are to be returned.
MMAX2DiscourseElement
objects in Markable
markable.MMAX2DiscourseElement getNextDiscourseElement(MMAX2DiscourseElement currentElement)
MMAX2DiscourseElement
object at discourse position currentElement.DiscourseElementAPI.getDiscoursePosition()
+1, or null if none exists at this position.
currentElement
- The MMAX2DiscourseElement
object at the current position, or null.
MMAX2DiscourseElement
object at discourse position currentElement.DiscourseElementAPI.getDiscoursePosition()
+1, or null if none exists at this position. If currentElement is null, the first MMAX2DiscourseElement
object in the current discourse is returned.MMAX2DiscourseElement getPreviousDiscourseElement(MMAX2DiscourseElement currentElement)
MMAX2DiscourseElement
object at discourse position currentElement.DiscourseElementAPI.getDiscoursePosition()
-1, or null if none exists at this position.
currentElement
- The MMAX2DiscourseElement
object at the current position, or null.
MMAX2DiscourseElement
object at discourse position currentElement.DiscourseElementAPI.getDiscoursePosition()
-1, or null if none exists at this position. If currentElement is null, the last MMAX2DiscourseElement
object in the current discourse is returned.int getDiscourseElementCount()
MMAX2DiscourseElement
objects in this discourse.
MMAX2DiscourseElement
objects in this discourse.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |