org.eml.MMAX2.api
Interface MarkablePointerAPI

All Known Implementing Classes:
MarkablePointer

public interface MarkablePointerAPI


Method Summary
 boolean containsMarkable(Markable markable)
          (API) Returns whether Markable markable is the source or target markable in this MarkablePointer.
 MarkableRelation getMarkableRelation()
          (API) Returns the MarkableRelation object that this MarkablePointer is associated with.
 Markable getSourceMarkable()
          (API) Returns the Markable objects that is the source markable in this MarkablePointer.
 Markable[] getTargetMarkables()
          (API) Returns an array of Markable objects that are the target markables in this MarkablePointer.
 boolean isSourceMarkable(Markable potentialSourceMarkable)
          (API) Returns whether Markable potentialSourceMarkable is the source markable in this MarkablePointer.
 boolean isTargetMarkable(Markable potentialTargetMarkable)
          (API) Returns whether Markable potentialTargetMarkable is on of the target markables in this MarkablePointer.
 

Method Detail

getMarkableRelation

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

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

getTargetMarkables

Markable[] getTargetMarkables()
(API) Returns an array of Markable objects that are the target markables in this MarkablePointer.

Returns:
An array of Markable objects that are the target markables in this MarkablePointer.

getSourceMarkable

Markable getSourceMarkable()
(API) Returns the Markable objects that is the source markable in this MarkablePointer.

Returns:
The Markable object that is the source markable in this MarkablePointer.

isSourceMarkable

boolean isSourceMarkable(Markable potentialSourceMarkable)
(API) Returns whether Markable potentialSourceMarkable is the source markable in this MarkablePointer.

Parameters:
potentialSourceMarkable - The Markable to be tested as source markable.
Returns:
True if potentialSourceMarkable is the source markable in this MarkablePointer, else false.

isTargetMarkable

boolean isTargetMarkable(Markable potentialTargetMarkable)
(API) Returns whether Markable potentialTargetMarkable is on of the target markables in this MarkablePointer.

Parameters:
potentialTargetMarkable - The Markable to be tested as target markable.
Returns:
True if potentialTargetMarkable is the source markable in this MarkablePointer, else false.

containsMarkable

boolean containsMarkable(Markable markable)
(API) Returns whether Markable markable is the source or target markable in this MarkablePointer.

Parameters:
markable - The Markable to be tested as source or target markable.
Returns:
True if markable is the source or target markable in this MarkablePointer, else false.