This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %iKnow.TextTransformation.Output

%iKnow.TextTransformation.Output

class %iKnow.TextTransformation.Output extends %Library.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 %GetKeyValueClassname() and update the implementation of the AddSection(), GetSectionCount() and GetSectionAt() methods accordingly.

Property Inventory

Method Inventory

Properties

property ModelClass as %String (MAXLEN = 200);
Property methods: ModelClassDisplayToLogical(), ModelClassGet(), ModelClassIsValid(), ModelClassLogicalToDisplay(), ModelClassLogicalToOdbc(), ModelClassNormalize(), ModelClassSet()
property OutputText as %String);
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 methods: OutputTextDisplayToLogical(), OutputTextGet(), OutputTextIsValid(), OutputTextLogicalToDisplay(), OutputTextLogicalToOdbc(), OutputTextNormalize(), OutputTextSet()
property Ref as %CacheString;
Reference to the original record, when this object is populated during an %ApplyBatch() call.
Property methods: RefGet(), RefIsValid(), RefSet()

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

Indexes

index (RefIdx on Ref);

Inherited Members

Inherited Methods

FeedbackOpens in a new window