Instance: Super class that handles the general functionalities of the...

In miferreiro/bdp4R: Big Data Preprocessing For R

Description

The tasks of the functions, that the Instance class has, are to handle the variables associated with an instance.

Usage

Instance$new(path)

Arguments

path	(character) Path of the file.

Format

An object of class R6ClassGenerator of length 24.

Details

Building...

Methods

• obtainDate Abstract function to obtain the date that has to be implemented by the classes that inherit from instance.

• obtainSource Abstract function to obtain the source that has to be implemented by the classes that inherit from instance.

• getDate Getter of date.

  • Usage

    getDate()

  • Value

    Value of date.

• setDate Setter of date.

  • Usage

    setDate(date)

  • Arguments

    • date (character) The new value of date.

• getSource Getter of source.

  • Usage

    getSource()

  • Value

    Value of source.

• setSource Setter of source.

  • Usage

    setSource(source)

  • Arguments

    • source (character) The new value of source.

• getPath Getter of path.

  • Usage

    getPath()

  • Value

    Value of path.

• getProperties Getter of properties.

  • Usage

    getProperties()

  • Value

    Value of properties.

• setProperties Setter of properties.

  • Usage

    setProperties(properties)

  • Arguments

    • properties (list) The new value of properties.

• addProperties Add a property to the list of properties.

  • Usage

    addProperties(propertyValue, propertyName)

  • Arguments

    • propertyValue () The value of the new property.

    • propertyName (character) The name of the new property.

• getSpecificProperty Obtains a specific property.

  • Usage

    getSpecificProperty(propertyName)

  • Value

    The value of the specific property.

  • Arguments

    • propertyName (character) The name of the property to obtain.

• isSpecificProperty Obtains if exists a specific property.

  • Usage

    isSpecificProperty(propertyName)

  • Value

    TRUE or FALSE depending on whether the property is on the list of properties.

  • Arguments

    • propertyName (character) The name of the property to check.

• setSpecificProperty Changes the value of the one property.

  • Usage

    setSpecificProperty(propertyName, propertyValue)

  • Arguments

    • propertyName () The new value of the property.

    • propertyValue (character) The name of the property.

• getNamesOfProperties Getter of the names of properties.

  • Usage

    getNamesOfProperties()

  • Value

    Value of the names of properties.

• isInstanceValid Obtains if the Instance is valid.

  • Usage

    isInstanceValid()

  • Value

    Value of isValid.

• invalidate Sets the instance in the invalid state.

  • Usage

    invalidate()

• getFlowPipes Get the pipe flow list.

  • Usage

    getNamesOfProperties()

  • Value

    Value of pipe flow list.

• addFlowPipes Added the name of the pipe to the list that keeps track of the flow of pipes that the instance has gone through.

  • Usage

    addFlowPipes(namePipe)

  • Arguments

    • namePipe (character) Pipe name to be introduced into the flow.

• getBanPipes Get the pipe flow array.

  • Usage

    getNamesOfProperties()

  • Value

    Value of pipe ban array.

• addBanPipes Added the name of the pipe to the array that keeps track pipes that can not be run after.

  • Usage

    addBanPipes(namePipe)

  • Arguments

    • namePipe (character) Pipe name to be introduced into the ban array.

• checkCompatibility Check compability between pipes.

  • Usage

    checkCompatibility(namePipe, alwaysBefore)

  • Value

    TRUE/FALSE depends if the compability between pipes is correctly or not.

  • Arguments

    • namePipe (character) Name of the pipe to check the compatibility.

    • alwaysBefore (list) Pipes that the instance had to go through.

Private fields

• date (character) The date on which the source was generated or sent.

• source (character) The text of the file without modifications.

• path (character) Identifier of the instance, in this case it will be the path of the file from which the properties are extracted.

• data (character) The text of the file with modifications.

• properties (list) Contains a list of properties extracted from the text that is being processed.

• isValid (logical) Indicates if the instance is valid or not.

• flowPipes (list) The list contains the pipes that the instance has passed through.

• banPipes (array) The list contains the pipes that can not be executed from that moment.

miferreiro/bdp4R documentation built on May 20, 2019, 12:59 a.m.