Provides the required methods to succesfully handle each
Instance class.
InstanceInstance$new(path)
Arguments:
path: (character) path of the file.
obtainDate:
abstract function responsible for obtainining the date of the
Instance.
obtainSource:
abstract function in charge of determining the source of the
Instance.
getDate: gets of date.
Usage:
getDate()
Value: Value of date.
setDate: sets of date.
Usage:
setDate(date)
Arguments:
date: (character) the new value of date.
getSource: gets of source.
Usage:
getSource()
Value: value of source.
setSource: modifies the source value.
Usage:
setSource(source)
Arguments:
source: (character) the new value of source.
getPath: gets of path.
Usage:
getPath()
Value: value of path.
getProperties: gets the list of properties.
Usage:
getProperties()
Value: Value of properties.
setProperties: modifies the list of properties.
Usage:
setProperties(properties)
Arguments:
properties: (list) containing the new properties.
addProperties: adds a property to the list of properties.
Usage:
addProperties(propertyValue, propertyName)
Arguments:
propertyValue: (Object) 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: checks for the existence of an specific property.
Usage:
isSpecificProperty(propertyName)
Value: A boolean results according to the existence of the specific property in the list of properties.
Arguments:
propertyName: (character) the name of the property to check.
setSpecificProperty: modifies the value of the one property.
Usage:
setSpecificProperty(propertyName, propertyValue)
Arguments:
propertyName: (Object) the new value of the property.
propertyValue: (character) the name of the property.
getNamesOfProperties: gets of the names of all properties.
Usage:
getNamesOfProperties()
Value: the names of properties.
isInstanceValid:
checks if the Instance is valid.
Usage:
isInstanceValid()
Value: value of isValid.
invalidate:
forces the invalidation of an specific Instance.
Usage:
invalidate()
getFlowPipes: gets the list of the flow of Pipes.
Usage:
getNamesOfProperties()
Value: names of the Pipes used.
addFlowPipes: adds a new Pipe to the flow of Pipes.
Usage:
addFlowPipes(namePipe)
Arguments:
namePipe: (character) name of the new Pipe to be added in the Pipe flow.
getBanPipes: gets an array with contaning all the Pipes.
Usage:
getBanPipes()
Value: value of Pipe ban array.
addBanPipes: added the name of the Pipe to the array that keeps the track of Pipes having running after restrictions.
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: boolean, 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.
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.