GenericPipe: Abstract super class that handles the management of the Pipes

In bdpar: Big Data Preprocessing Architecture

Abstract super class that handles the management of the Pipes

Description

Provides the required methods to successfully handle each GenericPipe class.

Methods

Public methods

• GenericPipe$new()

• GenericPipe$pipe()

• GenericPipe$getPropertyName()

• GenericPipe$getAlwaysBeforeDeps()

• GenericPipe$getNotAfterDeps()

• GenericPipe$setPropertyName()

• GenericPipe$setAlwaysBeforeDeps()

• GenericPipe$setNotAfterDeps()

• GenericPipe$hash()

• GenericPipe$clone()

---

Method new()

Creates a GenericPipe object.

Usage

GenericPipe$new(propertyName, alwaysBeforeDeps, notAfterDeps)

Arguments

propertyName

A character value. Name of the property associated with the Pipe.

alwaysBeforeDeps

A list value. The dependencies alwaysBefore (Pipes that must be executed before this one).

notAfterDeps

A list value. The dependencies notAfter (Pipes that cannot be executed after this one).

---

Method pipe()

Abstract method to preprocess the Instance.

Usage

GenericPipe$pipe(instance)

Arguments

instance

A Instance value. The Instance to preprocess.

Returns

The preprocessed Instance.

---

Method getPropertyName()

Gets of name of property.

Usage

GenericPipe$getPropertyName()

Returns

Value of name of property.

---

Method getAlwaysBeforeDeps()

Gets of the dependencies always before.

Usage

GenericPipe$getAlwaysBeforeDeps()

Returns

Value of dependencies always before.

---

Method getNotAfterDeps()

Gets of the dependencies not after.

Usage

GenericPipe$getNotAfterDeps()

Returns

Value of dependencies not after.

---

Method setPropertyName()

Changes the value of property's name.

Usage

GenericPipe$setPropertyName(propertyName)

Arguments

propertyName

A character value. The new value of the property's name.

---

Method setAlwaysBeforeDeps()

Changes the value of dependencies always before.

Usage

GenericPipe$setAlwaysBeforeDeps(alwaysBeforeDeps)

Arguments

alwaysBeforeDeps

A list value. The new value of the dependencies always before.

---

Method setNotAfterDeps()

Changes the value of dependencies not after.

Usage

GenericPipe$setNotAfterDeps(notAfterDeps)

Arguments

notAfterDeps

A list value. The new value of the dependencies not after.

---

Method hash()

Generates an identification of pipe based on its fields.

Usage

GenericPipe$hash(algo = "md5")

Arguments

algo

Algorithm to be applied. Options: "md5", "sha1", "crc32", "sha256", "sha512", "xxhash32", "xxhash64", "murmur32", "spookyhash

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GenericPipe$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

AbbreviationPipe, bdpar.log, ContractionPipe, File2Pipe, FindEmojiPipe, FindEmoticonPipe, FindHashtagPipe, FindUrlPipe, FindUserNamePipe, GuessDatePipe, GuessLanguagePipe, Instance, InterjectionPipe, MeasureLengthPipe, ResourceHandler, SlangPipe, StopWordPipe, StoreFileExtPipe, TargetAssigningPipe, TeeCSVPipe, ToLowerCasePipe

bdpar documentation built on Aug. 22, 2022, 5:08 p.m.