Classdefault`Abstract`

Hierarchy (view full)

default
- default
  - default
  - default

Implements

RetrieverInterface

Index

Constructors

Methods

addToHistory buildPath checkIsValidDownloadedFile clearHistory download getBasePath getDownloader retrieve retrieveHistory searchElements searchNamespace setDownloader urlParts

Constructors

constructor

new default(basePath, downloader?): default
Parameters
- basePath: string
- Optionaldownloader: DownloaderInterface
Returns default
Overrides default.constructor
- Defined in abstract_xml_retriever.ts:12

Methods

`Protected`addToHistory

addToHistory(source, localPath): void
Parameters
- source: string
- localPath: string
Returns void
Inherited from default.addToHistory
- Defined in abstract_base_retriever.ts:86

buildPath

buildPath(url): string
Return the path where an url would be located
Parameters
- url: string
Returns string
Implementation of RetrieverInterface.buildPath
Inherited from default.buildPath
- Defined in abstract_base_retriever.ts:40

`Protected`checkIsValidDownloadedFile

checkIsValidDownloadedFile(source, localPath): Promise<void>
This method checks if the recently downloaded file from source located at path is a valid resource, if not will remove the file and throw an exception
Parameters
- source: string
- localPath: string
Returns Promise<void>
Overrides default.checkIsValidDownloadedFile
- Defined in abstract_xml_retriever.ts:26

`Protected`clearHistory

clearHistory(): void
Returns void
Inherited from default.clearHistory
- Defined in abstract_base_retriever.ts:82

download

download(url): Promise<string>
Download an url without its related resources Return the path where the resource is located (as in buildPath)
Parameters
- url: string
Returns Promise<string>
Implementation of RetrieverInterface.download
Inherited from default.download
- Defined in abstract_base_retriever.ts:49

getBasePath

getBasePath(): string
Must return the base path where the elements will be downloaded

Returns string
Implementation of RetrieverInterface.getBasePath
Inherited from default.getBasePath
- Defined in abstract_base_retriever.ts:28

getDownloader

getDownloader(): DownloaderInterface
Returns DownloaderInterface
Inherited from default.getDownloader
- Defined in abstract_base_retriever.ts:32

retrieve

retrieve(url): Promise<string>
Retrieve an url and all its related resources Return the path where the resource is located (as in buildPath)
Parameters
- url: string
Returns Promise<string>
Implementation of RetrieverInterface.retrieve
Overrides default.retrieve
- Defined in abstract_xml_retriever.ts:16

retrieveHistory

retrieveHistory(): Record<string, string>
Returns the history of the last retrieve operation The return is un record of key value pairs where the key is the url retrieved and the value is the path

Returns Record<string, string>
Implementation of RetrieverInterface.retrieveHistory
Inherited from default.retrieveHistory
- Defined in abstract_base_retriever.ts:76

`Protected` `Abstract`searchElements

searchElements(): Record<string, string>[]
Must return a table with rows (array of records) every row must contain the keys element and attribute "element" is the tag name to search for "attribute" is the attribute name that contains the url

Returns Record<string, string>[]
- Defined in abstract_xml_retriever.ts:58

`Protected` `Abstract`searchNamespace

searchNamespace(): string
Must return a string with the namespace to search for

Returns string
- Defined in abstract_xml_retriever.ts:50

setDownloader

setDownloader(downloader): void
Parameters
- downloader: DownloaderInterface
Returns void
Inherited from default.setDownloader
- Defined in abstract_base_retriever.ts:36

`Protected`urlParts

urlParts(url): undefined | Record<string, string>
Retrieve url parts If url is malformed return false
Parameters
- url: string
  string url
Returns undefined | Record<string, string>
Inherited from default.urlParts
- Defined in abstract_base_retriever.ts:96