org.eml.MMAX2.discourse
Class MMAX2DiscourseLoader

java.lang.Object
  extended by org.eml.MMAX2.discourse.MMAX2DiscourseLoader

public class MMAX2DiscourseLoader
extends java.lang.Object


Constructor Summary
MMAX2DiscourseLoader(java.lang.String fileName, boolean withGUI, java.lang.String suppliedCommonPathsFile)
          Creates new DiscourseLoader from the supplied .MMAX file.
 
Method Summary
static java.lang.String addHotSpot(java.lang.String toDisplay, java.lang.String hotSpotText)
           
static void addLeftMarkableHandle(java.lang.String layerName, java.lang.String markableId, int extent)
          Adds a left markable handle (clickable area directly associated with a markable) of size extent.
static void addLeftMarkableHandle(java.lang.String layerName, java.lang.String markableId, int extent, int leftHandle)
          Adds a right markable handle (clickable area directly associated with a markable) of size extent, where the actual handle is at position leftHandle relative to extent.
static java.lang.String addLeftMarkableHandle(java.lang.String layerName, java.lang.String markableId, java.lang.String handleText)
          Adds handleText as a left markable handle (clickable area directly associated with a markable).
static java.lang.String addLeftMarkableHandle(java.lang.String layerName, java.lang.String markableId, java.lang.String handleText, int highlightPos)
          Adds handleText as a left markable handle (clickable area directly associated with a markable).
static void addRightMarkableHandle(java.lang.String layerName, java.lang.String markableId, int extent)
          Adds a right markable handle (clickable area directly associated with a markable) of size extent.
static void addRightMarkableHandle(java.lang.String layerName, java.lang.String markableId, int extent, int rightHandle)
          Adds a right markable handle (clickable area directly associated with a markable) of size extent, where the actual handle is at position rightHandle relative to extent.
static java.lang.String addRightMarkableHandle(java.lang.String layerName, java.lang.String markableId, java.lang.String handleText)
          Adds handleText as a right markable handle (clickable area directly associated with a markable).
static java.lang.String addRightMarkableHandle(java.lang.String layerName, java.lang.String markableId, java.lang.String handleText, int highlightPos)
          Adds handleText as a right markable handle (clickable area directly associated with a markable).
static java.lang.String concat(java.lang.String string1, java.lang.String string2)
           
static java.lang.String concat(java.lang.String string1, java.lang.String string2, java.lang.String string3)
           
static java.lang.String concat(java.lang.String string1, java.lang.String string2, java.lang.String string3, java.lang.String string4)
           
static java.lang.String concat(java.lang.String string1, java.lang.String string2, java.lang.String string3, java.lang.String string4, java.lang.String string5)
           
static void endAssociatedColor(java.lang.String levelname)
           
static void endBold()
           
static void endColor(java.lang.String colorName)
           
static void endItalic()
           
static void endStrikeThrough()
           
static void endSubscript()
           
static void endSuperscript()
           
static void endUnderline()
           
static boolean finishesMarkableFromLevel(java.lang.String markableID, java.lang.String ownLevelName, java.lang.String targetLevelName)
           
static void flushDocument()
           
 java.lang.String getCommonQueryPath()
           
 java.lang.String getCommonStylePath()
           
 MMAX2Discourse getCurrentDiscourse()
          Returns the Discourse object currently loaded by this loader.
static org.apache.xpath.NodeSet getEndedMarkables(java.lang.String discourseElementId)
           
static org.apache.xpath.NodeSet getEndedMarkables(java.lang.String discourseElementId, java.lang.String levels)
           
static java.lang.String getFromHash(java.lang.String key)
           
static org.w3c.dom.NodeList getStartedMarkables(java.lang.String discourseElementId)
          This method returns a NodeSet of all Markables from all ACTIVE layers beginning at the DiscourseElement with ID discourseElementId.
static org.w3c.dom.NodeList getStartedMarkables(java.lang.String discourseElementId, java.lang.String levels)
          This method returns a NodeSet of all Markables from all ACTIVE layers beginning at the DiscourseElement with ID discourseElementId.
 java.lang.String[] getUserSwitches()
           
 java.lang.String getWorkingDirectory()
           
static boolean inMarkableFromLevel(java.lang.String DE_ID, java.lang.String targetLevelName)
           
static boolean inMarkableFromLevel(java.lang.String markableID, java.lang.String ownLevelName, java.lang.String targetLevelName)
           
static boolean isOn(java.lang.String switchName)
           
static void putInHash(java.lang.String key, java.lang.String value)
           
static void registerDiscourseElement(java.lang.String id)
           
static void setDiscourseElementEnd()
          This method has to be called from the XSL style sheet from within the word template, BEFORE the call to getEndedMarkables() (if any)! This order is important because markable handles are supposed to end AFTER the actual word string.
static void setDiscourseElementStart()
          This method has to be called from the XSL style sheet from within the word template, AFTER the call to getStartedMarkables() (if any)! This order is important because markable handles are supposed to begin BEFORE the actual word string.
static void startAssociatedColor(java.lang.String levelname)
           
static void startBold()
           
static void startColor(java.lang.String colorName)
           
static void startItalic()
           
static boolean startsMarkableFromLevel(java.lang.String markableID, java.lang.String ownLevelName, java.lang.String targetLevelName)
           
static void startStrikeThrough()
           
static void startSubscript()
           
static void startSuperscript()
           
static void startUnderline()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MMAX2DiscourseLoader

public MMAX2DiscourseLoader(java.lang.String fileName,
                            boolean withGUI,
                            java.lang.String suppliedCommonPathsFile)
Creates new DiscourseLoader from the supplied .MMAX file.

Method Detail

getCommonQueryPath

public final java.lang.String getCommonQueryPath()

getUserSwitches

public final java.lang.String[] getUserSwitches()

getWorkingDirectory

public final java.lang.String getWorkingDirectory()

getCurrentDiscourse

public final MMAX2Discourse getCurrentDiscourse()
Returns the Discourse object currently loaded by this loader.


addHotSpot

public static java.lang.String addHotSpot(java.lang.String toDisplay,
                                          java.lang.String hotSpotText)

concat

public static java.lang.String concat(java.lang.String string1,
                                      java.lang.String string2)

concat

public static java.lang.String concat(java.lang.String string1,
                                      java.lang.String string2,
                                      java.lang.String string3)

concat

public static java.lang.String concat(java.lang.String string1,
                                      java.lang.String string2,
                                      java.lang.String string3,
                                      java.lang.String string4)

concat

public static java.lang.String concat(java.lang.String string1,
                                      java.lang.String string2,
                                      java.lang.String string3,
                                      java.lang.String string4,
                                      java.lang.String string5)

addLeftMarkableHandle

public static void addLeftMarkableHandle(java.lang.String layerName,
                                         java.lang.String markableId,
                                         int extent)
Adds a left markable handle (clickable area directly associated with a markable) of size extent.


addRightMarkableHandle

public static void addRightMarkableHandle(java.lang.String layerName,
                                          java.lang.String markableId,
                                          int extent)
Adds a right markable handle (clickable area directly associated with a markable) of size extent.


addLeftMarkableHandle

public static java.lang.String addLeftMarkableHandle(java.lang.String layerName,
                                                     java.lang.String markableId,
                                                     java.lang.String handleText,
                                                     int highlightPos)
Adds handleText as a left markable handle (clickable area directly associated with a markable).


addLeftMarkableHandle

public static java.lang.String addLeftMarkableHandle(java.lang.String layerName,
                                                     java.lang.String markableId,
                                                     java.lang.String handleText)
Adds handleText as a left markable handle (clickable area directly associated with a markable).


addRightMarkableHandle

public static java.lang.String addRightMarkableHandle(java.lang.String layerName,
                                                      java.lang.String markableId,
                                                      java.lang.String handleText,
                                                      int highlightPos)
Adds handleText as a right markable handle (clickable area directly associated with a markable).


addRightMarkableHandle

public static java.lang.String addRightMarkableHandle(java.lang.String layerName,
                                                      java.lang.String markableId,
                                                      java.lang.String handleText)
Adds handleText as a right markable handle (clickable area directly associated with a markable).


addLeftMarkableHandle

public static void addLeftMarkableHandle(java.lang.String layerName,
                                         java.lang.String markableId,
                                         int extent,
                                         int leftHandle)
Adds a right markable handle (clickable area directly associated with a markable) of size extent, where the actual handle is at position leftHandle relative to extent.


addRightMarkableHandle

public static void addRightMarkableHandle(java.lang.String layerName,
                                          java.lang.String markableId,
                                          int extent,
                                          int rightHandle)
Adds a right markable handle (clickable area directly associated with a markable) of size extent, where the actual handle is at position rightHandle relative to extent.


registerDiscourseElement

public static void registerDiscourseElement(java.lang.String id)

isOn

public static boolean isOn(java.lang.String switchName)

setDiscourseElementStart

public static void setDiscourseElementStart()
This method has to be called from the XSL style sheet from within the word template, AFTER the call to getStartedMarkables() (if any)! This order is important because markable handles are supposed to begin BEFORE the actual word string. The method's function is mainly to create an association between the running number of the currently processed element and the position in the display that this element starts at. Internal use only!


setDiscourseElementEnd

public static void setDiscourseElementEnd()
This method has to be called from the XSL style sheet from within the word template, BEFORE the call to getEndedMarkables() (if any)! This order is important because markable handles are supposed to end AFTER the actual word string. The method's function is mainly to create an association between the running number of the currently processed element and the position in the display that this element ends at. Internal use only!


startItalic

public static void startItalic()

endItalic

public static void endItalic()

startBold

public static void startBold()

endBold

public static void endBold()

startUnderline

public static void startUnderline()

endUnderline

public static void endUnderline()

startSubscript

public static void startSubscript()

endSubscript

public static void endSubscript()

startStrikeThrough

public static void startStrikeThrough()

endStrikeThrough

public static void endStrikeThrough()

startSuperscript

public static void startSuperscript()

endSuperscript

public static void endSuperscript()

startColor

public static void startColor(java.lang.String colorName)

endColor

public static void endColor(java.lang.String colorName)

startAssociatedColor

public static void startAssociatedColor(java.lang.String levelname)

endAssociatedColor

public static void endAssociatedColor(java.lang.String levelname)

getFromHash

public static final java.lang.String getFromHash(java.lang.String key)

putInHash

public static final void putInHash(java.lang.String key,
                                   java.lang.String value)

inMarkableFromLevel

public static final boolean inMarkableFromLevel(java.lang.String DE_ID,
                                                java.lang.String targetLevelName)

inMarkableFromLevel

public static final boolean inMarkableFromLevel(java.lang.String markableID,
                                                java.lang.String ownLevelName,
                                                java.lang.String targetLevelName)

startsMarkableFromLevel

public static final boolean startsMarkableFromLevel(java.lang.String markableID,
                                                    java.lang.String ownLevelName,
                                                    java.lang.String targetLevelName)

finishesMarkableFromLevel

public static final boolean finishesMarkableFromLevel(java.lang.String markableID,
                                                      java.lang.String ownLevelName,
                                                      java.lang.String targetLevelName)

getCommonStylePath

public final java.lang.String getCommonStylePath()

flushDocument

public static void flushDocument()

getStartedMarkables

public static final org.w3c.dom.NodeList getStartedMarkables(java.lang.String discourseElementId)
This method returns a NodeSet of all Markables from all ACTIVE layers beginning at the DiscourseElement with ID discourseElementId. If more than one Markable starts at a given DiscourseElement, the Markables returned are sorted in the following way: Markables from a LOWER MarkableLayer (i.e. higher position) are returned before Markables from a HIGHER MarkableLayer (i.e. one with a lower position). Within the same MarkableLayer, longer Markables are ordered before shorter ones. This way, MarkableLayers are added on top of each other.


getStartedMarkables

public static final org.w3c.dom.NodeList getStartedMarkables(java.lang.String discourseElementId,
                                                             java.lang.String levels)
This method returns a NodeSet of all Markables from all ACTIVE layers beginning at the DiscourseElement with ID discourseElementId. If more than one Markable starts at a given DiscourseElement, the Markables returned are sorted in the following way: Markables from a LOWER MarkableLayer (i.e. higher position) are returned before Markables from a HIGHER MarkableLayer (i.e. one with a lower position). Within the same MarkableLayer, longer Markables are ordered before shorter ones. This way, MarkableLayers are added on top of each other.


getEndedMarkables

public static final org.apache.xpath.NodeSet getEndedMarkables(java.lang.String discourseElementId)

getEndedMarkables

public static final org.apache.xpath.NodeSet getEndedMarkables(java.lang.String discourseElementId,
                                                               java.lang.String levels)