Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%iKnow] >  [TextTransformation] >  [Output]
Private  Storage   

class %iKnow.TextTransformation.Output extends %RegisteredObject

This class represents the output generated upon executing a Text Transformation model defined in a %iKnow.TextTransformation.Definition class. By default, instances of this class are populated to represent the sections and key-value pairs identified in the input text, so they can be accessed and acted upon directly.

However, instances of this class are not persisted. To enable persisting TT model output, just create a subclass from this class that also inherits from %Persistent and register its name through the outputClass attribute of the root model element in your TT model definition. Subclasses can also refine the rest of the output class by defining additional indices and/or adding custom properties that can be populated in the callbacks of the TT model definition class.

If you choose to refine the child classes OutputSection and OutputKeyValue as well, make sure to update the return value for the %GetSectionClassname and and update the implementation of the AddSection>%GetKeyValueClassname and update the implementation of the AddSection, GetSectionCount and GetSectionAt methods accordingly.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 5 1


Summary

Properties
ModelClass OutputText Ref

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetKeyValueClassname %GetParameter %GetSectionClassname %IsA
%IsModified %New %NormalizeObject %ObjectModified
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject AddSection GetSectionAt
GetSectionCount


Properties

• property ModelClass as %String(MAXLEN=200);
• property OutputText as %String(MAXLEN="");
Any "transform" operations in the TT model may have had an impact on the original input text. This propert contains the final form of the text after processing, which the OutputLine numbers in any OutputLocation location references point to.
• property Ref as %RawString;
Reference to the original record, when this object is populated during an %ApplyBatch() call.

Methods

• method %GetKeyValueClassname() as %String
• method %GetSectionClassname() as %String
• method AddSection(pSection As OutputSection) as %Status
• method GetSectionAt(pPosition As %Integer) as OutputSection
• method GetSectionCount() as %Integer

Indices

•index (RefIdx on Ref);


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