Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [VDoc] >  [SearchTable]
Private  Storage   

abstract class Ens.VDoc.SearchTable extends Ens.SearchTableBase

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 7 2


Summary

Properties
DocId PropId PropValue

Methods
BuildIndex DeleteProps GetExtentSuperclass IndexDoc
IsASub IsListExpression RemoveIndex RemoveSearchTableEntries
Search SearchHeader genGetCode genGetCodeList

Subclasses
Ens.VDoc.XMLSearchTable EnsLib.EDI.EDIFACT.SearchTable EnsLib.EDI.X12.SearchTable
EnsLib.EDI.XML.SearchTable

Properties

• property PropId as %Integer;
Index of a virtual property definition row in class Ens.Config.SearchTableProp, in the context of the current SearchTable subclass's storage extent
• property PropValue as %String(MAXLEN=256,TRUNCATE=1);
Value found in the document using the ValueGetExpression from the property Item referred to by PropId

Methods

• classmethod DeleteProps() as %Status
Delete the objects that define SearchTable properties for this searchTable class and all other classes in the same inheritance tree.
• classmethod IndexDoc(pDocObj As %Persistent) as %Status
Method which actually performs indexing of the message / document supplied in the pDocObj argument. This method should be overridden in subclasses.
• classmethod IsListExpression(tGetExpression As %String) as %Boolean
Returns True if the given expression will return multiple values
• classmethod Search(Output pOutput, pPropId As %Integer, pPropValue As %String, pSearchNulls As %Boolean = 0, ByRef pRows=250) as %Status
Build output array of all documents and message headers that contain the given value for the given property
• classmethod genGetCode(tGetExpression As %String) as %String
Generates an expression that 1) evaluates to a string value and 2) sets status code 'tSCGet'
• classmethod genGetCodeList(tGetExpression As %String, tPreExpression As %String, tPostExpression As %String) as %String
Generates an expression that sets an array of values found in 'tList' and 2) sets status code 'tSCGet' It may evaluate to a string but we intend to ignore that.

Indices

•index (indexDocId on DocId,PropId,PropValue) [Unique];
•index (indexValue on PropId,PropValue,DocId) [IdKey,Unique];


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