nlptoolkit-annotatedtree 1.0.2 → 1.0.4

package/README.md

@@ -19,11 +19,16 @@ After all levels of processing are finished, the data structure stored for the s
 
 As is self-explanatory, 'turkish' tag shows the original Turkish word; 'morphologicalanalysis' tag shows the correct morphological parse of that word; 'semantics' tag shows the ID of the correct sense of that word; 'namedEntity' tag shows the named entity tag of that word; 'propbank' tag shows the semantic role of that word for the verb synset id (frame id in the frame file) which is also given in that tag.
 
+Video Lectures
+============
+
+[<img src=https://github.com/StarlangSoftware/AnnotatedTree/blob/master/video1.jpg width="50%">](https://youtu.be/LfMf1bo3tEw)[<img src=https://github.com/StarlangSoftware/AnnotatedTree/blob/master/video2.jpg width="50%">](https://youtu.be/QoFPb9XY8Vc)
+
 For Developers
 ============
 
 You can also see [Java](https://github.com/starlangsoftware/AnnotatedTree), [Python](https://github.com/starlangsoftware/AnnotatedTree-Py), 
-[Cython](https://github.com/starlangsoftware/AnnotatedTree-Cy), [C++](https://github.com/starlangsoftware/AnnotatedTree-CPP), [Swift](https://github.com/starlangsoftware/AnnotatedTree-Swift), or [C#](https://github.com/starlangsoftware/AnnotatedTree-CS) repository.
+[Cython](https://github.com/starlangsoftware/AnnotatedTree-Cy), [C++](https://github.com/starlangsoftware/AnnotatedTree-CPP), [C](https://github.com/starlangsoftware/AnnotatedTree-C), [Swift](https://github.com/starlangsoftware/AnnotatedTree-Swift), or [C#](https://github.com/starlangsoftware/AnnotatedTree-CS) repository.
 
 ## Requirements
 

package/dist/Layer/DependencyLayer.d.ts

@@ -1,4 +1,8 @@
 import { SingleWordLayer } from "./SingleWordLayer";
 export declare class DependencyLayer extends SingleWordLayer<string> {
+    /**
+     * Constructor for the dependency layer. Dependency layer stores the dependency information of a node.
+     * @param layerValue Value of the dependency layer.
+     */
     constructor(layerValue: string);
 }

package/dist/Layer/DependencyLayer.js

@@ -12,6 +12,10 @@
     exports.DependencyLayer = void 0;
     const SingleWordLayer_1 = require("./SingleWordLayer");
     class DependencyLayer extends SingleWordLayer_1.SingleWordLayer {
+        /**
+         * Constructor for the dependency layer. Dependency layer stores the dependency information of a node.
+         * @param layerValue Value of the dependency layer.
+         */
         constructor(layerValue) {
             super();
             this.layerName = "dependency";

package/dist/Layer/DependencyLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"DependencyLayer.js","sourceRoot":"","sources":["../../source/Layer/DependencyLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uDAAkD;IAElD,MAAa,eAAgB,SAAQ,iCAAuB;QAExD,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,YAAY,CAAA;YAC7B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;KACJ;IAPD,0CAOC"}
+{"version":3,"file":"DependencyLayer.js","sourceRoot":"","sources":["../../source/Layer/DependencyLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uDAAkD;IAElD,MAAa,eAAgB,SAAQ,iCAAuB;QAExD;;;WAGG;QACH,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,YAAY,CAAA;YAC7B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;KACJ;IAXD,0CAWC"}

package/dist/Layer/EnglishPropbankLayer.d.ts

@@ -1,6 +1,15 @@
 import { SingleWordMultiItemLayer } from "./SingleWordMultiItemLayer";
 import { Argument } from "nlptoolkit-propbank/dist/Argument";
 export declare class EnglishPropbankLayer extends SingleWordMultiItemLayer<Argument> {
+    /**
+     * Constructor for the propbank layer for English language.
+     * @param layerValue Value for the English propbank layer.
+     */
     constructor(layerValue: string);
+    /**
+     * Sets the value for the propbank layer in a node. Value may consist of multiple propbank information separated via
+     * '#' character. Each propbank value consists of argumentType and id info separated via '$' character.
+     * @param layerValue New layer info
+     */
     setLayerValue(layerValue: string): void;
 }

package/dist/Layer/EnglishPropbankLayer.js

@@ -13,11 +13,20 @@
     const SingleWordMultiItemLayer_1 = require("./SingleWordMultiItemLayer");
     const Argument_1 = require("nlptoolkit-propbank/dist/Argument");
     class EnglishPropbankLayer extends SingleWordMultiItemLayer_1.SingleWordMultiItemLayer {
+        /**
+         * Constructor for the propbank layer for English language.
+         * @param layerValue Value for the English propbank layer.
+         */
         constructor(layerValue) {
             super();
             this.layerName = "englishPropbank";
             this.setLayerValue(layerValue);
         }
+        /**
+         * Sets the value for the propbank layer in a node. Value may consist of multiple propbank information separated via
+         * '#' character. Each propbank value consists of argumentType and id info separated via '$' character.
+         * @param layerValue New layer info
+         */
         setLayerValue(layerValue) {
             this.items = new Array();
             this.layerValue = layerValue;

package/dist/Layer/EnglishPropbankLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"EnglishPropbankLayer.js","sourceRoot":"","sources":["../../source/Layer/EnglishPropbankLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,yEAAoE;IACpE,gEAA2D;IAE3D,MAAa,oBAAqB,SAAQ,mDAAkC;QAExE,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAA;YAClC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,aAAa,CAAC,UAAkB;YAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAY,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,UAAU,IAAI,IAAI,EAAC;gBACnB,IAAI,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACvC,KAAK,IAAI,IAAI,IAAI,UAAU,EAAC;oBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;iBACvC;aACJ;QACL,CAAC;KACJ;IAlBD,oDAkBC"}
+{"version":3,"file":"EnglishPropbankLayer.js","sourceRoot":"","sources":["../../source/Layer/EnglishPropbankLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,yEAAoE;IACpE,gEAA2D;IAE3D,MAAa,oBAAqB,SAAQ,mDAAkC;QAExE;;;WAGG;QACH,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAA;YAClC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED;;;;WAIG;QACH,aAAa,CAAC,UAAkB;YAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAY,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,UAAU,IAAI,IAAI,EAAC;gBACnB,IAAI,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACvC,KAAK,IAAI,IAAI,IAAI,UAAU,EAAC;oBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;iBACvC;aACJ;QACL,CAAC;KACJ;IA3BD,oDA2BC"}

package/dist/Layer/EnglishSemanticLayer.d.ts

@@ -1,4 +1,9 @@
 import { SingleWordLayer } from "./SingleWordLayer";
 export declare class EnglishSemanticLayer extends SingleWordLayer<string> {
+    /**
+     * Constructor for the semantic layer for English language. Sets the layer value to the synset id defined in English
+     * WordNet.
+     * @param layerValue Value for the English semantic layer.
+     */
     constructor(layerValue: string);
 }

package/dist/Layer/EnglishSemanticLayer.js

@@ -12,6 +12,11 @@
     exports.EnglishSemanticLayer = void 0;
     const SingleWordLayer_1 = require("./SingleWordLayer");
     class EnglishSemanticLayer extends SingleWordLayer_1.SingleWordLayer {
+        /**
+         * Constructor for the semantic layer for English language. Sets the layer value to the synset id defined in English
+         * WordNet.
+         * @param layerValue Value for the English semantic layer.
+         */
         constructor(layerValue) {
             super();
             this.layerName = "englishSemantics";

package/dist/Layer/EnglishSemanticLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"EnglishSemanticLayer.js","sourceRoot":"","sources":["../../source/Layer/EnglishSemanticLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uDAAkD;IAElD,MAAa,oBAAqB,SAAQ,iCAAuB;QAE7D,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAA;YACnC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;KACJ;IAPD,oDAOC"}
+{"version":3,"file":"EnglishSemanticLayer.js","sourceRoot":"","sources":["../../source/Layer/EnglishSemanticLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uDAAkD;IAElD,MAAa,oBAAqB,SAAQ,iCAAuB;QAE7D;;;;WAIG;QACH,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAA;YACnC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;KACJ;IAZD,oDAYC"}

package/dist/Layer/EnglishWordLayer.d.ts

@@ -1,4 +1,8 @@
 import { SourceLanguageWordLayer } from "./SourceLanguageWordLayer";
 export declare class EnglishWordLayer extends SourceLanguageWordLayer {
+    /**
+     * Constructor for the word layer for English language. Sets the surface form.
+     * @param layerValue Value for the word layer.
+     */
     constructor(layerValue: string);
 }

package/dist/Layer/EnglishWordLayer.js

@@ -12,6 +12,10 @@
     exports.EnglishWordLayer = void 0;
     const SourceLanguageWordLayer_1 = require("./SourceLanguageWordLayer");
     class EnglishWordLayer extends SourceLanguageWordLayer_1.SourceLanguageWordLayer {
+        /**
+         * Constructor for the word layer for English language. Sets the surface form.
+         * @param layerValue Value for the word layer.
+         */
         constructor(layerValue) {
             super(layerValue);
             this.layerName = "english";

package/dist/Layer/EnglishWordLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"EnglishWordLayer.js","sourceRoot":"","sources":["../../source/Layer/EnglishWordLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uEAAkE;IAElE,MAAa,gBAAiB,SAAQ,iDAAuB;QAEzD,YAAY,UAAkB;YAC1B,KAAK,CAAC,UAAU,CAAC,CAAC;YAClB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC9B,CAAC;KACJ;IAND,4CAMC"}
+{"version":3,"file":"EnglishWordLayer.js","sourceRoot":"","sources":["../../source/Layer/EnglishWordLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uEAAkE;IAElE,MAAa,gBAAiB,SAAQ,iDAAuB;QAEzD;;;WAGG;QACH,YAAY,UAAkB;YAC1B,KAAK,CAAC,UAAU,CAAC,CAAC;YAClB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC9B,CAAC;KACJ;IAVD,4CAUC"}

package/dist/Layer/MetaMorphemeLayer.d.ts

@@ -1,8 +1,27 @@
 import { MetaMorphemesMovedLayer } from "./MetaMorphemesMovedLayer";
 import { MetamorphicParse } from "nlptoolkit-morphologicalanalysis/dist/MorphologicalAnalysis/MetamorphicParse";
 export declare class MetaMorphemeLayer extends MetaMorphemesMovedLayer {
+    /**
+     * Constructor for the metamorpheme layer. Sets the metamorpheme information for multiple words in the node.
+     * @param layerValue Layer value for the metamorpheme information. Consists of metamorpheme information of multiple
+     *                   words separated via space character.
+     */
     constructor(layerValue: string);
+    /**
+     * Sets the layer value to the string form of the given parse.
+     * @param parse New metamorphic parse.
+     */
     setLayerValue(parse: any): void;
+    /**
+     * Constructs metamorpheme information starting from the position index.
+     * @param index Position of the morpheme to start.
+     * @return Metamorpheme information starting from the position index.
+     */
     getLayerInfoFrom(index: number): string;
+    /**
+     * Removes metamorphemes from the given index. Index shows the position of the metamorpheme in the metamorphemes list.
+     * @param index Position of the metamorpheme from which the other metamorphemes will be removed.
+     * @return New metamorphic parse not containing the removed parts.
+     */
     metaMorphemeRemoveFromIndex(index: number): MetamorphicParse;
 }

package/dist/Layer/MetaMorphemeLayer.js

@@ -14,10 +14,19 @@
     const MetamorphicParse_1 = require("nlptoolkit-morphologicalanalysis/dist/MorphologicalAnalysis/MetamorphicParse");
     const ViewLayerType_1 = require("nlptoolkit-annotatedsentence/dist/ViewLayerType");
     class MetaMorphemeLayer extends MetaMorphemesMovedLayer_1.MetaMorphemesMovedLayer {
+        /**
+         * Constructor for the metamorpheme layer. Sets the metamorpheme information for multiple words in the node.
+         * @param layerValue Layer value for the metamorpheme information. Consists of metamorpheme information of multiple
+         *                   words separated via space character.
+         */
         constructor(layerValue) {
             super(layerValue);
             this.layerName = "metaMorphemes";
         }
+        /**
+         * Sets the layer value to the string form of the given parse.
+         * @param parse New metamorphic parse.
+         */
         setLayerValue(parse) {
             this.layerValue = parse.toString();
             this.items = new Array();
@@ -28,6 +37,11 @@
                 }
             }
         }
+        /**
+         * Constructs metamorpheme information starting from the position index.
+         * @param index Position of the morpheme to start.
+         * @return Metamorpheme information starting from the position index.
+         */
         getLayerInfoFrom(index) {
             let size = 0;
             for (let parse of this.items) {
@@ -44,6 +58,11 @@
             }
             return null;
         }
+        /**
+         * Removes metamorphemes from the given index. Index shows the position of the metamorpheme in the metamorphemes list.
+         * @param index Position of the metamorpheme from which the other metamorphemes will be removed.
+         * @return New metamorphic parse not containing the removed parts.
+         */
         metaMorphemeRemoveFromIndex(index) {
             if (index >= 0 && index < this.getLayerSize(ViewLayerType_1.ViewLayerType.META_MORPHEME)) {
                 let size = 0;

package/dist/Layer/MetaMorphemeLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"MetaMorphemeLayer.js","sourceRoot":"","sources":["../../source/Layer/MetaMorphemeLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uEAAkE;IAClE,mHAA8G;IAC9G,mFAA8E;IAE9E,MAAa,iBAAkB,SAAQ,iDAAuB;QAE1D,YAAY,UAAkB;YAC1B,KAAK,CAAC,UAAU,CAAC,CAAC;YAClB,IAAI,CAAC,SAAS,GAAG,eAAe,CAAA;QACpC,CAAC;QAED,aAAa,CAAC,KAAU;YACpB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAoB,CAAC;YAC3C,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAAC;gBACxB,IAAI,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAC9C,KAAK,IAAI,IAAI,IAAI,UAAU,EAAC;oBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC/C;aACJ;QACL,CAAC;QAED,gBAAgB,CAAC,KAAa;YAC1B,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;gBACzB,IAAI,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,EAAC;oBAC5B,IAAI,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;oBACjD,KAAK,EAAE,CAAC;oBACR,OAAO,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,EAAC;wBAC/B,MAAM,GAAG,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,eAAe,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;wBAC5D,KAAK,EAAE,CAAC;qBACX;oBACD,OAAO,MAAM,CAAC;iBACjB;gBACD,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACxB;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,2BAA2B,CAAC,KAAa;YACrC,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,6BAAa,CAAC,aAAa,CAAC,EAAC;gBACrE,IAAI,IAAI,GAAG,CAAC,CAAC;gBACb,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;oBACzB,IAAI,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,EAAC;wBAC5B,KAAK,CAAC,2BAA2B,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;wBAChD,OAAO,KAAK,CAAC;qBAChB;oBACD,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;iBACxB;aACJ;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;KACJ;IAhDD,8CAgDC"}
+{"version":3,"file":"MetaMorphemeLayer.js","sourceRoot":"","sources":["../../source/Layer/MetaMorphemeLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uEAAkE;IAClE,mHAA8G;IAC9G,mFAA8E;IAE9E,MAAa,iBAAkB,SAAQ,iDAAuB;QAE1D;;;;WAIG;QACH,YAAY,UAAkB;YAC1B,KAAK,CAAC,UAAU,CAAC,CAAC;YAClB,IAAI,CAAC,SAAS,GAAG,eAAe,CAAA;QACpC,CAAC;QAED;;;WAGG;QACH,aAAa,CAAC,KAAU;YACpB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAoB,CAAC;YAC3C,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAAC;gBACxB,IAAI,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAC9C,KAAK,IAAI,IAAI,IAAI,UAAU,EAAC;oBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC/C;aACJ;QACL,CAAC;QAED;;;;WAIG;QACH,gBAAgB,CAAC,KAAa;YAC1B,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;gBACzB,IAAI,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,EAAC;oBAC5B,IAAI,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;oBACjD,KAAK,EAAE,CAAC;oBACR,OAAO,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,EAAC;wBAC/B,MAAM,GAAG,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,eAAe,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;wBAC5D,KAAK,EAAE,CAAC;qBACX;oBACD,OAAO,MAAM,CAAC;iBACjB;gBACD,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACxB;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED;;;;WAIG;QACH,2BAA2B,CAAC,KAAa;YACrC,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,6BAAa,CAAC,aAAa,CAAC,EAAC;gBACrE,IAAI,IAAI,GAAG,CAAC,CAAC;gBACb,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;oBACzB,IAAI,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,EAAC;wBAC5B,KAAK,CAAC,2BAA2B,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;wBAChD,OAAO,KAAK,CAAC;qBAChB;oBACD,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;iBACxB;aACJ;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;KACJ;IAnED,8CAmEC"}

package/dist/Layer/MetaMorphemesMovedLayer.d.ts

@@ -2,8 +2,28 @@ import { MultiWordMultiItemLayer } from "./MultiWordMultiItemLayer";
 import { MetamorphicParse } from "nlptoolkit-morphologicalanalysis/dist/MorphologicalAnalysis/MetamorphicParse";
 import { ViewLayerType } from "nlptoolkit-annotatedsentence/dist/ViewLayerType";
 export declare class MetaMorphemesMovedLayer extends MultiWordMultiItemLayer<MetamorphicParse> {
+    /**
+     * Constructor for the metaMorphemesMoved layer. Sets the metamorpheme information for multiple words in the node.
+     * @param layerValue Layer value for the metaMorphemesMoved information. Consists of metamorpheme information of
+     *                   multiple words separated via space character.
+     */
     constructor(layerValue: string);
+    /**
+     * Returns the metamorpheme at position index in the metamorpheme list.
+     * @param viewLayer Not used.
+     * @param index Position in the metamorpheme list.
+     * @return The metamorpheme at position index in the metamorpheme list.
+     */
     getLayerInfoAt(viewLayer: ViewLayerType, index: number): string;
+    /**
+     * Returns the total number of metamorphemes in the words in the node.
+     * @param viewLayer Not used.
+     * @return Total number of metamorphemes in the words in the node.
+     */
     getLayerSize(viewLayer: ViewLayerType): number;
+    /**
+     * Sets the layer value to the string form of the given parse.
+     * @param layerValue New metamorphic parse.
+     */
     setLayerValue(layerValue: string): void;
 }

package/dist/Layer/MetaMorphemesMovedLayer.js

@@ -13,11 +13,22 @@
     const MultiWordMultiItemLayer_1 = require("./MultiWordMultiItemLayer");
     const MetamorphicParse_1 = require("nlptoolkit-morphologicalanalysis/dist/MorphologicalAnalysis/MetamorphicParse");
     class MetaMorphemesMovedLayer extends MultiWordMultiItemLayer_1.MultiWordMultiItemLayer {
+        /**
+         * Constructor for the metaMorphemesMoved layer. Sets the metamorpheme information for multiple words in the node.
+         * @param layerValue Layer value for the metaMorphemesMoved information. Consists of metamorpheme information of
+         *                   multiple words separated via space character.
+         */
         constructor(layerValue) {
             super();
             this.layerName = "metaMorphemesMoved";
             this.setLayerValue(layerValue);
         }
+        /**
+         * Returns the metamorpheme at position index in the metamorpheme list.
+         * @param viewLayer Not used.
+         * @param index Position in the metamorpheme list.
+         * @return The metamorpheme at position index in the metamorpheme list.
+         */
         getLayerInfoAt(viewLayer, index) {
             let size = 0;
             for (let parse of this.items) {
@@ -28,6 +39,11 @@
             }
             return null;
         }
+        /**
+         * Returns the total number of metamorphemes in the words in the node.
+         * @param viewLayer Not used.
+         * @return Total number of metamorphemes in the words in the node.
+         */
         getLayerSize(viewLayer) {
             let size = 0;
             for (let parse of this.items) {
@@ -35,6 +51,10 @@
             }
             return size;
         }
+        /**
+         * Sets the layer value to the string form of the given parse.
+         * @param layerValue New metamorphic parse.
+         */
         setLayerValue(layerValue) {
             this.items = new Array();
             this.layerValue = layerValue;

package/dist/Layer/MetaMorphemesMovedLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"MetaMorphemesMovedLayer.js","sourceRoot":"","sources":["../../source/Layer/MetaMorphemesMovedLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uEAAkE;IAClE,mHAA8G;IAG9G,MAAa,uBAAwB,SAAQ,iDAAyC;QAElF,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,oBAAoB,CAAA;YACrC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,cAAc,CAAC,SAAwB,EAAE,KAAa;YAClD,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;gBACzB,IAAI,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,EAAC;oBAC5B,OAAO,KAAK,CAAC,eAAe,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;iBAC9C;gBACD,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACxB;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,YAAY,CAAC,SAAwB;YACjC,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;gBACzB,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACxB;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,aAAa,CAAC,UAAkB;YAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAoB,CAAC;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,UAAU,IAAI,IAAI,EAAC;gBACnB,IAAI,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACzC,KAAK,IAAI,IAAI,IAAI,UAAU,EAAC;oBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC/C;aACJ;QACL,CAAC;KAEJ;IAtCD,0DAsCC"}
+{"version":3,"file":"MetaMorphemesMovedLayer.js","sourceRoot":"","sources":["../../source/Layer/MetaMorphemesMovedLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uEAAkE;IAClE,mHAA8G;IAG9G,MAAa,uBAAwB,SAAQ,iDAAyC;QAElF;;;;WAIG;QACH,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,oBAAoB,CAAA;YACrC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED;;;;;WAKG;QACH,cAAc,CAAC,SAAwB,EAAE,KAAa;YAClD,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;gBACzB,IAAI,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,EAAC;oBAC5B,OAAO,KAAK,CAAC,eAAe,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;iBAC9C;gBACD,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACxB;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED;;;;WAIG;QACH,YAAY,CAAC,SAAwB;YACjC,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;gBACzB,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACxB;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED;;;WAGG;QACH,aAAa,CAAC,UAAkB;YAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAoB,CAAC;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,UAAU,IAAI,IAAI,EAAC;gBACnB,IAAI,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACzC,KAAK,IAAI,IAAI,IAAI,UAAU,EAAC;oBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC/C;aACJ;QACL,CAAC;KAEJ;IA1DD,0DA0DC"}

package/dist/Layer/MorphologicalAnalysisLayer.d.ts

@@ -2,10 +2,42 @@ import { MultiWordMultiItemLayer } from "./MultiWordMultiItemLayer";
 import { MorphologicalParse } from "nlptoolkit-morphologicalanalysis/dist/MorphologicalAnalysis/MorphologicalParse";
 import { ViewLayerType } from "nlptoolkit-annotatedsentence/dist/ViewLayerType";
 export declare class MorphologicalAnalysisLayer extends MultiWordMultiItemLayer<MorphologicalParse> {
+    /**
+     * Constructor for the morphological analysis layer. Sets the morphological parse information for multiple words in
+     * the node.
+     * @param layerValue Layer value for the morphological parse information. Consists of morphological parse information
+     *                   of multiple words separated via space character.
+     */
     constructor(layerValue: string);
+    /**
+     * Returns the morphological tag (for PART_OF_SPEECH) or inflectional group (for INFLECTIONAL_GROUP) at position
+     * index.
+     * @param viewLayer Layer type.
+     * @param index Position of the morphological tag (for PART_OF_SPEECH) or inflectional group (for INFLECTIONAL_GROUP)
+     * @return The morphological tag (for PART_OF_SPEECH) or inflectional group (for INFLECTIONAL_GROUP)
+     */
     getLayerInfoAt(viewLayer: ViewLayerType, index: number): string;
+    /**
+     * Returns the total number of morphological tags (for PART_OF_SPEECH) or inflectional groups
+     * (for INFLECTIONAL_GROUP) in the words in the node.
+     * @param viewLayer Layer type.
+     * @return Total number of morphological tags (for PART_OF_SPEECH) or inflectional groups (for INFLECTIONAL_GROUP)
+     * in the words in the node.
+     */
     getLayerSize(viewLayer: ViewLayerType): number;
+    /**
+     * Sets the layer value to the string form of the given morphological parse.
+     * @param layerValue New morphological parse.
+     */
     setLayerValue(layerValue: any): void;
+    /**
+     * Checks if the last inflectional group contains VERB tag.
+     * @return True if the last inflectional group contains VERB tag, false otherwise.
+     */
     isVerbal(): boolean;
+    /**
+     * Checks if the last verbal inflectional group contains ZERO tag.
+     * @return True if the last verbal inflectional group contains ZERO tag, false otherwise.
+     */
     isNominal(): boolean;
 }

package/dist/Layer/MorphologicalAnalysisLayer.js

@@ -14,11 +14,24 @@
     const MorphologicalParse_1 = require("nlptoolkit-morphologicalanalysis/dist/MorphologicalAnalysis/MorphologicalParse");
     const ViewLayerType_1 = require("nlptoolkit-annotatedsentence/dist/ViewLayerType");
     class MorphologicalAnalysisLayer extends MultiWordMultiItemLayer_1.MultiWordMultiItemLayer {
+        /**
+         * Constructor for the morphological analysis layer. Sets the morphological parse information for multiple words in
+         * the node.
+         * @param layerValue Layer value for the morphological parse information. Consists of morphological parse information
+         *                   of multiple words separated via space character.
+         */
         constructor(layerValue) {
             super();
             this.layerName = "morphologicalAnalysis";
             this.setLayerValue(layerValue);
         }
+        /**
+         * Returns the morphological tag (for PART_OF_SPEECH) or inflectional group (for INFLECTIONAL_GROUP) at position
+         * index.
+         * @param viewLayer Layer type.
+         * @param index Position of the morphological tag (for PART_OF_SPEECH) or inflectional group (for INFLECTIONAL_GROUP)
+         * @return The morphological tag (for PART_OF_SPEECH) or inflectional group (for INFLECTIONAL_GROUP)
+         */
         getLayerInfoAt(viewLayer, index) {
             let size;
             switch (viewLayer) {
@@ -43,6 +56,13 @@
             }
             return null;
         }
+        /**
+         * Returns the total number of morphological tags (for PART_OF_SPEECH) or inflectional groups
+         * (for INFLECTIONAL_GROUP) in the words in the node.
+         * @param viewLayer Layer type.
+         * @return Total number of morphological tags (for PART_OF_SPEECH) or inflectional groups (for INFLECTIONAL_GROUP)
+         * in the words in the node.
+         */
         getLayerSize(viewLayer) {
             let size;
             switch (viewLayer) {
@@ -62,6 +82,10 @@
                     return 0;
             }
         }
+        /**
+         * Sets the layer value to the string form of the given morphological parse.
+         * @param layerValue New morphological parse.
+         */
         setLayerValue(layerValue) {
             if (layerValue instanceof MorphologicalParse_1.MorphologicalParse) {
                 let parse = layerValue;
@@ -80,6 +104,10 @@
                 }
             }
         }
+        /**
+         * Checks if the last inflectional group contains VERB tag.
+         * @return True if the last inflectional group contains VERB tag, false otherwise.
+         */
         isVerbal() {
             let dbLabel = "^DB+";
             let needle = "VERB+";
@@ -92,6 +120,10 @@
             }
             return haystack.includes(needle);
         }
+        /**
+         * Checks if the last verbal inflectional group contains ZERO tag.
+         * @return True if the last verbal inflectional group contains ZERO tag, false otherwise.
+         */
         isNominal() {
             let dbLabel = "^DB+VERB+";
             let needle = "ZERO+";

package/dist/Layer/MorphologicalAnalysisLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"MorphologicalAnalysisLayer.js","sourceRoot":"","sources":["../../source/Layer/MorphologicalAnalysisLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uEAAkE;IAClE,uHAAkH;IAClH,mFAA8E;IAE9E,MAAa,0BAA2B,SAAQ,iDAA2C;QAEvF,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,uBAAuB,CAAA;YACxC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,cAAc,CAAC,SAAwB,EAAE,KAAa;YAClD,IAAI,IAAI,CAAC;YACT,QAAQ,SAAS,EAAC;gBACd,KAAK,6BAAa,CAAC,cAAc;oBAC7B,IAAI,GAAG,CAAC,CAAC;oBACT,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;wBACzB,IAAI,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,EAAC;4BAC/B,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;yBACrC;wBACD,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;qBAC3B;oBACD,OAAO,IAAI,CAAC;gBAChB,KAAK,6BAAa,CAAC,kBAAkB;oBACjC,IAAI,GAAG,CAAC,CAAC;oBACT,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;wBACzB,IAAI,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,EAAC;4BAC5B,OAAO,KAAK,CAAC,0BAA0B,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;yBACzD;wBACD,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;qBACxB;oBACD,OAAO,IAAI,CAAC;aACnB;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,YAAY,CAAC,SAAwB;YACjC,IAAI,IAAI,CAAA;YACR,QAAQ,SAAS,EAAC;gBACd,KAAK,6BAAa,CAAC,cAAc;oBAC7B,IAAI,GAAG,CAAC,CAAC;oBACT,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;wBACzB,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;qBAC3B;oBACD,OAAO,IAAI,CAAC;gBAChB,KAAK,6BAAa,CAAC,kBAAkB;oBACjC,IAAI,GAAG,CAAC,CAAC;oBACT,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;wBACzB,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;qBACxB;oBACD,OAAO,IAAI,CAAC;gBAChB;oBACI,OAAO,CAAC,CAAC;aAChB;QACL,CAAC;QAED,aAAa,CAAC,UAAe;YACzB,IAAI,UAAU,YAAY,uCAAkB,EAAC;gBACzC,IAAI,KAAK,GAAG,UAAU,CAAA;gBACtB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,mCAAmC,EAAE,CAAC;gBAC9D,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAsB,CAAC;gBAC7C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAC1B;iBAAM;gBACH,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAsB,CAAC;gBAC7C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;gBAC7B,IAAI,UAAU,IAAI,IAAI,EAAC;oBACnB,IAAI,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oBACzC,KAAK,IAAI,IAAI,IAAI,UAAU,EAAC;wBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,uCAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;qBACjD;iBACJ;aACJ;QACL,CAAC;QAED,QAAQ;YACJ,IAAI,OAAO,GAAG,MAAM,CAAC;YACrB,IAAI,MAAM,GAAG,OAAO,CAAC;YACrB,IAAI,QAAQ,CAAA;YACZ,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAC;gBAClC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;aAClF;iBAAM;gBACH,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC;aAC9B;YACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QAED,SAAS;YACL,IAAI,OAAO,GAAG,WAAW,CAAC;YAC1B,IAAI,MAAM,GAAG,OAAO,CAAC;YACrB,IAAI,QAAQ,CAAA;YACZ,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAC;gBAClC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;aAClF;iBAAM;gBACH,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC;aAC9B;YACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;KAEJ;IA/FD,gEA+FC"}
+{"version":3,"file":"MorphologicalAnalysisLayer.js","sourceRoot":"","sources":["../../source/Layer/MorphologicalAnalysisLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uEAAkE;IAClE,uHAAkH;IAClH,mFAA8E;IAE9E,MAAa,0BAA2B,SAAQ,iDAA2C;QAEvF;;;;;WAKG;QACH,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,uBAAuB,CAAA;YACxC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED;;;;;;WAMG;QACH,cAAc,CAAC,SAAwB,EAAE,KAAa;YAClD,IAAI,IAAI,CAAC;YACT,QAAQ,SAAS,EAAC;gBACd,KAAK,6BAAa,CAAC,cAAc;oBAC7B,IAAI,GAAG,CAAC,CAAC;oBACT,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;wBACzB,IAAI,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,EAAC;4BAC/B,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;yBACrC;wBACD,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;qBAC3B;oBACD,OAAO,IAAI,CAAC;gBAChB,KAAK,6BAAa,CAAC,kBAAkB;oBACjC,IAAI,GAAG,CAAC,CAAC;oBACT,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;wBACzB,IAAI,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,EAAC;4BAC5B,OAAO,KAAK,CAAC,0BAA0B,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;yBACzD;wBACD,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;qBACxB;oBACD,OAAO,IAAI,CAAC;aACnB;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED;;;;;;WAMG;QACH,YAAY,CAAC,SAAwB;YACjC,IAAI,IAAI,CAAA;YACR,QAAQ,SAAS,EAAC;gBACd,KAAK,6BAAa,CAAC,cAAc;oBAC7B,IAAI,GAAG,CAAC,CAAC;oBACT,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;wBACzB,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;qBAC3B;oBACD,OAAO,IAAI,CAAC;gBAChB,KAAK,6BAAa,CAAC,kBAAkB;oBACjC,IAAI,GAAG,CAAC,CAAC;oBACT,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAC;wBACzB,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;qBACxB;oBACD,OAAO,IAAI,CAAC;gBAChB;oBACI,OAAO,CAAC,CAAC;aAChB;QACL,CAAC;QAED;;;WAGG;QACH,aAAa,CAAC,UAAe;YACzB,IAAI,UAAU,YAAY,uCAAkB,EAAC;gBACzC,IAAI,KAAK,GAAG,UAAU,CAAA;gBACtB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,mCAAmC,EAAE,CAAC;gBAC9D,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAsB,CAAC;gBAC7C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAC1B;iBAAM;gBACH,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAsB,CAAC;gBAC7C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;gBAC7B,IAAI,UAAU,IAAI,IAAI,EAAC;oBACnB,IAAI,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oBACzC,KAAK,IAAI,IAAI,IAAI,UAAU,EAAC;wBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,uCAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;qBACjD;iBACJ;aACJ;QACL,CAAC;QAED;;;WAGG;QACH,QAAQ;YACJ,IAAI,OAAO,GAAG,MAAM,CAAC;YACrB,IAAI,MAAM,GAAG,OAAO,CAAC;YACrB,IAAI,QAAQ,CAAA;YACZ,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAC;gBAClC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;aAClF;iBAAM;gBACH,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC;aAC9B;YACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QAED;;;WAGG;QACH,SAAS;YACL,IAAI,OAAO,GAAG,WAAW,CAAC;YAC1B,IAAI,MAAM,GAAG,OAAO,CAAC;YACrB,IAAI,QAAQ,CAAA;YACZ,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAC;gBAClC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;aAClF;iBAAM;gBACH,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC;aAC9B;YACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;KAEJ;IA/HD,gEA+HC"}

package/dist/Layer/MultiWordLayer.d.ts

@@ -1,7 +1,16 @@
 import { WordLayer } from "./WordLayer";
 export declare abstract class MultiWordLayer<T> extends WordLayer {
     protected items: Array<T>;
+    /**
+     * Returns the item (word or its property) at position index.
+     * @param index Position of the item (word or its property).
+     * @return The item at position index.
+     */
     getItemAt(index: number): T;
+    /**
+     * Returns number of items (words) in the items array list.
+     * @return Number of items (words) in the items array list.
+     */
     size(): number;
     abstract setLayerValue(layerValue: string): void;
 }

package/dist/Layer/MultiWordLayer.js

@@ -16,6 +16,11 @@
             super(...arguments);
             this.items = new Array();
         }
+        /**
+         * Returns the item (word or its property) at position index.
+         * @param index Position of the item (word or its property).
+         * @return The item at position index.
+         */
         getItemAt(index) {
             if (index < this.items.length) {
                 return this.items[index];
@@ -24,6 +29,10 @@
                 return undefined;
             }
         }
+        /**
+         * Returns number of items (words) in the items array list.
+         * @return Number of items (words) in the items array list.
+         */
         size() {
             return this.items.length;
         }

package/dist/Layer/MultiWordLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"MultiWordLayer.js","sourceRoot":"","sources":["../../source/Layer/MultiWordLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,2CAAsC;IAEtC,MAAsB,cAAkB,SAAQ,qBAAS;QAAzD;;YAEc,UAAK,GAAa,IAAI,KAAK,EAAK,CAAA;QAe9C,CAAC;QAbG,SAAS,CAAC,KAAa;YACnB,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAC;gBAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aAC5B;iBAAM;gBACH,OAAO,SAAS,CAAC;aACpB;QACL,CAAC;QAED,IAAI;YACA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;QAC5B,CAAC;KAGJ;IAjBD,wCAiBC"}
+{"version":3,"file":"MultiWordLayer.js","sourceRoot":"","sources":["../../source/Layer/MultiWordLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,2CAAsC;IAEtC,MAAsB,cAAkB,SAAQ,qBAAS;QAAzD;;YAEc,UAAK,GAAa,IAAI,KAAK,EAAK,CAAA;QAwB9C,CAAC;QAtBG;;;;WAIG;QACH,SAAS,CAAC,KAAa;YACnB,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAC;gBAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aAC5B;iBAAM;gBACH,OAAO,SAAS,CAAC;aACpB;QACL,CAAC;QAED;;;WAGG;QACH,IAAI;YACA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;QAC5B,CAAC;KAGJ;IA1BD,wCA0BC"}

package/dist/Layer/NERLayer.d.ts

@@ -2,7 +2,21 @@ import { SingleWordLayer } from "./SingleWordLayer";
 import { NamedEntityType } from "nlptoolkit-namedentityrecognition/dist/NamedEntityType";
 export declare class NERLayer extends SingleWordLayer<NamedEntityType> {
     private namedEntity;
+    /**
+     * Constructor for the named entity layer. Sets single named entity information for multiple words in
+     * the node.
+     * @param layerValue Layer value for the named entity information. Consists of single named entity information
+     *                   of multiple words.
+     */
     constructor(layerValue: string);
+    /**
+     * Sets the layer value for Named Entity layer. Converts the string form to a named entity.
+     * @param layerValue New value for Named Entity layer.
+     */
     setLayerValue(layerValue: string): void;
+    /**
+     * Get the string form of the named entity value. Converts named entity type to string form.
+     * @return String form of the named entity value.
+     */
     getLayerValue(): string;
 }

package/dist/Layer/NERLayer.js

@@ -13,16 +13,30 @@
     const SingleWordLayer_1 = require("./SingleWordLayer");
     const NamedEntityTypeStatic_1 = require("nlptoolkit-namedentityrecognition/dist/NamedEntityTypeStatic");
     class NERLayer extends SingleWordLayer_1.SingleWordLayer {
+        /**
+         * Constructor for the named entity layer. Sets single named entity information for multiple words in
+         * the node.
+         * @param layerValue Layer value for the named entity information. Consists of single named entity information
+         *                   of multiple words.
+         */
         constructor(layerValue) {
             super();
             this.namedEntity = null;
             this.layerName = "namedEntity";
             this.setLayerValue(layerValue);
         }
+        /**
+         * Sets the layer value for Named Entity layer. Converts the string form to a named entity.
+         * @param layerValue New value for Named Entity layer.
+         */
         setLayerValue(layerValue) {
             this.layerValue = layerValue;
             this.namedEntity = NamedEntityTypeStatic_1.NamedEntityTypeStatic.getNamedEntityType(layerValue);
         }
+        /**
+         * Get the string form of the named entity value. Converts named entity type to string form.
+         * @return String form of the named entity value.
+         */
         getLayerValue() {
             return NamedEntityTypeStatic_1.NamedEntityTypeStatic.getNamedEntity(this.namedEntity);
         }

package/dist/Layer/NERLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"NERLayer.js","sourceRoot":"","sources":["../../source/Layer/NERLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uDAAkD;IAElD,wGAAmG;IAEnG,MAAa,QAAS,SAAQ,iCAAgC;QAI1D,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YAHJ,gBAAW,GAAoB,IAAI,CAAA;YAIvC,IAAI,CAAC,SAAS,GAAG,aAAa,CAAA;YAC9B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,aAAa,CAAC,UAAkB;YAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;YAC5B,IAAI,CAAC,WAAW,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAA;QAC3E,CAAC;QAED,aAAa;YACT,OAAO,6CAAqB,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACjE,CAAC;KACJ;IAlBD,4BAkBC"}
+{"version":3,"file":"NERLayer.js","sourceRoot":"","sources":["../../source/Layer/NERLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uDAAkD;IAElD,wGAAmG;IAEnG,MAAa,QAAS,SAAQ,iCAAgC;QAI1D;;;;;WAKG;QACH,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YATJ,gBAAW,GAAoB,IAAI,CAAA;YAUvC,IAAI,CAAC,SAAS,GAAG,aAAa,CAAA;YAC9B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED;;;WAGG;QACH,aAAa,CAAC,UAAkB;YAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;YAC5B,IAAI,CAAC,WAAW,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAA;QAC3E,CAAC;QAED;;;WAGG;QACH,aAAa;YACT,OAAO,6CAAqB,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACjE,CAAC;KACJ;IAhCD,4BAgCC"}

package/dist/Layer/PersianWordLayer.d.ts

@@ -1,4 +1,8 @@
 import { TargetLanguageWordLayer } from "./TargetLanguageWordLayer";
 export declare class PersianWordLayer extends TargetLanguageWordLayer {
+    /**
+     * Constructor for the word layer for Persian language. Sets the surface form.
+     * @param layerValue Value for the word layer.
+     */
     constructor(layerValue: string);
 }

package/dist/Layer/PersianWordLayer.js

@@ -12,6 +12,10 @@
     exports.PersianWordLayer = void 0;
     const TargetLanguageWordLayer_1 = require("./TargetLanguageWordLayer");
     class PersianWordLayer extends TargetLanguageWordLayer_1.TargetLanguageWordLayer {
+        /**
+         * Constructor for the word layer for Persian language. Sets the surface form.
+         * @param layerValue Value for the word layer.
+         */
         constructor(layerValue) {
             super(layerValue);
             this.layerName = "persian";

package/dist/Layer/PersianWordLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"PersianWordLayer.js","sourceRoot":"","sources":["../../source/Layer/PersianWordLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uEAAkE;IAElE,MAAa,gBAAiB,SAAQ,iDAAuB;QAEzD,YAAY,UAAkB;YAC1B,KAAK,CAAC,UAAU,CAAC,CAAC;YAClB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC9B,CAAC;KACJ;IAND,4CAMC"}
+{"version":3,"file":"PersianWordLayer.js","sourceRoot":"","sources":["../../source/Layer/PersianWordLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uEAAkE;IAElE,MAAa,gBAAiB,SAAQ,iDAAuB;QAEzD;;;WAGG;QACH,YAAY,UAAkB;YAC1B,KAAK,CAAC,UAAU,CAAC,CAAC;YAClB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC9B,CAAC;KACJ;IAVD,4CAUC"}

package/dist/Layer/ShallowParseLayer.d.ts

@@ -1,5 +1,16 @@
 import { MultiWordLayer } from "./MultiWordLayer";
 export declare class ShallowParseLayer extends MultiWordLayer<string> {
+    /**
+     * Constructor for the shallow parse layer. Sets shallow parse information for each word in
+     * the node.
+     * @param layerValue Layer value for the shallow parse information. Consists of shallow parse information
+     *                   for every word.
+     */
     constructor(layerValue: string);
+    /**
+     * Sets the value for the shallow parse layer in a node. Value may consist of multiple shallow parse information
+     * separated via space character. Each shallow parse value is a string.
+     * @param layerValue New layer info
+     */
     setLayerValue(layerValue: string): void;
 }

package/dist/Layer/ShallowParseLayer.js

@@ -12,11 +12,22 @@
     exports.ShallowParseLayer = void 0;
     const MultiWordLayer_1 = require("./MultiWordLayer");
     class ShallowParseLayer extends MultiWordLayer_1.MultiWordLayer {
+        /**
+         * Constructor for the shallow parse layer. Sets shallow parse information for each word in
+         * the node.
+         * @param layerValue Layer value for the shallow parse information. Consists of shallow parse information
+         *                   for every word.
+         */
         constructor(layerValue) {
             super();
             this.layerName = "shallowParse";
             this.setLayerValue(layerValue);
         }
+        /**
+         * Sets the value for the shallow parse layer in a node. Value may consist of multiple shallow parse information
+         * separated via space character. Each shallow parse value is a string.
+         * @param layerValue New layer info
+         */
         setLayerValue(layerValue) {
             this.items = new Array();
             this.layerValue = layerValue;

package/dist/Layer/ShallowParseLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"ShallowParseLayer.js","sourceRoot":"","sources":["../../source/Layer/ShallowParseLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,qDAAgD;IAEhD,MAAa,iBAAkB,SAAQ,+BAAsB;QAEzD,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,cAAc,CAAA;YAC/B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,aAAa,CAAC,UAAkB;YAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAU,CAAC;YACjC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,UAAU,IAAI,IAAI,EAAC;gBACnB,IAAI,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACvC,KAAK,IAAI,IAAI,IAAI,UAAU,EAAC;oBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;iBACxB;aACJ;QACL,CAAC;KAEJ;IAnBD,8CAmBC"}
+{"version":3,"file":"ShallowParseLayer.js","sourceRoot":"","sources":["../../source/Layer/ShallowParseLayer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,qDAAgD;IAEhD,MAAa,iBAAkB,SAAQ,+BAAsB;QAEzD;;;;;WAKG;QACH,YAAY,UAAkB;YAC1B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,SAAS,GAAG,cAAc,CAAA;YAC/B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED;;;;WAIG;QACH,aAAa,CAAC,UAAkB;YAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAU,CAAC;YACjC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,UAAU,IAAI,IAAI,EAAC;gBACnB,IAAI,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACvC,KAAK,IAAI,IAAI,IAAI,UAAU,EAAC;oBACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;iBACxB;aACJ;QACL,CAAC;KAEJ;IA9BD,8CA8BC"}