Class DataCubeEngineAbstract

constructor

• new DataCubeEngine(): DataCubeEngine

• Returns DataCubeEngine

ReadonlyaggregateOperations

ReadonlyfilterOperations

Readonlylayout

alert

• alert(
      options: {
          actions?: ActionAlertAction[];
          message: string;
          text?: string;
          type: AlertType;
          windowConfig?: WindowConfiguration;
          windowTitle?: string;
      },
  ): void

• Parameters

  • options: {
        actions?: ActionAlertAction[];
        message: string;
        text?: string;
        type: AlertType;
        windowConfig?: WindowConfiguration;
        windowTitle?: string;
    }

  Returns void

alertCodeCheckError

• alertCodeCheckError(
      error: EngineError,
      code: string,
      codePrefix: string,
      options: {
          actions?: ActionAlertAction[];
          message: string;
          text?: string;
          windowConfig?: WindowConfiguration;
          windowTitle?: string;
      },
  ): void

• Parameters

  • error: EngineError
  • code: string
  • codePrefix: string
  • options: {
        actions?: ActionAlertAction[];
        message: string;
        text?: string;
        windowConfig?: WindowConfiguration;
        windowTitle?: string;
    }

  Returns void

alertError

• alertError(
      error: Error,
      options: {
          actions?: ActionAlertAction[];
          message: string;
          text?: string;
          windowConfig?: WindowConfiguration;
          windowTitle?: string;
      },
  ): void

• Parameters

  • error: Error
  • options: {
        actions?: ActionAlertAction[];
        message: string;
        text?: string;
        windowConfig?: WindowConfiguration;
        windowTitle?: string;
    }

  Returns void

alertUnhandledError

• alertUnhandledError(error: Error): void

• Parameters

  • error: Error

  Returns void

AbstractbuildExecutionContext

• buildExecutionContext(source: DataCubeSource): undefined | V1_AppliedFunction

• Parameters

  • source: DataCubeSource

  Returns undefined | V1_AppliedFunction

debugProcess

• debugProcess(processName: string, ...data: [string, unknown][]): void

• Parameters

  • processName: string
  • ...data: [string, unknown][]

  Returns void

AbstractexecuteQuery

• executeQuery(
      query: V1_Lambda,
      source: DataCubeSource,
      api: DataCubeAPI,
  ): Promise<DataCubeExecutionResult>

• Parameters

  • query: V1_Lambda
  • source: DataCubeSource
  • api: DataCubeAPI

  Returns Promise<DataCubeExecutionResult>

generateInitialQuery

• generateInitialQuery(snapshot: DataCubeQuerySnapshot): V1_AppliedFunction

• Parameters

  • snapshot: DataCubeQuerySnapshot

  Returns V1_AppliedFunction

getAggregateOperation

• getAggregateOperation(value: string): DataCubeQueryAggregateOperation

• Parameters

  • value: string

  Returns DataCubeQueryAggregateOperation

AbstractgetBaseQuery

• getBaseQuery(): Promise<undefined | DataCubeQuery>

• Returns Promise<undefined | DataCubeQuery>

getDocumentationEntry

• getDocumentationEntry(key: string): undefined | DocumentationEntry

• Parameters

  • key: string

  Returns undefined | DocumentationEntry

getDocumentationURL

• getDocumentationURL(): undefined | string

• Returns undefined | string

getFilterOperation

• getFilterOperation(value: string): DataCubeQueryFilterOperation

• Parameters

  • value: string

  Returns DataCubeQueryFilterOperation

getPartialQueryCode

• getPartialQueryCode(
      snapshot: DataCubeQuerySnapshot,
      pretty?: boolean,
  ): Promise<string>

• By default, for a function chain, Pure grammar composer will extract the first parameter of the first function and render it as the caller of that function rather than a parameter e.g. fx(fy(p1, p2), p3) will be rendered as p1->fy(p2)->fx(p3) instead of fy(p1, p2)-> fx(p3)

  We do a hack to get around this by setting a dummy value as the first parameter of the first function in the chain. Then remove this dummy value from the final code.

  Parameters

  • snapshot: DataCubeQuerySnapshot
  • Optionalpretty: boolean

  Returns Promise<string>

AbstractgetQueryCodeRelationReturnType

• getQueryCodeRelationReturnType(
      code: string,
      baseQuery: V1_ValueSpecification,
      source: DataCubeSource,
  ): Promise<RelationType>

• Parameters

  • code: string
  • baseQuery: V1_ValueSpecification
  • source: DataCubeSource

  Returns Promise<RelationType>

AbstractgetQueryRelationType

• getQueryRelationType(
      query: V1_Lambda,
      source: DataCubeSource,
  ): Promise<RelationType>

• Parameters

  • query: V1_Lambda
  • source: DataCubeSource

  Returns Promise<RelationType>

AbstractgetQueryTypeahead

• getQueryTypeahead(
      code: string,
      baseQuery: V1_Lambda,
      source: DataCubeSource,
  ): Promise<CompletionItem[]>

• Parameters

  • code: string
  • baseQuery: V1_Lambda
  • source: DataCubeSource

  Returns Promise<CompletionItem[]>

AbstractgetValueSpecificationCode

• getValueSpecificationCode(
      value: V1_ValueSpecification,
      pretty?: boolean,
  ): Promise<string>

• Parameters

  • value: V1_ValueSpecification
  • Optionalpretty: boolean

  Returns Promise<string>

initialize

• initialize(): Promise<void>

• Returns Promise<void>

logDebug

• logDebug(message: string, ...data: unknown[]): void

• Parameters

  • message: string
  • ...data: unknown[]

  Returns void

logError

• logError(event: LogEvent, ...data: unknown[]): void

• Parameters

  • event: LogEvent
  • ...data: unknown[]

  Returns void

logIllegalStateError

• logIllegalStateError(message: string, error?: Error): void

• Parameters

  • message: string
  • Optionalerror: Error

  Returns void

logInfo

• logInfo(event: LogEvent, ...data: unknown[]): void

• Parameters

  • event: LogEvent
  • ...data: unknown[]

  Returns void

logUnhandledError

• logUnhandledError(error: Error): void

• Parameters

  • error: Error

  Returns void

logWarning

• logWarning(event: LogEvent, ...data: unknown[]): void

• Parameters

  • event: LogEvent
  • ...data: unknown[]

  Returns void

openLink

• openLink(url: string): void

• Parameters

  • url: string

  Returns void

AbstractparseValueSpecification

• parseValueSpecification(
      code: string,
      returnSourceInformation?: boolean,
  ): Promise<V1_ValueSpecification>

• Parameters

  • code: string
  • OptionalreturnSourceInformation: boolean

  Returns Promise<V1_ValueSpecification>

AbstractprocessQuerySource

• processQuerySource(value: PlainObject<T>): Promise<DataCubeSource>

• Parameters

  • value: PlainObject<T>

  Returns Promise<DataCubeSource>

sendTelemetry

• sendTelemetry(event: string, data: PlainObject<T>): void

• Parameters

  • event: string
  • data: PlainObject<T>

  Returns void

shouldDisplayDocumentationEntry

• shouldDisplayDocumentationEntry(entry: DocumentationEntry): boolean

• Parameters

  • entry: DocumentationEntry

  Returns boolean