bdpar (version 3.1.0)

Instance: Abstract super class that handles the management of the Instances

Description

Provides the required methods to successfully handle each Instance class.

Methods

Public methods

• Instance$new()

• Instance$obtainDate()

• Instance$obtainSource()

• Instance$getDate()

• Instance$getSource()

• Instance$getPath()

• Instance$getData()

• Instance$getProperties()

• Instance$setSource()

• Instance$setData()

• Instance$setDate()

• Instance$setProperties()

• Instance$addProperties()

• Instance$getSpecificProperty()

• Instance$isSpecificProperty()

• Instance$setSpecificProperty()

• Instance$getNamesOfProperties()

• Instance$isInstanceValid()

• Instance$invalidate()

• Instance$getFlowPipes()

• Instance$addFlowPipes()

• Instance$getBanPipes()

• Instance$addBanPipes()

• Instance$checkCompatibility()

• Instance$toString()

• Instance$clone()

---

Method new()

Creates a Instance object.

Usage

Instance$new(path)

Arguments

path

A character value. Path of the file.

---

Method obtainDate()

Abstract function responsible for obtaining the date of the Instance.

Usage

Instance$obtainDate()

---

Method obtainSource()

Abstract function responsible for determining the source of the Instance.

Usage

Instance$obtainSource()

---

Method getDate()

Gets the date.

Usage

Instance$getDate()

Returns

Value of date.

---

Method getSource()

Gets the source.

Usage

Instance$getSource()

Returns

Value of source.

---

Method getPath()

Gets the path.

Usage

Instance$getPath()

Returns

Value of path.

---

Method getData()

Gets the data.

Usage

Instance$getData()

Returns

Value of data.

---

Method getProperties()

Gets the properties

Usage

Instance$getProperties()

Returns

Value of properties.

---

Method setSource()

Modifies the source value.

Usage

Instance$setSource(source)

Arguments

source

A character value. The new value of source.

---

Method setData()

Modifies the data value.

Usage

Instance$setData(data)

Arguments

data

A character value. The new value of data.

---

Method setDate()

Modifies the date value.

Usage

Instance$setDate(date)

Arguments

date

A character value. The new value of date.

---

Method setProperties()

Modifies the properties value.

Usage

Instance$setProperties(properties)

Arguments

properties

A list value. The new list of properties.

---

Method addProperties()

Adds a property to the list of the properties.

Usage

Instance$addProperties(propertyValue, propertyName)

Arguments

propertyValue

A Object value. The value of the new property.

propertyName

A character value. The name of the new property.

---

Method getSpecificProperty()

Obtains a specific property.

Usage

Instance$getSpecificProperty(propertyName)

Arguments

propertyName

A character value. The name of the property to obtain.

Returns

The value of the specific property.

---

Method isSpecificProperty()

Checks for the existence of an specific property.

Usage

Instance$isSpecificProperty(propertyName)

Arguments

propertyName

A character value. The name of the property to check.

Returns

A logical results according to the existence of the specific property in the list of properties.

---

Method setSpecificProperty()

Modifies the value of the one property.

Usage

Instance$setSpecificProperty(propertyName, propertyValue)

Arguments

propertyName

A character value. The name of the property.

propertyValue

A Object value. The new value of the property.

---

Method getNamesOfProperties()

Gets of the names of all properties.

Usage

Instance$getNamesOfProperties()

Returns

The names of properties.

---

Method isInstanceValid()

Checks if the Instance is valid.

Usage

Instance$isInstanceValid()

Returns

Value of isValid flag.

---

Method invalidate()

Forces the invalidation of an specific Instance.

Usage

Instance$invalidate()

---

Method getFlowPipes()

Gets the list of the flow of GenericPipe.

Usage

Instance$getFlowPipes()

Returns

Names of the GenericPipe used.

---

Method addFlowPipes()

Gets the list of the flow of GenericPipe.

Usage

Instance$addFlowPipes(namePipe)

Arguments

namePipe

A character value. Name of the new GenericPipe to be added in the GenericPipeline.

---

Method getBanPipes()

Gets an array with containing all the ban GenericPipe.

Usage

Instance$getBanPipes()

Returns

Value of ban GenericPipe array.

---

Method addBanPipes()

Added the name of the Pipe to the array that keeps the track of GenericPipes having running after restrictions.

Usage

Instance$addBanPipes(namePipe)

Arguments

namePipe

A character value. GenericPipe name to be introduced into the ban array.

---

Method checkCompatibility()

Check compatibility between GenericPipes.

Usage

Instance$checkCompatibility(namePipe, alwaysBefore)

Arguments

namePipe

A character value. The name of the GenericPipe name to check the compatibility.

alwaysBefore

A list value. GenericPipes that the Instance had to go through.

---

Method toString()

Returns a character representing the instance

Usage

Instance$toString()

Returns

Instance character representation

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Instance$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

ExtractorEml, ExtractorSms, ExtractorYtbid