Processor Class Reference

Inheritance diagram for Processor:

Collaboration diagram for Processor:

Public Member Functions
_.Library.String	GetKnownLanguage (_.Library.Integer loc, _.Library.List ref, _.Library.Integer keyid)
_.Library.Status	SetParams (_.Library.String params)
Public Member Functions inherited from Processor
_.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 Member Functions
_.Library.Status	__FetchSource (_.Library.Integer loc, _.Library.List ref)

Private Attributes
	__MetaFields
	More...
	__OverrideLanguage
	More...
	__PreserveSentences
	More...
	__SrcDomainId
	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 existing sources in a (typically different) domain, as listed by the ExpandList method of the <class>iKnow.Source.Domain.Lister</class>. These Lister and Processor classes are at the core of the <class>iKnow.Utils.CopyUtils</class> and <class>iKnow.Utils.UpgradeUtils</class> classes.

Processor parameters:

1. srcDomainId As <class>Integer</class> - the domain where to copy data from. (only required when specifying metaFields)
2. metaFields As <class>List</class> (optional) - the metadata fields to copy from the source domain into the target one.
3. overrideLanguage As <class>String</class> (optional) - the two-letter language code of a language to use overriding what can be derived from the source domain. Leave blank to use source domain values and use "AUTO" to re-detect using normal configuration settings.
4. preserveSentences As <class>Boolean</class> (optional, defaults to 1) - whether or not to preserve the exact same sentence splittings as in the original indexation.

Extracted metadata keys: see metaFields Processor parameter.

Member Function Documentation

__FetchSource()

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

private

This Processor implementation reads data from existing sources in a (typically different) domain, as listed by the ExpandList method of the <class>iKnow.Source.Domain.Lister</class>. These Lister and Processor classes are at the core of the <class>iKnow.Utils.CopyUtils</class> and <class>iKnow.Utils.UpgradeUtils</class> classes.

Processor parameters:

1. srcDomainId As <class>Integer</class> - the domain where to copy data from. (only required when specifying metaFields)
2. metaFields As <class>List</class> (optional) - the metadata fields to copy from the source domain into the target one.
3. overrideLanguage As <class>String</class> (optional) - the two-letter language code of a language to use overriding what can be derived from the source domain. Leave blank to use source domain values and use "AUTO" to re-detect using normal configuration settings.
4. preserveSentences As <class>Boolean</class> (optional, defaults to 1) - whether or not to preserve the exact same sentence splittings as in the original indexation.

Extracted metadata keys: see metaFields Processor parameter.

Reimplemented from Processor.

GetKnownLanguage()

_.Library.String GetKnownLanguage	(	_.Library.Integer	loc,
		_.Library.List	ref,
		_.Library.Integer	keyid
	)

This method is called from <method>ProcessListElement</method> and <method>ProcessVirtualListElement</method>

right before calling on the Indexer to process the data read by this Processor instance. It returns the language (two-letter ISO code) for the source being processed, if there is any means to derive it from known facts about the source. If no language can be derived with enough certainty, this method returns "".

The default implementation looks if there is a $$$IKPLANGUAGEFIELDNAME parameter defined pointing to a metadata field containing the language code. Subclasses may override and/or extend this method if they have access to additional information.

Reimplemented from Processor.

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

__MetaFields

__MetaFields

private

 

 

__OverrideLanguage

__OverrideLanguage

private

 

 

__PreserveSentences

__PreserveSentences

private

 

 

__SrcDomainId

__SrcDomainId

private