|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MarkableLevelAPI
This interface defines public methods for accessing MarkableLevel objects.
Method Summary | |
---|---|
Markable |
addMarkable(java.util.ArrayList discourseElements,
java.util.HashMap attributes)
(API) Adds a Markable to this MarkableLevel, and returns the newly added Markable. |
void |
deleteAllMarkables()
(API) Deletes all Markables from this MarkableLevel. |
void |
deleteMarkable(Markable toDelete)
(API) Deletes the Markable toDelete from this MarkableLevel. |
Markable[] |
getAllMarkablesAtDiscoursePosition(int discoursePosition)
(API) Returns an array of all Markables associated with the DiscourseElement at discourse position discoursePosition, or empty array if none. |
Markable[] |
getAllMarkablesEndedByDiscourseElement(java.lang.String discourseElementID)
(API) Returns an array of all Markables whose last DiscourseElement is the one with ID discourseElementID, or empty array if none. |
Markable[] |
getAllMarkablesStartedByDiscourseElement(java.lang.String discourseElementID)
(API) Returns an array of all Markables whose first DiscourseElement is the one with ID discourseElementID, or empty array if none. |
java.lang.String |
getMarkableLevelName()
(API) Returns the name of this MarkableLevel. |
void |
saveMarkables(java.lang.String fileName)
(API) Saves the Markables on this MarkableLevel to file fileName. |
Method Detail |
---|
java.lang.String getMarkableLevelName()
void saveMarkables(java.lang.String fileName)
fileName
- The name of the file in which the Markables are to be saved.Markable addMarkable(java.util.ArrayList discourseElements, java.util.HashMap attributes)
discourseElements
- An ArrayList of DiscourseElement objects which the new Markable is to span.attributes
- A HashMap of content attibutes that the new Markable is to carry.
void deleteMarkable(Markable toDelete)
toDelete
- The Markable to delete.void deleteAllMarkables()
Markable[] getAllMarkablesAtDiscoursePosition(int discoursePosition)
discoursePosition
- The numeric discourse position for which the Markables on this MarkableLevel are to be returned.
Markable[] getAllMarkablesEndedByDiscourseElement(java.lang.String discourseElementID)
discourseElementID
- The ID of a DiscourseElement (e.g. 'word_4').
Markable[] getAllMarkablesStartedByDiscourseElement(java.lang.String discourseElementID)
discourseElementID
- The ID of a DiscourseElement (e.g. 'word_4').
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |