File2Pipe {bdpar}

Class to obtain the source field of an Instance

Description

Obtains the source using the method which implements the subclass of Instance.

Note

File2Pipe will automatically invalidate the Instance whenever the obtained source is empty or not in UTF-8 format.

Inherit

This class inherits from GenericPipe and implements the pipe abstract function.

Super class

bdpar::GenericPipe -> File2Pipe

Methods

Public methods

• File2Pipe$new()

• File2Pipe$pipe()

• File2Pipe$clone()

Inherited methods

• bdpar::GenericPipe$getAlwaysBeforeDeps()
• bdpar::GenericPipe$getNotAfterDeps()
• bdpar::GenericPipe$getPropertyName()
• bdpar::GenericPipe$hash()
• bdpar::GenericPipe$setAlwaysBeforeDeps()
• bdpar::GenericPipe$setNotAfterDeps()
• bdpar::GenericPipe$setPropertyName()

Method new()

Creates a File2Pipe object.

Usage

File2Pipe$new(
  propertyName = "source",
  alwaysBeforeDeps = list("TargetAssigningPipe"),
  notAfterDeps = list()
)

Arguments

propertyName

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

alwaysBeforeDeps

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

notAfterDeps

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

Method pipe()

Preprocesses the Instance to obtain the source.

Usage

File2Pipe$pipe(instance)

Arguments

instance

A Instance value. The Instance to preprocess.

Returns

The Instance with the modifications that have occurred in the pipe.

Method clone()

The objects of this class are cloneable with this method.

Usage

File2Pipe$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

AbbreviationPipe, ContractionPipe, FindEmojiPipe, FindEmoticonPipe, FindHashtagPipe, FindUrlPipe, FindUserNamePipe, GuessDatePipe, GuessLanguagePipe, Instance, InterjectionPipe, MeasureLengthPipe, GenericPipe, SlangPipe, StopWordPipe, StoreFileExtPipe, TargetAssigningPipe, TeeCSVPipe, ToLowerCasePipe