Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [Query] >  [Find] >  [slicerFind]
Private  Storage   

class %DeepSee.Query.Find.slicerFind extends %SQL.AbstractFind

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 5


Summary

Properties
qid

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
ContainsItem Find GetChunk NextChunk
PreviousChunk


Properties

• property qid as %Integer;

Methods

• method ContainsItem(pItem As %String) as %Boolean
At minimum, ContainsItem() must always be supported. It returns 1 iff the given pItem is in the set S.
• classmethod Find(pQID As %List) as %SQL.AbstractFind [ SQLProc = slicerFind ]
Find expects pQID in the format $LB(CUBE,slicerKey). The appropriate slotNo to read the slicer from the cache is calculated from the chunk number as needed.
• method GetChunk(pChunk As %Integer) as %Binary

For a given chunk number pChunk, return the corresponding actual bitmap string.

This method must be implemented when %FIND is used.

• method NextChunk(ByRef pChunk As %Integer = "") as %Binary

This method simulates the usage of $ORDER() to traverse through the chunks of a bitmap index or a bitmap temp-file that would represent the set S.

For a given chunk number pChunk, find the first chunk number > pChunk and return it in .pChunk, with the method return value being the corresponding actual bitmap string. Return .pChunk="" if none found.

Note that when returning a positive .pChunk, it's OK for the returned bitmap b to have no bits set to 1, including b="" . On the other hand, it's also OK for the method implementation to skip such a chunk and proceed to the next pChunk.

This method must be implemented when %FIND is used.

• method PreviousChunk(ByRef pChunk As %Integer = "") as %Binary

This method simulates the usage of $ORDER() to traverse backwards through the chunks of a bitmap index or a bitmap temp-file that would represent the set S.

For a given chunk number pChunk, find the first chunk number < pChunk and return it in .pChunk, with the method return value being the corresponding actual bitmap string. Return .pChunk="" if none found.

Note that when returning a positive .pChunk, it's OK for the returned bitmap b to have no bits set to 1, including b="" . On the other hand, it's also OK for the method implementation to skip such a chunk and proceed to the next pChunk.

This method must be implemented when %FIND is used.



Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.