Processor Class Reference

Inheritance diagram for Processor:

Collaboration diagram for Processor:

Public Member Functions
_.Library.Status	FetchSource (_.Library.Integer loc, _.Library.List ref)
_.Library.Status	SetParams (_.Library.String params)
Public Member Functions inherited from Processor
_.Library.String	GetKnownLanguage (_.Library.Integer loc, _.Library.List ref, _.Library.Integer keyid)
_.Library.Status	ProcessListElement (_.Library.Integer loc, _.Library.List ref, _.Library.Integer keyid, _.Library.String metadata, _.Library.Boolean skipped)
_.Library.Status	ProcessVirtualListElement (_.Library.Integer loc, _.Library.List ref)
	Same as <method>ProcessListElement</method>, but for Virtual Sources.
_.Library.Status	SetConverter (_.Library.Integer convId, _.Library.String convParams)
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 Member Functions
_.Library.List	GetMetadataKeys (_.Library.String params)

Private Attributes
	__GlobalId
	More...
	__GlobalRef
	More...
	__MetadataFields
	More...
	__Separator
	More...
	__Type
	More...

Additional Inherited Members
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 Processor implementation reads data from global nodes, as listed by the ExpandList method of the <class>iKnow.Source.Global.Lister</class>.

Processor parameters:

1. type As <class>Integer</class> - format of global data:
   • 0 - single node (default)
   • 1 - top node has count with subnodes 1..n having data
   • 2 - top node has metadata, subnodes 1..n have data
2. separator As <class>String</class> - default "", but could use " ", $c(13,10) or $c(10), " . " to either keep each node separated, or on separate line, or separate sentence.
3. metadataFields As <class>String</class> - for type 2 only, list of metadata fields in top node

Extracted metadata keys: [None]

Member Function Documentation

FetchSource()

_.Library.Status FetchSource	(	_.Library.Integer	loc,
		_.Library.List	ref
	)

This Processor implementation reads data from global nodes, as listed by the ExpandList method of the <class>iKnow.Source.Global.Lister</class>.

Processor parameters:

1. type As <class>Integer</class> - format of global data:
   • 0 - single node (default)
   • 1 - top node has count with subnodes 1..n having data
   • 2 - top node has metadata, subnodes 1..n have data
2. separator As <class>String</class> - default "", but could use " ", $c(13,10) or $c(10), " . " to either keep each node separated, or on separate line, or separate sentence.
3. metadataFields As <class>String</class> - for type 2 only, list of metadata fields in top node

Extracted metadata keys: [None]

GetMetadataKeys()

_.Library.List GetMetadataKeys ( _.Library.String  params )

static

Subclasses should override this method to identify those metadata keys that are

calculated or extracted by this Processor implementation and will be registered for every source processed by calling <method>SetCurrentMetadataValues</method> during the <method>FetchSource</method> execution.

Reimplemented from Processor.

SetParams()

_.Library.Status SetParams

(

_.Library.String

params

)

This method stores the Processor parameters in the <property>Params</property> property,

from where they can be referenced in the <method>FetchSource</method> implementation.

NOTE: If this method is overridden by a subclass, it should make sure to either call this method via ##super, or set <property>Params</property> itself.

Reimplemented from Processor.

Member Data Documentation

__GlobalId

__GlobalId

private

 

 

__GlobalRef

__GlobalRef

private

 

 

__MetadataFields

__MetadataFields

private

 

 

__Separator

__Separator

private

 

 

__Type

__Type

private