Home Reference Source 
import Processor from 'information-retrieval-boilerplate/node-information-retrieval-boilerplate/src/processors/Processor.js'
public class | source

Processor

A Processor

Constructor Summary

Public Constructor
public

constructor(config: object)

Construct a new Processor

Member Summary

Public Members
public

bind: *

public

Type of index.

Method Summary

Public Methods
public

async addDocuments(system: *, documentIndices: *, documents: *)

for classes with bind 'add'
public

async processQuery(system: *, query: *)

for classes with bind 'query'
public

async processResults(system: *, query: *, results: *)

for classes with bind 'results'
public

async removeDocuments(system: *, documentIndices: *)

for classes with bind 'remove'
public

async state(): object

Dump current index state.

Public Constructors

public constructor(config: object) source

Construct a new Processor

Params:

NameTypeAttributeDescription
config object
  • optional
  • default: {}

configuration; see properties

Public Members

public bind: * source

public type: string source

Type of index. These are usually predefined values. Filled in by class.

Public Methods

public async addDocuments(system: *, documentIndices: *, documents: *) source

for classes with bind 'add'

Params:

NameTypeAttributeDescription
system *
documentIndices *
documents *

public async processQuery(system: *, query: *) source

for classes with bind 'query'

Params:

NameTypeAttributeDescription
system *
query *

public async processResults(system: *, query: *, results: *) source

for classes with bind 'results'

Params:

NameTypeAttributeDescription
system *
query *
results *

public async removeDocuments(system: *, documentIndices: *) source

for classes with bind 'remove'

Params:

NameTypeAttributeDescription
system *
documentIndices *

public async state(): object source

Dump current index state.

Return:

object