nlptoolkit-framenet 1.0.1 → 1.0.2

package/README.md

@@ -25,7 +25,7 @@ Video Lectures
 For Developers
 ============
 You can also see either [Python](https://github.com/starlangsoftware/TurkishFrameNet-Py), [Java](https://github.com/starlangsoftware/TurkishFrameNet),
-[C++](https://github.com/starlangsoftware/TurkishFrameNet-CPP), [C#](https://github.com/starlangsoftware/TurkishFrameNet-CS), 
+[C++](https://github.com/starlangsoftware/TurkishFrameNet-CPP), [C](https://github.com/starlangsoftware/TurkishFrameNet-C), [C#](https://github.com/starlangsoftware/TurkishFrameNet-CS), [Php](https://github.com/starlangsoftware/TurkishFrameNet-Php), 
 [Cython](https://github.com/starlangsoftware/TurkishFrameNet-Cy), or [Swift](https://github.com/starlangsoftware/TurkishFrameNet-Swift) repository.
 
 ## Requirements

package/dist/Frame.d.ts

@@ -8,12 +8,47 @@ export declare class Frame {
      * @param name  Name of the frame
      */
     constructor(name: string);
+    /**
+     * Adds a new lexical unit to the current frame
+     * @param lexicalUnit Lexical unit to be added
+     */
     addLexicalUnit(lexicalUnit: string): void;
+    /**
+     * Adds a new frame element to the current frame
+     * @param frameElement Frame element to be added
+     */
     addFrameElement(frameElement: string): void;
+    /**
+     * Checks if the given lexical unit exists in the current frame
+     * @param lexicalUnit Lexical unit to be searched.
+     * @return True if the lexical unit exists, false otherwise.
+     */
     lexicalUnitExists(lexicalUnit: string): boolean;
+    /**
+     * Accessor for a given index in the lexicalUnit array.
+     * @param index Index of the lexical unit
+     * @return The lexical unit at position index in the lexicalUnit array
+     */
     getLexicalUnit(index: number): string;
+    /**
+     * Accessor for a given index in the frameElements array.
+     * @param index Index of the frame element
+     * @return The frame element at position index in the frameElements array
+     */
     getFrameElement(index: number): string;
+    /**
+     * Returns number of lexical units in the current frame
+     * @return Number of lexical units in the current frame
+     */
     lexicalUnitSize(): number;
+    /**
+     * Returns number of frame elements in the current frame
+     * @return Number of frame elements in the current frame
+     */
     frameElementSize(): number;
+    /**
+     * Accessor for the name of the frame
+     * @return Name of the frame
+     */
     getName(): string;
 }

package/dist/Frame.js

@@ -21,27 +21,62 @@
             this.lexicalUnits = [];
             this.frameElements = [];
         }
+        /**
+         * Adds a new lexical unit to the current frame
+         * @param lexicalUnit Lexical unit to be added
+         */
         addLexicalUnit(lexicalUnit) {
             this.lexicalUnits.push(lexicalUnit);
         }
+        /**
+         * Adds a new frame element to the current frame
+         * @param frameElement Frame element to be added
+         */
         addFrameElement(frameElement) {
             this.frameElements.push(frameElement);
         }
+        /**
+         * Checks if the given lexical unit exists in the current frame
+         * @param lexicalUnit Lexical unit to be searched.
+         * @return True if the lexical unit exists, false otherwise.
+         */
         lexicalUnitExists(lexicalUnit) {
             return this.lexicalUnits.includes(lexicalUnit);
         }
+        /**
+         * Accessor for a given index in the lexicalUnit array.
+         * @param index Index of the lexical unit
+         * @return The lexical unit at position index in the lexicalUnit array
+         */
         getLexicalUnit(index) {
             return this.lexicalUnits[index];
         }
+        /**
+         * Accessor for a given index in the frameElements array.
+         * @param index Index of the frame element
+         * @return The frame element at position index in the frameElements array
+         */
         getFrameElement(index) {
             return this.frameElements[index];
         }
+        /**
+         * Returns number of lexical units in the current frame
+         * @return Number of lexical units in the current frame
+         */
         lexicalUnitSize() {
             return this.lexicalUnits.length;
         }
+        /**
+         * Returns number of frame elements in the current frame
+         * @return Number of frame elements in the current frame
+         */
         frameElementSize() {
             return this.frameElements.length;
         }
+        /**
+         * Accessor for the name of the frame
+         * @return Name of the frame
+         */
         getName() {
             return this.name;
         }

package/dist/Frame.js.map

@@ -1 +1 @@
-{"version":3,"file":"Frame.js","sourceRoot":"","sources":["../source/Frame.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,MAAa,KAAK;QAMd;;;;WAIG;QACH,YAAY,IAAY;YACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAA;YACtB,IAAI,CAAC,aAAa,GAAG,EAAE,CAAA;QAC3B,CAAC;QAED,cAAc,CAAC,WAAmB;YAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvC,CAAC;QAED,eAAe,CAAC,YAAoB;YAChC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACzC,CAAC;QAED,iBAAiB,CAAC,WAAmB;YACjC,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QAClD,CAAC;QAED,cAAc,CAAC,KAAa;YACxB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;QACnC,CAAC;QAED,eAAe,CAAC,KAAa;YACzB,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;QACpC,CAAC;QAED,eAAe;YACX,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAA;QACnC,CAAC;QAED,gBAAgB;YACZ,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAA;QACpC,CAAC;QAED,OAAO;YACH,OAAO,IAAI,CAAC,IAAI,CAAA;QACpB,CAAC;KACJ;IAhDD,sBAgDC"}
+{"version":3,"file":"Frame.js","sourceRoot":"","sources":["../source/Frame.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,MAAa,KAAK;QAMd;;;;WAIG;QACH,YAAY,IAAY;YACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAA;YACtB,IAAI,CAAC,aAAa,GAAG,EAAE,CAAA;QAC3B,CAAC;QAED;;;WAGG;QACH,cAAc,CAAC,WAAmB;YAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvC,CAAC;QAED;;;WAGG;QACH,eAAe,CAAC,YAAoB;YAChC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACzC,CAAC;QAED;;;;WAIG;QACH,iBAAiB,CAAC,WAAmB;YACjC,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QAClD,CAAC;QAED;;;;WAIG;QACH,cAAc,CAAC,KAAa;YACxB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;QACnC,CAAC;QAED;;;;WAIG;QACH,eAAe,CAAC,KAAa;YACzB,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;QACpC,CAAC;QAED;;;WAGG;QACH,eAAe;YACX,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAA;QACnC,CAAC;QAED;;;WAGG;QACH,gBAAgB;YACZ,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAA;QACpC,CAAC;QAED;;;WAGG;QACH,OAAO;YACH,OAAO,IAAI,CAAC,IAAI,CAAA;QACpB,CAAC;KACJ;IAnFD,sBAmFC"}

package/dist/FrameElement.d.ts

@@ -1,7 +1,7 @@
 export declare class FrameElement {
     private readonly frameElementType;
     private readonly frame;
-    private readonly id;
+    private id;
     /**
      * A constructor of {@link FrameElement} class which takes frameElement string which is in the form of frameElementType$id
      * and parses this string into frameElementType and id. If the frameElement string does not contain '$' then the
@@ -30,6 +30,13 @@ export declare class FrameElement {
      * @return id.
      */
     getId(): string;
+    /**
+     * Mutator for id.
+     *
+     * @param id New id.
+     * @return id.
+     */
+    setId(id: string): void;
     /**
      * toString converts an {@link FrameElement} to a string. If the frameElementType is "NONE" returns only "NONE", otherwise
      * it returns argument string which is in the form of frameElementType$id

package/dist/FrameElement.js

@@ -61,6 +61,15 @@
         getId() {
             return this.id;
         }
+        /**
+         * Mutator for id.
+         *
+         * @param id New id.
+         * @return id.
+         */
+        setId(id) {
+            this.id = id;
+        }
         /**
          * toString converts an {@link FrameElement} to a string. If the frameElementType is "NONE" returns only "NONE", otherwise
          * it returns argument string which is in the form of frameElementType$id

package/dist/FrameElement.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrameElement.js","sourceRoot":"","sources":["../source/FrameElement.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,MAAa,YAAY;QAMrB;;;;;;;;WAQG;QACH,YAAY,YAAoB,EAAE,KAAc,EAAE,EAAW;YACzD,IAAI,KAAK,IAAI,SAAS,EAAC;gBACnB,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAC;oBAC3B,IAAI,CAAC,gBAAgB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;oBACzE,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;oBACjG,IAAI,CAAC,EAAE,GAAG,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;iBACtE;qBAAM;oBACH,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAA;iBACjC;aACJ;iBAAM;gBACH,IAAI,CAAC,gBAAgB,GAAG,YAAY,CAAA;gBACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;gBAClB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;aACf;QACL,CAAC;QAED;;;;WAIG;QACH,mBAAmB;YACf,OAAO,IAAI,CAAC,gBAAgB,CAAA;QAChC,CAAC;QAED;;;;WAIG;QACH,QAAQ;YACJ,OAAO,IAAI,CAAC,KAAK,CAAA;QACrB,CAAC;QAED;;;;WAIG;QACH,KAAK;YACD,OAAO,IAAI,CAAC,EAAE,CAAA;QAClB,CAAC;QAED;;;;;WAKG;QACH,QAAQ;YACJ,IAAI,IAAI,CAAC,gBAAgB,IAAI,MAAM,EAAC;gBAChC,OAAO,IAAI,CAAC,gBAAgB,CAAA;aAC/B;iBAAM;gBACH,OAAO,IAAI,CAAC,gBAAgB,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC;aACnE;QACL,CAAC;KACJ;IAvED,oCAuEC"}
+{"version":3,"file":"FrameElement.js","sourceRoot":"","sources":["../source/FrameElement.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,MAAa,YAAY;QAMrB;;;;;;;;WAQG;QACH,YAAY,YAAoB,EAAE,KAAc,EAAE,EAAW;YACzD,IAAI,KAAK,IAAI,SAAS,EAAC;gBACnB,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAC;oBAC3B,IAAI,CAAC,gBAAgB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;oBACzE,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;oBACjG,IAAI,CAAC,EAAE,GAAG,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;iBACtE;qBAAM;oBACH,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAA;iBACjC;aACJ;iBAAM;gBACH,IAAI,CAAC,gBAAgB,GAAG,YAAY,CAAA;gBACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;gBAClB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;aACf;QACL,CAAC;QAED;;;;WAIG;QACH,mBAAmB;YACf,OAAO,IAAI,CAAC,gBAAgB,CAAA;QAChC,CAAC;QAED;;;;WAIG;QACH,QAAQ;YACJ,OAAO,IAAI,CAAC,KAAK,CAAA;QACrB,CAAC;QAED;;;;WAIG;QACH,KAAK;YACD,OAAO,IAAI,CAAC,EAAE,CAAA;QAClB,CAAC;QAED;;;;;WAKG;QACH,KAAK,CAAC,EAAU;YACZ,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;QAChB,CAAC;QAED;;;;;WAKG;QACH,QAAQ;YACJ,IAAI,IAAI,CAAC,gBAAgB,IAAI,MAAM,EAAC;gBAChC,OAAO,IAAI,CAAC,gBAAgB,CAAA;aAC/B;iBAAM;gBACH,OAAO,IAAI,CAAC,gBAAgB,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC;aACnE;QACL,CAAC;KACJ;IAjFD,oCAiFC"}

package/dist/FrameElementList.d.ts

@@ -0,0 +1,54 @@
+export declare class FrameElementList {
+    private readonly _frameElements;
+    /**
+     * Constructor of frame element list from a string. The frame elements for a word is a concatenated list of
+     * frame element separated via '#' character.
+     * @param frameElementList String consisting of frame elements separated with '#' character.
+     */
+    constructor(frameElementList: string);
+    /**
+     * Overloaded toString method to convert a frame element list to a string. Concatenates the string forms of all
+     * frame element with '#' character.
+     * @return String form of the frame element list.
+     */
+    toString(): string;
+    /**
+     * Replaces id's of predicates, which have previousId as synset id, with currentId.
+     * @param previousId Previous id of the synset.
+     * @param currentId Replacement id.
+     */
+    updateConnectedId(previousId: string, currentId: string): void;
+    /**
+     * Adds a predicate argument to the frame element list of this word.
+     * @param predicateId Synset id of this predicate.
+     */
+    addPredicate(predicateId: string): void;
+    /**
+     * Removes the predicate with the given predicate id.
+     */
+    removePredicate(): void;
+    /**
+     * Checks if one of the frame elements is a predicate.
+     * @return True, if one of the frame elements is predicate; false otherwise.
+     */
+    containsPredicate(): boolean;
+    /**
+     * Checks if one of the frame element is a predicate with the given id.
+     * @param predicateId Synset id to check.
+     * @return True, if one of the frame element is predicate; false otherwise.
+     */
+    containsPredicateWithId(predicateId: string): boolean;
+    /**
+     * Returns the frame elements as an array list of strings.
+     * @return Frame elements as an array list of strings.
+     */
+    getFrameElements(): Array<string>;
+    /**
+     * Checks if the given argument with the given type and id exists or not.
+     * @param frameElementType Type of the frame element to search for.
+     * @param frame frame Name of the frame to search for
+     * @param id Id of the frame element to search for.
+     * @return True if the frame element exists, false otherwise.
+     */
+    containsFrameElement(frameElementType: string, frame: string, id: string): boolean;
+}

package/dist/FrameElementList.js

@@ -0,0 +1,135 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./FrameElement"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.FrameElementList = void 0;
+    const FrameElement_1 = require("./FrameElement");
+    class FrameElementList {
+        /**
+         * Constructor of frame element list from a string. The frame elements for a word is a concatenated list of
+         * frame element separated via '#' character.
+         * @param frameElementList String consisting of frame elements separated with '#' character.
+         */
+        constructor(frameElementList) {
+            this._frameElements = [];
+            let items = frameElementList.split("#");
+            for (let item of items) {
+                this._frameElements.push(new FrameElement_1.FrameElement(item));
+            }
+        }
+        /**
+         * Overloaded toString method to convert a frame element list to a string. Concatenates the string forms of all
+         * frame element with '#' character.
+         * @return String form of the frame element list.
+         */
+        toString() {
+            if (this._frameElements.length == 0) {
+                return "NONE";
+            }
+            else {
+                let result = this._frameElements[0].toString();
+                for (let i = 1; i < this._frameElements.length; i++) {
+                    result += "#" + this._frameElements[i].toString();
+                }
+                return result;
+            }
+        }
+        /**
+         * Replaces id's of predicates, which have previousId as synset id, with currentId.
+         * @param previousId Previous id of the synset.
+         * @param currentId Replacement id.
+         */
+        updateConnectedId(previousId, currentId) {
+            for (let frameElement of this._frameElements) {
+                if (frameElement.getId() == previousId) {
+                    frameElement.setId(currentId);
+                }
+            }
+        }
+        /**
+         * Adds a predicate argument to the frame element list of this word.
+         * @param predicateId Synset id of this predicate.
+         */
+        addPredicate(predicateId) {
+            if (this._frameElements.length != 0 && this._frameElements[0].getFrameElementType() == "NONE") {
+                this._frameElements.shift();
+            }
+            this._frameElements.push(new FrameElement_1.FrameElement("PREDICATE", "NONE", predicateId));
+        }
+        /**
+         * Removes the predicate with the given predicate id.
+         */
+        removePredicate() {
+            let i = 0;
+            for (let frameElement of this._frameElements) {
+                if (frameElement.getFrameElementType() == "PREDICATE") {
+                    this._frameElements.splice(i, 1);
+                    break;
+                }
+                i++;
+            }
+        }
+        /**
+         * Checks if one of the frame elements is a predicate.
+         * @return True, if one of the frame elements is predicate; false otherwise.
+         */
+        containsPredicate() {
+            for (let frameElement of this._frameElements) {
+                if (frameElement.getFrameElementType() == "PREDICATE") {
+                    return true;
+                }
+            }
+            return false;
+        }
+        /**
+         * Checks if one of the frame element is a predicate with the given id.
+         * @param predicateId Synset id to check.
+         * @return True, if one of the frame element is predicate; false otherwise.
+         */
+        containsPredicateWithId(predicateId) {
+            for (let frameElement of this._frameElements) {
+                if (frameElement.getFrameElementType() == "PREDICATE" && frameElement.getId() == predicateId) {
+                    return true;
+                }
+            }
+            return false;
+        }
+        /**
+         * Returns the frame elements as an array list of strings.
+         * @return Frame elements as an array list of strings.
+         */
+        getFrameElements() {
+            let result = [];
+            for (let frameElement of this._frameElements) {
+                result.push(frameElement.toString());
+            }
+            return result;
+        }
+        /**
+         * Checks if the given argument with the given type and id exists or not.
+         * @param frameElementType Type of the frame element to search for.
+         * @param frame frame Name of the frame to search for
+         * @param id Id of the frame element to search for.
+         * @return True if the frame element exists, false otherwise.
+         */
+        containsFrameElement(frameElementType, frame, id) {
+            for (let frameElement of this._frameElements) {
+                if (frameElement.getFrameElementType() == frameElementType &&
+                    frameElement.getFrame() == frame &&
+                    frameElement.getId() == id) {
+                    return true;
+                }
+            }
+            return false;
+        }
+    }
+    exports.FrameElementList = FrameElementList;
+});
+//# sourceMappingURL=FrameElementList.js.map

package/dist/FrameElementList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameElementList.js","sourceRoot":"","sources":["../source/FrameElementList.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,iDAA4C;IAE5C,MAAa,gBAAgB;QAIzB;;;;WAIG;QACH,YAAY,gBAAwB;YAChC,IAAI,CAAC,cAAc,GAAG,EAAE,CAAA;YACxB,IAAI,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxC,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE;gBACpB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,2BAAY,CAAC,IAAI,CAAC,CAAC,CAAC;aACpD;QACL,CAAC;QAED;;;;WAIG;QACH,QAAQ;YACJ,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,IAAI,CAAC,EAAC;gBAChC,OAAO,MAAM,CAAA;aAChB;iBAAM;gBACH,IAAI,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;gBAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAC;oBAChD,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;iBACpD;gBACD,OAAO,MAAM,CAAC;aACjB;QACL,CAAC;QAED;;;;WAIG;QACH,iBAAiB,CAAC,UAAkB,EAAE,SAAiB;YACnD,KAAK,IAAI,YAAY,IAAI,IAAI,CAAC,cAAc,EAAE;gBAC1C,IAAI,YAAY,CAAC,KAAK,EAAE,IAAI,UAAU,EAAC;oBACnC,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;iBACjC;aACJ;QACL,CAAC;QAED;;;WAGG;QACH,YAAY,CAAC,WAAmB;YAC5B,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,mBAAmB,EAAE,IAAI,MAAM,EAAC;gBAC1F,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;aAC/B;YACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,2BAAY,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;QACjF,CAAC;QAED;;WAEG;QACH,eAAe;YACX,IAAI,CAAC,GAAG,CAAC,CAAA;YACT,KAAK,IAAI,YAAY,IAAI,IAAI,CAAC,cAAc,EAAE;gBAC1C,IAAI,YAAY,CAAC,mBAAmB,EAAE,IAAI,WAAW,EAAC;oBAClD,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBACjC,MAAM;iBACT;gBACD,CAAC,EAAE,CAAA;aACN;QACL,CAAC;QAED;;;WAGG;QACH,iBAAiB;YACb,KAAK,IAAI,YAAY,IAAI,IAAI,CAAC,cAAc,EAAE;gBAC1C,IAAI,YAAY,CAAC,mBAAmB,EAAE,IAAI,WAAW,EAAC;oBAClD,OAAO,IAAI,CAAC;iBACf;aACJ;YACD,OAAO,KAAK,CAAC;QACjB,CAAC;QAED;;;;WAIG;QACH,uBAAuB,CAAC,WAAmB;YACvC,KAAK,IAAI,YAAY,IAAI,IAAI,CAAC,cAAc,EAAE;gBAC1C,IAAI,YAAY,CAAC,mBAAmB,EAAE,IAAI,WAAW,IAAI,YAAY,CAAC,KAAK,EAAE,IAAI,WAAW,EAAC;oBACzF,OAAO,IAAI,CAAC;iBACf;aACJ;YACD,OAAO,KAAK,CAAC;QACjB,CAAC;QAED;;;WAGG;QACH,gBAAgB;YACZ,IAAI,MAAM,GAAG,EAAE,CAAA;YACf,KAAK,IAAI,YAAY,IAAI,IAAI,CAAC,cAAc,EAAE;gBAC1C,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC;aACxC;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QAED;;;;;;WAMG;QACH,oBAAoB,CAAC,gBAAwB,EAAE,KAAa,EAAE,EAAU;YACpE,KAAK,IAAI,YAAY,IAAI,IAAI,CAAC,cAAc,EAAE;gBAC1C,IAAI,YAAY,CAAC,mBAAmB,EAAE,IAAI,gBAAgB;oBACtD,YAAY,CAAC,QAAQ,EAAE,IAAI,KAAK;oBAChC,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,EAAC;oBAC3B,OAAO,IAAI,CAAC;iBACf;aACJ;YACD,OAAO,KAAK,CAAC;QACjB,CAAC;KACJ;IAhID,4CAgIC"}

package/dist/FrameNet.d.ts

@@ -1,9 +1,32 @@
 import { Frame } from "./Frame";
 export declare class FrameNet {
-    private frames;
+    private readonly frames;
+    /**
+     * A constructor of {@link FrameNet} class which reads all frame files inside the files2.txt file. For each
+     * filename inside that file, the constructor creates a FrameNet.Frame and puts in inside the frames {@link ArrayList}.
+     */
     constructor();
+    /**
+     * Checks if the given lexical unit exists in any frame in the frame set.
+     * @param synSetId Id of the lexical unit
+     * @return True if any frame contains the given lexical unit, false otherwise.
+     */
     lexicalUnitExists(synSetId: string): boolean;
+    /**
+     * Returns an array of frames that contain the given lexical unit in their lexical units
+     * @param synSetId Id of the lexical unit.
+     * @return An array of frames that contains the given lexical unit.
+     */
     getFrames(synSetId: string): Array<Frame>;
+    /**
+     * Returns number of frames in the frame set.
+     * @return Number of frames in the frame set.
+     */
     size(): number;
+    /**
+     * Returns the element at the specified position in the frame list.
+     * @param index index of the element to return
+     * @return The element at the specified position in the frame list.
+     */
     getFrame(index: number): Frame;
 }

package/dist/FrameNet.js

@@ -13,6 +13,10 @@
     const Frame_1 = require("./Frame");
     const XmlDocument_1 = require("nlptoolkit-xmlparser/dist/XmlDocument");
     class FrameNet {
+        /**
+         * A constructor of {@link FrameNet} class which reads all frame files inside the files2.txt file. For each
+         * filename inside that file, the constructor creates a FrameNet.Frame and puts in inside the frames {@link ArrayList}.
+         */
         constructor() {
             let xmlDocument;
             xmlDocument = new XmlDocument_1.XmlDocument("framenet.xml");
@@ -38,6 +42,11 @@
                 frameNode = frameNode.getNextSibling();
             }
         }
+        /**
+         * Checks if the given lexical unit exists in any frame in the frame set.
+         * @param synSetId Id of the lexical unit
+         * @return True if any frame contains the given lexical unit, false otherwise.
+         */
         lexicalUnitExists(synSetId) {
             for (let frame of this.frames) {
                 if (frame.lexicalUnitExists(synSetId)) {
@@ -46,6 +55,11 @@
             }
             return false;
         }
+        /**
+         * Returns an array of frames that contain the given lexical unit in their lexical units
+         * @param synSetId Id of the lexical unit.
+         * @return An array of frames that contains the given lexical unit.
+         */
         getFrames(synSetId) {
             var result = [];
             for (let frame of this.frames) {
@@ -55,9 +69,18 @@
             }
             return result;
         }
+        /**
+         * Returns number of frames in the frame set.
+         * @return Number of frames in the frame set.
+         */
         size() {
             return this.frames.length;
         }
+        /**
+         * Returns the element at the specified position in the frame list.
+         * @param index index of the element to return
+         * @return The element at the specified position in the frame list.
+         */
         getFrame(index) {
             return this.frames[index];
         }

package/dist/FrameNet.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrameNet.js","sourceRoot":"","sources":["../source/FrameNet.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,mCAA8B;IAC9B,uEAAkE;IAElE,MAAa,QAAQ;QAIjB;YACI,IAAI,WAAwB,CAAC;YAC7B,WAAW,GAAG,IAAI,yBAAW,CAAC,cAAc,CAAC,CAAA;YAC7C,WAAW,CAAC,KAAK,EAAE,CAAA;YACnB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA;YAChB,IAAI,QAAQ,GAAG,WAAW,CAAC,aAAa,EAAE,CAAA;YAC1C,IAAI,SAAS,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAA;YACxC,OAAO,SAAS,IAAI,SAAS,EAAC;gBAC1B,IAAI,YAAY,GAAG,IAAI,aAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAA;gBACjE,IAAI,YAAY,GAAG,SAAS,CAAC,aAAa,EAAE,CAAA;gBAC5C,IAAI,WAAW,GAAG,YAAY,CAAC,aAAa,EAAE,CAAA;gBAC9C,OAAO,WAAW,IAAI,SAAS,EAAC;oBAC5B,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,CAAA;oBACpD,WAAW,GAAG,WAAW,CAAC,cAAc,EAAE,CAAA;iBAC7C;gBACD,IAAI,aAAa,GAAG,YAAY,CAAC,cAAc,EAAE,CAAA;gBACjD,IAAI,YAAY,GAAG,aAAa,CAAC,aAAa,EAAE,CAAA;gBAChD,OAAO,YAAY,IAAI,SAAS,EAAC;oBAC7B,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAA;oBACtD,YAAY,GAAG,YAAY,CAAC,cAAc,EAAE,CAAA;iBAC/C;gBACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;gBAC9B,SAAS,GAAG,SAAS,CAAC,cAAc,EAAE,CAAA;aACzC;QACL,CAAC;QAED,iBAAiB,CAAC,QAAgB;YAC9B,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAC;gBAC1B,IAAI,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAC;oBAClC,OAAO,IAAI,CAAA;iBACd;aACJ;YACD,OAAO,KAAK,CAAA;QAChB,CAAC;QAED,SAAS,CAAC,QAAgB;YACtB,IAAI,MAAM,GAAiB,EAAE,CAAA;YAC7B,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAC;gBAC1B,IAAI,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAC;oBAClC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;iBACrB;aACJ;YACD,OAAO,MAAM,CAAA;QACjB,CAAC;QAED,IAAI;YACA,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAA;QAC7B,CAAC;QAED,QAAQ,CAAC,KAAa;YAClB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC7B,CAAC;KACJ;IAxDD,4BAwDC"}
+{"version":3,"file":"FrameNet.js","sourceRoot":"","sources":["../source/FrameNet.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,mCAA8B;IAC9B,uEAAkE;IAElE,MAAa,QAAQ;QAIjB;;;WAGG;QACH;YACI,IAAI,WAAwB,CAAC;YAC7B,WAAW,GAAG,IAAI,yBAAW,CAAC,cAAc,CAAC,CAAA;YAC7C,WAAW,CAAC,KAAK,EAAE,CAAA;YACnB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA;YAChB,IAAI,QAAQ,GAAG,WAAW,CAAC,aAAa,EAAE,CAAA;YAC1C,IAAI,SAAS,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAA;YACxC,OAAO,SAAS,IAAI,SAAS,EAAC;gBAC1B,IAAI,YAAY,GAAG,IAAI,aAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAA;gBACjE,IAAI,YAAY,GAAG,SAAS,CAAC,aAAa,EAAE,CAAA;gBAC5C,IAAI,WAAW,GAAG,YAAY,CAAC,aAAa,EAAE,CAAA;gBAC9C,OAAO,WAAW,IAAI,SAAS,EAAC;oBAC5B,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,CAAA;oBACpD,WAAW,GAAG,WAAW,CAAC,cAAc,EAAE,CAAA;iBAC7C;gBACD,IAAI,aAAa,GAAG,YAAY,CAAC,cAAc,EAAE,CAAA;gBACjD,IAAI,YAAY,GAAG,aAAa,CAAC,aAAa,EAAE,CAAA;gBAChD,OAAO,YAAY,IAAI,SAAS,EAAC;oBAC7B,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAA;oBACtD,YAAY,GAAG,YAAY,CAAC,cAAc,EAAE,CAAA;iBAC/C;gBACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;gBAC9B,SAAS,GAAG,SAAS,CAAC,cAAc,EAAE,CAAA;aACzC;QACL,CAAC;QAED;;;;WAIG;QACH,iBAAiB,CAAC,QAAgB;YAC9B,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAC;gBAC1B,IAAI,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAC;oBAClC,OAAO,IAAI,CAAA;iBACd;aACJ;YACD,OAAO,KAAK,CAAA;QAChB,CAAC;QAED;;;;WAIG;QACH,SAAS,CAAC,QAAgB;YACtB,IAAI,MAAM,GAAiB,EAAE,CAAA;YAC7B,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAC;gBAC1B,IAAI,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAC;oBAClC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;iBACrB;aACJ;YACD,OAAO,MAAM,CAAA;QACjB,CAAC;QAED;;;WAGG;QACH,IAAI;YACA,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAA;QAC7B,CAAC;QAED;;;;WAIG;QACH,QAAQ,CAAC,KAAa;YAClB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC7B,CAAC;KACJ;IA/ED,4BA+EC"}