org.eml.MMAX2.api
Interface MarkableSetAPI

All Known Implementing Classes:
MarkableSet

public interface MarkableSetAPI

This interface defines public methods to access MarkableSet objects. MarkableSets are maintained by MarkableRelation objects of type AttributeAPI.MARKABLE_SET MARKABLE_SET: MarkableRelations of this type have sets of MarkableSet objects, and there is one MarkableSet for each different value for the attribute they are associated with.


Method Summary
 boolean containsMarkable(Markable markable)
          (API) Whether this MarkableSet contains the Markable markable.
 Markable getInitialMarkable()
          (API) Returns the Markable object that this MarkableSet starts with.
 int getMarkableIndex(Markable markable)
          (API) Returns the position of Markable markable in this MarkableSet.
 MarkableRelation getMarkableRelation()
          (API) Returns the MarkableRelation object that this MarkableSet is associated with.
 Markable[] getOrderedMarkables()
          (API) Returns an array of all Markable objects in this MarkableSet.
 

Method Detail

getMarkableRelation

MarkableRelation getMarkableRelation()
(API) Returns the MarkableRelation object that this MarkableSet is associated with.

Returns:
The MarkableRelation object that this MarkableSet is associated with.

containsMarkable

boolean containsMarkable(Markable markable)
(API) Whether this MarkableSet contains the Markable markable.

Parameters:
markable - The Markable object to be tested for membership in this MarkableSet.
Returns:
True if markable is contained in this MarkableSet, else false.

getInitialMarkable

Markable getInitialMarkable()
(API) Returns the Markable object that this MarkableSet starts with.

Returns:
The Markable object that this MarkableSet begins with. This method is available for ordered sets only!

getOrderedMarkables

Markable[] getOrderedMarkables()
(API) Returns an array of all Markable objects in this MarkableSet.

Returns:
An array of all Markable objects in this MarkableSet, in discourse order. This method is available for ordered sets only!

getMarkableIndex

int getMarkableIndex(Markable markable)
(API) Returns the position of Markable markable in this MarkableSet.

Parameters:
markable - The Markable to be localized in this MarkableSet.
Returns:
The index (zero-based) of Markable markable, or -1. This method is available for ordered sets only!