Class AbstractXmlRetriever`Abstract`

Hierarchy

AbstractBaseRetriever
- AbstractXmlRetriever
  - XsdRetriever
  - XsltRetriever

Implements

RetrieverInterface

Index

Constructors

Methods

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

Constructors

constructor

new AbstractXmlRetriever(basePath: string, downloader?: DownloaderInterface): AbstractXmlRetriever
Parameters
- basePath: string
- Optional downloader: DownloaderInterface
Returns AbstractXmlRetriever
Overrides AbstractBaseRetriever.constructor
- Defined in abstract-xml-retriever.ts:14

Methods

`Protected` addToHistory

addToHistory(source: string, localPath: string): void
Parameters
- source: string
- localPath: string
Returns void
Inherited from AbstractBaseRetriever.addToHistory
- Defined in abstract-base-retriever.ts:88

buildPath

buildPath(url: string): string
Parameters
- url: string
Returns string
Implementation of RetrieverInterface.buildPath

Inherited from AbstractBaseRetriever.buildPath
- Defined in abstract-base-retriever.ts:42

`Protected` checkIsValidDownloadedFile

checkIsValidDownloadedFile(source: string, localPath: string): 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 AbstractBaseRetriever.checkIsValidDownloadedFile
- Defined in abstract-xml-retriever.ts:32

`Protected` clearHistory

clearHistory(): void
Returns void
Inherited from AbstractBaseRetriever.clearHistory
- Defined in abstract-base-retriever.ts:84

`Private` doRetrieve

doRetrieve(resource: string): Promise<string>
Parameters
- resource: string
Returns Promise<string>
- Defined in abstract-xml-retriever.ts:69

download

download(url: string): Promise<string>
Parameters
- url: string
Returns Promise<string>
Implementation of RetrieverInterface.download

Inherited from AbstractBaseRetriever.download
- Defined in abstract-base-retriever.ts:51

getBasePath

getBasePath(): string
Returns string
Implementation of RetrieverInterface.getBasePath

Inherited from AbstractBaseRetriever.getBasePath
- Defined in abstract-base-retriever.ts:30

getDownloader

getDownloader(): DownloaderInterface
Returns DownloaderInterface
Inherited from AbstractBaseRetriever.getDownloader
- Defined in abstract-base-retriever.ts:34

`Private` recursiveRetrieve

recursiveRetrieve(document: Document, tagName: string, attributeName: string, currentUrl: string, currentFile: string): Promise<boolean>
Parameters
- document: Document
- tagName: string
- attributeName: string
- currentUrl: string
- currentFile: string
Returns Promise<boolean>
- Defined in abstract-xml-retriever.ts:132

`Private` relativeToAbsoluteUrl

relativeToAbsoluteUrl(url: string, currentUrl: string): string
Parameters
- url: string
- currentUrl: string
Returns string
- Defined in abstract-xml-retriever.ts:166

retrieve

retrieve(url: string): Promise<string>
Parameters
- url: string
Returns Promise<string>
Implementation of RetrieverInterface.retrieve

Overrides AbstractBaseRetriever.retrieve
- Defined in abstract-xml-retriever.ts:18

retrieveHistory

retrieveHistory(): Record<string, string>
Returns Record<string, string>
Implementation of RetrieverInterface.retrieveHistory

Inherited from AbstractBaseRetriever.retrieveHistory
- Defined in abstract-base-retriever.ts:78

`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:67

`Protected` `Abstract` searchNamespace

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

Returns string
- Defined in abstract-xml-retriever.ts:59

setDownloader

setDownloader(downloader: DownloaderInterface): void
Parameters
- downloader: DownloaderInterface
Returns void
Inherited from AbstractBaseRetriever.setDownloader
- Defined in abstract-base-retriever.ts:38

`Protected` urlParts

urlParts(url: string): 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 AbstractBaseRetriever.urlParts
- Defined in abstract-base-retriever.ts:98

Generated using TypeDoc