Output Class Reference

Inheritance diagram for Output:

Collaboration diagram for Output:

Public Attributes
	ModelClass
	More...
	OutputText
	Any "transform" operations in the TT model may have had an impact on the original input text. More...
	Ref
	Reference to the original record, when this object is populated during an ApplyBatch() call. More...

Private Member Functions
_.Library.String	GetKeyValueClassname ()

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

This class represents the output generated upon executing a Text Transformation model defined in a <class>iKnow.TextTransformation.Definition</class> 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 <class>Persistent</class> 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 <class>OutputSection</class> and <class>OutputKeyValue</class> as well, make sure to update the return value for the <method>GetSectionClassname</method> and <method>GetKeyValueClassname</methods> and update the implementation of the <method>AddSection</method>, <method>GetSectionCount</method> and <method>GetSectionAt</method> methods accordingly.

Member Function Documentation

GetKeyValueClassname()

_.Library.String GetKeyValueClassname ( )

private

This class represents the output generated upon executing a Text Transformation model defined in a <class>iKnow.TextTransformation.Definition</class> 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 <class>Persistent</class> 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 <class>OutputSection</class> and <class>OutputKeyValue</class> as well, make sure to update the return value for the <method>GetSectionClassname</method> and <method>GetKeyValueClassname</methods> and update the implementation of the <method>AddSection</method>, <method>GetSectionCount</method> and <method>GetSectionAt</method> methods accordingly.

Member Data Documentation

ModelClass

ModelClass

 

 

OutputText

OutputText

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 <class>OutputLocation</class> location references point to.  

Ref

Ref

Reference to the original record, when this object is populated during an ApplyBatch() call.