nlptoolkit-annotatedtree 1.0.3 → 1.0.5

package/source/Layer/MultiWordLayer.ts

@@ -4,6 +4,11 @@ export abstract class MultiWordLayer<T> extends WordLayer{
 
     protected items: Array<T> = new 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{
         if (index < this.items.length){
             return this.items[index];
@@ -12,6 +17,10 @@ export abstract class MultiWordLayer<T> extends WordLayer{
         }
     }
 
+    /**
+     * Returns number of items (words) in the items array list.
+     * @return Number of items (words) in the items array list.
+     */
     size(): number{
         return this.items.length
     }

package/source/Layer/NERLayer.ts

@@ -6,17 +6,31 @@ export class NERLayer extends SingleWordLayer<NamedEntityType>{
 
     private namedEntity: NamedEntityType = null
 
+    /**
+     * 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) {
         super();
         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: string) {
         this.layerValue = layerValue
         this.namedEntity = 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(): string {
         return NamedEntityTypeStatic.getNamedEntity(this.namedEntity)
     }

package/source/Layer/PersianWordLayer.ts

@@ -2,6 +2,10 @@ import {TargetLanguageWordLayer} from "./TargetLanguageWordLayer";
 
 export 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) {
         super(layerValue);
         this.layerName = "persian"

package/source/Layer/ShallowParseLayer.ts

@@ -2,12 +2,23 @@ import {MultiWordLayer} from "./MultiWordLayer";
 
 export 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) {
         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: string): void {
         this.items = new Array<string>();
         this.layerValue = layerValue;

package/source/Layer/SingleWordLayer.ts

@@ -2,6 +2,10 @@ import {WordLayer} from "./WordLayer";
 
 export abstract class SingleWordLayer<T> extends WordLayer{
 
+    /**
+     * Sets the property of the word
+     * @param layerValue Layer info
+     */
     setLayerValue(layerValue: string){
         this.layerValue = layerValue
     }

package/source/Layer/SourceLanguageWordLayer.ts

@@ -2,6 +2,10 @@ import {SingleWordLayer} from "./SingleWordLayer";
 
 export abstract class SourceLanguageWordLayer extends SingleWordLayer<string>{
 
+    /**
+     * Sets the name of the word
+     * @param layerValue Name of the word
+     */
     constructor(layerValue: string) {
         super();
         this.setLayerValue(layerValue)

package/source/Layer/TargetLanguageWordLayer.ts

@@ -3,11 +3,20 @@ import {ViewLayerType} from "nlptoolkit-annotatedsentence/dist/ViewLayerType";
 
 export abstract class TargetLanguageWordLayer extends MultiWordLayer<string>{
 
-    constructor(layerValue: string) {
+    /**
+     * Sets the surface form(s) of the word(s) possibly separated with space.
+     * @param layerValue Surface form(s) of the word(s) possibly separated with space.
+     */
+    protected constructor(layerValue: string) {
         super();
         this.setLayerValue(layerValue)
     }
 
+    /**
+     * Sets the surface form(s) of the word(s). Value may consist of multiple surface form(s)
+     * separated via space character.
+     * @param layerValue New layer info
+     */
     setLayerValue(layerValue: string) {
         this.items = new Array<string>();
         this.layerValue = layerValue;

package/source/Layer/TurkishPropbankLayer.ts

@@ -5,21 +5,39 @@ export class TurkishPropbankLayer extends SingleWordLayer<Argument>{
 
     private propbank: Argument = null
 
+    /**
+     * Constructor for the Turkish propbank layer. Sets single semantic role information for multiple words in
+     * the node.
+     * @param layerValue Layer value for the propbank information. Consists of semantic role information
+     *                   of multiple words.
+     */
     constructor(layerValue: string) {
         super();
         this.layerName = "propBank"
         this.setLayerValue(layerValue)
     }
 
+    /**
+     * Sets the layer value for Turkish propbank layer. Converts the string form to an Argument.
+     * @param layerValue New value for Turkish propbank layer.
+     */
     setLayerValue(layerValue: string) {
         this.layerValue = layerValue
         this.propbank = new Argument(layerValue)
     }
 
+    /**
+     * Accessor for the propbank field.
+     * @return Propbank field.
+     */
     getArgument(): Argument{
         return this.propbank
     }
 
+    /**
+     * Another accessor for the propbank field.
+     * @return String form of the propbank field.
+     */
     getLayerValue(): string {
         return this.propbank.getArgumentType() + "$" + this.propbank.getId()
     }

package/source/Layer/TurkishSemanticLayer.ts

@@ -2,12 +2,23 @@ import {MultiWordLayer} from "./MultiWordLayer";
 
 export class TurkishSemanticLayer extends MultiWordLayer<string>{
 
+    /**
+     * Constructor for the Turkish semantic layer. Sets semantic information for each word in
+     * the node.
+     * @param layerValue Layer value for the Turkish semantic information. Consists of semantic (Turkish synset id)
+     *                   information for every word.
+     */
     constructor(layerValue: string) {
         super();
         this.layerName = "semantics"
         this.setLayerValue(layerValue)
     }
 
+    /**
+     * Sets the value for the Turkish semantic layer in a node. Value may consist of multiple sense information
+     * separated via '$' character. Each sense value is a string representing the synset id of the sense.
+     * @param layerValue New layer info
+     */
     setLayerValue(layerValue: string): void {
         this.items = new Array<string>();
         this.layerValue = layerValue;

package/source/Layer/TurkishWordLayer.ts

@@ -2,6 +2,10 @@ import {TargetLanguageWordLayer} from "./TargetLanguageWordLayer";
 
 export class TurkishWordLayer extends TargetLanguageWordLayer{
 
+    /**
+     * Constructor for the word layer for Turkish language. Sets the surface form.
+     * @param layerValue Value for the word layer.
+     */
     constructor(layerValue: string) {
         super(layerValue);
         this.layerName = "turkish"

package/source/Layer/WordLayer.ts

@@ -3,14 +3,26 @@ export abstract class WordLayer {
     protected layerValue: string
     protected layerName: string
 
+    /**
+     * Accessor for the layerValue attribute.
+     * @return LayerValue attribute.
+     */
     getLayerValue(): string{
         return this.layerValue
     }
 
+    /**
+     * Accessor for the layerName attribute.
+     * @return LayerName attribute.
+     */
     getLayerName(): string{
         return this.layerName
     }
 
+    /**
+     * Returns string form of the word layer.
+     * @return String form of the word layer.
+     */
     getLayerDescription(): string{
         return "{" + this.layerName + "=" + this.layerValue + "}"
     }