This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
Overview
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
Package
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:
Interfaces (italic)
Classes
Exceptions
Errors
Class/Interface
Each class, interface, inner class and inner interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
Class inheritance diagram
Direct Subclasses
All Known Subinterfaces
All Known Implementing Classes
Class/interface declaration
Class/interface description
Inner Class Summary
Field Summary
Constructor Summary
Method Summary
Field Detail
Constructor Detail
Method Detail
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
Tree (Class Hierarchy)
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
Deprecated API
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
Index
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
Prev/Next
These links take you to the next or previous class, interface, package, or related page.
Frames/No Frames
These links show and hide the HTML frames. All pages are available with or without frames.
Serialized Form
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
This help file applies to API documentation generated using the standard doclet.
This field holds a clone of the currently displayed Markable with its values unchanged by any attribute window manipulations that occured since it was
selected by the user.
This field holds a clone of the currently displayed Markable with its values unchanged by any attribute window manipulations that occured since it was
selected by the user.
This method returns true if the Text attribute of one of this Markable's DiscourseEntities is identical (according to caseSensitive) with text, false otherwise.
This method returns true if the Text attribute of one of the DiscourseEntities on this Markable's Base level is identical (according to caseSensitive)
with text, false otherwise.
This method returns true if the Text attribute of one of this Markable's DiscourseEntities ends with suffix (compared according to caseSensitive), false otherwise.
This method returns true if the Text attribute of one of this Markable's DiscourseEntities ends with suffix (compared according to caseSensitive), false otherwise.
This method takes the raw display string (as returned by Discourse.getRawDisplayString()) and transforms it into the final
display string to be displayed in the text pane.
This method tokenizes the sentence in rawText according to this.Disocurse.Separators, adds the tokens as
DiscourseElements and finally creates a Sentence object with these DisocurseElements as span.
This method returns an ArrayList with IDs of those DiscourseElements in this Markable that have Text.endsWith(suffix)==true, compared according to caseSensitivity, or empty list.
This method returns an ArrayList with IDs of those DiscourseElements in this Markable that have Text == text, compared according to caseSensitivity, or empty list.
Orders the DiscourseElement objects this contains according to their starttime values by setting their XContainerPosition
attributes from 0 to getElementCount()-1.
wrapper class for returning results
PRscore.recall, PRscore.precision:
3-field array of int, each containing values needed for calculating precision (p) and recall (r) respectively:
.r/p[0] : S (size of key/response equivalence classes summed up for all key/response-ECs)
.r/p[1] : p (number of partions of key/response-EC relative to response/key-EC summed up for all key/response-ECs
.r/p[2] : n (number of ECs in key/response)
precision/recall = (S-p)/(S-n)
VilainEvaluator:
first implementation of algorithm described in ...
drawbacks (2b mended soon):
> lazy expensive implementation of calculateEC (2b replaced by proper union-find alg);
> exploits java's saloon data structures (fat, slow, ...);
>>> does not check for any errors (denominator = 1, wrong input ...)
howto use:
- create instance (v) of vilain.VilainEvaluator
- call vilain.PRscore score = v.evaluate(keyInputArray, reponseInputArray)
- input format: array of pairs in String format "A B", pair elements separated by whitespace
- return format: instance of class vilain.PRscore (s) containing two arrays of three integers (see PRscore.java)
MMAX094/developer/javadoc/index.html 0100644 0000764 0001001 00000001427 07646562041 017746 0 ustar Administrator Kein
Generated Documentation (Untitled)
<H2>
Frame Alert</H2>
<P>
This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
<BR>
Link to <A HREF="/">Non-frame version.</A>
MMAX094/developer/javadoc/org/ 0040755 0000764 0001001 00000000000 07646563035 016543 5 ustar Administrator Kein MMAX094/developer/javadoc/org/eml/ 0040755 0000764 0001001 00000000000 07646563035 017320 5 ustar Administrator Kein MMAX094/developer/javadoc/org/eml/MMAX/ 0040755 0000764 0001001 00000000000 07646563043 020061 5 ustar Administrator Kein MMAX094/developer/javadoc/org/eml/MMAX/core/ 0040755 0000764 0001001 00000000000 07646563044 021012 5 ustar Administrator Kein MMAX094/developer/javadoc/org/eml/MMAX/core/Markable.html 0100644 0000764 0001001 00000177742 07646562050 023431 0 ustar Administrator Kein
: Class Markable
condenseListHead(java.util.ArrayList realSignalIDs)
Recursively collapses subsequent signal IDs of the same namespace to strings of the form
namespace_x..namespace_y.
containsDiscourseElement(java.lang.String text,
boolean caseSensitive)
This method returns true if the Text attribute of one of this Markable's DiscourseEntities is identical (according to caseSensitive) with text, false otherwise.
boolean
containsDiscourseElementAtBaseLevel(java.lang.String text,
boolean caseSensitive)
This method returns true if the Text attribute of one of the DiscourseEntities on this Markable's Base level is identical (according to caseSensitive)
with text, false otherwise.
boolean
containsDiscourseElementAtBaseLevelEndingWith(java.lang.String suffix,
boolean caseSensitive)
This method returns true if the Text attribute of one of this Markable's DiscourseEntities ends with suffix (compared according to caseSensitive), false otherwise.
boolean
containsDiscourseElementEndingWith(java.lang.String suffix,
boolean caseSensitive)
This method returns true if the Text attribute of one of this Markable's DiscourseEntities ends with suffix (compared according to caseSensitive), false otherwise.
getAttributeValue(java.lang.String attributename)
This method returns the value of the attribute attributename from this Markable's Attributes HashMap.
getDiscourseElementsEndingWithText(java.lang.String suffix,
boolean caseSensitivity)
This method returns an ArrayList with IDs of those DiscourseElements in this Markable that have Text.endsWith(suffix)==true, compared according to caseSensitivity, or empty list.
java.util.ArrayList
getDiscourseElementsWithText(java.lang.String text,
boolean caseSensitivity)
This method returns an ArrayList with IDs of those DiscourseElements in this Markable that have Text == text, compared according to caseSensitivity, or empty list.
getElementAt(int position)
Returns the DiscourseElement at position in this Markable object.
int
getElementCount()
Returns the number of DiscourseElements in this Markable
java.util.ArrayList
getEmbeddedMarkables()
This method returns an ArrayList of all Markables that are embedded in (completely contained by) this one, or empty list if none exists.
hasWordInRightContext(java.lang.String word,
int width)
This method returns the position within 1 and width at which a word with text word appears, or -1 if no word is found within the width
boolean
isClone()
Returns true if this Markable object is a clone, false otherwise.
matches(java.lang.String criterion)
This method receives a String of attribute::value returns true if this Markables matches it, false otherwise.
boolean
matchesAll(java.lang.String[] criteria)
This method receives an array of attribute::value pairs and returns true if this Markable matches all of them, false otherwise.
boolean
matchesAny(java.lang.String[] criteria)
This method receives an array of attribute::value pairs and returns true if this Markables matches at least one of them, false otherwise.
toBracketedString()
This method returns a bracketed String representation of this Markable and it's embeddees.
java.lang.String
toBracketedStringFromList(java.util.ArrayList list)
This method returns a bracketed String representation of this Markable and those of it's embeddees contained in ArrayList list.
toSegmentedString(java.lang.String separator)
This method returns a string representation of this Markable, where single words are separated using separator.
java.lang.String
toString()
This method returns a string representation of this Markable.
Pointer to the Discourse object this Markable is part of (if any).
DiscourseElements
private java.util.ArrayList DiscourseElements
ArrayList of IDs of DiscourseElements that this Markable object consists of. In the 'Discourse API' environment, the Markable
constructor is called with the list of DiscourseElement IDs that have been determined from the markable xml file. In this
environment, the Signals ArrayList (cf. below) is always empty. If we are in the MMAX tool environment, the same constructor
is used. In addition to the DiscourseElements list, however, the Signals ArrayList is maintained as well, containing the IDs
of the abstract (GUI-related) signals that the Markable consists of.
cloned
private boolean cloned
Indicates if this Markable object is a clone.
Signals
public java.util.ArrayList Signals
ArrayList of the IDs of the abstract (internal) signals that this Markable consists of.
Abstract signals are NOT identical to the signals that occur in the span attributes in the markable XML file! (For those, cf. ArrayList DiscourseElements)
When a markable is created in the MMAX tool environment by selecting a portion of text on the GUI....
SignalCount
public int SignalCount
Number of abstract (internal) signals that this Markable consists of.
This is a convenience attribute for this.Signals.size().
ID
public java.lang.String ID
Unique descriptor for this Markable of the form markable_X, where X is a running number.
This attribute is mapped to and from the ID attribute in the markable XML file.
Attributes
public java.util.HashMap Attributes
Collection of attributes of this Markable.
This collection is mapped to and from the attributes in the markable XML file.
displayStartPosition
public int displayStartPosition
displayEndPosition
public int displayEndPosition
Constructor Detail
Markable
public Markable(java.lang.String id,
java.util.ArrayList delist,
java.util.HashMap attributes,
Discourse discourse)
Creates new Markable and initializes fields with supplied parameters. This constructor is used for both the 'Discourse
API' environment and the MMAX tool environment. In any case, the markable is constructed using the IDs of DiscourseElements
underlying it, since those are the only ones available in both environments (as opposed to the Signals ArrayList, which is
non-empty in the 'MMAX tool environment' only.
This constructor also tells the DiscourseElements that they are part of a Markable by adding this.ID to their Markables collections.
Creates a copy of this markable including a deep copy of the Attributes HashMap. To be used for the creation of BackupMarkables in the attribute window.
Returns the first Markable (if any) that points to this Markable, or null.
This method uses the global Markables hash of the MMAX object.
removeAttribute
public void removeAttribute(java.lang.String attributename)
This method removes the attribute with name attributename from this Markable's Attributes HashMap.
Note: Removing the ID attribute is NOT supported.
getAttributeValue
public java.lang.String getAttributeValue(java.lang.String attributename)
This method returns the value of the attribute attributename from this Markable's Attributes HashMap.
The supplied Attribute name is converted to lower case and then looked up. The retrieved value is set to lowercase
before it is returned.
Note: Access to the ID attribute is NOT supported.
setAttributeValue
public void setAttributeValue(java.lang.String attributename,
java.lang.String value)
This method sets the value of the attribute attributename to value value.
The supplied attribute name is converted to lower case before the coresponding attribute is retrieved. So is the value it is set to.
Note: Access to the ID attribute is NOT supported.
applyStyle
public void applyStyle(javax.swing.text.SimpleAttributeSet style)
isIdenticalWith
public boolean isIdenticalWith(java.util.ArrayList abstractSignalList)
MMAX-only! This method returns true if this.Signals consists of the same abstract signals as abstractSignalList
contains
public boolean contains(java.util.ArrayList abstractSignalList)
MMAX-only! This method returns true if this.Signals contains all the abstract signals in abstractSignalList
overlapsWith
public boolean overlapsWith(java.util.ArrayList abstractSignalList)
MMAX-only! This method returns true if this.Signals and abstractSignalList have at least one element in common
matches
public boolean matches(java.lang.String criterion)
This method receives a String of attribute::value returns true if this Markables matches it, false otherwise.
The criterion may be negated by a prepended '!', e.g. !npform::prp
matchesAll
public boolean matchesAll(java.lang.String[] criteria)
This method receives an array of attribute::value pairs and returns true if this Markable matches all of them, false otherwise.
matchesAny
public boolean matchesAny(java.lang.String[] criteria)
This method receives an array of attribute::value pairs and returns true if this Markables matches at least one of them, false otherwise.
getAttributes
public java.util.HashMap getAttributes()
synchronizeAbstractSignalsWithDiscourseElements
public void synchronizeAbstractSignalsWithDiscourseElements()
MMAX-only! This method alters this Markable's Signals list to contain all abstract signal IDs underlying this Markable's DiscourseElements.
It is called 1. during initialization of Markables loaded from the markables xml file and 2. after each alteration of inidividual
Markables through addition and deletion of DiscourseElements. Cf. the complementary method this.synchronizeDiscourseElementsWithAbstractSignals().
synchronizeDiscourseElementsWithAbstractSignals
public void synchronizeDiscourseElementsWithAbstractSignals()
MMAX-only! This method alters this Markable's DiscourseElements list to contain all base signal IDs underlying this Markable's abstract signals.
It is called after each alteration of inidividual Markables through addition and deletion of Signals via the MMAX gui. Cf. the complementary method this.synchronizeAbstractSignalsWithDiscourseElements().
Since Signals is always re-ordered after abstract signals have been added, DiscourseElements, when updated using this method, are also guaranteed to be in document order.
addAbstractSignals
public void addAbstractSignals(java.util.ArrayList abstractSignalList,
boolean hybridAllowed)
MMAX-only! This method adds the abstract signals in abstractSignalList to this Markable's signal collection.
The new signal collection is then sorted internally to always reflect document order.
Finally, this.synchronizeDiscourseElementsWithAbstractSignals() is called, so that the DiscourseElement list reflects the new extent of the Markable.
removeAbstractSignals
public void removeAbstractSignals(java.util.ArrayList abstractSignalList)
MMAX-only! This method removes the abstract signals in abstractSignalList from this Markable's signal collection.
Then it calls this.synchronizeDiscourseElementsWithAbstractSignals() to ensure this.DiscourseElements is up-to-date.
orderAbstractSignalList
public void orderAbstractSignalList()
MMAX-only!
GetStartTime
public double GetStartTime()
This method returns the start time of this Markable, or 0 if no time is supplied.
The value returned is copied from the markable XML file.
Note: This method is temporarily disabled and returns always 0.
GetEndTime
public double GetEndTime()
This method returns the end time of this Markable, or 0 if no time is supplied.
The value returned is copied from the markable XML file.
Note: This method is temporarily disabled and returns always 0.
toString
public java.lang.String toString()
This method returns a string representation of this Markable.
Overrides:
toString in class java.lang.Object
toTrimmedString
public java.lang.String toTrimmedString()
toSegmentedString
public java.lang.String toSegmentedString(java.lang.String separator)
This method returns a string representation of this Markable, where single words are separated using separator.
getRightFrontier
public java.util.ArrayList getRightFrontier()
This method returns an ArrayList of all Markables at the right frontier of this, or empty list.
toBracketedStringFromList
public java.lang.String toBracketedStringFromList(java.util.ArrayList list)
This method returns a bracketed String representation of this Markable and those of it's embeddees contained in ArrayList list.
toBracketedString
public java.lang.String toBracketedString()
This method returns a bracketed String representation of this Markable and it's embeddees.
condenseListHead
public java.lang.String condenseListHead(java.util.ArrayList realSignalIDs)
Recursively collapses subsequent signal IDs of the same namespace to strings of the form
namespace_x..namespace_y.
getSpan
public java.lang.String getSpan()
MMAX-only!! Returns the element span of this Markable. This can handle hybrid markables.
toXMLElement
public java.lang.String toXMLElement()
This method converts this Markable into an XML String representation for file storage.
dumpAttributes
public void dumpAttributes()
hasDefaultValue
public boolean hasDefaultValue(java.lang.String attributename)
getDefaultValue
public java.lang.String getDefaultValue()
getDiscourseElementsWithText
public java.util.ArrayList getDiscourseElementsWithText(java.lang.String text,
boolean caseSensitivity)
This method returns an ArrayList with IDs of those DiscourseElements in this Markable that have Text == text, compared according to caseSensitivity, or empty list.
getDiscourseElementsEndingWithText
public java.util.ArrayList getDiscourseElementsEndingWithText(java.lang.String suffix,
boolean caseSensitivity)
This method returns an ArrayList with IDs of those DiscourseElements in this Markable that have Text.endsWith(suffix)==true, compared according to caseSensitivity, or empty list.
getDiscourseElements
public java.util.ArrayList getDiscourseElements()
containsDiscourseElementEndingWith
public boolean containsDiscourseElementEndingWith(java.lang.String suffix,
boolean caseSensitive)
This method returns true if the Text attribute of one of this Markable's DiscourseEntities ends with suffix (compared according to caseSensitive), false otherwise.
containsDiscourseElementAtBaseLevelEndingWith
public boolean containsDiscourseElementAtBaseLevelEndingWith(java.lang.String suffix,
boolean caseSensitive)
This method returns true if the Text attribute of one of this Markable's DiscourseEntities ends with suffix (compared according to caseSensitive), false otherwise.
containsDiscourseElement
public boolean containsDiscourseElement(java.lang.String text,
boolean caseSensitive)
This method returns true if the Text attribute of one of this Markable's DiscourseEntities is identical (according to caseSensitive) with text, false otherwise.
containsDiscourseElementAtBaseLevel
public boolean containsDiscourseElementAtBaseLevel(java.lang.String text,
boolean caseSensitive)
This method returns true if the Text attribute of one of the DiscourseEntities on this Markable's Base level is identical (according to caseSensitive)
with text, false otherwise.
getMatchingEmbeddedMarkables
public java.util.ArrayList getMatchingEmbeddedMarkables(java.lang.String[] criteria)
getEmbeddedMarkables
public java.util.ArrayList getEmbeddedMarkables()
This method returns an ArrayList of all Markables that are embedded in (completely contained by) this one, or empty list if none exists.
The Markables returned are ordered in Document order, shorter before longer ones.
addAbstractSignalsToMarkable()
This method is called when the addition of abstract signals to a Markable has been performed via the GUI.
static void
addMarkableToAnnotation(java.lang.String Startsignal,
java.lang.String Endsignal)
This method is called when the creation of a new Markable has been performed via the MMAX gui.
exitForm(java.awt.event.WindowEvent evt)
Exit the Application
static void
fireMarkableCreated(Markable newMarkable)
This method notifies the registered MarkableEventListener (if any) that a
new Markable object has been created.
static void
fireMarkableDeleted(Markable deletedMarkable)
This method notifies the registered MarkableEventListener (if any) that a
Markable object has been deleted.
static void
fireMemberRelationCreated(Markable selectedmember,
Markable newmember)
This method notifies the registered MarkableEventListener (if any) that a member
relation between two Markable objects has been created.
static void
fireMemberRelationDeleted(Markable selectedmember,
Markable removedmember)
This method notifies the registered MarkableEventListener (if any) that the member
relation between two Markable objects has been deleted.
static void
firePointingRelationCreated(Markable pointer,
Markable pointee)
This method notifies the registered MarkableEventListener (if any) that a pointing
relation between two Markable objects has been created.
static void
firePointingRelationDeleted(Markable pointer,
Markable pointee)
This method notifies the registered MarkableEventListener (if any) that the pointing
relation between two Markable objects has been deleted.
static java.lang.String
getAbstractSignalID(java.lang.String basesignalid)
This method returns the abstract signal ID (e.g. signal_54) coresponding to the supplied base signal ID (e.g. word_89).
static java.lang.String
getBaseSignalID(java.lang.String abstractsignalid)
This method returns the base signal ID (e.g. word_4) coresponding to the supplied abstract signal ID (e.g. signal_89).
static java.util.ArrayList
getMarkableIDs(java.lang.String abstractsignalid)
This method returns an ArrayList with IDs of those Markables that the supplied abstract signal (e.g. signal_8) is part of.
removeAbstractSignalsFromMarkable()
This method is called when the removal of abstract signals from a Markable has been performed via the GUI.
static void
removeSignalToMarkableMapping(java.lang.String markableid)
This method removes all references to markable markableid from ListHash.
static void
removeSignalToMarkableMappingForKey(java.lang.String markableid,
java.lang.String abstractSignalID)
This method removes all references of abstract signals in abstractSignalList to markable markableid from ListHash.
boolean
resetAll()
This method resets all internal settings prior to loading a new .anno file.
static void
saveAnnotations(java.lang.String Name)
Writes Markable-DOM to Markable-file, creates backup first
setSaveButtonEnabled(boolean newStatus)
This method is called (e.g. from the AttributeWindow) to enable or disable the save button in the main display.
public static void setSaveButtonEnabled(boolean newStatus)
This method is called (e.g. from the AttributeWindow) to enable or disable the save button in the main display.
resetAll
public boolean resetAll()
This method resets all internal settings prior to loading a new .anno file.
hybridMarkableSupport
public static boolean hybridMarkableSupport()
baseSignalsToAbstractSignals
public static java.util.ArrayList baseSignalsToAbstractSignals(java.util.ArrayList signals)
MMAX-only! This method receives an ArrayList of base signal IDs (e.g. word_5) and maps it to an ArrayList of corresponsding abstract signal IDs
abstractSignalsToBaseSignals
public static java.util.ArrayList abstractSignalsToBaseSignals(java.util.ArrayList signals)
MMAX-only! This method receives an ArrayList of abstract signal IDs (e.g. signal_5) and maps it to an ArrayList of corresponsding base signal IDs
getMarkableIDs
public static java.util.ArrayList getMarkableIDs(java.lang.String abstractsignalid)
This method returns an ArrayList with IDs of those Markables that the supplied abstract signal (e.g. signal_8) is part of.
clearSignalToMarkableMapping
public static void clearSignalToMarkableMapping()
insertSignalToMarkableMapping
public static void insertSignalToMarkableMapping(java.lang.String abstractsignalid,
java.lang.String markableid)
removeSignalToMarkableMapping
public static void removeSignalToMarkableMapping(java.lang.String markableid)
This method removes all references to markable markableid from ListHash. This method is called after deletion of Markable markableid.
removeSignalToMarkableMappingForKey
public static void removeSignalToMarkableMappingForKey(java.lang.String markableid,
java.lang.String abstractSignalID)
This method removes all references of abstract signals in abstractSignalList to markable markableid from ListHash. This method is called after the abstract signal has been removed from the Markable.
getParentUnitID
public static java.lang.String getParentUnitID(java.lang.String abstractsignalid)
getBaseSignalID
public static java.lang.String getBaseSignalID(java.lang.String abstractsignalid)
This method returns the base signal ID (e.g. word_4) coresponding to the supplied abstract signal ID (e.g. signal_89).
getAbstractSignalID
public static java.lang.String getAbstractSignalID(java.lang.String basesignalid)
This method returns the abstract signal ID (e.g. signal_54) coresponding to the supplied base signal ID (e.g. word_89).
parseAnnoFile
public void parseAnnoFile(java.lang.String annofilename,
boolean validate)
This method is the main entry point into the MMAX application. It takes the .anno file specified by the supplied String and
creates the entire internal representation and display string from it.
signalToString
public static java.lang.String signalToString(java.lang.String ID)
saveAnnotations
public static void saveAnnotations(java.lang.String Name)
Writes Markable-DOM to Markable-file, creates backup first
saveAnnotationsAs
public static boolean saveAnnotationsAs()
loadAnnotations
public static boolean loadAnnotations()
updatePointerSet
public static void updatePointerSet()
updateMarkableSets
public static void updateMarkableSets(boolean membprior)
DoUserAction
public static void DoUserAction()
removeAbstractSignalsFromMarkable
public static void removeAbstractSignalsFromMarkable()
This method is called when the removal of abstract signals from a Markable has been performed via the GUI.
getSomeValue
public static int getSomeValue(int factor)
addAbstractSignalsToMarkable
public static void addAbstractSignalsToMarkable()
This method is called when the addition of abstract signals to a Markable has been performed via the GUI.
deleteMarkableFromAnnotation
public static void deleteMarkableFromAnnotation()
This method is called when the deletion of a Markable has been performed via the GUI.
addMarkableToAnnotation
public static void addMarkableToAnnotation(java.lang.String Startsignal,
java.lang.String Endsignal)
This method is called when the creation of a new Markable has been performed via the MMAX gui.
processUserAction
public static void processUserAction()
initComponents
private void initComponents()
This method is called from within the constructor to
initialize the form.
WARNING: Do NOT modify this code. The content of this method is
always regenerated by the FormEditor.
This class is used to model a discourse object. A discourse is either a written text, or a (possibly multi-modal) dialogue with arbitrary many speakers.
Field Summary
protected java.lang.String
annoFileName
This field stores the name of the anno file from which this Discourse has been built (by the DiscourseLoader), or to which it is to be written.
wordDOMFileName
This field stores the name of the Word XML file.
protected java.lang.String
wordFileDoctype
This field stores the word file DOCTYPE, (if any), as read from the DOM parser or set manually.
protected java.lang.String
wordFileHeader
This field stores the word file header (incl. xml decl. and encoding (if any)), as read from the DOM parser or set manually.
(package private) java.util.ArrayList
Words
Contains IDs of all DiscourseElement objects of type WORD in this Discourse .
Constructor Summary
Discourse(java.lang.String annofilename,
java.lang.String separators)
Creates an empty Discourse object as the basis for incremental Discourse building by means of the DiscourseBuilder.
createInitialMarkableHashBackup()
This method converts the markables in this object's markableDOM to Markable objects and puts them in the MarkableHash.
getLongestMarkable(java.util.ArrayList markables)
This method receives a list of Markables beginning at the same position, and returns the longest one of those.
getMarkableList(boolean sortToDocumentOrder)
This method returns a list of all Markables in this Discourse, optionally sorted in document order, with shorter Markables before longer ones.
getRawDisplayString(java.lang.String datapath)
This method submits the supraBaseDOM to the XSL transformation, using the XSL style sheet this.getStylesheetFileName().
Contains all DiscourseElements in this Discourse object and maps them to their respective IDs. This is the sole object repository for retrieval of any DiscourseElement.
Sentences
java.util.ArrayList Sentences
Contains all Sentence objects in this Discourse.
Turns
java.util.ArrayList Turns
Contains all Turn objects in this Discourse.
Utterances
java.util.ArrayList Utterances
Contains all Utterance objects in this Discourse.
Markables
java.util.ArrayList Markables
Contains all Markable objects in this Discourse.
Words
java.util.ArrayList Words
Contains IDs of all DiscourseElement objects of type WORD in this Discourse .
Gestures
java.util.ArrayList Gestures
Contains IDs of all DiscourseElement objects of type GESTURE in this Discourse .
Keyactions
java.util.ArrayList Keyactions
Contains IDs of all DiscourseElement objects of type KEYACTION in this Discourse .
discourseType
protected java.lang.String discourseType
Type of this Discourse. Possible values are 'text' or 'dialogue'. This field is set automatically depending on either the constellation of input DOMs (when used with the DiscourseLoader), or the type of elements added incrementally (when used with the DiscourseBuilder).
mainStructuralUnit
protected java.lang.String mainStructuralUnit
The main structural unit of a Discourse object depends on the type of Discourse. Possible values are 'sentence' or 'turn'. This field is set automatically depending on the the value of the discourseType field.
wordDOMFileName
protected java.lang.String wordDOMFileName
This field stores the name of the Word XML file.
wordFileHeader
protected java.lang.String wordFileHeader
This field stores the word file header (incl. xml decl. and encoding (if any)), as read from the DOM parser or set manually.
wordFileDoctype
protected java.lang.String wordFileDoctype
This field stores the word file DOCTYPE, (if any), as read from the DOM parser or set manually.
gestureDOMFileName
protected java.lang.String gestureDOMFileName
This field stores the name of the Gesture XML file.
gestureFileHeader
protected java.lang.String gestureFileHeader
This field stores the gesture file header (incl. xml decl. and encoding (if any)), as read from the DOM parser or set manually.
gestureFileDoctype
protected java.lang.String gestureFileDoctype
This field stores the gesture file DOCTYPE, (if any), as read from the DOM parser or set manually.
keyactionDOMFileName
protected java.lang.String keyactionDOMFileName
This field stores the name of the Keyaction XML file.
keyactionFileHeader
protected java.lang.String keyactionFileHeader
This field stores the keyaction file header (incl. xml decl. and encoding (if any)), as read from the DOM parser or set manually.
keyactionFileDoctype
protected java.lang.String keyactionFileDoctype
This field stores the keyaction file DOCTYPE, (if any), as read from the DOM parser or set manually.
dialogueDOMFileName
protected java.lang.String dialogueDOMFileName
This field stores the name of the Dialogue XML file.
dialogueFileHeader
protected java.lang.String dialogueFileHeader
This field stores the dialogue file header (incl. xml decl. and encoding (if any)), as read from the DOM parser or set manually.
dialogueFileDoctype
protected java.lang.String dialogueFileDoctype
This field stores the dialogue file DOCTYPE, (if any), as read from the DOM parser or set manually.
textDOMFileName
protected java.lang.String textDOMFileName
This field stores the name of the Text XML file.
textFileHeader
protected java.lang.String textFileHeader
This field stores the text file header (incl. xml decl. and encoding (if any)), as read from the DOM parser or set manually.
textFileDoctype
protected java.lang.String textFileDoctype
This field stores the text file DOCTYPE, (if any), as read from the DOM parser or set manually.
utteranceDOMFileName
protected java.lang.String utteranceDOMFileName
This field stores the name of the Utterance XML file.
utteranceFileHeader
protected java.lang.String utteranceFileHeader
This field stores the utterance file header (incl. xml decl. and encoding (if any)), as read from the DOM parser or set manually.
utteranceFileDoctype
protected java.lang.String utteranceFileDoctype
This field stores the utterance file DOCTYPE, (if any), as read from the DOM parser or set manually.
nextFreeMarkableID
public int nextFreeMarkableID
This field stores the next free ID for an element of this type
nextFreeSignalID
public int nextFreeSignalID
This field stores the next free ID for an element of this type
nextFreeUtteranceID
private int nextFreeUtteranceID
This field stores the next free ID for an element of this type
nextFreeWordID
private int nextFreeWordID
This field stores the next free ID for an element of this type
nextFreeGestureID
private int nextFreeGestureID
This field stores the next free ID for an element of this type
nextFreeKeyactionID
private int nextFreeKeyactionID
This field stores the next free ID for an element of this type
nextFreeTurnID
private int nextFreeTurnID
This field stores the next free ID for an element of this type
nextFreeSentenceID
private int nextFreeSentenceID
This field stores the next free ID for an element of this type
annoFileName
protected java.lang.String annoFileName
This field stores the name of the anno file from which this Discourse has been built (by the DiscourseLoader), or to which it is to be written.
stylesheetFileName
protected java.lang.String stylesheetFileName
This field stores the name of the style sheet XSL file.
schemeFileName
protected java.lang.String schemeFileName
This field stores the name of the scheme file (.scheme or .xml).
readonlyLevels
protected java.lang.String readonlyLevels
This field stores the IDs of SchemeLevels within annotation scheme file this.schemeFileName
public Discourse(java.lang.String annofilename,
java.lang.String separators)
Creates an empty Discourse object as the basis for incremental Discourse building by means of the DiscourseBuilder.
Discourse objects created by means of this constructor do not make use of any xxxDOM objects, all of which will be null.
The same is true for the markableHash object, for baseDOM and supraBaseDOM, and for all kinds of signalToAbstractSignalID mappings.
public MarkablegetMarkableByID(java.lang.String id)
removeMarkableByID
public void removeMarkableByID(java.lang.String id)
isSeparator
public boolean isSeparator(java.lang.String token)
This method returns true for single-character strings that consist of characters in this.Separators. For multi-character strings,
it returns false if they contain at least one non-separator character, true otherwise.
Returns the number of formal DiscourseElementContainer elements between element1 and element2.
If element1 and element2 are words, it returns the number of sentence elements, which is 0 if both are in the same sentence.
Returns the number of pragmatic DiscourseElementContainer elements between element1 and element2.
It returns the number of utterance elements, which is 0 if both are in the same sentence.
Returns the number of non-separator DiscourseElements + 1 between element1 and element2.
The distance between two neighbouring elements is 1 !!!
getMemberSetWithValue
public java.util.ArrayList getMemberSetWithValue(java.lang.String membervalue,
boolean sort)
getMemberSets
public java.util.ArrayList[] getMemberSets(boolean sort)
getMemberSetsBackup
public java.util.ArrayList[] getMemberSetsBackup(boolean sort)
getMarkableList
public java.util.ArrayList getMarkableList(boolean sortToDocumentOrder)
This method returns a list of all Markables in this Discourse, optionally sorted in document order, with shorter Markables before longer ones.
getMarkableListBackup
public java.util.ArrayList getMarkableListBackup()
This is not REALLY ordered ??
createBaseDOM
public void createBaseDOM()
MMAX-only! This method merges the word, gesture and keyaction DOMs into an abstract signal DOM of DOCTYPE .
Signal elements are inserted as children to their respective abstract signals.
The DOM returned by this method serves as the _content_ part of the display DOM
to be submitted to the XSL processor for display creation. TODO: Modify so that this method does not use DOMs any more.
displayPositionsToAbstractSignallist
public java.util.ArrayList displayPositionsToAbstractSignallist(int dot,
int mark,
boolean hybrid)
MMAX-only! This method creates an ArrayList of all abstract signals between positions dot and mark (incl.).
If hybrid == false, it checks in StringHash AbstractSignalIDToSignalID whether all signals have the same namespace.
Returns the signallist, which is empty in case it would be illegally hybrid.
createSupraBaseDOM
public void createSupraBaseDOM()
MMAX-only! This method takes the given structureDOM of global type MainStructuralUnit (i.e. turn or sentence) and adds
abstract signals (incl. their children) from signalDOM according to these elements' span attributes.
getRawDisplayString
public java.lang.String getRawDisplayString(java.lang.String datapath)
This method submits the supraBaseDOM to the XSL transformation, using the XSL style sheet this.getStylesheetFileName().
The result is a linearized String containing tags for those elements that are supposed to be clickable in the
display. It also contains all kinds of markup like ... etc. The raw display string returned by this method
is then used in the DeepTextPane constructor.
createInitialMarkableHash
public void createInitialMarkableHash()
MMAX-only! This method also inits the global counter for markable ID creation and for memberset value creation.
createInitialMarkableHashBackup
public void createInitialMarkableHashBackup()
This method converts the markables in this object's markableDOM to Markable objects and puts them in the MarkableHash.
The MarkableHash is the single repository to which all subsequent changes of markables (like creation, deletion, annotation)
are written. The this.markableDOM should be destroyed after this method ends !! (Or should it?)
This method also inits the global counter for markable ID creation and for memberset value creation.
public void setMarkableFileHeader(java.lang.String header)
getMarkableFileHeader
public java.lang.String getMarkableFileHeader()
getMainStructuralUnit
public java.lang.String getMainStructuralUnit()
getDiscourseType
public java.lang.String getDiscourseType()
hasUtteranceMarkup
public boolean hasUtteranceMarkup()
hasTimeStamps
public boolean hasTimeStamps()
setWordDOMFileName
public void setWordDOMFileName(java.lang.String name)
getWordDOMFileName
public java.lang.String getWordDOMFileName()
setWordFileHeader
public void setWordFileHeader(java.lang.String header)
getWordFileHeader
public java.lang.String getWordFileHeader()
setWordFileDoctype
public void setWordFileDoctype(java.lang.String doctype)
getWordFileDoctype
public java.lang.String getWordFileDoctype()
setGestureDOMFileName
public void setGestureDOMFileName(java.lang.String name)
getGestureDOMFileName
public java.lang.String getGestureDOMFileName()
setGestureFileHeader
public void setGestureFileHeader(java.lang.String header)
getGestureFileHeader
public java.lang.String getGestureFileHeader()
setGestureFileDoctype
public void setGestureFileDoctype(java.lang.String doctype)
getGestureFileDoctype
public java.lang.String getGestureFileDoctype()
setKeyactionDOMFileName
public void setKeyactionDOMFileName(java.lang.String name)
getKeyactionDOMFileName
public java.lang.String getKeyactionDOMFileName()
setKeyactionFileHeader
public void setKeyactionFileHeader(java.lang.String header)
getKeyactionFileHeader
public java.lang.String getKeyactionFileHeader()
setKeyactionFileDoctype
public void setKeyactionFileDoctype(java.lang.String doctype)
getKeyactionFileDoctype
public java.lang.String getKeyactionFileDoctype()
setDialogueDOMFileName
public void setDialogueDOMFileName(java.lang.String name)
getDialogueDOMFileName
public java.lang.String getDialogueDOMFileName()
setDialogueFileHeader
public void setDialogueFileHeader(java.lang.String header)
getDialogueFileHeader
public java.lang.String getDialogueFileHeader()
setDialogueFileDoctype
public void setDialogueFileDoctype(java.lang.String doctype)
getDialogueFileDoctype
public java.lang.String getDialogueFileDoctype()
setTextDOMFileName
public void setTextDOMFileName(java.lang.String name)
getTextDOMFileName
public java.lang.String getTextDOMFileName()
setTextFileHeader
public void setTextFileHeader(java.lang.String header)
getTextFileHeader
public java.lang.String getTextFileHeader()
setTextFileDoctype
public void setTextFileDoctype(java.lang.String doctype)
getTextFileDoctype
public java.lang.String getTextFileDoctype()
setUtteranceDOMFileName
public void setUtteranceDOMFileName(java.lang.String name)
getUtteranceDOMFileName
public java.lang.String getUtteranceDOMFileName()
setUtteranceFileHeader
public void setUtteranceFileHeader(java.lang.String header)
getUtteranceFileHeader
public java.lang.String getUtteranceFileHeader()
setUtteranceFileDoctype
public void setUtteranceFileDoctype(java.lang.String doctype)
getUtteranceFileDoctype
public java.lang.String getUtteranceFileDoctype()
setAnnoFileName
public void setAnnoFileName(java.lang.String name)
getAnnoFileName
public java.lang.String getAnnoFileName()
setStylesheetFileName
public void setStylesheetFileName(java.lang.String name)
getStylesheetFileName
public java.lang.String getStylesheetFileName()
setSchemeFileName
public void setSchemeFileName(java.lang.String name)
getSchemeFileName
public java.lang.String getSchemeFileName()
setReadonlyLevels
public void setReadonlyLevels(java.lang.String levels)
getReadonlyLevels
public java.lang.String getReadonlyLevels()
setMarkableDOMFileName
public void setMarkableDOMFileName(java.lang.String name)
getMarkableDOMFileName
public java.lang.String getMarkableDOMFileName()
setMarkableFileDoctype
public void setMarkableFileDoctype(java.lang.String name)
getMarkableFileDoctype
public java.lang.String getMarkableFileDoctype()
getWordCount
public int getWordCount()
getGestureCount
public int getGestureCount()
getKeyactionCount
public int getKeyactionCount()
getMarkableCount
public int getMarkableCount()
saveWordFile
public void saveWordFile()
This method saves DiscourseElements of type WORD to a file named this.wordDOMFileName. If a file with this name already exists, a .bak is created first.
saveGestureFile
public void saveGestureFile()
This method saves DiscourseElements of type GESTURE to a file named this.gestureDOMFileName. If a file with this name already exists, a .bak is created first.
saveKeyactionFile
public void saveKeyactionFile()
This method saves DiscourseElements of type KEYACTION to a file named this.keyactionDOMFileName. If a file with this name already exists, a .bak is created first.
saveDialogueFile
public void saveDialogueFile()
This method saves DiscourseElementContainers of type to a file named this.dialogueDOMFileName. If a file with this name already exists, a .bak is created first.
saveTextFile
public void saveTextFile()
This method saves DiscourseElementContainers of type to a file named this.textDOMFileName. If a file with this name already exists, a .bak is created first.
saveMarkableFile
public void saveMarkableFile()
This method saves Markables to a file named this.markableDOMFileName. If a file with this name already exists, a .bak is created first.
saveAnnoFile
public void saveAnnoFile()
getNextFreeTurnID
public java.lang.String getNextFreeTurnID()
getNextFreeSentenceID
public java.lang.String getNextFreeSentenceID()
getNextFreeUtteranceID
public java.lang.String getNextFreeUtteranceID()
getNextFreeWordID
public java.lang.String getNextFreeWordID()
getNextFreeGestureID
public java.lang.String getNextFreeGestureID()
getNextFreeKeyactionID
public java.lang.String getNextFreeKeyactionID()
getNextFreeMarkableID
public java.lang.String getNextFreeMarkableID()
getSeparators
public java.lang.String getSeparators()
getLongestMarkable
public MarkablegetLongestMarkable(java.util.ArrayList markables)
This method receives a list of Markables beginning at the same position, and returns the longest one of those.
createSentence(java.lang.String rawText)
This method tokenizes the sentence in rawText according to this.Disocurse.Separators, adds the tokens as
DiscourseElements and finally creates a Sentence object with these DisocurseElements as span.
Returns the Discourse in its current state. This method is intended to retrieve intermediate Discourse
objects for incremental display. It is also the only method to retrieve the completed Discourse from the DiscourseBuilder.
addMarkable
public java.lang.String addMarkable(java.util.ArrayList discourseElements,
java.util.HashMap attributes)
addTurnAtDiscoursePosition
public java.lang.String addTurnAtDiscoursePosition(java.util.ArrayList discourseElements,
java.util.HashMap attributes,
int discoursePosition)
addSentenceAtDiscoursePosition
public java.lang.String addSentenceAtDiscoursePosition(java.util.ArrayList discourseElements,
java.util.HashMap attributes,
int discoursePosition)
addWord
public java.lang.String addWord(java.lang.String text,
java.util.HashMap attributes)
Add a DiscourseElement object of ElementType WORD to the Discourse's Repository. No association between newly added word and any turn or sentence is established!
addGesture
public java.lang.String addGesture(java.util.HashMap attributes)
Add a DiscourseElement object of ElementType GESTURE to the Discourse's Repository. No association between newly added gesture and any turn is established!
addKeyaction
public java.lang.String addKeyaction(java.util.HashMap attributes)
Add a DiscourseElement object of ElementType KEYACTION to the Discourse's Repository. No association between newly added keyaction and any turn is established!
createAttributes
public java.util.HashMap createAttributes(java.lang.String initialKey,
java.lang.String initialValue)
createSentence
public void createSentence(java.lang.String rawText)
This method tokenizes the sentence in rawText according to this.Disocurse.Separators, adds the tokens as
DiscourseElements and finally creates a Sentence object with these DisocurseElements as span. DiscourseElements
get the attribute separator='true' if they are separators (for use with style sheet).
importERFFileFormat
public void importERFFileFormat(java.lang.String erffile)
importPennTreebankFormat
public void importPennTreebankFormat(java.lang.String mergeFileName)
Experimental!!
buildTextDiscourse
public void buildTextDiscourse(java.lang.String textFileName)
DiscourseElement objects represent the smallest entities that a discourse can consist of.
Three types of DiscourseElement objects exist: WORD, GESTURE, KEYACTION
Field Summary
private java.util.HashMap
Attributes
Diverse Attributes of this DiscourseElement (copied from basic signal).
PragmaticContainer
The DiscourseElementContainer this DiscourseElement is part of on the pragmatic level (utterance)
protected int
PragmaticContainerPosition
Position of this DiscourseElement in the pragmatic DiscourseElementContainer (utterance) it belongs to, or -1.
java.lang.String
Text
Textual representation of this DiscourseElement (depending on ElementType).
Constructor Summary
DiscourseElement(org.w3c.dom.Element currentbasicsignal,
java.lang.String signaltype)
Creates new DiscourseElement of type signaltype (WORD, GESTURE, KEYACTION) from Element currentbasicsignal.
DiscourseElement(java.lang.String signaltype,
java.util.HashMap attributes,
java.lang.String text)
Creates new DiscourseElement of type signaltype with attributes attributes and Text text.
Method Summary
void
addMarkable(java.lang.String markableid)
Adds to this DiscourseElement's Markables collection the id markableid
endsMarkable(Markable markable)
Returns true if this DiscourseElement is the last one in Markable markable, false otherwise.
java.lang.String
getAttributeValue(java.lang.String attributename)
This method returns the value of the attribute attributename from this DiscourseElement's Attributes HashMap.
java.util.ArrayList
getEndedMarkables()
This method returns an ArrayList of those Markable objects that it is the last one in, or empty list.
The DiscourseElementContainer this DiscourseElement is part of on the formal level (sentence or turn).
FormalContainerPosition
protected int FormalContainerPosition
Position of this DiscourseElement in the formal DiscourseElementContainer (sentence or turn) it belongs to, or -1.
Valid ranges is from 0 (first element) to length of DiscourseElementContainer-1
The DiscourseElementContainer this DiscourseElement is part of on the pragmatic level (utterance)
PragmaticContainerPosition
protected int PragmaticContainerPosition
Position of this DiscourseElement in the pragmatic DiscourseElementContainer (utterance) it belongs to, or -1.
Valid range is from 0 (first element) to length of DiscourseElementContainer-1
ID
public java.lang.String ID
ID of this DiscourseElement, copied from original Node. This is a shortcut to getAttributes.getNamedItem("id").getNodeValue
Markables
protected java.util.ArrayList Markables
List of Markables' ID strings that this DiscourseElement is part of.
Constructor Detail
DiscourseElement
public DiscourseElement(java.lang.String signaltype,
java.util.HashMap attributes,
java.lang.String text)
Creates new DiscourseElement of type signaltype with attributes attributes and Text text. If signaltype != WORD and text =="", Text is set to a generic descriptor.
DiscourseElement
public DiscourseElement(org.w3c.dom.Element currentbasicsignal,
java.lang.String signaltype)
Creates new DiscourseElement of type signaltype (WORD, GESTURE, KEYACTION) from Element currentbasicsignal.
Method Detail
setPositionInFormalContainer
public void setPositionInFormalContainer(int formalcontainerposition)
Sets the value of the field FormalContainerPosition
getPositionInFormalContainer
public int getPositionInFormalContainer()
Returns the value of the field FormalContainerPosition
This method returns true if this DiscourseElement is on the base level of Markable markable, false otherwise.
This is the case if this DiscourseElement does not contain in its Markables list any Markable that is _shorter_ than the supplied one.
DiscourseElementContainer is the basic class from which Utterance, Turn and Sentence classes are derived.
This class implements the basic methods for accessing DiscourseElement objects.
Field Summary
protected java.util.HashMap
Attributes
Diverse Attributes of this DiscourseElementContainer (copied from basic signal).
protected boolean
cloned
Indicates if this DiscourseElementContainer object is a clone.
Discourse
Reference to the Discourse object that this DiscourseElementContainer is part of
protected java.util.ArrayList
DiscourseElements
List of all DiscourseElement ID strings in this utterance/turn/sentence
protected int
DiscoursePosition
Position of this container in the Discourse object it belongs to
protected java.lang.String
ID
Unique identifier of this utterance/turn/sentence in the discourse (copied from MMAX element tag)
protected java.lang.String
Type
Indicates the type of this DiscourseElementContainer: SENTENCE, TURN or UTTERANCE
Constructor Summary
DiscourseElementContainer(java.lang.String id,
java.util.ArrayList discourseelementids,
java.util.HashMap attributes,
int discourseposition,
Discourse discourse)
Creates new DiscourseElementContainer
Method Summary
java.lang.String
condenseListHead(java.util.ArrayList elementIDs)
Recursively collapses subsequent signal IDs of the same namespace to strings of the form
namespace_x..namespace_y.
java.lang.String
getAttributeValue(java.lang.String attributename)
Returns the value of the Attribute with name attributename
getFollowingElement(DiscourseElement currentelement)
Returns the DiscourseElement directly following currentelement in this container, or null if not available
getPreceedingElement(DiscourseElement currentelement)
Returns the DiscourseElement directly preceeding currentelement in this container, or null if not available
java.lang.String
getSpan()
Returns the span of this DiscourseElementContainer in XML.
void
orderByStartTime(boolean dump)
Orders the DiscourseElement objects this contains according to their starttime values by setting their XContainerPosition
attributes from 0 to getElementCount()-1.
Reference to the Discourse object that this DiscourseElementContainer is part of
cloned
protected boolean cloned
Indicates if this DiscourseElementContainer object is a clone.
Type
protected java.lang.String Type
Indicates the type of this DiscourseElementContainer: SENTENCE, TURN or UTTERANCE
Constructor Detail
DiscourseElementContainer
public DiscourseElementContainer(java.lang.String id,
java.util.ArrayList discourseelementids,
java.util.HashMap attributes,
int discourseposition,
Discourse discourse)
Creates new DiscourseElementContainer
Method Detail
getElementCount
public int getElementCount()
Returns the number of DiscourseElements in this container.
If _this_ is a Sentence object, both words and separators are returned. Use getWordCount() to get number of non-separators!
Returns the DiscourseElement at position pos from this container
getPositionInDiscourse
public int getPositionInDiscourse()
getAttributeValue
public java.lang.String getAttributeValue(java.lang.String attributename)
Returns the value of the Attribute with name attributename
setAttributeValue
public boolean setAttributeValue(java.lang.String attributename,
java.lang.String value)
orderByStartTime
public void orderByStartTime(boolean dump)
Orders the DiscourseElement objects this contains according to their starttime values by setting their XContainerPosition
attributes from 0 to getElementCount()-1. This method is called by the Discourse constructor after creating a DiscourseElementContainer object.
It also changes the order in DiscourseElements to reflect the new order!
getSpan
public java.lang.String getSpan()
Returns the span of this DiscourseElementContainer in XML. The span is allowed to be hybrid and/or discontinuous.
condenseListHead
public java.lang.String condenseListHead(java.util.ArrayList elementIDs)
Recursively collapses subsequent signal IDs of the same namespace to strings of the form
namespace_x..namespace_y.
toXMLElement
public java.lang.String toXMLElement()
This method converts this DiscourseElementContainer into an XML String representation for file storage.
removeAttribute
public void removeAttribute(java.lang.String attributename)
wordDOMFileName
This field temporarily stores the name of the Word XML file (as given in the -anno file).
protected java.lang.String
wordFileDoctype
This field temporarily stores the word file DOCTYPE, (if any), as read from the DOM parser.
protected java.lang.String
wordFileHeader
This field temporarily stores the word file header (incl. xml decl. and encoding), as read from the DOM parser.
Constructor Summary
DiscourseLoader(java.lang.String annoinfilename,
boolean validate,
boolean quiet)
Create a new DiscourseLoader by supplying the name of the .anno file specifying the set of MMAX files.
This field temporarily stores the name of the .anno file from which the discourse is to be build.
markableDOMFileName
protected java.lang.String markableDOMFileName
This field temporarily stores the name of the Markable XML file (as given in the -anno file).
stylesheetFileName
protected java.lang.String stylesheetFileName
This field temporarily stores the name of the style sheet XSL file (as given in the .anno file).
schemeFileName
protected java.lang.String schemeFileName
This field temporarily stores the name of the annotation scheme file (as given in the .anno file).
readonlyLevels
protected java.lang.String readonlyLevels
This field stores the value of the readonly_levels parameter from the .anno file
markableFileHeader
protected java.lang.String markableFileHeader
This field temporarily stores the markable file header, as read from the DOM parser.
wordDOMFileName
protected java.lang.String wordDOMFileName
This field temporarily stores the name of the Word XML file (as given in the -anno file).
wordFileHeader
protected java.lang.String wordFileHeader
This field temporarily stores the word file header (incl. xml decl. and encoding), as read from the DOM parser.
wordFileDoctype
protected java.lang.String wordFileDoctype
This field temporarily stores the word file DOCTYPE, (if any), as read from the DOM parser.
gestureDOMFileName
protected java.lang.String gestureDOMFileName
This field temporarily stores the name of the Gesture XML file (as given in the -anno file).
gestureFileHeader
protected java.lang.String gestureFileHeader
This field temporarily stores the gesture file header (incl. xml decl. and encoding), as read from the DOM parser.
gestureFileDoctype
protected java.lang.String gestureFileDoctype
This field temporarily stores the gesture file DOCTYPE, (if any), as read from the DOM parser.
keyactionDOMFileName
protected java.lang.String keyactionDOMFileName
This field temporarily stores the name of the Keyactionm XML file (as given in the -anno file).
keyactionFileHeader
protected java.lang.String keyactionFileHeader
This field temporarily stores the keyaction file header (incl. xml decl. and encoding), as read from the DOM parser.
keyactionFileDoctype
protected java.lang.String keyactionFileDoctype
This field temporarily stores the keyaction file DOCTYPE, (if any), as read from the DOM parser.
textDOMFileName
protected java.lang.String textDOMFileName
This field temporarily stores the name of the Text XML file (as given in the -anno file).
textFileHeader
protected java.lang.String textFileHeader
This field temporarily stores the text file header (incl. xml decl. and encoding), as read from the DOM parser.
textFileDoctype
protected java.lang.String textFileDoctype
This field temporarily stores the text file DOCTYPE, (if any), as read from the DOM parser.
dialogueDOMFileName
protected java.lang.String dialogueDOMFileName
This field temporarily stores the name of the Dialogue XML file (as given in the -anno file).
dialogueFileHeader
protected java.lang.String dialogueFileHeader
This field temporarily stores the dialogue file header (incl. xml decl. and encoding), as read from the DOM parser.
dialogueFileDoctype
protected java.lang.String dialogueFileDoctype
This field temporarily stores the dialogue file DOCTYPE, (if any), as read from the DOM parser.
utteranceDOMFileName
protected java.lang.String utteranceDOMFileName
This field temporarily stores the name of the Utterance XML file (as given in the -anno file).
utteranceFileHeader
protected java.lang.String utteranceFileHeader
This field temporarily stores the utterance file header (incl. xml decl. and encoding), as read from the DOM parser.
utteranceFileDoctype
protected java.lang.String utteranceFileDoctype
This field temporarily stores the utterance file DOCTYPE, (if any), as read from the DOM parser.
Constructor Detail
DiscourseLoader
public DiscourseLoader(java.lang.String annoinfilename,
boolean validate,
boolean quiet)
Create a new DiscourseLoader by supplying the name of the .anno file specifying the set of MMAX files. If validate = TRUE, DTD validation on the individual
input XML files is performed. If quite = TRUE, debug screen messages are (largely) suppressed.
BackupMarkable
This field holds a clone of the currently displayed Markable with its values unchanged by any attribute window manipulations that occured since it was
selected by the user.
searchResultStyle
This field holds the style that is used to render the result of a search (Normally some background color, as defined in mmaxsettings.xml).
javax.swing.text.SimpleAttributeSet
selectedMemberSetStyle
This field holds the style that is used to render a markable member set (Normally some foreground color, as defined in mmaxsettings.xml).
javax.swing.text.SimpleAttributeSet
selectedPointerSetStyle
This field holds the style that is used to render a markable pointer set (Normally some foreground color, as defined in mmaxsettings.xml).
javax.swing.text.SimpleAttributeSet
selectedStyle
This field holds the style that is used to render a selected markable (Normally some background color, as defined in mmaxsettings.xml).
unSelectedStyle
This field holds the style that is used to render a normal, unselected markable (Normally some foreground color, as defined in mmaxsettings.xml).
create(java.lang.String schemefilename)
This method creates an attribute window from the given schemefile.
void
displayInitComplete()
This method is called by the main application to inform the AttributeWindow that the display has been built.
void
displayMarkableAttributes(Markable markable)
This method displays the attributes of the supplied markable, by retrieving from the underlying AnnotationScheme
the correct SchemeLevels.
java.util.ArrayList
getAllAttributes()
This method returns an ArrayList of all attributes defined in the schemefile
This method is called in the context of Kappa calculation.
java.util.ArrayList
getAllPossibleValues(java.lang.String attribute)
This method returns an ArrayList of all possible values (ordered alphabetically) defined in the schemefile
for the suplied attribute.
java.util.HashMap
getAttributeValuePairs()
This method returns a hashmap representing a 'snapshot' of the currently displayed attributes and their values.
setAutoApply(boolean newStatus)
This method is called from the main application if the auto apply status of the annotation changes or is set initially.
setDirty(boolean newStatus)
This method is called from the main application if the dirty status of the annotation changes.
void
setMarkableAttributes(Markable markable)
This method applies the attributes and values which are currently displayed in the AttributeWindow to Markable markable.
void
setMarkableAttributesBackup(Markable markable)
This method applies the attributes and values which are currently displayed in the AttributeWindow to Markable markable.
If true, changes to the attribute window are to be committed automatically, without the user having to
click some kind of 'Apply' button. This field is set at start up time when the main application calls setAutoApply with the value of the element in the file mmaxsettings.xml.
DO NOT MODIFY! At run time, changes to this attribute have to be made using the 'Settings' menu in the MMAX application!
Dirty
public boolean Dirty
Indicates if the currently loaded annotation contains unsaved changes.
This field must be set by the attribute window's setDirty(value) method, which is called by the main application whenever changes to the annotation occur.
It is read by the main application when the user tries to close the application in order to determine if the user has to be prompted for saving.
Therefore, make sure to set this field to TRUE whenever permanent changes to the annotation (i.e. Markable's attributes) occurr!
MMAXDataPath
public static java.lang.String MMAXDataPath
Indicates the absolute path to the directory in which the .anno file resides. This path is needed to access the scheme file in the .create() method.
DO NOT MODIFY!
This field holds a clone of the currently displayed Markable with its values unchanged by any attribute window manipulations that occured since it was
selected by the user. Use this field to implement attribute manipulation undo. Attributes of type ID (i.e. Member and Pointer) are removed from this clone
directly after creation. They are not needed for undo functionality, because attributes of type ID are NEVER altered through AttributeWindow interaction.
BackupMemberValue
public java.lang.String BackupMemberValue
BackupPointerValue
public java.lang.String BackupPointerValue
selectedStyle
public javax.swing.text.SimpleAttributeSet selectedStyle
This field holds the style that is used to render a selected markable (Normally some background color, as defined in mmaxsettings.xml).
unSelectedStyle
public javax.swing.text.SimpleAttributeSet unSelectedStyle
This field holds the style that is used to render a normal, unselected markable (Normally some foreground color, as defined in mmaxsettings.xml).
deSelectedStyle
public javax.swing.text.SimpleAttributeSet deSelectedStyle
This field holds the style that is used to render markable minus its selection (cf. above). This is currently implented by just resetting the background color to white.
selectedMemberSetStyle
public javax.swing.text.SimpleAttributeSet selectedMemberSetStyle
This field holds the style that is used to render a markable member set (Normally some foreground color, as defined in mmaxsettings.xml).
selectedPointerSetStyle
public javax.swing.text.SimpleAttributeSet selectedPointerSetStyle
This field holds the style that is used to render a markable pointer set (Normally some foreground color, as defined in mmaxsettings.xml).
searchResultStyle
public javax.swing.text.SimpleAttributeSet searchResultStyle
This field holds the style that is used to render the result of a search (Normally some background color, as defined in mmaxsettings.xml).
modifiablePanel
public javax.swing.JPanel modifiablePanel
warningBox
public javax.swing.Box warningBox
Constructor Detail
AttributeWindow
public AttributeWindow()
Method Detail
showAnnotationHint
public final void showAnnotationHint(java.lang.String hint,
java.lang.String attribute)
hideAnnotationHint
public final void hideAnnotationHint()
setAutoApply
public final void setAutoApply(boolean newStatus)
This method is called from the main application if the auto apply status of the annotation changes or is set initially.
The implementing method must set the value of the AutoApply field (as defined in PluggableAttributeWindow) appropriately.
In addition, measures must be implemented to inform the user on the current status.
setDirty
public final void setDirty(boolean newStatus)
This method is called from the main application if the dirty status of the annotation changes.
The implementing method must set the value of the Dirty field (as defined in PluggableAttributeWindow) appropriately.
In addition, measures must be implemented to inform the user on the current status.
Note: The AttributeWindow must also call MMAX.setSaveButtonEnabled(newStatus), in order for the save button in the MMAX file
menu to reflect the current dirty status !!
getAllPossibleValues
public final java.util.ArrayList getAllPossibleValues(java.lang.String attribute)
This method returns an ArrayList of all possible values (ordered alphabetically) defined in the schemefile
for the suplied attribute. This method is called in the context of Kappa calculation.
Values returned are lower case
getAllAttributes
public final java.util.ArrayList getAllAttributes()
This method returns an ArrayList of all attributes defined in the schemefile
This method is called in the context of Kappa calculation.
displayInitComplete
public void displayInitComplete()
This method is called by the main application to inform the AttributeWindow that the display has been built.
This method can implement any changes it wants to make to the display, e.g. in terms of markable colouring.
getDeselectedStyle
public javax.swing.text.SimpleAttributeSet getDeselectedStyle(Markable markable)
This method returns the style which is to be used to render a de-selected Markable in the display.
In the default case, this method just returns the value of this.deSelectedStyle, which is just background=white. In order to handle
different renderings dependent on markable attributes, arbitrary styles can be returned by this method as well.
getSelectedStyle
public javax.swing.text.SimpleAttributeSet getSelectedStyle(Markable currentmarkable)
This method returns the style which is to be used to render a selected Markable in the display.
In the default case, this method just returns the value of this.selectedStyle. In order to handle
different renderings dependent on markable attributes, arbitrary styles can be returned by this method as well.
getUnselectedStyle
public javax.swing.text.SimpleAttributeSet getUnselectedStyle(Markable currentmarkable)
This method returns the style which is to be used to render an unselected Markable in the display.
In the default case, this method just returns the value of this.unSelectedStyle. In order to handle
different renderings dependent on markable attributes, arbitrary styles can be returned by this method as well.
getSelectedMemberSetStyle
public javax.swing.text.SimpleAttributeSet getSelectedMemberSetStyle(MemberSet membereset)
This method returns the style which is to be used to render a Markable member set in the display.
In the default case, this method just returns the value of this.selectedMemberSetStyle. In order to handle
different renderings dependent on markable attributes, arbitrary styles can be returned by this method as well.
getSelectedPointerSetStyle
public javax.swing.text.SimpleAttributeSet getSelectedPointerSetStyle(MarkableSet markableset)
This method returns the style which is to be used to render a Markable pointer set in the display.
In the default case, this method just returns the value of this.selectedPointerSetStyle. In order to handle
different renderings dependent on markable attributes, arbitrary styles can be returned by this method as well.
getSearchResultStyle
public javax.swing.text.SimpleAttributeSet getSearchResultStyle(Markable currentMarkable)
This method returns the style which is to be used to render a search result in the display.
In the default case, this method just returns the value of this.searchResultStyle. In order to handle
different renderings dependent on markable attributes, arbitrary styles can be returned by this method as well.
create
public final void create(java.lang.String schemefilename)
This method creates an attribute window from the given schemefile.
setAutoApplyWarning
public final void setAutoApplyWarning(boolean status)
displayMarkableAttributes
public final void displayMarkableAttributes(Markable markable)
This method displays the attributes of the supplied markable, by retrieving from the underlying AnnotationScheme
the correct SchemeLevels. This method is called whenever a Markable gets selected in the MMAX display.
getAttributeValuePairs
public final java.util.HashMap getAttributeValuePairs()
This method returns a hashmap representing a 'snapshot' of the currently displayed attributes and their values.
Attribute-Value pairs for attributes of type ID are NOT contained in this snapshot, because they cannot be modified via the AttributeWindow GUI.
Both attribute and value strings are set to lowercase
getCurrentSchemeLevels
public final java.util.ArrayList getCurrentSchemeLevels()
setMarkableAttributes
public final void setMarkableAttributes(Markable markable)
This method applies the attributes and values which are currently displayed in the AttributeWindow to Markable markable.
It does so by creating a new Attributes HashMap, filling it with the displayed attributes and values,
and assigning it to markable. Values of ID-type attributes member and pointer are not changed.
When this method is called, BackupMarkable can be ignored.
setMarkableAttributesBackup
public final void setMarkableAttributesBackup(Markable markable)
This method applies the attributes and values which are currently displayed in the AttributeWindow to Markable markable.
It does so by creating a new Attributes HashMap, filling it with the displayed attributes and values,
and assigning it to markable. Values of ID-type attributes member and pointer are not changed.
When this method is called, BackupMarkable can be ignored.
removeAllSchemeLevels
public final void removeAllSchemeLevels()
addSchemeLevels
public final void addSchemeLevels(SchemeLevel[] levels)
removeTrailingSchemeLevels
public final SchemeLevel[] removeTrailingSchemeLevels(java.lang.String lastLevelID)
Removes and returns the SchemeLevels after the one with id lastLevelID, or null if none exist
actionPerformed
public final void actionPerformed(java.awt.event.ActionEvent p1)
Specified by:
actionPerformed in interface java.awt.event.ActionListener
createFinalDisplayString(java.lang.String RawDisplayString)
This method takes the raw display string (as returned by Discourse.getRawDisplayString()) and transforms it into the final
display string to be displayed in the text pane.
public java.util.ArrayList HotSpotCommandAtPosition
StyleAtPosition
public java.util.ArrayList StyleAtPosition
SignalStartPosition
java.util.Hashtable SignalStartPosition
SignalEndPosition
java.util.Hashtable SignalEndPosition
ChosenColor
public java.awt.Color ChosenColor
BoldChar
public javax.swing.text.SimpleAttributeSet BoldChar
UnboldChar
public javax.swing.text.SimpleAttributeSet UnboldChar
ItalicChar
public javax.swing.text.SimpleAttributeSet ItalicChar
UnitalicChar
public javax.swing.text.SimpleAttributeSet UnitalicChar
UnderlinedChar
public javax.swing.text.SimpleAttributeSet UnderlinedChar
UnunderlinedChar
public javax.swing.text.SimpleAttributeSet UnunderlinedChar
SubChar
public javax.swing.text.SimpleAttributeSet SubChar
UnSubChar
public javax.swing.text.SimpleAttributeSet UnSubChar
SuperChar
public javax.swing.text.SimpleAttributeSet SuperChar
UnSuperChar
public javax.swing.text.SimpleAttributeSet UnSuperChar
NormalChar
public javax.swing.text.SimpleAttributeSet NormalChar
deMarkabelizedChar
public javax.swing.text.SimpleAttributeSet deMarkabelizedChar
LeftClick
public boolean LeftClick
RightClick
public boolean RightClick
ShiftClick
public boolean ShiftClick
ControlClick
public boolean ControlClick
XMousePos
int XMousePos
YMousePos
int YMousePos
Dot
public int Dot
Mark
public int Mark
Selection
public boolean Selection
FlipPopUp
boolean FlipPopUp
CurrentSignal
java.lang.String CurrentSignal
HoverSignal
java.lang.String HoverSignal
boldbit
byte boldbit
italicbit
byte italicbit
underlinedbit
byte underlinedbit
subbit
byte subbit
superbit
byte superbit
quiet
private boolean quiet
Constructor Detail
DeepTextPane
public DeepTextPane(java.lang.String RawDisplayString,
boolean Quiet)
Method Detail
applyInitialStyleToPoint
public void applyInitialStyleToPoint(int position,
boolean do_default)
applyInitialStyleToRange
public void applyInitialStyleToRange(int start,
int end,
boolean do_default)
getSignalStartPosition
public int getSignalStartPosition(java.lang.String signalid)
getSignalEndPosition
public int getSignalEndPosition(java.lang.String signalid)
createFinalDisplayString
public java.lang.String createFinalDisplayString(java.lang.String RawDisplayString)
This method takes the raw display string (as returned by Discourse.getRawDisplayString()) and transforms it into the final
display string to be displayed in the text pane. In the process, tags are removed from the string and their extension
is stored in SignalStartPosition and SignalEndPosition (and SignalAtPosition). Also, string markup tags like ... are removed, and
their information encoded in StyleAtPosition.
getMarkableXPosition
public int getMarkableXPosition(Markable markable)
getMarkableYPosition
public int getMarkableYPosition(Markable markable)
paintComponent_grrr
public void paintComponent_grrr(java.awt.Graphics gr)
Overload standard paintComponent method to redraw display upon paint
Fields inherited from interface javax.swing.text.Document
StreamDescriptionProperty, TitleProperty
Constructor Summary
FastDocument()
Constructs a default styled document.
FastDocument(javax.swing.text.StyleContext styles)
Constructs a styled document with the default content
storage implementation and a shared set of styles.
public FastDocument(javax.swing.text.StyleContext styles)
Constructs a styled document with the default content
storage implementation and a shared set of styles.
Parameters:
styles - the styles
FastDocument
public FastDocument()
Constructs a default styled document. This buffers
input content by a size of BUFFER_SIZE_DEFAULT
and has a style context that is scoped by the lifetime
of the document and is not shared with other documents.
Method Detail
setCharacterAttributesToMarkableSet
public void setCharacterAttributesToMarkableSet(MarkableSet markables,
javax.swing.text.AttributeSet s,
boolean replace)
setCharacterAttributesToMemberSet
public void setCharacterAttributesToMemberSet(MemberSet markables,
javax.swing.text.AttributeSet s,
boolean replace)
setCharacterAttributesToMarkable
public final void setCharacterAttributesToMarkable(Markable currentMarkable,
javax.swing.text.AttributeSet s,
boolean replace)
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
Field Detail
idField
javax.swing.JTextField idField
idSearchButton
javax.swing.JButton idSearchButton
clearButton
javax.swing.JButton clearButton
Constructor Detail
FindMarkableWindow
public FindMarkableWindow()
Creates new form FindMarkableWindow
Method Detail
initComponents
private void initComponents()
This method is called from within the constructor to
initialize the form.
WARNING: Do NOT modify this code. The content of this method is
always regenerated by the Form Editor.
ApplyDefaultAttributesUponCreation
If true, default attributes and values as defined in the scheme file are applied to a Markable object upon its creation.
boolean
ApplyDefaultAttributesUponFirstSelection
If true, default attributes and values as defined in the scheme file are applied to a Markable object upon its first selection.
BackupMarkable
This field holds a clone of the currently displayed Markable with its values unchanged by any attribute window manipulations that occured since it was
selected by the user.
selectedMemberSetStyle
This field holds the style that is used to render a markable member set (Normally some foreground color, as defined in mmaxsettings.xml).
javax.swing.text.SimpleAttributeSet
selectedPointerSetStyle
This field holds the style that is used to render a markable pointer set (Normally some foreground color, as defined in mmaxsettings.xml).
javax.swing.text.SimpleAttributeSet
selectedStyle
This field holds the style that is used to render a selected markable (Normally some background color, as defined in mmaxsettings.xml).
unSelectedStyle
This field holds the style that is used to render a normal, unselected markable (Normally some foreground color, as defined in mmaxsettings.xml).
pointingRelationCreated(MarkableEvent me)
This method is invoked every time a pointing relation between two Markables is created in the MMAX application.
void
pointingRelationDeleted(MarkableEvent me)
This method is invoked every time a pointing relation between two Markables is deleted in the MMAX application.
setMarkableAttributes(Markable markable)
This method applies the attributes and values which are currently displayed in the AttributeWindow to Markable markable.
If true, changes to the attribute window are to be committed automatically, without the user having to
click some kind of 'Apply' button. This field is set at start up time when the main application calls setAutoApply with the value of the element in the file mmaxsettings.xml.
DO NOT MODIFY! At run time, changes to this attribute have to be made using the 'Settings' menu in the MMAX application!
ApplyDefaultAttributesUponCreation
public boolean ApplyDefaultAttributesUponCreation
If true, default attributes and values as defined in the scheme file are applied to a Markable object upon its creation.
This field is set at start up time by the value of the element in the file mmaxsettings.xml.
DO NOT MODIFY! At run time, changes to this attribute have to be made using the 'Settings' menu in the MMAX application!
ApplyDefaultAttributesUponFirstSelection
public boolean ApplyDefaultAttributesUponFirstSelection
If true, default attributes and values as defined in the scheme file are applied to a Markable object upon its first selection.
This field is set at start up time by the value of the element in the file mmaxsettings.xml.
DO NOT MODIFY! At run time, changes to this attribute have to be made using the 'Settings' menu in the MMAX application!
Dirty
public boolean Dirty
Indicates if the currently loaded annotation contains unsaved changes.
This field must be set by the attribute window's setDirty(value) method, which is called by the main application whenever changes to the annotation occur.
It is read by the main application when the user tries to close the application in order to determine if the user has to be prompted for saving.
Therefore, make sure to set this field to TRUE whenever permanent changes to the annotation (i.e. Markable's attributes) occurr!
MMAXDataPath
public static java.lang.String MMAXDataPath
Indicates the absolute path to the directory in which the .anno file resides. This path is needed to access the scheme file in the .create() method.
DO NOT MODIFY!
This field holds a clone of the currently displayed Markable with its values unchanged by any attribute window manipulations that occured since it was
selected by the user. Use this field to implement attribute manipulation undo. Attributes of type ID (i.e. Member and Pointer) are removed from this clone
directly after creation. They are not needed for undo functionality, because attributes of type ID are NEVER altered through AttributeWindow interaction.
BackupMemberValue
public java.lang.String BackupMemberValue
BackupPointerValue
public java.lang.String BackupPointerValue
selectedStyle
public javax.swing.text.SimpleAttributeSet selectedStyle
This field holds the style that is used to render a selected markable (Normally some background color, as defined in mmaxsettings.xml).
unSelectedStyle
public javax.swing.text.SimpleAttributeSet unSelectedStyle
This field holds the style that is used to render a normal, unselected markable (Normally some foreground color, as defined in mmaxsettings.xml).
deSelectedStyle
public javax.swing.text.SimpleAttributeSet deSelectedStyle
This field holds the style that is used to render markable minus its selection (cf. above). This is currently implented by just resetting the background color to white.
selectedMemberSetStyle
public javax.swing.text.SimpleAttributeSet selectedMemberSetStyle
This field holds the style that is used to render a markable member set (Normally some foreground color, as defined in mmaxsettings.xml).
selectedPointerSetStyle
public javax.swing.text.SimpleAttributeSet selectedPointerSetStyle
This field holds the style that is used to render a markable pointer set (Normally some foreground color, as defined in mmaxsettings.xml).
public java.util.ArrayList getAllPossibleValues(java.lang.String attribute)
getAllAttributes
public java.util.ArrayList getAllAttributes()
displayInitComplete
public void displayInitComplete()
getDeselectedStyle
public javax.swing.text.SimpleAttributeSet getDeselectedStyle(Markable markable)
getSelectedStyle
public javax.swing.text.SimpleAttributeSet getSelectedStyle(Markable currentmarkable)
getUnselectedStyle
public javax.swing.text.SimpleAttributeSet getUnselectedStyle(Markable currentmarkable)
getSelectedMemberSetStyle
public javax.swing.text.SimpleAttributeSet getSelectedMemberSetStyle(MemberSet memberset)
getSelectedPointerSetStyle
public javax.swing.text.SimpleAttributeSet getSelectedPointerSetStyle(MarkableSet markableset)
create
public void create(java.lang.String schemefilename)
parse
public void parse(java.lang.String schemefilename)
displayMarkableAttributes
public void displayMarkableAttributes(Markable markable)
setMarkableAttributes
public void setMarkableAttributes(Markable markable)
This method applies the attributes and values which are currently displayed in the AttributeWindow to Markable markable.
It does so by creating a new Attributes HashMap, filling it with the displayed attributes and values, and assigning it to markable.
The Type attribute, which is not maintained via the Attributes HashMap, is set directly.
This method does not alter the values of ID, Member, Pointer and Span.
This method is called from within the constructor to
initialize the form.
WARNING: Do NOT modify this code. The content of this method is
always regenerated by the Form Editor.
playSound
public void playSound(java.lang.String soundfilename,
java.lang.String offsetstring,
java.lang.String lengthstring)
markableCreated(MarkableEvent me)
This method is invoked every time a new Markable object is created in the MMAX application.
void
markableDeleted(MarkableEvent me)
This method is invoked every time a Markable object is deleted in the MMAX application.
void
memberRelationCreated(MarkableEvent me)
This method is invoked every time a member relation between two Markables is created in the MMAX application.
void
memberRelationDeleted(MarkableEvent me)
This method is invoked every time a member relation between two Markables is deleted in the MMAX application.
void
pointingRelationCreated(MarkableEvent me)
This method is invoked every time a pointing relation between two Markables is created in the MMAX application.
void
pointingRelationDeleted(MarkableEvent me)
This method is invoked every time a pointing relation between two Markables is deleted in the MMAX application.
getCurrentSearchCriteria()
This method resturns an Array of attribute value pairs in the form attribute::value, which can be submitted directly to Markable.matchesX() methods.
getAllDistinctDisplayAttributeNames()
This method returns an ArrayList of all distinct DisplyAttributeNames, irrespective of their SchemeLevels.
java.util.ArrayList
getAllDistinctValuesForAttributeName(java.lang.String attribute)
This method returns a list of all values (lower-cased) defined for any number of SchemeLevels with name = attribute.
mapSelections(SchemeLevel[] removedLevels,
SchemeLevel[] requestedLevels)
This method transfers those selections in removedLevels that are valid for requestedLevels to the latter.
void
reset()
This method resets the AttributeWindow to the initial state as defined in this AnnotationScheme
valueChanged_Backup(SchemeLevel callingLevel,
SchemeLevel[] oldRemovedLevels)
This method is called from the SchemeLevel callingLevel when the user changed some value on it by clicking a button.
void
valueChanged(SchemeLevel callingLevel,
SchemeLevel[] oldRemovedLevels,
int position)
This method is called from the SchemeLevel callingLevel when the user changed some value on it by clicking a button.
Returns the first SchemeLevel objects with initial = true up to and incl. the first with initial = false.
Used to create the initial AttributeWindow display. Initial is 'true' if none of the level's values has a 'next' attribute
valueChanged
public void valueChanged(SchemeLevel callingLevel,
SchemeLevel[] oldRemovedLevels,
int position)
This method is called from the SchemeLevel callingLevel when the user changed some value on it by clicking a button. This method also calls
itself recursively.
valueChanged_Backup
public void valueChanged_Backup(SchemeLevel callingLevel,
SchemeLevel[] oldRemovedLevels)
This method is called from the SchemeLevel callingLevel when the user changed some value on it by clicking a button. This method also calls
itself recursively.
This method transfers those selections in removedLevels that are valid for requestedLevels to the latter.
If a requestedLevel cannot be set according to a removedLevel, it is set to default. This method will not alter attributes of type ID!
The two parameter arrays may contain references to the same objects !
addValueIDToLevelIDMapping
public void addValueIDToLevelIDMapping(java.lang.String valueID,
java.lang.String levelID)
getNextSchemeLevels
public SchemeLevel[] getNextSchemeLevels(java.lang.String valueID)
Returns those SchemeLevel objects to which value valueID points as 'next', or empty Array
resetAllLevels
public void resetAllLevels()
reset
public void reset()
This method resets the AttributeWindow to the initial state as defined in this AnnotationScheme
This method returns an array of SchemeLevel objects reflecting the attributes of Markable markable.
?If Markable does not have any attributes, or an error occured, only initialSchemeLevels with default values are returned?
isDefined
public boolean isDefined(java.lang.String attributename)
getAttributeTypeByAttributeName
public java.lang.String getAttributeTypeByAttributeName(java.lang.String attribute)
getAllAttributeNames
public java.util.ArrayList getAllAttributeNames()
getAllDistinctValuesForAttributeName
public java.util.ArrayList getAllDistinctValuesForAttributeName(java.lang.String attribute)
This method returns a list of all values (lower-cased) defined for any number of SchemeLevels with name = attribute.
getAllDistinctDisplayAttributeNames
public java.util.ArrayList getAllDistinctDisplayAttributeNames()
This method returns an ArrayList of all distinct DisplyAttributeNames, irrespective of their SchemeLevels.
getMaxListLen(java.util.ArrayList[] lists,
int upperthreshold)
This method returns the length of the longest ArrayList in the parameter array of ArrayLists
getTotalListLen(java.util.ArrayList[] lists)
This method returns the summed length of all ArrayLists in the parameter array of ArrayLists
java.util.HashMap
getValueDistributionForAttribute(java.lang.String attributeName,
java.util.ArrayList markables)
returns a HashMap with attribute values as hash keys and their frequencies as hash values
public java.lang.String[] mergeArrays(java.lang.String[] array1,
java.lang.String[] array2)
getMostFrequentLen
public static int getMostFrequentLen(int[] lengthDistribution)
getMedian
public static float getMedian(int[] distribution)
mergeDistributions
public static int[] mergeDistributions(int[][] distributions)
getAllAttributeNames
public java.lang.String[] getAllAttributeNames(java.util.ArrayList markables)
filter
public java.util.ArrayList filter(java.util.ArrayList markables,
java.lang.String[] criteria)
removeMarkablesWithDefaultValue
public java.util.ArrayList removeMarkablesWithDefaultValue(java.util.ArrayList inList,
java.lang.String attribute)
getValueDistributionForAttribute
public java.util.HashMap getValueDistributionForAttribute(java.lang.String attributeName,
java.util.ArrayList markables)
returns a HashMap with attribute values as hash keys and their frequencies as hash values
getListLenDistribution
public static int[] getListLenDistribution(java.util.ArrayList[] lists)
getAvgListLen
public static float getAvgListLen(java.util.ArrayList[] lists)
This method returns the average length of the ArrayList in the parameter array of ArrayLists
getTotalListLen
public static int getTotalListLen(java.util.ArrayList[] lists)
This method returns the summed length of all ArrayLists in the parameter array of ArrayLists
getMaxListLen
public static int getMaxListLen(java.util.ArrayList[] lists,
int upperthreshold)
This method returns the length of the longest ArrayList in the parameter array of ArrayLists
getMinListLen
public int getMinListLen(java.util.ArrayList[] lists)
This method returns the length of the shortest ArrayList in the parameter array of ArrayLists
createUniqueIdentifier
public static java.lang.String createUniqueIdentifier(java.lang.String namespace)
parseCompleteSpan
public static java.util.ArrayList parseCompleteSpan(java.lang.String span)
This method parses the value of a span attribute and returns all elements in an ArrayList. Spans of the form word_x..word_y
will be expanded to include all intermediate ids
parseSpanFragment
public static java.util.ArrayList parseSpanFragment(java.lang.String span)
This method Parses the value of a DE's span attribute and returns all elements in an ArrayList. Spans of the form word_x..word_y
are expanded to include all intermediate ids
parseCompleteSpanToString
public static java.lang.String parseCompleteSpanToString(java.lang.String span)
convertNodeMapToHashMap
public static java.util.HashMap convertNodeMapToHashMap(org.w3c.dom.NamedNodeMap nodemap)
isInStringList
public boolean isInStringList(java.lang.String text,
java.util.ArrayList stringlist,
boolean caseSensitive)
getConstituents(java.lang.String constituentname)
This method returns an ArrayList of two-element arrays containing the start and end positions of all
constituents with name constituentname (e.g.
int
getMatchingBracketPosition(int startposition)
This method returns the position at which the bracket opening at startposition is closed, or -1 if none is found.
private java.lang.String
getTerminalAt(int position)
This method returns the terminal (incl. brackets) at position, or empty string if none.
This list contains one element for each character in the tree represented in the input .mrg file. At position X,
it contains the String representation of the terminal (if any) at this position.
serializedTree
protected java.lang.String serializedTree
size
public int size
Constructor Detail
PennTree
public PennTree(java.lang.String mergefile,
java.lang.String separators)
Create a new PennTree from input .mrg file with separators.
SchemeLevel(java.lang.String id,
java.lang.String attributeName,
java.lang.String typevalue,
org.w3c.dom.NodeList allChildren,
AnnotationScheme currentScheme,
int width,
java.lang.String tiptext)
Creates new SchemaLevel. attributeName is in the original spelling (upper/lower case) as supplied in the annotation scheme.
Method Summary
void
actionPerformed(java.awt.event.ActionEvent p1)
This handler is called upon the selection of a button on this SchemeLevel.
public SchemeLevel(java.lang.String id,
java.lang.String attributeName,
java.lang.String typevalue,
org.w3c.dom.NodeList allChildren,
AnnotationScheme currentScheme,
int width,
java.lang.String tiptext)
Creates new SchemaLevel. attributeName is in the original spelling (upper/lower case) as supplied in the annotation scheme.
Method Detail
getDefaultValue
public java.lang.String getDefaultValue()
This method returns the (lower cased) default value for this attribute
actionPerformed
public void actionPerformed(java.awt.event.ActionEvent p1)
This handler is called upon the selection of a button on this SchemeLevel.
Specified by:
actionPerformed in interface java.awt.event.ActionListener
getNextSchemeLevels
public SchemeLevel[] getNextSchemeLevels(boolean toDefault)
This method returns an array of the SchemeLevels that the current value of this points to as 'next', or null
getSelectedIndex
public int getSelectedIndex()
getSelectedValue
public java.lang.String getSelectedValue()
setSelectedValue
public boolean setSelectedValue(java.lang.String desiredValue)
This method tries to select the JRadioButton associated with the value desiredValue.
For attributes of type freetext or id, it sets the value to desiredValue.
It returns true if the value was found, false otherwise. For attributes of type id and freetext, result is always
true, because no constraints can exist for these attributes.
If desiredValue is a null String, the DefaultIndex is set.
setSelectedIndex
public void setSelectedIndex(int num)
setEnabled
public void setEnabled(boolean status)
Overrides:
setEnabled in class javax.swing.JComponent
toDefault
public void toDefault()
This method resets this Schemelevel to default
removeUpdate
public void removeUpdate(javax.swing.event.DocumentEvent p1)
Specified by:
removeUpdate in interface javax.swing.event.DocumentListener
changedUpdate
public void changedUpdate(javax.swing.event.DocumentEvent p1)
Specified by:
changedUpdate in interface javax.swing.event.DocumentListener
insertUpdate
public void insertUpdate(javax.swing.event.DocumentEvent p1)
Specified by:
insertUpdate in interface javax.swing.event.DocumentListener
getType
public java.lang.String getType()
isDefined
public boolean isDefined(java.lang.String value)
getAllPossibleValues
public java.util.ArrayList getAllPossibleValues()
This method returns all values for this SchemeLevel. If this.Type == nominal, it returns the list of values defined for this SchemeLevel (in lower case).
If this.Type == freetext, it iterates over all currently available Markables and collects all lower-cased values this attribute has.
The list thus returned contains as its first element the string ___freetext. If this.Type == id, a one-element list with the string ___id is returned.
setFrozen
public void setFrozen(boolean status,
java.lang.String illegalValue)
A convenience implementation of FileFilter that filters out
all files except for those type extensions that it knows about.
Extensions are of the type ".foo", which is typically found on
Windows and Unix boxes, but not on Macinthosh. Case is ignored.
Example - create a new filter that filerts out all files
but gif and jpg image files:
JFileChooser chooser = new JFileChooser();
ExampleFileFilter filter = new ExampleFileFilter(
new String{"gif", "jpg"}, "JPEG & GIF Images")
chooser.addChoosableFileFilter(filter);
chooser.showOpenDialog(this);
public SmartFileFilter(java.lang.String extension,
java.lang.String description)
Creates a file filter that accepts the given file type.
Example: new ExampleFileFilter("jpg", "JPEG Image Images");
Note that the "." before the extension is not needed. If
provided, it will be ignored.
public SmartFileFilter(java.lang.String[] filters)
Creates a file filter from the given string array.
Example: new ExampleFileFilter(String {"gif", "jpg"});
Note that the "." before the extension is not needed adn
will be ignored.
public SmartFileFilter(java.lang.String[] filters,
java.lang.String description)
Creates a file filter from the given string array and description.
Example: new ExampleFileFilter(String {"gif", "jpg"}, "Gif and JPG Images");
Note that the "." before the extension is not needed and will be ignored.
public void addExtension(java.lang.String extension)
Adds a filetype "dot" extension to filter against.
For example: the following code will create a filter that filters
out all files except those that end in ".jpg" and ".tif":
ExampleFileFilter filter = new ExampleFileFilter();
filter.addExtension("jpg");
filter.addExtension("tif");
Note that the "." before the extension is not needed and will be ignored.
getDescription
public java.lang.String getDescription()
Returns the human readable description of this filter. For
example: "JPEG and GIF Image Files (*.jpg, *.gif)"
Overrides:
getDescription in class javax.swing.filechooser.FileFilter
public void setExtensionListInDescription(boolean b)
Determines whether the extension list (.jpg, .gif, etc) should
show up in the human readable description.
Only relevent if a description was provided in the constructor
or using setDescription();
Returns whether the extension list (.jpg, .gif, etc) should
show up in the human readable description.
Only relevent if a description was provided in the constructor
or using setDescription();
ValidatingSmartDOM(org.w3c.dom.Document dom,
java.lang.String elementname)
Creates a ValidatingSmartDOM cast of the parameter Document, setting IDs for all elements of type elementname.
ValidatingSmartDOM(java.lang.String typestring)
Creates new ValidatingSmartDOM of type typestring and a root element.
wrapper class for returning results
PRscore.recall, PRscore.precision:
3-field array of int, each containing values needed for calculating precision (p) and recall (r) respectively:
.r/p[0] : S (size of key/response equivalence classes summed up for all key/response-ECs)
.r/p[1] : p (number of partions of key/response-EC relative to response/key-EC summed up for all key/response-ECs
.r/p[2] : n (number of ECs in key/response)
precision/recall = (S-p)/(S-n)
VilainEvaluator:
first implementation of algorithm described in ...
drawbacks (2b mended soon):
> lazy expensive implementation of calculateEC (2b replaced by proper union-find alg);
> exploits java's saloon data structures (fat, slow, ...);
>>> does not check for any errors (denominator = 1, wrong input ...)
howto use:
- create instance (v) of vilain.VilainEvaluator
- call vilain.PRscore score = v.evaluate(keyInputArray, reponseInputArray)
- input format: array of pairs in String format "A B", pair elements separated by whitespace
- return format: instance of class vilain.PRscore (s) containing two arrays of three integers (see PRscore.java)
wrapper class for returning results
PRscore.recall, PRscore.precision:
3-field array of int, each containing values needed for calculating precision (p) and recall (r) respectively:
.r/p[0] : S (size of key/response equivalence classes summed up for all key/response-ECs)
.r/p[1] : p (number of partions of key/response-EC relative to response/key-EC summed up for all key/response-ECs
.r/p[2] : n (number of ECs in key/response)
precision/recall = (S-p)/(S-n)
main(java.lang.String[] args)
This method accepts as input the name of an old .scheme Scheme file, and outputs the equivalent new XML-based Scheme file to standard out.
This method accepts as input the name of an old .scheme Scheme file, and outputs the equivalent new XML-based Scheme file to standard out. Use redirection > to pipe output to the new file. Example: Scheme2XML oldfile.scheme > newFile.xml
VilainEvaluator:
first implementation of algorithm described in ...
drawbacks (2b mended soon):
> lazy expensive implementation of calculateEC (2b replaced by proper union-find alg);
> exploits java's saloon data structures (fat, slow, ...);
>>> does not check for any errors (denominator = 1, wrong input ...)
howto use:
- create instance (v) of vilain.VilainEvaluator
- call vilain.PRscore score = v.evaluate(keyInputArray, reponseInputArray)
- input format: array of pairs in String format "A B", pair elements separated by whitespace
- return format: instance of class vilain.PRscore (s) containing two arrays of three integers (see PRscore.java)
representation of two linked elements of type String
!!! should implement some safety measures such as type check
failed split operation
!!! uses StringTokenizer of analysing Links in Stringformat
relies on blank-separated pair of input elements: "A B"
If true, changes to the attribute window are to be committed automatically, without the user having to
click some kind of 'Apply' button. This field is set at start up time when the main application calls setAutoApply with the value of the element in the file mmaxsettings.xml.
DO NOT MODIFY! At run time, changes to this attribute have to be made using the 'Settings' menu in the MMAX application!
Dirty
boolean Dirty
Indicates if the currently loaded annotation contains unsaved changes.
This field must be set by the attribute window's setDirty(value) method, which is called by the main application whenever changes to the annotation occur.
It is read by the main application when the user tries to close the application in order to determine if the user has to be prompted for saving.
Therefore, make sure to set this field to TRUE whenever permanent changes to the annotation (i.e. Markable's attributes) occurr!
This field holds a clone of the currently displayed Markable with its values unchanged by any attribute window manipulations that occured since it was
selected by the user. Use this field to implement attribute manipulation undo. Attributes of type ID (i.e. Member and Pointer) are removed from this clone
directly after creation. They are not needed for undo functionality, because attributes of type ID are NEVER altered through AttributeWindow interaction.
BackupMemberValue
java.lang.String BackupMemberValue
BackupPointerValue
java.lang.String BackupPointerValue
selectedStyle
javax.swing.text.SimpleAttributeSet selectedStyle
This field holds the style that is used to render a selected markable (Normally some background color, as defined in mmaxsettings.xml).
This field holds the style that is used to render markable minus its selection (cf. above). This is currently implented by just resetting the background color to white.
If true, changes to the attribute window are to be committed automatically, without the user having to
click some kind of 'Apply' button. This field is set at start up time when the main application calls setAutoApply with the value of the element in the file mmaxsettings.xml.
DO NOT MODIFY! At run time, changes to this attribute have to be made using the 'Settings' menu in the MMAX application!
ApplyDefaultAttributesUponCreation
boolean ApplyDefaultAttributesUponCreation
If true, default attributes and values as defined in the scheme file are applied to a Markable object upon its creation.
This field is set at start up time by the value of the element in the file mmaxsettings.xml.
DO NOT MODIFY! At run time, changes to this attribute have to be made using the 'Settings' menu in the MMAX application!
ApplyDefaultAttributesUponFirstSelection
boolean ApplyDefaultAttributesUponFirstSelection
If true, default attributes and values as defined in the scheme file are applied to a Markable object upon its first selection.
This field is set at start up time by the value of the element in the file mmaxsettings.xml.
DO NOT MODIFY! At run time, changes to this attribute have to be made using the 'Settings' menu in the MMAX application!
Dirty
boolean Dirty
Indicates if the currently loaded annotation contains unsaved changes.
This field must be set by the attribute window's setDirty(value) method, which is called by the main application whenever changes to the annotation occur.
It is read by the main application when the user tries to close the application in order to determine if the user has to be prompted for saving.
Therefore, make sure to set this field to TRUE whenever permanent changes to the annotation (i.e. Markable's attributes) occurr!
This field holds a clone of the currently displayed Markable with its values unchanged by any attribute window manipulations that occured since it was
selected by the user. Use this field to implement attribute manipulation undo. Attributes of type ID (i.e. Member and Pointer) are removed from this clone
directly after creation. They are not needed for undo functionality, because attributes of type ID are NEVER altered through AttributeWindow interaction.
BackupMemberValue
java.lang.String BackupMemberValue
BackupPointerValue
java.lang.String BackupPointerValue
selectedStyle
javax.swing.text.SimpleAttributeSet selectedStyle
This field holds the style that is used to render a selected markable (Normally some background color, as defined in mmaxsettings.xml).
This field holds the style that is used to render markable minus its selection (cf. above). This is currently implented by just resetting the background color to white.
Within the MMAX framework, the AnnotationScheme
provides a versatile and powerful means to define important parameters relevant
for an annotation.
Attributes can be defined by
specifying their names, types and domains, i.e. sets of possible values. An
attribute has to be defined in order to be applicable to a markable. At this
time, freetext and nominal attributes are supported: Freetext
attributes can take any string value, nominal attributes can take one of a
(user-definable) closed list of string values. In addition, the attribute type ID
is supported. In the current version, however, this type is available for the member
and the pointer attribute only. (Note: In a later version, the currently
hard-coded member and pointer attributes will be replaced by
attributes of type member-relation and pointer-relation).
Constraints on attributes can
also be defined. The availability (or applicability) of an attribute to a given
markable can be constrained depending on which other attributes the markable
already has. For nominal attributes, the availability (or applicability) of particular
values can be constrained depending on the same criteria by defining
different attributes of the same name and type but different domains. Important Note: Although different
attributes with identical names are supported, this support is experimental and it is recommended to avoid using
them if possible. Different attributes with identical names and identical
domains (i.e. sets of possible values) should work, though.
Finally, instructions can be specified
that tell annotators how the available attributes are to be assigned during the
annotation process.
Note: Older annotation
schemes (.scheme files) are no longer supported by MMAX. Scheme files of this
type can be converted to the new AnnotationScheme format with a converter
program found in org.eml.MMAX.tools.Scheme2XML. Cf. the class documentation in
the javadoc folder for details on how to use this class.
1.Attributes
The MMAX AnnotationScheme is specified as a
single XML document of the type <annotationscheme>. It contains an
ordered sequence of <attribute> elements, each of which
corresponds to a single attribute.
Each <attribute> element has the
following XML attributes:
ID (required): This
assigns a unique identifier to the attribute.
name (required): This
specifies the name of the attribute as it will appear both in the
AttributeWindow. For the markables XML file, this name will be set to lower
case.
type (optional): The
type (currently nominal or freetext) of the attribute. If this attribute is not
specified, type=nominal is assumed.
text (optional): Some
textual description of the attribute defined in this <attribute> element. This
text will be displayed in a separate window if the user moves the mouse over
this attributes name in the AttributeWindow (cf.example below).
Each <attribute> element has at
least one child element of type <value>. Each <value> element
corresponds to one possible value for the current attribute, and has at least
the following attributes:
ID (required): This
assigns a unique identifier to the value.
name (required): This
specifies the name of the value as it will appear in the AttributeWindow. In
the markables XML file, this name will be set to lower case. (except for
freetext attributes, cf. below). Attribute values are case-insensitive!
text (optional): Like
for the <attribute> element (cf. above) some etxtual description associated
with this value. This text will be displayed in a separate window if the user
moves the mouse over this values name in the AttributeWindow.
For each attribute, first child serves as
the default value, which is displayed (and assigned to a selected
markable) if the markable does not have a value for the corresponding
attribute. Since default values express the fact that a markable does not have
a value for a given attribute, default values should not have dependent
attributes (cf. below)!
The actual number of children depends on the
type of the attribute: An attribute of type freetext has only one <value>
child.
In this case, the childs name attribute is identical to the name of the parent
attribute. A nominal attribute, on the other hand, has one <value> child for every
possible value defined for it. Consider the following simple example:
<annotationscheme>
<attribute
id="comment_level" name="Comment" text="Add your
comment here!" type="freetext">
<value
id="value_1" name="comment"/>
</attribute>
<attribute
id="class_level" name="Class" text=Choose the class of the
element, if applicable!>
<value id="value_2" name="none"/>
<value
id="value_3" name="A"/>
<value
id="value_4" name="B"/>
<value
id="value_5" name="C"/>
</attribute>
</annotationscheme>
In the above example, two attributes are
defined: A freetext attribute called Comment, and a nominal attribute
called Class. For the latter, the possible values none, A, B and C are
defined.
This simple AnnotationScheme will produce the
following AttributeWindow:
When the mouse is moved over the Class label in the
above window, the textual description defined for this attribute will be
displayed in a separate window:
This window is always visible and will change
its content depending on the mouse position.
2.One-to-one dependencies
The above example of an AnnotationScheme is quite
simple in that it defines two attributes that are independent of each other.
One could imagine, however, that additional attributes for further
subclassification could be required which are dependent on which value is
currently selected for the Class attribute. This can be done by specifying additional
attributes the availability of which is constrained by the Class attribute.
As a first step towards that, the new attributes
have to be defined as usual. The following XML code defines three additional nominal
attributes,each of which has three possible values.
These three attributes are not valid at the same
time: Subclass_A, e.g., is relevant only if Class is A, and so on. The
downward dependency between attributes is specified by means of the next attribute on
individual <value> elements: By means of this attribute, each possible
value of a nominal attribute can be associated with (a list of, cf. below)
dependent attributes, like in the following example:
<annotationscheme>
<attribute id="comment_level"
name="Comment" text="Add your comment here!"
type="freetext">
<value
id="value_1" name="comment"/>
</attribute>
<attribute
id="class_level" name="Class" text=Choose the class of the
element, if applicable!>
(Note how the default value value_2 is not assigned any next attribute!)
The above code will produce the following
AttributeWindow, the appearance of which changes with the value currently
selected for the Class attribute:
(Note: The following
part describes the use of different attributes with identical
names and different domains. This feature is described although using it
is discouraged (cf. note in the Introduction). The following examples are
illustrative anyway and are therefore kept.)
Instead of defining three attributes with
different names (Subclass_A, Subclass_B, Subclass_C) and identical
possible values (none, 1, 2), it is also possible to define three attributes with
identical name (e.g. Subclass), and vary the possible values depending on the
value of Class. The following AnnotationScheme does just that:
<annotationscheme>
<attribute
id="comment_level" name="Comment" text="Add your
comment here!" type="freetext">
<value
id="value_1" name="comment"/>
</attribute>
<attribute
id="class_level" name="Class" text=Choose the class of the
element, if applicable!>
One of the strengths of the MMAX
AnnotationScheme is the fact that dependent attributes can themselves have
other attributes depending on them. This way,
cascading dependencies of
(in principle) arbitrary depth can be expressed.
3.One-to-many dependencies
Apart from the simple dependencies described
above (one attribute determines the availability of one
other, dependent one), one-to-many dependencies can be expressed as well. This
is simply done by specifying more than one attribute in a <value> elements next attribute. The
following example will suffice to illustrate this feature: In order to supply
the additional attribute Type for markables of Class C, the following
slight modification to the original AnnotationScheme is required:
<annotationscheme>
<attribute
id="comment_level" name="Comment" text="Add your
comment here!" type="freetext">
<value
id="value_1" name="comment"/>
</attribute>
<attribute
id="class_level" name="Class" text=Choose the class of the
element, if applicable!>
This AnnotationScheme will produce an
AttributeWindow which looks like this when ClassC is selected:
If one attribute references several dependent
attributes, the order in which the latter are displayed in the AttributeWindow
can be specified by the order in which the attributes are specified in the next attribute.
MMAX094/help/AttributeWindow.htm 0100644 0000764 0001001 00000065072 07644235436 017163 0 ustar Administrator Kein
The MMAX HotSpotListener
The MMAX AttributeWindow
(c) Christoph Mller, European Media Lab
(www.eml.org)
Within the MMAX framework, the AttributeWindow
is the central instance for browsing and modifying markable attributes (other
than member and pointer). At startup, the AttributeWindow is created from the
MMAX AnnotationScheme, which specifies valid attributes, possible values and
attribute combinations. Cf. the MMAX AnnotationScheme documentation for
details.
1.Basic Interaction
1.1Display of markable
attributes
Whenever a markable on the MMAX GUI is selected
by left-clicking, its attributes are displayed in the AttributeWindow. In order
to do so, the AttributeWindow first retrieves all initial attributes,
i.e. those attributes that are defined for every markable. (Initial attributes
include non-branching attributes defined at the beginning of the AnnotationScheme,
up to and including the first branching attribute.) Each markable must
have a value for at least each of those initial attributes.
The AttributeWindow then tries to map the
attribute values found on the currently selected markable to the initial
attributes.
For attributes of type freetext or id
(i.e. member or pointer), if the current markable does have a non-null value,
this value is simply taken as the value to be displayed. This is because no
constraints can exist for attributes of this type. If no non-null value is
available, the value to be displayed is left empty.
For nominal attributes, several cases
have to be distinguished:
The markable does not have a value for a given
initial attribute: In this case, the default value for this
attribute (as defined in the AnnotationScheme) is taken as the value to be
displayed.
The markable does have a value, and this value is
defined as valid for a given initial attribute: In this case, this value
is taken as the value to be displayed.
The markable does have a value, but this value is
not defined for a given attribute. In this case, a dialogue window with
two options will appear:
Overwrite the invalid value:
Choosing this option will cause the invalid value to be removed from the
current markable. The corresponding attribute in the AttributeWindow will
be set to default.
Keep the invalid value
(default): Choosing this option will retain the invalid value for this
markable. In the AttributeWindow, the corresponding attribute will be set
to reflect the invalid state: The attribute name will be displayed in
red, and all defined values will be unselected. If an attribute is in
this state, moving the mouse over the (red) attribute name in the
AttributeWindow will cause a ToolTip with the current (invalid) value to
appear.
After all initial attributes have been
processed in this way, the AttributeWindow retrieves dependent
attributes (if any) that might be accessible as a result of the current
markables attribute values. Dependent attributes might become accessible as a
result of the last initial attribute having a value for which dependent
attributes are defined in the AnnotationScheme (by means of the next attribute on a <value> element). If any
dependent attributes are found, they are mapped to the current markables
attributes in the way described above (i.e. just like the initial
attributes). After that, the AttributeWindow again tries to retrieve dependent
attributes (if any), depending on the value of the last attribute retrieved in
the previous step. If any dependent attributes are found, they are mapped to
the current markables attributes, and so on. Thus, the display of markable
attributes is a recursive process.
At the end of the recursion, i.e. if no more
dependent attributes could be retrieved, the current markable can still have
attributes not yet accounted for. Again, two cases have to be distinguished:
The attribute has a name which is defined
somewhere in the AnnotationScheme. This can indicate a potential
annotation inconsistency, because this attribute should have been
processed and displayed on the AttributeWindow earlier. The fact that it
wasnt indicates that it is (still) inapplicable to the markable in its
current annotation status. However, the attribute can be valid
anyway, e.g. if certain markable attributes were generated automatically:
In that case, the attribute is available even when the attribute it
depends on is not.
If this kind of attribute is found on the current markable, a dialogue box
with two options will appear:
oRemove the attribute: Choosing this option will cause
the attribute to be removed from the current markable.
oLeave the attribute unaltered (default): Choosing this
option will cause the attribute to be retained on the markable.When the same markable is selected again
later, and the attribute is still undefined, the same message will appear. The
user can suppress warnings of this type by checking the suppress check
checkbox in the lower part of the AttributeWindow.
The attribute has a name which is not defined
anywhere in the AnnotationScheme. This kind of extra attribute
cannot corrupt the consistency of the annotation because it does not clash
with any defined attribute. If one or more extra attributes are detected
on a markable, the user is informed by means of a warning message box. The
attributes themselves are not altered in any way! When the same markable
is selected again later, the same warning message will appear again. The
user can suppress warnings of this kind by unchecking the warn on extra
attributes checkbox in the lower part of the AttributeWindow.
1.2Modification of markable
attributes
The attributes of the currently selected
markable (except for member and pointer attributes) can also be modified by
means of the AttributeWindow.
Freetext attributes are
modified by entering or deleting text in the text field associated with the
attribute.
Nominal attributes are
modified by selecting one of the values defined for it. When a newly selected
value has dependent attributes, these are immediately added to the
AttributeWindow.
If the currently selected markables does not have
any values for one of these (the normal case), the dependent attributes
will be displayed with their default values.
If the currently selected markable has a value
for one or more of the dependent attributes, these will be set to reflect
it.
If the currently selected markable has an
undefined value for a dependent attribute, the Keep/Overwrite dialogue box
(cf. above) will appear. If the user chooses to keep the undefined value,
the corresponding attribute name will be displayed in red and all values
will be unselected.
The modifications will not be written to the
markable until the Apply button is pressed. As long as this button is not
pressed, all changes to the AttributeWindow can be undone by pressing the Undo
changes button. This behaviour can be changed by activating the AutoApply
function (via the Settings menu). If AutoApply is on, changes to nominal
attributes are committed as they occur and cannot be
undone. For freetext attributes, AutoApply does not have any
effect.
(Note: No permanent changes to the
annotation will be done until the annotation is saved (either via the menu File/Save
Markables, or by pressing CTRL-S). If an annotation is saved, any existing
markable file of the same name will be renamed to [oldname].bak. If a file of
the form [oldname].bak exists, it will be deleted.)
2.Advanced Features
2.1User-defined markable
display styles
By default, MMAX uses the colors defined in
mmaxsettings.xml for the display of markables. These settings can be modfied
and saved via the menu Settings/Colors/. MMAX also offers the possibility to
define arbitrary styles to render markables depending on their current
attributes. This can be done by means of a set of methods defined on the
AttributeWindow (cf. also the javadoc for the AttributeWindow class):
getSelectedStyle(Markable m): Returns the style
for rendering a selected (i.e. clicked) markable (normally some background
color).
getUnselectedStyle(Markable m): Returns the style
for rendering an unselected markable (normally background color=white,
foreground color = black).
getDeselectedStyle(Markable m): Returns the style
for rendering a markable from which selection has been removed (normally
background color = white, with no changes being made to the foreground
color).
getSelectedMemberSetStyle(MemberSet m): Returns
the style for rendering a set of markables with the same member value
(normally some foreground color).
getSelectedPointerSetStyle(MarkableSet m):
Returns the style for rendering source and target markable of a pointing
relation (normally some foreground color).
All of these methods return an object of class
javax.swing.text.SimpleAttributeSet. These methods are called every time the
respective style is required to render the display. In the default AttributeWindow,
they return the value on the respective fields on the AttributeWindow class. By
overwriting these methods, users can define their own styles and return them
depending on the attributes the markable to be rendered has.
Overwriting is done by simply writing a new
class which extends org.eml.MMAX.gui.AttributeWindow. On this class, the
methods mentioned above are overwritten by user-defined implementations. At
MMAX startup, use the command line parameter
attributewindow [new class name]
to use the new class. The complied class file
must be located in the MMAX root directory.
MMAX provides a way to define clickable areas in
the display, and to associate those areas with event handlers for executing
Java code. Adding clickable areas (HotSpots) to a MMAX document requires two
steps: Modification of the XSL style sheet and implementation of the Java
method to be associated with the HotSpot. A HotSpot can be activated by shift-clicking
it with the left mouse button.
The sample file in samples/text/textsample.anno gives an idea of how
HotSpots work: Upon shiftt-clicking a word in the display, a Java message box
with the selected word and its ID is displayed.
1. XSL
style sheet modification
In MMAX, an XSL style sheet is used to render
the initial display on which markable information (in the form of colours) is
displayed dynamically during the MMAX session. By means ofthis style sheet, users can define clickable
areas in the display by simply enclosing them in <hotspot>...</hotspot> tags. Each <hotspot> tag has a single command attribute which
specifies the action to be executed when the HotSpot is activated. The
attribute has the form
command=JavaMethodName:arg1
arg2 ...
The number of arguments depends on the method to
be invoked. At the moment, only arguments of type String are supported.
The following is an example HotSpot tag which
uses the popUp method defined in the default HotSpotListener class (cf. below).
The popUp method accepts a string argument with a message (HelloWorld) to be
displayed to the user. When the HotSpot is activated by shift-clicking it with
the left mouse button, a popup window with the message will appear.
<hotspot
command=popUp:HelloWorld>there</hotspot>
It is important to note that a HotSpot does not
have any default text or other visual elements associated with it. Rather, it
has to be wrapped around the text that is intended to be clickable. In the
above example, this is a single word from the underlying corpus. The above
HotSpot is defined for the display by means of the following template in the
XSL style sheet:
This rule will wrap a <hotspot>...</hotspot> tag around every
single word element in the corpus. Note how the wrapping is performed by
placing the
<xsl:text> tags for the opening and
closing <hotspot> tags around the <xsl:apply-templates/> tag!
In most cases, the command arguments of
individual HotSpots will not be invariant (like in the above example), but they
will depend on properties of the element around which they are wrapped. The
following is an example HotSpot tag which uses the playSound method also
supplied in the default HotSpotListener class (cf. below). The playSound method
accepts as arguments three strings: the name of a .WAV file to be played, an
offset and a length. If the two latter arguments are 0, the whole .WAV file
is played.
Note how in this example, text is explicitly
added to the display as a clickable label!
Obviously, the name of the sound file to be
played has to be different for every element the HotSpot is wrapped around.
HotSpots like the one above could be added to e.g. the turn level, with each
turn being associated with an individual sound file. In order to be able to do
this, the <turn> elements in the MMAX document have to contain additional attributes,
like in the following example:
<xsl:text></hotspot></xsl:text>
<!- Closing HS tag
-->
</xsl:template>
Not how in this example the HotSpot is added
after the turn element itself placing the <xsl:text> tags for the
opening and closing <hotspot> tags after the <xsl:apply-templates/>
tag!
2. Java
method implementation
Methods that are to be callable from HotSpots
have to be implemented somewhere. In MMAX, this is done in the HotSpotListener
class. This class is defined in org.eml.MMAX.gui.pluggable.HotSpotListener. It
is derived from javax.swing.JPanel, so it is a visual component. The
HotSpotListener is displayed in the right-hand side of the MMAX display. The
default HotSpotListener class only contains the two methods described above,
i.e. popUp and playSound, but users can add arbitrarily many additional
methods. This is done by writing a new HotSpotListener class which extends
the default one. In its most simple form, a derived HotSpotListener class looks
as follows:
public class
MyHotSpotListener extends org.eml.MMAX.gui.pluggable.HotSpotListener
{
public
MyHotSpotListener()
{
super();
System.out.println(MyHotSpotListener!);
}
}
This class simply extends the default
HotSpotListener but does not add any functionality to it yet. In order to use
it instead of the default one, the argument
hotspotlistener classname has to be added
when starting MMAX. For the above example, this would be:
hotspotlistener
MyHotSpotListener
In order to be accessible by MMAX, the compiled
.class file must be located in the MMAX root directory.
Adding new functionality to MyHotSpotListener
can be done by simply implementing new methods for it. If, e.g., a MMAX
document contains references to not just sound, but to video files, one might
wish to add a method like playVideo, which accepts the name of a .AVI file and
additional offset and length arguments. Similar to the playSound example
mentioned above, calls to this method could be made from a HotSpot associated
with individual turn elements in the document. Adding a new method to
MyHotSpotListener is straighforward:
public class
MyHotSpotListener extends org.eml.MMAX.gui.pluggable.HotSpotListener
{
public
MyHotSpotListener()
{
super();
}
public
void playVideo(String filename, String offset, String length)
{
// Add
actual implementation here
}
}
Note again that (at least in the current
version) all arguments that a method can accept must be of type String!
Since the HotSpotListener (and every class
derived from it) is a visual component, the display to be used for video
playback can even be placed on the HotSpotListener itself, so that it appears
embedded into the right-hand side of the MMAX display. In that case, the
constructor of MyHotSpotListener can be modified to create some visual
components:
public class
MyHotSpotListener extends org.eml.MMAX.gui.pluggable.HotSpotListener
{
SomeTypeOfDisplay display;
public
MyHotSpotListener()
{
super();
display
= new SomeTypeOfDisplay();
getContentPane().add(display);
...
...
}
public
void playVideo(String filename, String offset, String length)
MMAX094/help/eml-logo-kl.jpg 0100644 0000764 0001001 00000006700 07240166552 016122 0 ustar Administrator Kein JFIF C
C B s"
} !1AQa"q2#BR$3br
%&'()*456789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz
w !1AQaq"2B #3Rbr
$4%&'()*56789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz ? _> 4u;-OJ˺eʈIӈhUԑSVQs:mQѾ 6]B+Y^5M̅J cl82 =7/Q'=R{-{Ò-wM
;MVe^<_rR¿q qg=v4( ltl2') 8 ᕔ3sN6[{Ogl7_
3~מO |8jyƯ.#FZr3d C? }Tw& eq:S*_['+G %#ƿ |>]JKʣ3y뀧yTz OU\